Skip to main content

Cyware Orchestrate

View Audit Logs

Audit logs enable administrators to track platform-related user activities through activity logs and API request logs. Activity logs provide a human-readable summary of platform activities, and API request logs offer developer-friendly logs tracking interactions with platform APIs.

Note

Ensure that your user group has View Audit Logs permission.

Activity Logs

Activity logs help administrators track platform-related user activities. Activity logs capture the logs from the playbook, app instance, user login, and logout activities. You can view activity logs for the following modules:

  • Playbooks

  • Apps

  • Persistent Lists

  • User Management

  • User Group Management

  • Tags

  • Labels

  • Code Snippets

  • Email Templates

You can view the following information in the activity logs:

  • The user who performed the activity. 

  • Date and time when the activity was performed.

  • Module name where the activity was performed.

  • You can view which user activity was performed by a user, such as update, delete, and create, with details on previous and current field values. You can also view the node number where the activity was performed, login and logout details, and the corresponding IP address.

API Request Logs

Administrators can analyze API request logs to gain insights into API usage and monitor performance.

API request logs provide the following information:

  • API requests across the Orchestrate platform

  • Open API requests sent to the Orchestrate instance

You can view the following details of the API requests:

  • API Request: View the API endpoint accessed. For example, /playbook/playbook-result/

  • User Email: View the user's email address who triggered the API request. For example, john.doe@domain.com

  • IP Address: View the IP address of the device where the API was run. For example, 182.x1.170.1x4 

  • Request Method: View the HTTP method used to execute the API. For example, GET

  • Run On: View the date and time when the API was triggered. For example, January 20, 2022, 01:07:01 pm

  • Duration: View the total time taken to execute the API request.

  • Response Status: View the response status of the API request. The following are some of the common response statuses:

    • 200: Success

    • 404: Not found

    • 401: Unauthorized

    • 500: Internal server error

  • User: View the username of the user who executed the API. For example,john.doe

Manage API Request Logs 

You can perform the following actions to manage API request logs:

  • Search API request logs by API request or IP address.

  • Filter API request logs using one or more of the following criteria:

    • Modules: Filter logs based on activities within modules such as Apps, Persistent Lists, Run Logs, Playbooks, login, and logout.

    • User: Filter logs by the users who performed the activity.

    • Run on: Filter the logs by the time of the API execution, such as last day, last week, last month, last year, and custom date range.

    • Request Method: Filter the logs by the request method, such as GET, PUT, POST, and DELETE.

    • Response Status: Filter the logs by the response status, such as 200 OK, 201 Created, and more.

  • To clear the applied filter, click Reset.