Retrieve audit logs

GET 
/api/v1/audit-logs

Note: To see the complete list of possible values, please reference the available filter options for audit logs under Settings in the app. API key must have the View audit logs permission.

Request

Query Parameters

startTime date-time
endTime date-time
page int32required

Default value: 0

Page number to return, 0-indexed. Default 0.

pageSize int32required

Default value: 250

Number of results to return per page, between 1 and 1000. Default 250.

actions string[]

Possible values: [CREATE, READ, UPDATE, DELETE]

objectIdentifiers string[]
objectTypes string

Possible values: [CATALOG, TEAM, AWS_CONFIGURATION, BITBUCKET_CONFIGURATION]

Filter by Cortex object types (CATALOG, SERVICE, TEAM, SCORECARD, etc), integration configurations (AWS_CONFIGURATION, BITBUCKET_CONFIGURATION, etc), and more.

actorTypes string[]

Possible values: [API_KEY, PERSONAL_API_KEY, OAUTH2, BACKSTAGE, ANONYMOUS]

actorApiKeyIdentifiers string[]
actorEmails string[]
actorIpAddresses string[]
actorRequestTypes string

Possible values: [API_KEY_ENTITY, ATLASSIAN_WEBHOOK, SCORECARD_BADGES, SLACK_COMMAND]

Responses

200

Successfully retrieved audit logs

application/json

Schema

Schema

logs

object[]

required

Array [

action stringrequired

Possible values: [CREATE, UPDATE, DELETE]

Type of action performed

actorIdentifier string

Readable identifier of the authenticated actor. This could an be OAuth user email, API key identifier, attributed webhook, etc.

ipAddress string

IP address of the actor

objectIdentifier stringrequired

Readable identifier of the object acted upon

objectType stringrequired

Type of object acted upon

timestamp date-timerequired

]

page int32required

Current page number, 0-indexed

total int32required

Total number of results

totalPages int32required

Total number of pages

Example (from schema)

{
  "logs": [
    {
      "action": "CREATE",
      "actorIdentifier": "string",
      "ipAddress": "string",
      "objectIdentifier": "string",
      "objectType": "string",
      "timestamp": "2024-07-29T15:51:28.071Z"
    }
  ],
  "page": 0,
  "total": 0,
  "totalPages": 0
}

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

Response Headers

• Retry-After

  integer

  The number of seconds until the rate limiting resets.

application/problem+json

Schema

Schema

detail string
instance uri-reference
retryAfter int32

The number of seconds until the rate limiting resets.

status int32required

Possible values: >= 100 and <= 599, [429]

title stringrequired
type uri-referencerequired

Example (from schema)

{
  "detail": "string",
  "instance": "string",
  "retryAfter": 0,
  "status": 429,
  "title": "string",
  "type": "string"
}

Loading...