Jump to

• Request
• Response
• Examples

Get Audit Log Information

get

/console/admin/api/v2/dashboard/statistics/auditlog

The audit log records administrative console activity for the instance, including actions related to channels, organizations, nodes, and chaincode.

Request

Supported Media Types

• application/json

Query Parameters

• action(optional): string
  The name of the audit log action to return
• endTime: string
  The end time of a time range in the format 'yyyyMMddhhmmss'
• limit(optional): number
  The maximum number of log entries to return. If not specified, defaults to 100, which is also the maximum allowed value of the parameter.
• offset(optional): number
  The number of log entries to skip
• startTime: string
  The start time of a time range in the format 'yyyyMMddhhmmss'
• userIdentity(optional): string
  The user identity

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response with a series of audit logs by restriction.

Body ()

Root Schema : schema

Type: object

Show Source

• data(optional): object StatsAuditLog

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/StatsAuditLog"
        }
    }
}

Nested Schema : StatsAuditLog

Type: object

Show Source

• auditLogs(optional): array auditLogs
• limit(optional): number
• offset(optional): number
• total(optional): number

{
    "type":"object",
    "properties":{
        "total":{
            "type":"number"
        },
        "limit":{
            "type":"number"
        },
        "offset":{
            "type":"number"
        },
        "auditLogs":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : auditLogs

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Invalid arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

Example:

{
    "respMesg":"invalid argument"
}

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top

Examples

This endpoint is used to get the instance audit log, which records administrative console activity including actions related to channels, organizations, nodes, and chaincode. The action, userIdentity, limit, and offset parameters affect the behavior of the endpoint. The result is a JSON body that contains a series of audit log entries for the specified scope in the specified time range.

The following example shows how to retrieve the audit log by submitting a GET request on the REST resource using cURL.

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v2/dashboard/statistics/auditlog?startTime=<yyyymmddhhmmss>&endTime=<yyyymmddhhmmss>"

For example,

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v2/dashboard/statistics/auditlog?limit=50&offset=10&startTime=20210811050000&endTime=20210812050000"

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "limit": 50,
  "offset": 10,
  "count": 2,
  "auditLog": [
    {
      "TimeStamp": "2021-08-12 00:05:22.553",
      "UserIdentity": "[e-mail]",
      "Component": "CONSOLE",
      "ComponentID": "console-1",
      "Severity":"Informative",
      "Action": "Start Peer",
      "ActionStatus": "Succeeded",
      "Details": "Start Peer(peer1) successfully"
    },
    {
      "TimeStamp": "2021-08-12 00:05:25.553",
      "UserIdentity": "[e-mail]",
      "Component": "CONSOLE",
      "ComponentID": "console-1",
      "Severity":"Informative",
      "Action": "Start Peer",
      "ActionStatus": "Succeeded",
      "Details": "Start Peer(peer2) successfully"
    }
  ]
}

Back to Top