Platforms

Quick Navigation

For more information on related topics, please see Entity Types

GET Platforms

Returns a list of platforms for managed systems.

None.

None.

Content-Type: application/json

[
    {
        PlatformID : int,
        Name : string,
        ShortName : string,
        PortFlag : bool,
        DefaultPort: int, // can be null
        SupportsElevationFlag : bool,
        DomainNameFlag: bool,
        AutoManagementFlag: bool,
        DSSAutoManagementFlag: bool,
        ManageableFlag: bool,
        DSSFlag: bool,
        LoginAccountFlag : bool,
        DefaultSessionType: string // can be null,
        ApplicationHostFlag : bool
    }
    …
]
  • PlatformID: Platform ID.
  • Name: Platform name.
  • ShortName: Platform short name.
  • PortFlag: True if the platform supports setting a port, otherwise false.
  • DefaultPort: The default port used when no port is given for managed systems of this platform.
  • DomainNameFlag: True if the platform supports setting a domain name on a functional account of this platform, otherwise false.
  • SupportsElevationFlag: True if the platform supports elevation, otherwise false.
  • AutoManagementFlag: True if the platform supports password auto-management, otherwise false.
  • DSSAutoManagementFlag: True if the platform supports DSS key auto-management, otherwise false.
  • ManageableFlag: True if functional accounts can be created for the platform, otherwise false.
  • DSSFlag: True if the platform supports DSS keys, otherwise false.
  • LoginAccountFlag: True if the platform supports SSH login accounts, otherwise false.
  • DefaultSessionType: The default type of session for the platform (RDP, SSH, or null).
  • ApplicationHostFlag: true if the platform supports being used as a managed system application host, otherwise false.
  • RequiresApplicationHost: true if the platform requires a target application host, otherwise false.

200 – Request successful. Platforms in response body.

For more information, please see Common Response Codes.

GET Platforms/{id}

Returns a platform by ID for managed systems.

None.

id: ID of the platform.

None.

Content-Type: application/json

{
    PlatformID : int,
    Name : string,
    ShortName : string,
    PortFlag : bool,
    DefaultPort: int, // can be null
    SupportsElevationFlag : bool,
    DomainNameFlag: bool,
    AutoManagementFlag: bool,
    DSSAutoManagementFlag: bool,
    ManageableFlag: bool,
    DSSFlag: bool,
    LoginAccountFlag : bool,
    DefaultSessionType: string // can be null,
    ApplicationHostFlag : bool,
    RequiresApplicationHost : bool
}
  • PlatformID: Platform ID.
  • Name: Platform name.
  • ShortName: Platform short name.
  • PortFlag: True if the platform supports setting a port, otherwise false.
  • DefaultPort: The default port used when no port is given for managed systems of this platform.
  • DomainNameFlag: True if the platform supports setting a domain name on a functional account of this platform, otherwise false.
  • SupportsElevationFlag: True if the platform supports elevation, otherwise false.
  • AutoManagementFlag: True if the platform supports password auto-management, otherwise false.
  • DSSAutoManagementFlag: True if the platform supports DSS key auto-management, otherwise false.
  • ManageableFlag: True if functional accounts can be created for the platform, otherwise false.
  • DSSFlag: True if the platform supports DSS keys, otherwise false.
  • LoginAccountFlag: True if the platform supports SSH login accounts, otherwise false.
  • DefaultSessionType: The default type of session for the platform (RDP, SSH, or null).
  • ApplicationHostFlag: true if the platform supports being used as a managed system application host, otherwise false.
  • RequiresApplicationHost: true if the platform requires a target application host, otherwise false.

200 – Request successful. Platform in response body.

For more information, please see Common Response Codes.

GET EntityTypes/{id}/Platforms

Returns a list of Platforms by entity type ID.

None.

id: ID of the entity type.

None.

Content-Type: application/json

{
    PlatformID : int,
    Name : string,
    ShortName : string,
    PortFlag : bool,
    DefaultPort: int, // can be null
    SupportsElevationFlag : bool,
    DomainNameFlag: bool,
    AutoManagementFlag: bool,
    DSSAutoManagementFlag: bool,
    ManageableFlag: bool,
    DSSFlag: bool,
    LoginAccountFlag : bool,
    DefaultSessionType: string // can be null,
    ApplicationHostFlag : bool,RequiresApplicationHost : bool
}
  • PlatformID: Platform ID.
  • Name: Platform name.
  • ShortName: Platform short name.
  • PortFlag: True if the platform supports setting a port, otherwise false.
  • DefaultPort: The default port used when no port is given for managed systems of this platform.
  • DomainNameFlag: True if the platform supports setting a domain name on a functional account of this platform, otherwise false.
  • SupportsElevationFlag: True if the platform supports elevation, otherwise false.
  • AutoManagementFlag: True if the platform supports password auto-management, otherwise false.
  • DSSAutoManagementFlag: True if the platform supports DSS key auto-management, otherwise false.
  • ManageableFlag: True if functional accounts can be created for the platform, otherwise false.
  • DSSFlag: True if the platform supports DSS keys, otherwise false.
  • LoginAccountFlag: True if the platform supports SSH login accounts, otherwise false.
  • DefaultSessionType: The default type of session for the platform (RDP, SSH, or null).
  • ApplicationHostFlag: true if the platform supports being used as a managed system application host, otherwise false.
  • RequiresApplicationHost: true if the platform requires a target application host, otherwise false.

200 – Request successful. Platform in response body.

For more information, please see Common Response Codes.