Create an agent configuration.

post

https://{tenanturl}/config/v1.0/onpremagents

Creates a new agent configuration.

Entitlements:
- manageExternalAgents (Manage external Agent configurations)
- readExternalAgents (Read external Agent configurations)
- runExternalAgent must be disabled/unchecked

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A JSON payload that specifies the configuration data.

The creation data of an agent configuration.

name

string

required

The name of the agent configuration

description

string

required

The description of the agent configuration

heartbeat

int32

required

≥ 120

How often the agent should emit a heartbeat

authnCacheTimeout

int32

≥ 0

Time in minutes to cache authentications. Default is no caching

certLabel

string

The certificate label used to encrypt modules data, default certificate used if not supplied

references

array of objects

The entities referenced by this configuration.

references

purpose

string

enum

The purpose of the agent configuration

Allowed:

modules

array of objects

required

The associated modules with the agent configuration

modules*

apiClients

array of objects

apiClients

identitySources

array of objects

identitySources

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

201The agent configuration was created.

400The request cannot be processed because the request body contains improperly structured JSON

401The unauthenticated user does not have the permissions to perform the requested operation

403The authenticated user does not have the permissions to perform the requested operation

404The resource cannot be found

406The server cannot produce a response matching the list of acceptable values