Audit Logs

→

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

summary:

Retrieves a list of audit logs

Parameters:

Name	Type	Description	Required
startTime	string	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.	no
endTime	string	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.	no
userUid	string		no
projectUid	string		no
tenantUid	string		no
resourceKind	string		no
resourceUid	string		no
actionType	string		no
limit	integer	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.	no
offset	integer	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.	no
continue	string	continue token to paginate the subsequent data items	no

HTTP code: 200
Description: OK
Response body:

{
  "items": [
    {
      "metadata": {
        "annotations": "object",
        "creationTimestamp": "date-time",
        "deletionTimestamp": "date-time",
        "labels": "object",
        "lastModifiedTimestamp": "date-time",
        "name": "string",
        "namespace": "string",
        "resourceVersion": "string",
        "selfLink": "string",
        "uid": "string"
      },
      "spec": {
        "actionMsg": "string",
        "actionType": "string",
        "actor": {
          "actorType": "string",
          "project": {
            "name": "string",
            "uid": "string"
          },
          "serviceName": "string",
          "user": {
            "emailId": "string",
            "firstName": "string",
            "lastName": "string",
            "org": "string",
            "uid": "string"
          }
        },
        "contentMsg": "string",
        "resource": {
          "kind": "string",
          "name": "string",
          "uid": "string"
        },
        "userMsg": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/audits/{uid}

summary:

Returns the specified audit log

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "lastModifiedTimestamp": "date-time",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "actionMsg": "string",
    "actionType": "string",
    "actor": {
      "actorType": "string",
      "project": {
        "name": "string",
        "uid": "string"
      },
      "serviceName": "string",
      "user": {
        "emailId": "string",
        "firstName": "string",
        "lastName": "string",
        "org": "string",
        "uid": "string"
      }
    },
    "contentMsg": "string",
    "resource": {
      "kind": "string",
      "name": "string",
      "uid": "string"
    },
    "userMsg": "string"
  }
}

→

https://api.spectrocloud.com/v1/audits/{uid}/sysMsg

summary:

Returns the system message of the specified audit

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "actionMsg": "string",
  "contentMsg": "string"
}

→

https://api.spectrocloud.com/v1/audits/{uid}/userMsg

summary:

Updates the specified user message for the specified audit

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "userMsg": "string"
}

HTTP code: 204
Description: The resource was updated successfully

Edit on GitHub