GET Log/{guid}

Returns events information from the Log server based on the GUID of the Distinguished Name. This API call is helpful when the caller wants to view events for a specific object but does not have Read permission to the Default SQL Channel. In the UI, the same object information appears on the General Log tab.

Requirements

  • Permissions: The caller must have Read permission to the component.
  • Token scope:  Any valid scope, such as Agent, Certificate, or SSH

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters

Name

Description

{guid}

In the request URL, specify the component GUID that identifies a Distinguished Name (DN) of an object. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}.

Returns

Response description

Name

Description

LogEvents

An array of log events ordered by ServerTimestamp. The newest log entry appears first.

  • ClientTimestamp: The time that the client generated the event.
  • Component: A string that identifies a Distinguished Name (DN) of an object. For events that occur in a subsystem other than Config, such as a Secret Store, the component may be blank.
  • ComponentId: The component ID that originated the event.
  • ComponentSubsystem: The component subsystem that originated the event.
  • Data: The event stack trace. Otherwise, Null.
  • Grouping: An integer that correlates to a set of events that involve the Component.
  • Id: A hexadecimal value that corresponds to an Event Id.
  • Name: The event name.
  • ServerTimestamp: The time the Log server received the event.
  • Severity: A string value for one of these event severities: Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug.
  • SourceIP: The IP address of the client that originated the event.
  • Text1: A string variable that contains all or part of an event message.
  • Text2: An additional string variable, if present, that appears as part of an event message.
  • Value1: An integer variable. If present, appears as part of an event message.
  • Value2: An additional integer variable. If present, appears as part of an event message.

Example Get events from a folder

Request for Example

GET https://tpp.venafi.example/vedsdk/Log/{6d6d56a1-ab7e-4f8e-b745-defeb91f2905}
Authorization:Bearer 4MyGeneratedBearerTknz==

Response for Example

HTTP/1.1 200 OK
{
   "LogEvents":[
      {
         "ClientTimestamp":"2019-04-30T21:37:08.2230000",
         "Component":"\\VED\\Identity\\admin",
         "ComponentId":50,
         "ComponentSubsystem":"Config",
         "Data":null,
         "Grouping":65846347,
         "Id":131091,
         "Name":"Config - Validate Password Violation",
         "ServerTimestamp":"2019-04-30T21:35:55.2330000",
         "Severity":"Alert",
         "SourceIP":"192.168.7.198",
         "Text1":"IdentityLocal, Version=5.4.0.0, Culture=neutral, 
             PublicKeyToken=ba7ffb2f5e80d17c",
         "Text2":null,
         "Value1":0,
         "Value2":0
      }
   ]
}