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=19b5aa78-4c1b-4725-a658-4ee8f98380f3

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: 19b5aa78-4c1b-4725-a658-4ee8f98380f3

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.eyJ1c2VyX2lkIjoidWFhLWlkLTMwMCIsImVtYWlsIjoiZW1haWwtMjQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTd9.rnoaSS-rxAyRJ8eu_Qu1Hz-dIBriPX1bXcIt64d2CMU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_usage_events?results-per-page=1&after_guid=19b5aa78-4c1b-4725-a658-4ee8f98380f3" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwMCIsImVtYWlsIjoiZW1haWwtMjQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTd9.rnoaSS-rxAyRJ8eu_Qu1Hz-dIBriPX1bXcIt64d2CMU" \
	-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=19b5aa78-4c1b-4725-a658-4ee8f98380f3&order-direction=asc&page=2&results-per-page=1",
  "resources": [
    {
      "metadata": {
        "guid": "0f9452eb-2aa1-427b-bfb4-44ce9073c20e",
        "url": "/v2/service_usage_events/0f9452eb-2aa1-427b-bfb4-44ce9073c20e",
        "created_at": "2015-05-21T01:03:17Z"
      },
      "entity": {
        "state": "CREATED",
        "org_guid": "guid-a98a2828-0b0d-4f29-96f1-ed47ff684e4f",
        "space_guid": "guid-e6cdabc9-70b4-4c47-814b-0235eb7d6db2",
        "space_name": "name-2011",
        "service_instance_guid": "guid-3b8dfaa3-f0ac-4eea-88e7-03ef3d246266",
        "service_instance_name": "name-2012",
        "service_instance_type": "type-2",
        "service_plan_guid": "guid-ce70ca38-961d-473f-b311-00520e7630e2",
        "service_plan_name": "name-2013",
        "service_guid": "guid-8fd31fcb-2fcf-485a-85ca-aad8f2c8a17f",
        "service_label": "label-82"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 4f22d569-b079-4719-acd0-f50589b20c1b
Content-Length: 1053
X-Content-Type-Options: nosniff