Launch a GREP request

post

https://{hostname}/edge-diagnostics/v1/grep

Launches an asynchronous request to fetch logs for an edge server IP address using the grep command. To verify if an IP belongs to an edge server, run the Verify an IP operation first. If you known the exact values to filter the logs by and you want to get the data directly, run the synchronous Get specific logs operation.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

arls

object

Collects ARLs to filter the logs by.

clientIps

array of strings

length ≥ 0

Lists client IPs to filter the logs by.

clientIps

cpCodes

array of integers

length ≥ 0

Lists CP codes you want to get the logs for. You need to provide either this value or hostnames.

cpCodes

edgeIp

string

required

length ≥ 1

Edge IP you want to get the logs for. If you don't know if an IP is the edge IP, run the Verify an IP operation first. You can use the edge server IP value from the answerSection array in the Get domain details with dig operation response or the ip value from the edgeIps array in the collected diagnostic data.

end

date-time

required

ISO 8601 timestamp for a point of time in the past when the log search window ends.

hostnames

array of strings

length ≥ 0

Lists hostnames you want to get the logs for. You need to provide either this value or cpCodes.

hostnames

httpStatusCodes

object

Filters the logs by specific HTTP status codes.

logType

string

enum

required

Log record type you want to get. Possible values are: R for client requests to an edge server, F for forward requests from an edge server to the origin, or BOTH.

Allowed:

start

date-time

required

ISO 8601 timestamp for a point of time in the past when the log search window starts. You can get the logs from either the last 6 or 24 hours depending on the server and traffic conditions. The recommended 10-minute periods ensure that data fetches quickly and you get the most relevant logs.

userAgents

array of strings

length ≥ 0

Lists user agents to filter the logs by.

userAgents

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

202Process successfully launched.

400Validation error.

401Authorization error.

403Permission error.

405Method not allowed.

429Too many requests.