v1

latestOpenAPI 3.0.02026-08-06102185472.3 KB

Auditing

Get audits

Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance.

get/audit

Query parameters

pageinteger

The page number for paginated results. The value is zero-based, where 0 represents the first page.<br/> Set it to 0 to get the first page of results.

sizeinteger

Number of payments to return per page.

beforestring

Filters for audit events where the range_field value is before this specified time stamp (not inclusive). You can also specify after to create a time range between after and before. If before is specified, range_field must also be specified.

afterstring

Filters for audit events where the range_field value is after this specified time stamp (not inclusive). You can also specify before to create a time range between after and before. If after is specified, range_field must also be specified.

range_fieldstring

Filters payments before/after/between created and modified timestamps (CREATED_AT, MODIFIED_AT). For example, if you specify range_field=CREATED_AT, you would specify a timestamp (in the 24-character ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ format used in payment objects) as the value for before and/or after to fetch audit events before, after, or between the specified time range(s) (not inclusive). If range_field is specified, before and/or after must also be specified.

actorstring

Filters for audit events based upon actor.

actionstring

Filters for audit events based upon action.

level'INFO' | 'WARN' | 'ERROR'

Filters for audit events based upon audit level.

domain'USER_MANAGEMENT' | 'CONFIG_MANAGEMENT' | 'OTHER'

Filters for audit events based upon audit domain.

Response

Successful response

firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

Example response

{
  "sort": [
    {
      "direction": "ASC",
      "nullHandling": "NULLS_FIRST",
      "ascending": true
    }
  ],
  "content": [
    {
      "actor": "super_user_client",
      "action": "KEY_UPDATE",
      "eventId": "3d5d0831-762c-4e0c-980c-635b38fd9caf",
      "message": "Added public key class PublicKeyRecord {\n    publicKey: MCowBQYDK2VwAyEAb8Q2YzrbTIwrUn7u5Q6hJimp7jBFHx500MfDM4XVNJ0=\n    keyIntent: SIGNING_PUBLIC_KEY\n    keyType: ED_25519\n    keyVersion: 1\n    expiryDateTime: 2089-09-23T17:27:50.331Z\n} for RippleNet address rn.us.ny.new_york",
      "metadata": "{\"ip\":\"0:0:0:0:0:0:0:1\",\"uri\":\"/internal/key_service/addresses/rn.us.ny.new_york/keys\"}",
      "domain": "CONFIG_MANAGEMENT",
      "level": "INFO",
      "timeStamp": "2019-09-30T22:55:41.365000Z"
    }
  ]
}