Home
Version 3
Events API

Events API

List Service Plan Create Events

GET /v2/events

Request

Route

GET /v2/events?q=type:audit.service_plan.create

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: timestamp, type, actee
  • 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
q: type:audit.service_plan.create

Body

Name Description Default Valid Values Example Values
guid The guid of the event.
type The type of the event.
  • app.crash
  • audit.app.start
  • audit.app.stop
  • audit.app.update
  • audit.app.create
  • audit.app.delete-request
  • audit.app.ssh-authorized
  • audit.app.ssh-unauthorized
  • audit.space.create
  • audit.space.update
  • audit.space.delete-request
  • audit.service_broker.create
  • audit.service_broker.update
  • audit.service_broker.delete
  • audit.service.create
  • audit.service.update
  • audit.service.delete
  • audit.service_plan.create
  • audit.service_plan.update
  • audit.service_plan.delete
  • audit.service_plan_visibility.create
  • audit.service_plan_visibility.update
  • audit.service_plan_visibility.delete
  • audit.service_dashboard_client.create
  • audit.service_dashboard_client.delete
  • audit.service_instance.create
  • audit.service_instance.update
  • audit.service_instance.delete
  • audit.user_provided_service_instance.create
  • audit.user_provided_service_instance.update
  • audit.user_provided_service_instance.delete
  • audit.service_binding.create
  • audit.service_binding.delete
  • audit.service_key.create
  • audit.service_key.delete
  • app.crash
  • audit.app.update
actor The GUID of the actor.
actor_type The actor type.
  • user
  • app
actor_name The name of the actor.
actee The GUID of the actee.
actee_type The actee type.
  • space
  • app
  • v3-app
actee_name The name of the actee.
timestamp The event creation time.
metadata The additional information about event. {}
space_guid The guid of the associated space.
organization_guid The guid of the associated organization.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MyIsImVtYWlsIjoiZW1haWwtMjA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDJ9.sUaWwME6xfj4tyc1W-9Zcj4hhZuXr3AK7Y5uoh7xtDk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events?q=type:audit.service_plan.create" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI5MyIsImVtYWlsIjoiZW1haWwtMjA3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDJ9.sUaWwME6xfj4tyc1W-9Zcj4hhZuXr3AK7Y5uoh7xtDk" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "f35009b3-41e0-498d-a36e-79b02cac7239",
        "url": "/v2/events/f35009b3-41e0-498d-a36e-79b02cac7239",
        "created_at": "2015-09-11T18:39:02Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.service_plan.create",
        "actor": "82d2e2c2-a56d-4391-9f71-941e3ca56c5b",
        "actor_type": "service_broker",
        "actor_name": "name-1424",
        "actee": "guid",
        "actee_type": "service_plan",
        "actee_name": "plan-name",
        "timestamp": "2015-09-11T18:39:02Z",
        "metadata": {
          "name": "plan-name",
          "free": true,
          "description": "A plan",
          "service_guid": "f38c5503-9941-49b3-aac2-454771cd0868",
          "extra": null,
          "unique_id": "guid",
          "public": true,
          "active": true
        },
        "space_guid": "",
        "organization_guid": ""
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: fb9878cb-be88-444f-a1fa-44958f6ee462
Content-Length: 1042
X-Content-Type-Options: nosniff