Embedded APIResourcesOn-prem

Create On-prem Agent

Creates an On-prem agent in a customer workspace.

Path parameters

idstringRequired

Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringRequired

The name of the On-prem agent.

osstringRequired
The server operating system.
on_prem_group_idintegerRequired

The On-prem group ID to associate this agent with. See List On-prem groups.

awaiting_setupbooleanOptional

Optional. Set to true if the agent should be created in an awaiting setup state. Set to false to skip agent setup and get its status immediately.

Response

Success - The On-prem agent was created successfully.

idinteger or null

The unique identifier for the newly created On-prem agent.

namestring or null

The name of the On-prem agent.

osstring or null
The server operating system.
on_prem_group_idinteger or null

The On-prem group ID associated with this agent.

awaiting_setupboolean or null
Indicates whether the agent is awaiting setup.
created_atdatetime or null

Timestamp indicating when the On-prem agent was created.

Errors