REST API Reference

Back Next

Creating, updating, and deleting Secure Agent groups

You can use the runtimeEnvironment resource to create, update, and delete Secure Agent groups.

Use a POST request to create and update Secure Agent groups. Use a DELETE request to delete a Secure Agent group.

POST request

To create a Secure Agent group, use the following URI:

/api/v2/runtimeEnvironment

Include the following fields in the request:

Field	Type	Required	Description
name	String	Yes	Name of the Secure Agent group.
isShared	Boolean	-	Whether the Secure Agent group can be shared with sub-organizations.

To update a Secure Agent group, include the agent group ID as shown in the following URI:

/api/v2/runtimeEnvironment/<id>

You can add or remove agents and rename Secure Agent groups. To move an agent from one Secure Agent group to another group, send a request to remove the agent from its current group and then send a request to add the agent to the new group.

Include the following fields in the request:

Field	Type	Required	Description
name	String	Yes	Name of the Secure Agent group.
isShared	Boolean	-	Whether the Secure Agent group can be shared with sub-organizations.
agents	Array	Yes	Agents assigned to the Secure Agent group.
orgId	String	Yes	Organization ID.
id	String	Yes	Agent ID.

POST response

Field	Type	Description
id	String	Secure Agent group ID.
orgId	String	Organization ID.
name	String	Secure Agent group name.
description	String	Description of the Secure Agent group.
createTime	Date/time	Date and time the Secure Agent group was created.
updateTime	Date/time	Date and time that the Secure Agent group was last updated.
createdBy	String	User who created the Secure Agent group.
updatedBy	String	User who last updated the Secure Agent group.
agents	Array	Agents assigned to the Secure Agent group. 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.
federatedId	String	Global unique identifier.
serverlessConfig		Attribute that defines serverless runtime environment properties.

POST request examples

The following example shows a request to create a Secure Agent group:

POST <serverUrl>/api/v2/runtimeEnvironment
Accept:application/json
icSessionId: <icSessionId>
{
  "@type": "runtimeEnvironment",
  "name": "14402",
  "isShared": true
}

The following example shows a request to add an agent to a Secure Agent group:

POST <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004
Accept:application/json
icSessionId: <icSessionId>
{
  "@type": "runtimeEnvironment",
  "name": "14401",
  "agents": [
    {
      "@type": "agent",
      "id": "01000308000000000003",
      "orgId": "010003"
    }
  ],
  "isShared": false
}

POST response example

You might receive a response similar to the following example:

{
  "@type": "runtimeEnvironment",
  "id": "01000325000000000005",
  "orgId": "010003",
  "name": "USW1MJ02W6PP-2",
  "createTime": "2021-11-09T17:20:55.583Z",
  "updateTime": "2021-11-09T17:20:55.583Z",
  "createdBy": "ctan",
  "updatedBy": "ctan",
  "agents": [],
  "isShared": false,
  "federatedId": "9F4z0pY1kKqdlmLp5kYXkF",
  "createTimeUTC": "2021-11-09T22:20:55.583Z",
  "updateTimeUTC": "2021-11-09T22:20:55.583Z",
  "serverlessConfig": {
    "cloudProviderConfig": {
      "cloudConfig": []
    }
  }
}

DELETE request

To delete a Secure Agent group, include the agent group ID as shown in the following URI:

/api/v2/runtimeEnvironment/00000425000000000034

Runtime environments

Download Guide

Watch

Comments

Cloud Data Integration Homepage

0 COMMENTS

We’d like to hear from you! Log in to comment.

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Creating, updating, and deleting Secure Agent groups

Creating, updating, and deleting Secure Agent groups

POST request

POST response

POST request examples

POST response example

DELETE request