HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Update a specific agent configuration.

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

Updates the specified agent configuration.

NB: modifications may take several minutes to take effect.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
string
required

The agent identifier.

Body Params

The updated configuration.

string
required

The name of the agent configuration

string
required

The description of the agent configuration

apiClients
array of strings
required

The list of api clients which are permitted to access this configuration

apiClients*
int32
required
≄ 120

How often the agent should emit a heartbeat

int32
≄ 0

Time in minutes to cache authentications. Default is no caching

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
string
enum

The purpose of the agent configuration

Allowed:
modules
array of objects
required

The associated modules with the agent configuration

modules*
Responses
204

The configuration was updated.

Updated over 2 years ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated over 2 years ago