AuditLogs

The audit log provides audit trail information for user activity, changes to business objects and other important information. For more information, see Audit log.

Get audit logs

Get audit logs based on query params filter

SecuritybearerAuth

Request

query Parameters

start required	string <date-time> Start date of time range to fetch data in ISO 8601 timestamp format. Example: start=2023-06-06T12:09:18.211Z
end required	string <date-time> End date of time range to fetch data in ISO 8601 timestamp format. Example: end=2023-06-07T12:09:18.211Z
offset	integer <int32> The offset of the first item returned in the collection. Example: offset=100
numberOfSamples	integer [ 0 .. 1000 ] Default: 20 The number of samples to take in the specified time range. Example: numberOfSamples=20
sortOrder	string Default: "asc" Sort results in descending or ascending order. Enum: "asc" "desc"
sortBy	string Sort results by a parameters. Enum: "timestamp" "subject" "subject_type" "source_ip" "action" "http_method" "result" "url" "entity_type" "entity_name" "entity_id"
filterBy	Array of strings Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=. Example: filterBy=cluster_name==my-cluster_name,entity_type==cluster,entity_name==test

Responses

200

Executed successfully

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/audit/log

Response samples

application/json

{"total": 2000,
"next": 100,
"audit_logs": [{"id": "0000-000000-00000-00000",
"timestamp": "2022-01-01T03:49:52.531Z",
"tenant_id": 12345,
"subject": "researcher@run.ai",
"subject_type": "User",
"source_ip": "192.168.0.1",
"action": "create",
"http_method": "GET",
"url": "http://example.com",
"entity_type": "project",
"entity_name": "project-1",
"entity_id": "1234",
"result": "Succeeded",
"http_status_code": 200,
"cluster_name": "my favorite cluster",
"cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
"request_id": "bb0c4742-e52f-4d5e-bfee-2c4ff57c339c"
}
]
}

Download audit logs

Download audit logs as a file, based on query params filter

SecuritybearerAuth

Request

query Parameters

file_type	string Default: "CSV" Enum: "CSV" "JSON"
start required	string <date-time> Start date of time range to fetch data in ISO 8601 timestamp format. Example: start=2023-06-06T12:09:18.211Z
end required	string <date-time> End date of time range to fetch data in ISO 8601 timestamp format. Example: end=2023-06-07T12:09:18.211Z
numberOfSamples	integer [ 0 .. 1000 ] Default: 20 The number of samples to take in the specified time range. Example: numberOfSamples=20
filterBy	Array of strings Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=. Example: filterBy=cluster_name==my-cluster_name,entity_type==cluster,entity_name==test

Responses

200

File downloaded

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/audit/log/file

Response samples

application/json

{"code": 401,
"message": "Issuer is not familiar."
}

➔ Next to Datavolumes