Agent

GET request for Secure Agent install token

To request an install token so that you can complete the Secure Agent registration process, include the platform type in the URI as follows:

/api/v2/agent/installerInfo/<platform>

Use one of the following values for the platform:

```
win64
```
```
linux64 
```

A successful request returns the install token with the download URL, as shown in the following example response:

{
    "@type": "agentInstallerInfo",
    "downloadUrl": "https://pod.ics.dev:444/saas/download/linux64/installer/agent64_install_ext.bin",
    "installToken": "qataJCF_qf1XhhSQydT654NM6TZid-AAuq1sflw0oH9t1O6VUNRJ6OtoGqnwaCj49qBa4W8Giv8jXil7LkESCs"
}

GET Request

To request the details of all Secure Agents in the organization, use the following URI:

/api/v2/agent

To request the details of a particular Secure Agent, you can include the Secure Agent ID or the Secure Agent name in the URI. Use one of the following URIs:

/api/v2/agent/<id>

/api/v2/agent/name/<name>

If you use the Secure Agent name in the URI and the Secure Agent name includes a space, replace the space with %20. For example:

/api/v2/agent/name/special%20agent

To request the details of the services that run on all of the Secure Agents in the organization, use the following URI:

/api/v2/agent/details

To request the details of the services that run on a particular Secure Agent, include the agent ID in the URI as follows:

/api/v2/agent/details/<id>

GET Response

Returns the agent object for the requested Secure Agent ID or Secure Agent name.
If you request information for all Secure Agents in the organization, returns an agent object without the packages and agentConfigs attributes for each Secure Agent in the organization.
If you request information for agent services, returns an AgentEngine object in addition to the agent object.
Returns the error object if errors occur.
The agent object includes the following attributes:

Field	Type	Description
id	String	Secure Agent ID.
orgId	String	Organization ID.
name	String	Secure Agent name.
description	String	Description of the Secure Agent.
createTime	Date/time	Time the Secure Agent was created.
updateTime	Date/time	Last time the Secure Agent was updated.
createdBy	String	User who created the Secure Agent.
updatedBy	String	User who updated the Secure Agent.
active	Boolean	Whether the Secure Agent is active. Returns true or false.
readyToRun	Boolean	Whether the Secure Agent is ready to run a task. Returns true or false.
platform	String	Platform of the Secure Agent machine. Returns one of the following values: win64 linux64
agentHost	String	Host name of the Secure Agent machine.
password	String	Password of the Secure Agent machine.
proxyHost	String	Host name of the outgoing proxy server that the Secure Agent uses.
proxyPort	Int	Port number of the outgoing proxy server.
proxyUser	String	User name to connect to the outgoing proxy server.
proxyPassword	String	Password to connect to the outgoing proxy server.
agentVersion	String	Secure Agent version.
spiUrl	String	Informatica Cloud Application Integration URL for the organization the user belongs to.
upgradeStatus	String	Upgrade status.
lastUpgraded	Date/time	Last time the Secure Agent was upgraded.
lastUpgradeCheck	Date/time	Last time the Secure Agent was checked for upgrade.
lastStatusChange	Date/time	Last time the Secure Agent status was updated.
packages	String	Informatica Cloud Connector packages.
configUpdateTime	Date/time	Last time a user updated Secure Agent properties.
agentConfigs	String	Attribute that defines Secure Agent properties. Includes information in an agentConfig object for each Secure Agent property.
name	String	Included in the agentConfig object. Configuration property name
type	String	Included in the agentConfig object. Configuration type. Returns one of the following values: Secure Agent Core Secure Agent Manager DTM Apache Tomcat JRE Secure Agent Core JRE
subtype	String	Included in the agentConfig object. Configuration subtype. Returns one of the following values: INFO DEBUG
value	String	Included in the agentConfig object. Value of the property.
customized	Boolean	Included in the agentConfig object. Whether the property is in the custom configuration details. Returns true or false.
overridden	Boolean	Included in the agentConfig object. Whether the property has been overridden. Returns true or false.
defaultValue	String	Included in the agentConfig object. Default value.
platform	String	Included in the agentConfig object. Platform. Returns one of the following values: win64 linux64

If you request details for the services that run on Secure Agents, the agent object also includes the AgentEngine object. The AgentEngine object includes the following attributes

Field	Type	Description
agentEngineStatus		Status of the agent service, which includes information in the AgentEngineStatus object.
appname		Included in the AgentEngineStatus object. The service name that is used internally
appDisplayName		Included in the AgentEngineStatus object. The service name that displays in the user interface.
appversion		Included in the AgentEngineStatus object. The service version. The version number changes each time you modify the service.
status		Included in the AgentEngineStatus object. The status of the service.
createTime		Included in the AgentEngineStatus object. The time the service was created.
updateTime		Included in the AgentEngineStatus object. The last time the service was updated.
agentEngineConfigs		Defines agent service properties. Includes information in an engineConfig object for each agent service property.
type		Included in the engineConfig object. Configuration type.
name		Included in the engineConfig object. Configuration property name.
value		Included in the engineConfig object. Value of the property.
platform		Included in the engineConfig object. Platform. Returns one of the following values: win64 linux64
customized	Boolean	Included in the engineConfig object. Whether the property is in the custom configuration details. Returns true or false.

DELETE Request

You can delete a Secure Agent if it is not associated with any connections. Before you delete a Secure Agent, update associated connections to use another Secure Agent.
To delete a Secure Agent, use the Secure Agent ID in the following URI:

/api/v2/agent/<id>

DELETE Response

Returns the 200 response code if the request is successful.
Returns the error object if errors occur

GET Example

To request the details about the Secure Agent with an ID of 000H1L080000000000001, to be returned in JSON format, you might use the following request:

GET <serverUrl>/api/v2/agent/000H1L080000000000001
   Accept:application/json
   icSessionId: <icSessionId>

A successful request returns the agent object