GET
/
api
/
svc
/
v1
/
audit-logs
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/audit-logs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "action": "CREATE_DEPLOYMENT",
      "requestPath": "<string>",
      "resourceId": "<string>",
      "resourceType": "cluster",
      "resourceName": "<string>",
      "resourceFqn": "<string>",
      "tenantName": "<string>",
      "clusterId": "<string>",
      "workspaceId": "<string>",
      "subject": {
        "subjectId": "<string>",
        "subjectType": "user",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>"
      },
      "metaData": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
metric
enum<string>
required

Either list or count

Available options:
list,
count
​
action
string

Action

​
resourceId
string

Resource Id

​
resourceType
string

Resource Type

​
resourceName
string

Resource Name

​
resourceFqn
string

Resource Fqn

​
clusterId
string

Cluster Id

​
workspaceId
string

Workspace Id

​
subjectSlug
string

Slug of Subjects (comma separated)

​
start
string

Start Time (ISO 8601)

​
end
string

End Time (ISO 8601)

Response

200 - application/json

Returns list/count of audit logs according to filter

The response is of type object.