Skip to main content

Connecting to our Logs API

Our Logs our readable for third parties via API. You can connect to our logs with the following:

API endpoint: https://{automate_instance_url}/_ah/api/events/v1/{domain_id}


Parameters:
byUser - (Analogous to “User” in the UI)
from (yyyy-MM-dd) - “From” (date filter) in the UI
to (yyyy-MM-dd) - “To” (date filter) in the UI
contextType - “Context Type” (human-readable/translatable options) in the UI
contextName - “Context Name” in the UI
operation - “Operation Type” (human-readable/translatable options) in the UI
country (code) - “Country” (human-readable/translatable list) in the UI


Setup:

  • Service Account assigned to Role in Automate with global Permissions to view logs
  • To invoke the API use the access token as Bearer in the Authorization header of the request:
    Authorization: Bearer {service_account_access_token}
  • We also have a swagger client where the endpoint documentation can be viewed as well:
    By going to: https://cloudm-platform-qa-1.appspot.com/api/swagger-ui/index.html
    and typing in the search ../docs/logevents/v1/swagger.json
     
Was this article helpful?
0 out of 0 found this helpful