v4

latestSwagger 2.02026-08-0343714211.7 MB

exavault_api_request_logs

Exavault API Request Logs

List Exavault API Request Logs

get/exavault_api_request_logs

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 1000, 1,000 or less is recommended).

If set, return records where the specified field is equal to the supplied value. Valid fields are request_ip, request_method, success or created_at. Valid field combinations are [ request_ip ], [ request_method ], [ success ], [ created_at ], [ request_ip, request_method ], [ request_ip, success ], [ request_ip, created_at ], [ request_method, success ], [ request_method, created_at ], [ success, created_at ], [ request_ip, request_method, success ], [ request_ip, request_method, created_at ], [ request_ip, success, created_at ], [ request_method, success, created_at ] or [ request_ip, request_method, success, created_at ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at. Valid field combinations are [ request_ip ], [ request_method ], [ success ], [ created_at ], [ request_ip, request_method ], [ request_ip, success ], [ request_ip, created_at ], [ request_method, success ], [ request_method, created_at ], [ success, created_at ], [ request_ip, request_method, success ], [ request_ip, request_method, created_at ], [ request_ip, success, created_at ], [ request_method, success, created_at ] or [ request_ip, request_method, success, created_at ].

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at. Valid field combinations are [ request_ip ], [ request_method ], [ success ], [ created_at ], [ request_ip, request_method ], [ request_ip, success ], [ request_ip, created_at ], [ request_method, success ], [ request_method, created_at ], [ success, created_at ], [ request_ip, request_method, success ], [ request_ip, request_method, created_at ], [ request_ip, success, created_at ], [ request_method, success, created_at ] or [ request_ip, request_method, success, created_at ].

If set, return records where the specified field is prefixed by the supplied value. Valid fields are request_ip and request_method. Valid field combinations are [ request_ip ], [ request_method ], [ success ], [ created_at ], [ request_ip, request_method ], [ request_ip, success ], [ request_ip, created_at ], [ request_method, success ], [ request_method, created_at ], [ success, created_at ], [ request_ip, request_method, success ], [ request_ip, request_method, created_at ], [ request_ip, success, created_at ], [ request_method, success, created_at ] or [ request_ip, request_method, success, created_at ].

If set, return records where the specified field is less than the supplied value. Valid fields are created_at. Valid field combinations are [ request_ip ], [ request_method ], [ success ], [ created_at ], [ request_ip, request_method ], [ request_ip, success ], [ request_ip, created_at ], [ request_method, success ], [ request_method, created_at ], [ success, created_at ], [ request_ip, request_method, success ], [ request_ip, request_method, created_at ], [ request_ip, success, created_at ], [ request_method, success, created_at ] or [ request_ip, request_method, success, created_at ].

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at. Valid field combinations are [ request_ip ], [ request_method ], [ success ], [ created_at ], [ request_ip, request_method ], [ request_ip, success ], [ request_ip, created_at ], [ request_method, success ], [ request_method, created_at ], [ success, created_at ], [ request_ip, request_method, success ], [ request_ip, request_method, created_at ], [ request_ip, success, created_at ], [ request_method, success, created_at ] or [ request_ip, request_method, success, created_at ].

Response

A list of ExavaultApiRequestLogs objects.

timestampstring date-time

Start Time of Action. Deprecrated: Use created_at.

endpointstring

Name of API Endpoint

versioninteger

Exavault API Version

request_ipstring

IP of requesting client

request_methodstring

HTTP Method

error_typestring

Error type, if applicable

error_messagestring

Error message, if applicable

user_agentstring

User-Agent

response_codeinteger

HTTP Response Code

successboolean

false if HTTP Response Code is 4xx or 5xx

duration_msinteger

Duration (in milliseconds)

created_atstring date-time

Start Time of Action

Example response

[
  {
    "timestamp": "2000-01-01T01:00:00Z",
    "endpoint": "example",
    "version": 1,
    "request_ip": "example",
    "request_method": "example",
    "error_type": "example",
    "error_message": "example",
    "user_agent": "example",
    "response_code": 1,
    "success": true,
    "duration_ms": 1,
    "created_at": "2000-01-01T01:00:00Z"
  }
]