Quick Rule Managed Systems

Quick Navigation

GET QuickRules/{quickRuleID}/ManagedSystems

Purpose

Returns a list of managed systems by Quick Rule ID.

Required Permissions

Read access to the Quick Rule.

URL Parameters

quickRuleID: ID of the Quick Rule.

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        WorkgroupID : int
        HostName : string
        IPAddress : string
        DNSName : string
        InstanceName : string
        IsDefaultInstance : bool // can be null
        Template : string
        ForestName : string
        UseSSL : bool // can be null
        ManagedSystemID : int,
        EntityTypeID : int,
        AssetID : int, // can be null
        DatabaseID : int, // can be null
        DirectoryID : int, // can be null
        CloudID : int, // can be null
        SystemName : string,
        Timeout : short,
        PlatformID: int,
        NetBiosName : string,
        ContactEmail : string,
        Description : string,
        Port : int, // can be null
        Timeout : short,
        SshKeyEnforcementMode : int, // can be null
        PasswordRuleID : int,
        DSSKeyRuleID : int, // can be null
        LoginAccountID : int, // can be null
        AccountNameFormat : int,
        OracleInternetDirectoryID : guid, // can be null
        OracleInternetDirectoryServiceName : string,
        ReleaseDuration : int,
        MaxReleaseDuration : int,
        ISAReleaseDuration : int,
        AutoManagementFlag : bool,
        FunctionalAccountID : int, // can be null
        ElevationCommand : string, // can be null
        CheckPasswordFlag : bool,
        ChangePasswordAfterAnyReleaseFlag : bool,
        ResetPasswordOnMismatchFlag : bool,
        ChangeFrequencyType : string,
        ChangeFrequencyDays : int,
        ChangeTime : string,
        RemoteClientType : string,
        ApplicationHostID : int, // can be null
        IsApplicationHost : bool,
        AccessURL : string
    },
    …
]

Response Codes

200 – Request successful. Managed Systems in the response body.

For more information, please see Common Response Codes.

PUT QuickRules/{quickRuleID}/ManagedSystems

Purpose

Updates the entire list of Managed Systems in a Quick Rule by removing all Managed System - Quick Rule filters and adding a new one with the Managed Systems referenced by ID.

Required Permissions

Password Safe System Management (Read).

Read/Write access to the Quick Rule.

URL Parameters

quickRuleID: ID of the Quick Rule.

Request Body

Content-Type: application/json

{
    IDs: [ int, …]
}

Response Body

Content-Type: application/json

[
    {
        WorkgroupID : int
        HostName : string
        IPAddress : string
        DNSName : string
        InstanceName : string
        IsDefaultInstance : bool // can be null
        Template : string
        ForestName : string
        UseSSL : bool // can be null
        ManagedSystemID : int,
        EntityTypeID : int,
        AssetID : int, // can be null
        DatabaseID : int, // can be null
        DirectoryID : int, // can be null
        CloudID : int, // can be null
        SystemName : string,
        Timeout : short,
        PlatformID: int,
        NetBiosName : string,
        ContactEmail : string,
        Description : string,
        Port : int, // can be null
        Timeout : short,
        SshKeyEnforcementMode : int, // can be null
        PasswordRuleID : int,
        DSSKeyRuleID : int, // can be null
        LoginAccountID : int, // can be null
        AccountNameFormat : int,
        OracleInternetDirectoryID : guid, // can be null
        OracleInternetDirectoryServiceName : string,
        ReleaseDuration : int,
        MaxReleaseDuration : int,
        ISAReleaseDuration : int,
        AutoManagementFlag : bool,
        FunctionalAccountID : int, // can be null
        ElevationCommand : string, // can be null
        CheckPasswordFlag : bool,
        ChangePasswordAfterAnyReleaseFlag : bool,
        ResetPasswordOnMismatchFlag : bool,
        ChangeFrequencyType : string,
        ChangeFrequencyDays : int,
        ChangeTime : string,
        RemoteClientType : string,
        ApplicationHostID : int, // can be null
        IsApplicationHost : bool,
        AccessURL : string
    },
    …
]

Respon seCodes

200 – Request successful. Managed Systems in the response body.

For more information, please see Common Response Codes.

POST QuickRules/{quickRuleID}/ManagedSystems/{systemID}

Purpose

Adds the Managed System referenced by ID to the Quick Rule by adding it to the first Managed System - Quick Rule filter found.

Required Permissions

Password Safe System Management (Read).

Read/Write access to the Quick Rule.

URL Parameters

quickRuleID: ID of the Quick Rule.

systemID: ID of the Managed System.

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        WorkgroupID : int
        HostName : string
        IPAddress : string
        DNSName : string
        InstanceName : string
        IsDefaultInstance : bool // can be null
        Template : string
        ForestName : string
        UseSSL : bool // can be null
        ManagedSystemID : int,
        EntityTypeID : int,
        AssetID : int, // can be null
        DatabaseID : int, // can be null
        DirectoryID : int, // can be null
        CloudID : int, // can be null
        SystemName : string,
        Timeout : short,
        PlatformID: int,
        NetBiosName : string,
        ContactEmail : string,
        Description : string,
        Port : int, // can be null
        Timeout : short,
        SshKeyEnforcementMode : int, // can be null
        PasswordRuleID : int,
        DSSKeyRuleID : int, // can be null
        LoginAccountID : int, // can be null
        AccountNameFormat : int,
        OracleInternetDirectoryID : guid, // can be null
        OracleInternetDirectoryServiceName : string,
        ReleaseDuration : int,
        MaxReleaseDuration : int,
        ISAReleaseDuration : int,
        AutoManagementFlag : bool,
        FunctionalAccountID : int, // can be null
        ElevationCommand : string, // can be null
        CheckPasswordFlag : bool,
        ChangePasswordAfterAnyReleaseFlag : bool,
        ResetPasswordOnMismatchFlag : bool,
        ChangeFrequencyType : string,
        ChangeFrequencyDays : int,
        ChangeTime : string,
        RemoteClientType : string,
        ApplicationHostID : int, // can be null
        IsApplicationHost : bool,
        AccessURL : string
    },
    …
]

Response Codes

200 – Request successful. Managed Systems in the response body.

For more information, please see Common Response Codes.

DELETE QuickRules/{quickRuleID}/ManagedSystems/{systemID}

Purpose

Removes the Managed System referenced by ID from the Quick Rule by removing it from all Managed System - Quick Rule filters found.

 

A rule cannot be left in an invalid state. If removing the system would result in an empty filter, the filter itself will be removed. If there are no filters left in the rule, a "400 Bad Request" is returned.

Required Permissions

Read/Write access to the Quick Rule.

URL Parameters

quickRuleID: ID of the Quick Rule.

systemID: ID of the Managed System.

Request Body

None.

Response Codes

200 – Request successful.

For more information, please see Common Response Codes.