RunTimeEnvironment

To request runtime environment information, use the following URI:

/api/v2/runtimeEnvironment

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

/api/v2/runtimeEnvironment/<id>

/api/v2/runtimeEnvironment/name/<name>

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

/api/v2/runtimeEnvironment/name/my%20runtime%20environment

Get Response

Returns runtime environment information for the requested runtime environment. The runtimeEnvironment object includes the following attributes:

Field	Type	Description
id	String	Runtime environment ID.
orgId	String	Organization ID.
name	String	Runtime environment name.
description	String	Description of the runtime environment.
createTime	Date/time	Date and time the runtime environment was created.
updateTime	Date/time	Date and time that the runtime environment was last updated.
createdBy	String	User who created the runtime environment.
updatedBy	String	User who last updated the runtime environment.
agents		Agents assigned to the runtime environment. For more information, see the agent resource.
isShared	Boolean	Indicates whether the Secure Agent group is shared. Returns one of the following values: true. The Secure Agent group is shared. false. The Secure Agent group is not shared.

Get Example

To request the details of a particular runtime environment, you might use the following request:

GET <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004
Accept:application/json
icSessionId: <icSessionId>

The following text is a sample return in XML:

{
    "@type": "runtimeEnvironment",
    "id": "00000425000000000004",
    "orgId": "000004",
    "name": "SUT_Agent",
    "createTime": "2016-12-09T12:34:01.000Z",
    "updateTime": "2016-12-09T17:54:00.000Z",
    "createdBy": "[email protected]",
    "updatedBy": "[email protected]",
    "agents": [
      {
        "@type": "agent",
        "id": "00000408000000000002",
        "orgId": "000004",
        "name": "USW1MJ02YNKJ",
        "createTime": "2016-12-09T13:21:57.000Z",
        "updateTime": "2017-01-25T16:37:37.000Z",
        "createdBy": "admin",
        "updatedBy": "admin",
        "active": true,
        "readyToRun": false,
        "platform": "win64",
        "agentHost": "USW1MJ02YNKJ",
        "serverUrl": "https://aws-qa5.infaqa.com/saas",
        "proxyPort": 0,
        "agentVersion": "33.0",
        "upgradeStatus": "NotUpgrading",
        "spiUrl": "https://ts1w2a.rt.informaticacloud.com",
        "lastUpgraded": "2016-12-27T17:37:51.000Z",
        "packages": [],
        "agentConfigs": [],
        "configUpdateTime": "2017-01-18T13:57:15.000Z"
      }
    ],
    "isShared": true
  }