Developer APIResourcesOn-prem

Create On-prem agent

Create an On-prem agent.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
on_prem_group_idintegerRequired

On-prem group ID.

namestringRequired

On-prem agent name.

osenumOptional

On-prem agent operating.

Allowed values:
installation_methodenumOptional

On-prem agent installation method.

Allowed values:
enabledbooleanOptional

On-prem agent enabled state.

awaiting_setupbooleanOptional

true if agent should be created in awaiting setup state. Set to false to skip agent setup and get its status right away.

Response

Array of on-prem agents

idinteger or null

The unique identifier of the on-prem agent.

on_prem_group_idinteger or null

The unique identifier of the on-prem group this agent belongs to.

namestring or null

The name of the on-prem agent.

cnstring or null

The unique Common Name (CN) identifier of the on-prem agent.

osstring or null

The operating system of the on-prem agent.

awaiting_setupboolean or null

Indicates whether the on-prem agent is awaiting setup.

enabledboolean or null

Indicates whether the on-prem agent is enabled.

Errors