On prem

Use the following endpoints to work with On-prem Groups and On-prem Agents programmatically.

Quick reference

TypeResourceDescription
GET/api/v2/managed_users
/:id/on_prem_groups
List On-prem Groups in a customer workspace.
POST/api/v2/managed_users
/:id/on_prem_groups
Create an On-prem Group in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_groups
/:group_id
Retrieve details about an On-prem Group in a customer workspace.
PUT/api/v2/managed_users
/:id/on_prem_groups
/:group_id
Updates an On-prem group in a customer workspace.
DELETE/api/v2/managed_users
/:id/on_prem_groups
/:group_id
Deletes an On-prem group in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_groups
/:group_id
/status
Retrieves status of an On-prem group in a customer workspace.
GET/api/v2/managed_users
/:id/
on_prem_agents
List On-prem Agents in a customer workspace.
POST/api/v2/managed_users
/:id/
on_prem_agents
Create an On-prem Agent in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_agents
/:agent_id
Retrieve the details of a specific On-prem Agent in a customer workspace using its ID.
PUT/api/v2/managed_users
/:id/on_prem_agents
/:agent_id
Update an On-prem Agent in a customer workspace.
DELETE/api/v2/managed_users
/:id/on_prem_agents
/:agent_id
Delete an On-prem Agent in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_agents
/:agent_id
/status
Retrieve the status of an On-prem Agent in a customer workspace.
GET/api/v2/managed_users
/:id/on_prem_agents
/search
Finds On-prem Agents in a customer workspace by common name.