Home
Version 3
Service Usage Events (experimental) API

Service Usage Events (experimental) 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.

Fields

Name Description Default Valid Values Example Values
guid The guid of the event.
state The desired state of the service.
  • CREATED
  • DELETED
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.

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: 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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3OSIsImVtYWlsIjoiZW1haWwtMjgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczODF9.4l8BwNIhIBPowMsJSM7ZsUDvKk8xhzhquYQci0ylV_4
Host: example.org
Cookie: 

Route

GET /v2/service_usage_events?results-per-page=1&after_guid=ac06ba5b-58dc-4ec2-81a8-7969be0ceb7d

Query Parameters

results-per-page: 1
after_guid: ac06ba5b-58dc-4ec2-81a8-7969be0ceb7d

cURL

curl "https://api.[your-domain.com]/v2/service_usage_events?results-per-page=1&after_guid=ac06ba5b-58dc-4ec2-81a8-7969be0ceb7d" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM3OSIsImVtYWlsIjoiZW1haWwtMjgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczODF9.4l8BwNIhIBPowMsJSM7ZsUDvKk8xhzhquYQci0ylV_4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 12155c26-6e77-4a4c-9e62-be7f0577da37
Content-Length: 1053
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 2,
  "prev_url": null,
  "next_url": "/v2/service_usage_events?after_guid=ac06ba5b-58dc-4ec2-81a8-7969be0ceb7d&order-direction=asc&page=2&results-per-page=1",
  "resources": [
    {
      "metadata": {
        "guid": "bb2b6690-e56e-47c2-80fb-f27105bf6467",
        "url": "/v2/service_usage_events/bb2b6690-e56e-47c2-80fb-f27105bf6467",
        "created_at": "2015-02-10T01:43:01Z"
      },
      "entity": {
        "state": "CREATED",
        "org_guid": "guid-9d2f6143-1ea8-46f9-82d4-5323275208fc",
        "space_guid": "guid-dfe37fa7-ab34-48d1-ae04-bef42f3022dd",
        "space_name": "name-2029",
        "service_instance_guid": "guid-66a59bb8-3ba1-41b6-8a8d-740fa9c7a8eb",
        "service_instance_name": "name-2030",
        "service_instance_type": "type-8",
        "service_plan_guid": "guid-d555dcf6-1888-4cc9-95c5-bfd118208b1c",
        "service_plan_name": "name-2031",
        "service_guid": "guid-aa865ec8-be04-4185-9288-8e31594dea53",
        "service_label": "label-78"
      }
    }
  ]
}