Retrieves the list of audit logs

GET 
https://api.spectrocloud.com/v1/audits

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

Retrieves the list of audit logs

Request

Query Parameters

startTime date-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

endTime date-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

userUid string

Specify the user uid, to retrieve the specific user audit logs

projectUid string

Specify the project uid, to retrieve the specific project audit logs

tenantUid string

Specify the tenant uid, to retrieve the specific tenant audit logs

resourceKind string

Specify the resource name, to retrieve the specific resource audit logs

resourceUid string

Specify the resource uid, to retrieve the specific resource audit logs

actionType string

Possible values: [create, update, delete, publish, deploy]

limit int64

Default value: 50

limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.

offset int64

offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.

continue string

continue token to paginate the subsequent data items

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

(empty)

application/json

Schema

Schema

items object[]required
List of audit message
Array [
metadata object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set
property name*string
creationTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
deletionTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
labels object
Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag
property name*string
lastModifiedTimestampdate-time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
namestring
Name of the resource
uidstring
UID is the unique identifier generated for the resource. This is not an input field for any request.
Populated by the system. Read-only.
spec
Audit specifications
actionMsgstring
Audit action message
actionTypestring
Possible values: [create, update, delete, publish, deploy]
actor
Audit actor object
actorTypestring
Possible values: [user, system, service]
project object
namestring
uidstring
serviceNamestring
user object
emailIdstring
firstNamestring
lastNamestring
orgstring
uidstring
contentMsgstring
Audit content message
resource object
Audit resource reference object
kindstring
Audit resource type
labelstring
Audit resource label
namestring
Audit resource name
uidstringrequired
Audit resource uid
userMsgstring
Audit user message
]
listmeta object

ListMeta describes metadata for the resource listing

continuestring

Next token for the pagination. Next token is equal to empty string indicates end of result set.

countinteger

Total count of the resources which might change during pagination based on the resources addition or deletion

limitinteger

Number of records feteched

offsetinteger

The next offset for the pagination. Starting index for which next request will be placed.

Example (from schema)

{
  "items": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2023-12-01T21:31:48.192Z",
        "deletionTimestamp": "2023-12-01T21:31:48.192Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:48.192Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "actionMsg": "string",
        "actionType": "create",
        "actor": {
          "actorType": "user",
          "project": {
            "name": "string",
            "uid": "string"
          },
          "serviceName": "string",
          "user": {
            "emailId": "string",
            "firstName": "string",
            "lastName": "string",
            "org": "string",
            "uid": "string"
          }
        },
        "contentMsg": "string",
        "resource": {
          "kind": "string",
          "label": "string",
          "name": "string",
          "uid": "string"
        },
        "userMsg": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X GET 'https://api.spectrocloud.com/v1/audits' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

startTime — query

endTime — query

userUid — query

projectUid — query

tenantUid — query

resourceKind — query

resourceUid — query

actionType — query

---createupdatedeletepublishdeploy

limit — query

offset — query

continue — query

ProjectUid — header