Home
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.

Request

Route

GET /v2/service_usage_events?results-per-page=1&after_guid=36ec8730-b9c6-4254-b10e-1e8cbc90baf4

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, 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: 36ec8730-b9c6-4254-b10e-1e8cbc90baf4

Body

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.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NiIsImVtYWlsIjoiZW1haWwtODRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMzk4MTEwNX0.hTHkJOM0v5Pc2fkX4FY7gvraSf3op3YiYV_uoE3p-Nc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_usage_events?results-per-page=1&after_guid=36ec8730-b9c6-4254-b10e-1e8cbc90baf4" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NiIsImVtYWlsIjoiZW1haWwtODRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMzk4MTEwNX0.hTHkJOM0v5Pc2fkX4FY7gvraSf3op3YiYV_uoE3p-Nc" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 2,
  "total_pages": 2,
  "prev_url": null,
  "next_url": "/v2/service_usage_events?after_guid=36ec8730-b9c6-4254-b10e-1e8cbc90baf4&order-direction=asc&page=2&results-per-page=1",
  "resources": [
    {
      "metadata": {
        "guid": "0068f321-27f4-4667-993b-cadac3c2a906",
        "url": "/v2/service_usage_events/0068f321-27f4-4667-993b-cadac3c2a906",
        "created_at": "2015-06-04T00:05:05Z"
      },
      "entity": {
        "state": "CREATED",
        "org_guid": "guid-73b30123-6335-4e3b-9bc2-48e1a21bb034",
        "space_guid": "guid-5e6489ba-be06-4531-b4bf-6191ca566616",
        "space_name": "name-1300",
        "service_instance_guid": "guid-c490da6c-1baf-41ac-bd16-49ac1437b533",
        "service_instance_name": "name-1301",
        "service_instance_type": "type-8",
        "service_plan_guid": "guid-25ba1bf1-6666-4f8d-9795-6379efb33598",
        "service_plan_name": "name-1302",
        "service_guid": "guid-6eb0507a-8116-4526-878a-34d587460db0",
        "service_label": "label-30"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 639212a7-6799-4276-8edf-ed7fa8710f30
Content-Length: 1053
X-Content-Type-Options: nosniff