Audits

The audit resource allows you to gain insight of what goes on in your tenant.

Endpoints

Skip to section
GET/audits/settings
GET/audits
GET/audits/archive
GET/audits/sources
GET/audits/types
GET/audits/{id}

Returns the server configuration options.

It includes options that represent the server configuration state and parameters that were used to run the server with certain functionality.

Header Parameters GET /audits/settings

Authorization
string

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Responses GET /audits/settings

200
application/json

OK Response

500
application/json

Internal Server Error

GET/audits/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/audits/settings" \
 -H "Authorization: Bearer <API-key>"

Response GET /audits/settings

{
  "data": {
    "EventTTL": 0,
    "ArchiveEnabled": true
  }
}

Finds and returns the persisted audit events for the given tenant.

Header Parameters GET /audits

Authorization
string

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Query Parameters GET /audits

next
string

The cursor to the next page of resources. Provide either the next or prev cursor, but not both.

prev
string

The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.

limit
integer<int64>

The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).

sort
string

The property of a resource to sort on (default sort is +eventTime). The supported properties are source, eventType, and eventTime. A property must be prefixed by + or - to indicate ascending or descending sort order respectively.

id
string

The list of audit unique identifiers.

source
string

The case-sensitive string used to search by source.

eventType
string

The case-sensitive string used to search by eventType.

eventTime
string

The time interval formatted in ISO 8601 to search by eventTime.

userId
string

The case-sensitive string used to search by userId.

Responses GET /audits

200
application/json

OK Response

400
application/json

Bad Request

500
application/json

Internal Server Error

GET/audits

curl "https://your-tenant.us.qlikcloud.com/api/v1/audits" \
 -H "Authorization: Bearer <API-key>"

Response GET /audits

{
  "data": [
    {
      "contentType": "string",
      "data": {},
      "eventId": "string",
      "eventTime": "2021-06-18T08:27:32.086Z",
      "eventType": "string",
      "id": "string",
      "links": {
        "Self": {
          "Href": "string"
        },
        "self": {
          "href": "string"
        }
      },
      "source": "string",
      "tenantId": "string",
      "userId": "string"
    }
  ],
  "links": {
    "Next": {
      "Href": "string"
    },
    "Prev": {
      "Href": "string"
    },
    "Self": {
      "Href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Finds and returns audit events from the archive, formatted as a JSON array, for the given date and tenant (in JWT).

This endpoint retrieves audit events from long term storage.

Header Parameters GET /audits/archive

Authorization
string

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Query Parameters GET /audits/archive

date
pattern='YYYY-MM-DD'
string<date>

Date to be used as filter and criteria during extraction.

Responses GET /audits/archive

200
application/json

OK Response

400
application/json

Bad Request

404
application/json

Not Found

500
application/json

Internal Server Error

GET/audits/archive

curl "https://your-tenant.us.qlikcloud.com/api/v1/audits/archive" \
 -H "Authorization: Bearer <API-key>"

Response GET /audits/archive

{
  "data": []
}

Finds and returns the distinct list of unique event sources.

Header Parameters GET /audits/sources

Authorization
string

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Responses GET /audits/sources

200
application/json

OK Response

500
application/json

Internal Server Error

GET/audits/sources

curl "https://your-tenant.us.qlikcloud.com/api/v1/audits/sources" \
 -H "Authorization: Bearer <API-key>"

Response GET /audits/sources

{
  "data": [],
  "links": {
    "Next": {
      "Href": "string"
    },
    "Prev": {
      "Href": "string"
    },
    "Self": {
      "Href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Finds and returns the distinct list of unique event types.

Header Parameters GET /audits/types

Authorization
string

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Responses GET /audits/types

200
application/json

OK Response

500
application/json

Internal Server Error

GET/audits/types

curl "https://your-tenant.us.qlikcloud.com/api/v1/audits/types" \
 -H "Authorization: Bearer <API-key>"

Response GET /audits/types

{
  "data": [],
  "links": {
    "Next": {
      "Href": "string"
    },
    "Prev": {
      "Href": "string"
    },
    "Self": {
      "Href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Finds and returns the persisted audit events for the given tenant.

Header Parameters GET /audits/{id}

Authorization
string

The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema.

Path Parameters GET /audits/{id}

id
string

The audit item's unique identifier.

Responses GET /audits/{id}

200
application/json

OK Response

400
application/json

Bad Request

404
application/json

Not Found

500
application/json

Internal Server Error

GET/audits/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/audits/{id}" \
 -H "Authorization: Bearer <API-key>"

Response GET /audits/{id}

{
  "contentType": "string",
  "data": {},
  "eventId": "string",
  "eventTime": "2021-06-18T08:27:32.086Z",
  "eventType": "string",
  "id": "string",
  "links": {
    "Self": {
      "Href": "string"
    },
    "self": {
      "href": "string"
    }
  },
  "source": "string",
  "tenantId": "string",
  "userId": "string"
}

EmptyResponse

object

EmptyResponse indicates an empty response body.

ErrorResponse

object

ErrorResponse indicates the error response.

Properties

error
string

No description

GetByIDResult

object

GetByIDResult is the result type of the audit service GetByID method.

Properties

contentType
string

The type that content is encoded in, always "application/json".

data
object

Additional information about the event's details.

eventId
string

The event's unique identifier.

eventTime
string<date-time>

The RFC3339 datetime when the event happened.

eventType
string

The type of event that describes committed action.

id
string

The resource item's unique identifier.

GetLinks are the HAL links for a single result.

GetLinks are the HAL links for a single result.

source
string

The source of the event message, usually the producing service.

tenantId
string

The ID of the tenant that owns the item. This is populated using the JWT.

userId
string

The ID of the user who performed the action that triggered the event.

GetArchiveResult

object

GetArchiveResult is the result type of the audit service GetArchive method.

Properties

data
Array<object>

List of requested resources.

GetObjectsResult

object

GetObjectsResult is the result type of audit service generic resources.

Properties

data
Array<object>

List of requested resources.

ListLinks are the HAL links for a list result.

ListLinks are the HAL links for a list result.

GetResult

object

GetResult is the result type of the audit service Get method.

Properties

data

List of audit items.

ListLinks are the HAL links for a list result.

ListLinks are the HAL links for a list result.

GetSettingsResult

object

GetSettingsResult is the result type of a getSettings request.

Properties

data

Server configuration options.

Href

object
deprecated

Href is a URL.

Properties

Href
deprecated
string

No description

href

object

href is a URL.

Properties

href
string

No description

v1.9.2
Was this page helpful?