Getting started

mabl API reference
Authentication
mabl resource IDs
Pagination
Response types

mabl API

Application
Credentials
DataTable
DatabaseConnection
Environment
Event
Flow
- Get flow metadataget
- Update flow metadata onlypatch
Issue
LinkAgent
LinkLabel
- Query Link Labelsget
- Delete Link Labeldelete
Mailbox
Reporting
Test
- Get test metadataget
- Update test metadatapatch
User
- Query usersget
- Retrieve workspace userget

Query Link Agents

get https://api.mabl.com/link/agents

Query for Link Agents by workspace ID

URL Expired

The URL for this request expired after 30 days.

Query Params

workspace_id

string

required

ID of the workspace for which to query Link Agents

label

string

Label for which to query Link Agents

max_heartbeat_age_sec

int32

If specified, will only return Link Agents that have sent a heartbeat in the past max_heartbeat_age_sec seconds

limit

int32

≥ 1

The limit to use for pagination

cursor

string

The cursor to use for pagination

Responses

Response body

object

cursor

string

Cursor used for pagination

link_agents

array of objects

All Link Agents that matched the query

link_agents

object

is_connected

boolean

Indicates whether or not this Link Agent is connected to a Link Server

created_time

int64

Time at which the Link Agent was created

address

string

The Link Agent instance's local IP address

last_heartbeat_time

int64

Time at which the Link Agent last sent a heartbeat

current_link_server_endpoint

string

The Link Server endpoint the Link Agent will try to connect to (IP or URL)

label

string

The user-provided label for this Link Agent instance

operating_system_name

string

Value of the 'os.name' Java system property

version

string

The version of the Link Agent software that this instance is running

java_vm_name

string

Value of the 'java.vm.name' Java system property

current_link_server_id

string

ID of the Link Server that this Link Agent is connected to

workspace_id

string

The workspace associated with this Link Agent instance

hostname

string

The Link Agent instance's local hostname

protocol

string

The protocol that this Link Agent is configured to use. Note that wss is the only supported protocol at this time.

ssl https wss

operating_system_version

string

Value of the 'os.version' Java system property

no_ssl_verify

boolean

Flag indicating whether the agent was started with SSL verification disabled

operating_system_architecture

string

Value of the 'os.arch' Java system property

java_version

string

Value of the 'java.version' Java system property

string

UUID for this Link Agent instance

deleted_time

int64

Time at which the Link Agent was stopped or removed

status

string

The current status of the Link Agent

initializing updating announcing locating connecting ready terminated

Response body

object

code

int32

100 to 599

string

message

string

Response body

object

code

int32

100 to 599

string

message

string

Response body

object

code

int32

100 to 599

string

message

string

Response body

object

code

int32

100 to 599

string

message

string

Updated 5 months ago

Download Link Agent

Send a shutdown signal to a specific Link Agent. When invoked, the Link Agent process will shut down and will not attempt to reconnect.

Did this page help you?

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.mabl.com/link/agents \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 5 months ago

Download Link Agent

Send a shutdown signal to a specific Link Agent. When invoked, the Link Agent process will shut down and will not attempt to reconnect.

Did this page help you?

Getting started
mabl API reference
Authentication
mabl resource IDs
Pagination
Response types

mabl API
Application
Remove applicationdelete
Update applicationpatch
Get application by IDget
Get applications by workspaceget
Create applicationpost
Credentials
Remove Credentialsdelete
Update Credentialspatch
Get Credentialsget
Query Credentialsget
Create Credentialspost
DataTable
Remove Scenariodelete
Update Scenarioput
Get Scenarioget
Create Scenariopost
Get Scenariosget
Delete variable namepost
Update variable namepatch
Get variable namesget
Create variable namepost
Update DataTableput
Get DataTableget
Get DataTablesget
Create DataTablepost
DatabaseConnection
Remove database connectiondelete
Update database connectionpatch
Get database connectionget
Get database connections by workspaceget
Create database connectionpost
Environment
Remove environmentdelete
Update environmentpatch
Get Environment by IDget
Get environments by workspaceget
Create environmentpost
Event
Query Deployment Eventsget
Trigger tests on deploymentpost
Get a deployment result summaryget
Flow
Update flow metadata onlypatch
Get flow metadataget
Issue
Query issues by workspaceget
Remove issuedelete
Updates the given issue, and sets the committed flag to false.patch
Get issueget
Create issuepost
LinkAgent
Send a shutdown signal to a specific Link Agent. When invoked, the Link Agent process will shut down and will not attempt to reconnect.post
Query Link Agentsget
Download Link Agentget
LinkLabel
Delete Link Labeldelete
Query Link Labelsget
Mailbox
Update Mailbox statuspatch
Delete Mailboxdelete
Update Mailboxpatch
Get Mailboxget
Get information on Mailboxes by workspace IDget
Create Mailboxpost
Reporting
Get a test run artifact exportget
Retrieve activity feed entriesget
Create an export of test run artifactspost
Get test run summaries over a time rangeget
Get a plan run summaryget
Get a test run summaryget
Test
Update test metadatapatch
Get test metadataget
User
Retrieve workspace userget
Query usersget

200Results of the query

400Invalid or missing parameter

401User not authenticated

403User not authorized

defaultUnknown error