Retrieve a request

GET/requests/{request_id}

Retrieves a logged API request together with the audit entries it produced.

data.request describes the request itself, and data.effects lists the resulting audit entries in ascending order of occurred_at.

Requests that do not exist or are not accessible with the current credentials return 404 Not Found with the not_found error code.

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

request_id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/requests/string"
{  "data": {    "effects": [      {        "action": "string",        "actor": {          "admin_id": "string"        },        "client_request_id": "string",        "credential": {          "id": "string"        },        "diff": {},        "event_id": "string",        "http_status": 0,        "id": "string",        "item_key": "string",        "kind": "request",        "method": "string",        "object": "audit_entry",        "occurred_at": "2019-08-24T14:15:22Z",        "operation_id": "string",        "origin": {          "client": {            "install_id": "string",            "name": "string",            "version": "string"          },          "ip": "string",          "ip_source": "trusted_proxy",          "user_agent": "string"        },        "outcome": "succeeded",        "path": "string",        "recorded_at": "2019-08-24T14:15:22Z",        "request_id": "string",        "resource": {          "id": "string",          "object": "string"        }      }    ],    "request": {      "action": "string",      "actor": {        "admin_id": "string"      },      "client_request_id": "string",      "credential": {        "id": "string"      },      "diff": {},      "event_id": "string",      "http_status": 0,      "id": "string",      "item_key": "string",      "kind": "request",      "method": "string",      "object": "request_log",      "occurred_at": "2019-08-24T14:15:22Z",      "operation_id": "string",      "origin": {        "client": {          "install_id": "string",          "name": "string",          "version": "string"        },        "ip": "string",        "ip_source": "trusted_proxy",        "user_agent": "string"      },      "outcome": "succeeded",      "path": "string",      "recorded_at": "2019-08-24T14:15:22Z",      "request_id": "string",      "resource": {        "id": "string",        "object": "string"      }    }  }}