command:zray

zrayCreateSelectiveAccess

zrayCreateSelectiveAccess --iprange= --ttl= [--baseUrl=] [--title=] [--token=] [--actions=] [--inject=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Generate a random selective access for use in Z-Ray Selective Access mode.

  • --iprange
    IP Range allowed access to Z-Ray with this token. The iprange can be any ip address or CIDR range.
  • --ttl
    Limit this token’s access to expire after the given time in seconds is passed
  • --title
    Title, name or description of the access token. This field is not used for anything but display
  • --token
    Define if the token is required. Default is true.
  • --actions
    Allows server-side actions from Z-Ray. Default is false.
  • --inject
    Display Z-Ray on all pages open in a browser. Default is true.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayDeleteByPredefinedFilter

zrayDeleteByPredefinedFilter [--filterId=] [--filter=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Remove the zray records using a custom filter (name or filter fields).

  • --filterId
    Filter by name as it was saved in the filters table of gui db.
  • --filter
    Filter by fields to filter the zray entries to remove. The array contains the following fields: 'severity', 'response', 'method', 'from', 'to', 'freeText'.
    • ‘method’ is one of: 'GET','POST','CLI'
    • ‘response’ is one of : 2xx, 4xx, 5xx
    • freeText is looking for the string in url string or response (specific like 404, 500, ...)
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayGetAllRequestsInfo

zrayGetAllRequestsInfo [--from_timestamp=] [--limit=] [--offset=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get a list of requests starting from a specific timestamp (same as `zrayGetRequestsInfo` but not by pageID). The API receives three parameters: `from_timestamp`, `limit` and `offset`. The default limit is 10.

  • --from_timestamp
    Specify the timestamp to get all the requests that came after. provide the timestamp in microseconds, up to 13 digits.
  • --limit
    Limit number of requests. Default is 10. Max value is 500.
  • --offset
    Get data starting from a specific offset. Default is 0.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayGetRequestsInfo

zrayGetRequestsInfo --pageId= [--lastId=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get the list of requests according to a specific page ID. If lastId is specified, only requests that have a larger ID will be returned.

  • --pageId
    The page ID to retrieve requests from.
  • --lastId
    Specify the lastId used to retrieve only new requests.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayListAccessTokens

zrayListAccessTokens [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Display a list of all access tokens in the system.

  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayCreateAccessToken

zrayCreateAccessToken --iprange= --ttl= [--baseUrl=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Generate a random access token for use in the Z-Ray Secured Access mode.

  • --iprange
    IP Range allowed access to Z-Ray with this token. The iprange can be any IP address or CIDR range.
  • --ttl
    Limit this token’s access to expire after the given time in seconds is passed.
  • --baseUrl
    Limit access with Z-Ray to a specific base URL. Z-Ray and its activities will only be active on this specific base URL and any sub-paths. If no baseUrl is specified, this token is not limited to a specific baseUrl.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayRemoveAccessToken

zrayRemoveAccessToken --tokenId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Remove an access token. Removing a token means that pages loaded with this token will not display Z-Ray. Existing Z-Ray's will still have access to information.

  • --tokenId
    The identifier for the token to be removed. Note that this is a number representing the token, not the token itself.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayGetRequestFunctions

zrayGetRequestFunctions --requestId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get a list of all functions used in the request and their statistics.

  • --requestId
    The request ID of the function information to retrieve.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayGetRequestEnvironment

zrayGetRequestEnvironment --requestId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get superglobal arrays for a particular request.

  • --requestId
    The request ID of the function information to retrieve.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayGetDebuggerConfigurations

zrayGetDebuggerConfigurations [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Retrieve the Zend Debugger configurations array.

  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayGetBacktrace

zrayGetBacktrace --id [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get the backtrace for a specific backtrace ID.

  • --id
    The backtrace ID.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

zrayGetCustomData

zrayGetCustomData --requestId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get all custom data stored for the current request. Custom data is collected using the ZRayExtension class API and is stored with the official data collected by ZRay’s default operations. Custom data can be formatted in any way the extension is designed to hold. This may mean an unusually large payload.

  • --requestId
    The request ID of the environment information to retrieve.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.