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=aba43c3d-9a1e-4df1-b1c0-d4c315c1bdf4


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: aba43c3d-9a1e-4df1-b1c0-d4c315c1bdf4


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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NiIsImVtYWlsIjoiZW1haWwtMTk4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NjJ9.ADT4uWwu6lOWZXS3vRH1BhDZ8-P72fnJkVPCEwm6YHw
Host: example.org


curl "https://api.[your-domain.com]/v2/service_usage_events?results-per-page=1&after_guid=aba43c3d-9a1e-4df1-b1c0-d4c315c1bdf4" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2NiIsImVtYWlsIjoiZW1haWwtMTk4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjc0ODA4NjJ9.ADT4uWwu6lOWZXS3vRH1BhDZ8-P72fnJkVPCEwm6YHw" \
	-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=aba43c3d-9a1e-4df1-b1c0-d4c315c1bdf4&order-direction=asc&page=2&results-per-page=1",
  "resources": [
      "metadata": {
        "guid": "8b0cb8f5-d245-4aa9-9b68-41c260b5564a",
        "url": "/v2/service_usage_events/8b0cb8f5-d245-4aa9-9b68-41c260b5564a",
        "created_at": "2015-03-20T18:27:42Z"
      "entity": {
        "state": "CREATED",
        "org_guid": "guid-015864d9-b079-4653-a37c-4d29c98a5d78",
        "space_guid": "guid-82006db6-207d-44f1-b03b-b95b1bd8ead4",
        "space_name": "name-1681",
        "service_instance_guid": "guid-759c1be1-1114-452c-b1ac-9b000a5a352e",
        "service_instance_name": "name-1682",
        "service_instance_type": "type-5",
        "service_plan_guid": "guid-d61d1919-9373-4fbb-8d77-a9c1381a4533",
        "service_plan_name": "name-1683",
        "service_guid": "guid-c382da42-3087-4d1f-ac33-54e5ef73faf2",
        "service_label": "label-67"


Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e1f8bd42-93f7-41e2-b51c-bdc9665e5536
Content-Length: 1053
X-Content-Type-Options: nosniff