Login API

Prev Next

This URL allows you to create a login data in the TLC server.

URL

POST https://<TLC_IP>:<port>/rest/TLC/v1/bindingstore/{domain}

Request

The following input parameters must be specified in the request body.

Input parameter

Description

Data type

ip address

Specifies the user's IP address

String

username

Specifies the user name

String

computername

Name of the computer used by the user.

String

logintime

Login time of the user (in milliseconds).

Numeric

timeout

The specified period(in seconds)

Numeric


Trellix Logon Collector 3.0 RESTful API Reference Guide

5

2 | Introduction to Trellix Logon Collector


Input parameter

Description

Data type

that is allowed to elapse in a                     system before a specified event is                     to take place.

Example

{
    "ipaddress": "192.168.1.1",
    "username": "user1",
    "computername": "computer1",
    "logintime": "1405593089629",
    "timeout": "28800"
}

Response

The API request returns the following response data.

Response data

Description

Data type

status code

Status code 201 specifies the data is successfully added to the TLC server.
For failure requests, the status code for the type of failure is specified.

Numeric

error code

When there is a failure in the request, it specifies the API error code signifying the type of request failure.

Numeric

error message

Description of the error (optional)

String

2 | Introduction to Trellix Logon Collector


Note

For failure of multiple records, a collection of entries are returned. Each entry contains error code, error message, and IP address (unique key) of the failed record.

Response Example

1. Status Code: 201 Created