mirror of https://github.com/coder/coder.git
3.6 KiB
3.6 KiB
Audit
This page is incomplete, stay tuned.
Get audit logs
Code samples
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/audit?q=string \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /audit
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
q |
query | string | true | Search query |
after_id |
query | string(uuid) | false | After ID |
limit |
query | integer | false | Page limit |
offset |
query | integer | false | Page offset |
Example responses
200 Response
{
"audit_logs": [
{
"action": "create",
"additional_fields": [0],
"description": "string",
"diff": {
"property1": {
"new": null,
"old": null,
"secret": true
},
"property2": {
"new": null,
"old": null,
"secret": true
}
},
"id": "string",
"ip": "string",
"is_deleted": true,
"organization_id": "string",
"request_id": "string",
"resource_icon": "string",
"resource_id": "string",
"resource_link": "string",
"resource_target": "string",
"resource_type": "organization",
"status_code": 0,
"time": "string",
"user": {
"avatar_url": "string",
"created_at": "string",
"email": "string",
"id": "string",
"last_seen_at": "string",
"organization_ids": ["string"],
"roles": [
{
"display_name": "string",
"name": "string"
}
],
"status": "active",
"username": "string"
},
"user_agent": "string"
}
],
"count": 0
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | codersdk.AuditLogResponse |
To perform this operation, you must be authenticated. Learn more.
Generate fake audit log
Code samples
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/audit/testgenerate \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
POST /audit/testgenerate
Body parameter
{
"action": "create",
"resource_id": "string",
"resource_type": "organization",
"time": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body |
body | codersdk.CreateTestAuditLogRequest | true | Audit log request |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content |
To perform this operation, you must be authenticated. Learn more.