Actions & Endpoints

Introduction

The Liongard Integration with Rewst delivers a robust set of actions and endpoints for interacting with Liongard. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Liongard Integration:

Actions

Access Key

List Access Keys

GET https://companyABC.app.liongard.com/api/v1/access-keys

Returns a List of Access Tokens created by user

Create Access Key

POST https://companyABC.app.liongard.com/api/v1/access-keys

Create an Access Token with the permission of user or with only 'Add Agent' permission

Delete Access Key

DELETE https://companyABC.app.liongard.com/api/v1/access-keys/{AccessKeyID}

Delete Access Token created by user

Agents

List Agents

GET https://companyABC.app.liongard.com/api/v1/agents

List all agents.

Delete Agent

DELETE https://companyABC.app.liongard.com/api/v1/agents/{AgentID}

Remove an agent

Get Agent by ID

GET https://companyABC.app.liongard.com/api/v1/agents/{AgentID}

Get a specific Agent.

Update Agent

PUT https://companyABC.app.liongard.com/api/v1/agents/{AgentID}

Edits a deployed liongard agent, cannot update On-Demand agents.

Flush Job Queue

POST https://companyABC.app.liongard.com/api/v1/agents/{AgentID}/flush

Empty an agent's job queue.

Alerts

List Alerts

GET https://companyABC.app.liongard.com/api/v1/tasks

Returns a list of alerts that have been raised.

Get Alert by ID

GET https://companyABC.app.liongard.com/api/v1/tasks/{TaskID}

Returns a single alert that has been raised.

Detections

List Detection Events

GET https://companyABC.app.liongard.com/api/v1/detections

Returns a list of all detection events.

Get Detections by ID

GET https://companyABC.app.liongard.com/api/v1/detections/{DetectionID}

Gets a specific detection.

Generic Request

Liongard API Request

GET https://companyABC.app.liongard.com/<url_path>

Generic action for making authenticated requests against the Liongard API

Groups

List Groups

GET https://companyABC.app.liongard.com/api/v1/groups

Returns a List of available Assignable groups for a user

Inspector

Get Inspector Templates

GET https://companyABC.app.liongard.com/api/v1/inspector/{InspectorId}/templates

Retrieve Inspector Config and SecureConfig Fields, using the Name key for launchpoint configuration, and distinguishing between SecureConfig and Config fields with Secure and Required keys.

Get Inspector Versions

GET https://companyABC.app.liongard.com/api/v1/inspector/{InspectorId}/versions

Get a list of Inspector Versions and their IDs, sorted by "desc" for easy access to the latest version based on the highest ID or "CreatedOn" field.

List Inspector Types

GET https://companyABC.app.liongard.com/api/v1/inspectors

Lists all avaialble Inspectors in Liongard

Launchpoints

Delete Launchpoints in Bulk

DELETE https://companyABC.app.liongard.com/api/v1/launchpoints

Remove all launchpoints.

List Launchpoints

GET https://companyABC.app.liongard.com/api/v1/launchpoints

Lists all launchpoints.

Create Launchpoint

POST https://companyABC.app.liongard.com/api/v1/launchpoints

Create a launchpoint. You will need to reference the inspector templates for ilding out the config and secure config objects for this launchpoint. Each Inspector has a different template that contains the necessary configuration fields.

Edit Launchpoints in Bulk

PUT https://companyABC.app.liongard.com/api/v1/launchpoints

Update many launchpoints to run on the same schedule.

Run Inspections in Bulk

POST https://companyABC.app.liongard.com/api/v1/launchpoints/run

Kick off many inspections.

Delete Launchpoint

DELETE https://companyABC.app.liongard.com/api/v1/launchpoints/{LaunchpointID}

Remove a single launchpoint.

Get Launchpoints by ID

GET https://companyABC.app.liongard.com/api/v1/launchpoints/{LaunchpointID}

Return a specific launchpoint by ID.

Update Launchpoint

PUT https://companyABC.app.liongard.com/api/v1/launchpoints/{LaunchpointID}

Edit a single inspector launchpoint, referencing inspector templates for configuring the launchpoint with specific configuration fields.

Run Inspection

GET https://companyABC.app.liongard.com/api/v1/launchpoints/{LaunchpointID}/run

Set a Launchpoint to run an inspection

Get Launchpoint Log

GET https://companyABC.app.liongard.com/api/v1/logs

Return the logs for a specific inspection.

System

List Systems

GET https://companyABC.app.liongard.com/api/v1/systems

List all systems.

Get System Detail View by ID

POST https://companyABC.app.liongard.com/api/v1/systems/{SystemID}/view

Returns the Raw data from the latest inspection for a system.

Timeline

List Timeline Entries

GET https://companyABC.app.liongard.com/api/v1/timeline

Fetch all timeline entries.

Get Timeline by ID

GET https://companyABC.app.liongard.com/api/v1/timeline/{TimelineID}

Fetch a specific timeline.

Get Timeline Detail

GET https://companyABC.app.liongard.com/api/v1/timeline/{TimelineID}/detail

Fetch the Raw timeline entry (including the entire dataprint).

Users

List Users

GET https://companyABC.app.liongard.com/api/v1/users

Returns a list of users in your Liongard Instance

Create User

POST https://companyABC.app.liongard.com/api/v1/users

Creates a single User

Delete User

DELETE https://companyABC.app.liongard.com/api/v1/users/{UserID}

Remove a single User.

Get User by ID

GET https://companyABC.app.liongard.com/api/v1/users/{UserID}

Returns a Single User

Update User

PUT https://companyABC.app.liongard.com/api/v1/users/{UserID}

Updates a single User

V2 Environments

List Environments (V2)

GET https://companyABC.app.liongard.com/api/v2/environments/

Retrieve a list of environments. You can specify the page size, columns to include, and the order of the response

Add Environment (V2)

POST https://companyABC.app.liongard.com/api/v2/environments/

API endpoint to add a new environment. The endpoint requires a JSON body containing the label for the environment

Update Environments in Bulk (V2)

PUT https://companyABC.app.liongard.com/api/v2/environments/

Update multiple environments using the Liongard API

Add Environments in Bulk (V2)

POST https://companyABC.app.liongard.com/api/v2/environments/bulk

Add multiple environments by making a POST request to the /environments/bulk endpoint with a JSON body containing the necessary information

Delete Environment (V2)

DELETE https://companyABC.app.liongard.com/api/v2/environments/{environmentId}

Delete an environment by its ID

Get Environment (V2)

GET https://companyABC.app.liongard.com/api/v2/environments/{environmentId}

Get a single environment by providing the environmentId as a path parameter

Update Environment (V2)

PUT https://companyABC.app.liongard.com/api/v2/environments/{environmentId}

Update a single environment by providing the environment ID and the updated JSON body

GET https://companyABC.app.liongard.com/api/v2/environments/{environmentId}/relatedEntities

Returns all the Related Entities that are tied to a single Environment such as Agents, Launchpoints, and Integration mappings

V2 Metrics

List Metrics (V2)

GET https://companyABC.app.liongard.com/api/v2/metrics

Returns a list of metrics that have been created.

GET https://companyABC.app.liongard.com/api/v2/metrics/{MetricID}/relatedEnvironments

Returns Environment IDs for all related Environments for a given Metric ID

Last updated 6 months ago