Jump to

• Request
• Response

Get agent information for a tenant

get

/serviceapi/entityModel/data/entities/agents

Get agent version, entity types, and monitored entities for tenant

Request

Supported Media Types

• application/json

Query Parameters

• limit(optional): integer(int32)
  The maximum number of elements to be returned

  Default Value: 2000
• offset(optional): integer(int32)
  The offset into the result set

  Default Value: 0

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Agent

  This is the object that describes the Agent.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Agent"
    }
}

Nested Schema : Agent

Type: object

This is the object that describes the Agent.

Show Source

• agentId: string
  The agent id.

  Example: 1234
• agentName: string
  The agent name.

  Example: MyAgent
• agentType: string
  The agent type.

  Example: HostLinux
• monitoredEntities(optional): object monitoredEntities
  The name of the user.
• monitoredEntitiesCount(optional): integer
  The total count of monitored entities in the tenant.

  Example: 4
• operatingSystem: string
  The operating system of the agent's entity.

  Example: Linux
• version: string
  The agent version.

  Example: 1.46

{
    "required":[
        "agentId",
        "agentName",
        "agentType",
        "operatingSystem",
        "version"
    ],
    "properties":{
        "agentId":{
            "type":"string",
            "example":"1234",
            "description":"The agent id."
        },
        "agentName":{
            "type":"string",
            "example":"MyAgent",
            "description":"The agent name."
        },
        "agentType":{
            "type":"string",
            "example":"HostLinux",
            "description":"The agent type."
        },
        "monitoredEntities":{
            "type":"object",
            "example":"demouser",
            "description":"The name of the user."
        },
        "monitoredEntitiesCount":{
            "type":"integer",
            "example":4,
            "description":"The total count of monitored entities in the tenant."
        },
        "operatingSystem":{
            "type":"string",
            "example":"Linux",
            "description":"The operating system of the agent's entity."
        },
        "version":{
            "type":"string",
            "example":"1.46",
            "description":"The agent version."
        }
    },
    "description":"<p>This is the object that describes the Agent.</p>"
}

Nested Schema : monitoredEntities

Type: object

The name of the user.

Example:

demouser

Back to Top