Jump to

• Request
• Response

Upgrade Multiple Agents by AgentId

put

/serviceapi/agentlifecycle/upgrade/{agenttype}/id/

Upgrade the selected agents to the latest version.

Values:

• gateway
• cloudagent
• datacollector

Request

Path Parameters

• agenttype: string
  The type of the agent. The value is case-insensitive. Values: gateway | cloudagent | datacollector

Body ()

This is the object you must send in the body to process multiple agents. These agents should be of the same agent type as provided in the path parameter.

Root Schema : ProcessMultipleAgentJSON

Type: object

This is the object you must send in the body to process multiple agents. These agents should be of the same agent type as provided in the path parameter.

Show Source

• entities: array entities
  An array containing the Agent IDs.

{
    "type":"object",
    "required":[
        "entities"
    ],
    "properties":{
        "entities":{
            "type":"array",
            "example":"\"agentId1\", \"agentId2\", \"agentId3\"",
            "items":{
                "type":"string"
            },
            "description":"An array containing the Agent IDs. "
        }
    },
    "description":"<p>This is the object you must send in the body to process multiple agents. These agents should be of the same agent type as provided in the path parameter.</p>"
}

Nested Schema : entities

Type: array

An array containing the Agent IDs.

Show Source

• Array of: string

{
    "type":"array",
    "example":"\"agentId1\", \"agentId2\", \"agentId3\"",
    "items":{
        "type":"string"
    },
    "description":"An array containing the Agent IDs. "
}

Example:

"agentId1", "agentId2", "agentId3"

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted - All entities accepted for processing

206 Response

Partial Accepted - Partial list of entities accepted for processing

400 Response

Bad Request.

404 Response

Not Found - Agent not available in database

409 Response

Conflict - Entity upgrade already in progress.

412 Response

Pre-condition failed - Pre-requisite checks failed

500 Response

Internal Server Error - Unexpected exception occured

Back to Top