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=264a84cd-3f79-4dbb-921c-ecf4fbc914b2

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: 264a84cd-3f79-4dbb-921c-ecf4fbc914b2

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjUzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTB9.BD_H6fsnnUaNHjkDvOwky-9UdooRI7ZbWbzvgJI-aoc
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_usage_events?results-per-page=1&after_guid=264a84cd-3f79-4dbb-921c-ecf4fbc914b2" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjUzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTB9.BD_H6fsnnUaNHjkDvOwky-9UdooRI7ZbWbzvgJI-aoc" \
	-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=264a84cd-3f79-4dbb-921c-ecf4fbc914b2&order-direction=asc&page=2&results-per-page=1",
  "resources": [
    {
      "metadata": {
        "guid": "e730d44c-dd8e-4f05-9056-15f3976db3b7",
        "url": "/v2/service_usage_events/e730d44c-dd8e-4f05-9056-15f3976db3b7",
        "created_at": "2015-11-03T00:54:10Z"
      },
      "entity": {
        "state": "CREATED",
        "org_guid": "guid-789266aa-849b-495c-98e6-e9fbb4900946",
        "space_guid": "guid-bc754213-27b4-4f45-b1e9-27cf4c62e10c",
        "space_name": "name-1260",
        "service_instance_guid": "guid-d553db56-94a9-4f20-8310-7bf2634d030b",
        "service_instance_name": "name-1261",
        "service_instance_type": "type-8",
        "service_plan_guid": "guid-b9610d61-f4ff-4524-b39b-6999bd9a49e9",
        "service_plan_name": "name-1262",
        "service_guid": "guid-ef3b81da-b72e-43b4-9dea-9149a12194d8",
        "service_label": "label-63"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3f7f8636-9c91-4cba-becf-bdd639e50d4a
Content-Length: 1053
X-Content-Type-Options: nosniff