Name | Description | Default | Valid Values | Example Values |
---|---|---|---|---|
guid | The guid of the event. |
|
|
|
type | The type of the event. |
|
|
|
actor | The GUID of the actor. |
|
|
|
actor_type | The actor type. |
|
|
|
actor_name | The name of the actor. |
|
|
|
actee | The GUID of the actee. |
|
|
|
actee_type | The actee type. |
|
|
|
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. |
|
|
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 |
|
|
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 |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NiIsImVtYWlsIjoiZW1haWwtMTIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMjl9.PVeKe8Y4ytIPmo_5PGmY9ObiyR_ecqM9d1DUpBysX0g Host: example.org Cookie:
GET /v2/events?q=type:app.crash
q: type:app.crash
curl "https://api.[your-domain.com]/v2/events?q=type:app.crash" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NiIsImVtYWlsIjoiZW1haWwtMTIwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxMjl9.PVeKe8Y4ytIPmo_5PGmY9ObiyR_ecqM9d1DUpBysX0g" \ -H "Host: example.org" \ -H "Cookie: "
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 422ebaf0-0f49-452e-9df6-790d36d96cd7 Content-Length: 999 X-Content-Type-Options: nosniff
200 OK
{ "total_results": 1, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "596aaeae-058d-4d0d-be3f-de2b5d04a267", "url": "/v2/events/596aaeae-058d-4d0d-be3f-de2b5d04a267", "created_at": "2015-02-12T01:42:08Z", "updated_at": null }, "entity": { "type": "app.crash", "actor": "51a27286-4295-49b9-98fe-9b17abf4f862", "actor_type": "app", "actor_name": "name-686", "actee": "51a27286-4295-49b9-98fe-9b17abf4f862", "actee_type": "app", "actee_name": "name-686", "timestamp": "2015-02-12T01:42:08Z", "metadata": { "instance": 0, "index": 1, "exit_status": "1", "exit_description": "out of memory", "reason": "crashed" }, "space_guid": "bd0a14fa-3624-4e4d-9e78-67c44851a693", "organization_guid": "9e255c59-ce0d-4dab-8d45-22d92cadd985" } } ] }