DocumentationAPI ReferenceRelease Notes
API Reference

Create Managed System in Workgroup

post
https://example.com/beyondtrust/api/public/v3/workgroups//managedsystems

Creates a Managed System in the Workgroup by ID.

Required Permission(s)

  • Password Safe System Management (Full control)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

ID of the Workgroup

Query Params
string
Defaults to 3.0

Request body version:

  • : Base properties
  • : Adds RemoteClientType
  • : Adds ApplicationHostID, IsApplicationHost
  • : Adds AccessURL
Body Params

Managed System details

int32

ID of the Managed System

int32

Unknown (Default) = 0, Asset = 1, Database = 2, Domain = 3, Cloud = 4

int32 | null

Set if the Managed System is an Asset or a Database

int32 | null

Set if the Managed System is a Database

int32 | null

Set if the Managed System is a Directory

int32 | null

Set if the Managed System is a Cloud system

int32

ID of the Workgroup

string | null

Host name of the Managed System

string | null

DNS name of the Managed System

string | null

IP address of the Managed System

string | null

Database instance name

boolean | null

Indicates if this is the default instance

string | null

Template of the Database

string | null

Name of the Active Directory forest associated with this Managed System

boolean | null

True to use an SSL connection, otherwise false

uuid | null

ID for the Oracle Internet Directory (OID)

string | null

Name of the Oracle Internet Directory (OID) service

string | null

Name of the Managed System

int32

ID of the Managed System platform

string | null

(Managed domains only) Domain NetBIOS name. Setting this value will allow Password Safe to fall back to the NetBIOS name if needed

int32 | null

The port used to connect to the host. If null and the related Platform.PortFlag is true, Password Safe uses Platform.DefaultPort for communication

int32

Length of time in seconds before a slow or unresponsive connection to the system fails

string | null

Description of the Managed System

string | null

Contact email for the Managed System

int32

ID of the default password rule assigned to Managed Accounts created under this Managed System

int32 | null

ID of the default DSS key rule assigned to Managed Accounts created under this Managed System

int32

Default release duration in minutes, between 1 and 525600

int32

Default maximum release duration in minutes, between 1 and 525600

int32

Default Information Systems Administrator (ISA) release duration in minutes, between 1 and 525600

boolean

True if password auto-management is enabled, otherwise false

int32 | null

ID of the functional account used for local Managed Account password changes (required when AutoManagementFlag is true)

int32 | null

ID of the functional account used for SSH session logins

string | null

Elevation command to use. Must be one of sudo|pbrun|pmrun (applicable when AutoManagementFlag is true)

int32 | null

Enforcement mode for SSH host keys

0: None
1: Auto (Auto accept initial key)
2: Strict (Manually accept keys)

boolean

True to enable password testing, otherwise false

boolean

True to change passwords on release of a request, otherwise false

boolean

True to queue a password change when scheduled password test fails, otherwise false

string | null

The change frequency for scheduled password changes:

first: Changes scheduled for the first day of the month
last: Changes scheduled for the last day of the month
xdays: Changes scheduled every x days (see ChangeFrequencyDays)
(Required when AutoManagementFlag is true)

int32

(days: 1-999) When ChangeFrequencyType is xdays, password changes take place this configured number of days

string | null

(24hr format: 00:00-23:59) UTC time of day scheduled password changes take place

int32

Domain/Account = 0, UPN = 1, SAM = 2

string | null

The type of remote client to use

None: No remote client
EPM: Endpoint Privilege Management

int32 | null

Managed system ID of the target application host. Must be a Managed System whose IsApplicationHost = true

boolean

True if the Managed System can be used as an application host, otherwise false. Can be set when the Platform.ApplicationHostFlag = true, and cannot be set when ApplicationHostID has a value

string | null

URL used for Cloud access (applies to Cloud systems only)

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 19 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.