Access Risk Management Agent Management Service (v1)

Download OpenAPI specification:Download

Agent

Registers new agent using following agent data.

Request Body schema:

Agent data.

id
string <uuid>

Identifier of the agent entity.

customerId
string <uuid>

Identifier of the customer.

hostName
required
string

Name of the machine where agent is installed.

platform
required
string

Platform information, like win7-x64 or so.

agentVersion
required
string

Version of the agent.

wrapperVersion
required
string

Version of the wrapper.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "hostName": "string",
  • "platform": "string",
  • "agentVersion": "string",
  • "wrapperVersion": "string"
}

Response samples

Content type
No sample

Updates existing agent using following agent data.

Request Body schema:

Agent data.

id
string <uuid>

Identifier of the agent entity.

customerId
string <uuid>

Identifier of the customer.

hostName
required
string

Name of the machine where agent is installed.

platform
required
string

Platform information, like win7-x64 or so.

agentVersion
required
string

Version of the agent.

wrapperVersion
required
string

Version of the wrapper.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "hostName": "string",
  • "platform": "string",
  • "agentVersion": "string",
  • "wrapperVersion": "string"
}

Response samples

Content type
No sample

Gets instruction for specified agent. Also it updates appropriate agent metadata in the database.

Request Body schema:

Agent metadata.

id
string <uuid>

Identifier of the agent entity.

customerId
string <uuid>

Identifier of the customer.

hostName
required
string

Name of the machine where agent is installed.

platform
required
string

Platform information, like win7-x64 or so.

agentVersion
required
string

Version of the agent.

wrapperVersion
required
string

Version of the wrapper.

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "hostName": "string",
  • "platform": "string",
  • "agentVersion": "string",
  • "wrapperVersion": "string"
}

Response samples

Content type
No sample

Sends the emergency email to fix team with detailed information.

Request Body schema:
object (ErpMaestro.AgentManagementService.WebApi.Models.AgentModel)
message
required
string

Contains description and additional information which would be useful to solve the problem.

Array of objects (ErpMaestro.AgentManagementService.WebApi.Models.HeartbeatModel)

List of heartbeats from the agent

Responses

Request samples

Content type