Get all audit events by query parameters

curl --request GET \
  --url https://audit.cpln.io/audit/org/{org} \
  --header 'Authorization: <api-key>'

{
  "kind": "queryresult",
  "itemKind": "auditevent",
  "items": [
    {
      "resource": {
        "id": "dfedd8b9-7737-498a-883f-0162510c0d68",
        "name": "my-workload",
        "type": "workload",
        "data": {
          "foo": "bar"
        }
      },
      "id": "7f2195ac-e003-42a3-8324-d4bb1f11d10e",
      "eventTime": "2021-01-02T13:01:02.345Z",
      "postedTime": "2021-01-02T13:01:03.123Z",
      "receivedTime": "2021-01-02T13:01:03.159Z",
      "requestId": "d4e26a95-1988-4bf5-94fb-40d605cce0e9",
      "context": {
        "org": "myorg",
        "name": "audit-context-1",
        "remoteIp": "1.2.3.4",
        "eventSource": "system",
        "location": "aws-us-west-2",
        "gvcAlias": "gm0b1e3a1vxjj",
        "podId": "workload-00016-deployment-54b5b8f94f-jqkcn",
        "data": {}
      },
      "subject": {
        "email": "[email protected]",
        "name": "Bob Johnson",
        "claims": {},
        "data": {}
      },
      "action": {
        "type": "delete",
        "data": {}
      },
      "result": {
        "status": "OK",
        "message": "Object created successfully"
      }
    }
  ],
  "query": {
    "param1": "value1",
    "param2": "value2"
  },
  "links": [
    {
      "rel": "self",
      "href": "/audit/org/myorg/id/e40f6816-574a-4150-a089-8bea6b4b588b"
    }
  ]
}

GET

org

{org}

Get all audit events by query parameters

curl --request GET \
  --url https://audit.cpln.io/audit/org/{org} \
  --header 'Authorization: <api-key>'

{
  "kind": "queryresult",
  "itemKind": "auditevent",
  "items": [
    {
      "resource": {
        "id": "dfedd8b9-7737-498a-883f-0162510c0d68",
        "name": "my-workload",
        "type": "workload",
        "data": {
          "foo": "bar"
        }
      },
      "id": "7f2195ac-e003-42a3-8324-d4bb1f11d10e",
      "eventTime": "2021-01-02T13:01:02.345Z",
      "postedTime": "2021-01-02T13:01:03.123Z",
      "receivedTime": "2021-01-02T13:01:03.159Z",
      "requestId": "d4e26a95-1988-4bf5-94fb-40d605cce0e9",
      "context": {
        "org": "myorg",
        "name": "audit-context-1",
        "remoteIp": "1.2.3.4",
        "eventSource": "system",
        "location": "aws-us-west-2",
        "gvcAlias": "gm0b1e3a1vxjj",
        "podId": "workload-00016-deployment-54b5b8f94f-jqkcn",
        "data": {}
      },
      "subject": {
        "email": "[email protected]",
        "name": "Bob Johnson",
        "claims": {},
        "data": {}
      },
      "action": {
        "type": "delete",
        "data": {}
      },
      "result": {
        "status": "OK",
        "message": "Object created successfully"
      }
    }
  ],
  "query": {
    "param1": "value1",
    "param2": "value2"
  },
  "links": [
    {
      "rel": "self",
      "href": "/audit/org/myorg/id/e40f6816-574a-4150-a089-8bea6b4b588b"
    }
  ]
}

Authorizations

Authorization

string

header

required

Service account key can be used as API keys

Path Parameters

org

string

required

Query Parameters

location

string

gvcAlias

string

podId

string

actionType

string

resourceType

string

fromEvent

string

toEvent

string

page

integer

pageSize

integer

Response

The audit event was accepted and forwarded to the system, an internal message ID is returned.

kind

string

Example:

"queryresult"

itemKind

string

Example:

"auditevent"

items

object[]

Show child attributes

items.resource

object

required

Show child attributes

items.resource.id

string

Example:

"dfedd8b9-7737-498a-883f-0162510c0d68"

items.resource.name

string

Example:

"my-workload"

items.resource.type

string

Example:

"workload"

items.resource.data

object

Example:

{ "foo": "bar" }

items.id

string

The event ID, assigned by the system

Example:

"7f2195ac-e003-42a3-8324-d4bb1f11d10e"

items.eventTime

string

The time of the event's occurrence. This can be anytime before the event is posted to the system.

Example:

"2021-01-02T13:01:02.345Z"

items.postedTime

string

The time the event is posted to the system, assigned automatically

Example:

"2021-01-02T13:01:03.123Z"

items.receivedTime

string

The time the event is received and processed by the system, assigned automatically

Example:

"2021-01-02T13:01:03.159Z"

items.requestId

string

The identifier of the request, the event is associated with. It is not related to the event's identifier. There can be zero, or one or more audit events associated with the same request ID.

Example:

"d4e26a95-1988-4bf5-94fb-40d605cce0e9"

items.context

object

Show child attributes

items.context.org

string

The name of the posting organization, set based on the posting entity's organization.

Example:

"myorg"

items.context.name

string

The audit context name.

Example:

"audit-context-1"

items.context.remoteIp

string

Example:

"1.2.3.4"

items.context.eventSource

string

Example:

"system"

items.context.location

string

The location/region where the event is created.

Example:

"aws-us-west-2"

items.context.gvcAlias

string

Example:

"gm0b1e3a1vxjj"

items.context.podId

string

Example:

"workload-00016-deployment-54b5b8f94f-jqkcn"

items.context.data

object

Additional custom data about the event context

items.subject

object

Show child attributes

items.subject.email

string

Example:

"[email protected]"

items.subject.name

string

Example:

"Bob Johnson"

items.subject.claims

object

Additional optional claims about the subject

items.subject.data

object

Additional optional data about the subject

items.action

object

Show child attributes

items.action.type

string

Example:

"delete"

items.action.data

object

Additional optional data about the action

items.result

object

Show child attributes

items.result.status

string

Example:

"OK"

items.result.message

string

Example:

"Object created successfully"

query

object

Show child attributes

query.{key}

string

Example:

{ "param1": "value1", "param2": "value2" }

links

object[]

Show child attributes

links.rel

string

Example:

"self"

links.href

string

Example:

"/audit/org/myorg/id/e40f6816-574a-4150-a089-8bea6b4b588b"

Get all audit events by resource name Create a new audit event

⌘I

API Reference

Core API

Audit API

Get all audit events by query parameters

Authorizations

Path Parameters

Query Parameters

Response