Deprecated

The content in this section of the guide has been deprecated and is compatible with earlier versions only.

Quick Navigation

Imports

[deprecated] POST Imports/QueueImportFile

This API has been deprecated and is available for backwards compatibility only. Use POST Imports with Base64FileContents instead.

Queues a Password Safe XML import using multi-part form-data content.

Scan Management (Read/Write)

Content-Type: multipart/form-data

{
    Content-type: application/json
    {
        WorkgroupID: int,
        FileName: string
    }
    application/octet-stream
    {
        <string-encoded byte array representing the file>
    }
}
  • WorkgroupID: ID of the Workgroup to import the Assets into
  • FileName: Filename (including extension) of the import file

Content-Type: application/json

{
    ImportID: int
}
  • 200 – Request successful. Import ID in the response body.
  • 400 – The import file was not found in the body of the request, or a request body validation error has occurred.

Smart Rules

[deprecated] POST SmartRules/FilterSingleAccount

This API has been deprecated and is available for backwards compatibility only. Use QuickRules instead.

Specialized action for creating a Managed Account-type Smart Rule for filtering a single Managed Account by System Name and Account Name.

Smart Rule Management - Managed Account (Read/Write)

Content-type: application/json

{
    AccountID: int,
    Title: string
}
  • AccountID: (required) ID of the Managed Account you want to filter by parent System Name and Account Name.
  • Title: (optional) The title/name of the new Smart Rule. If omitted, a unique title is auto-generated.

Content-Type: application/json

{
    SmartRuleID: int,
    OrganizationID : string, // can be null
    Title: string,
    Description: string,
    Category: string,
    Status: int,
    LastProcessedDate: datetime,
    IsReadOnly: bool,
    RuleType: string
}

201 – Request successful. Smart Rule in the response body.

User Groups

[deprecated] GET UserGroups/{name}

This API has been deprecated and is available for backwards compatibility only. Use GET UserGroups?name={name} instead.

Returns a User Group by name.

User Accounts Management (Read)

name: Name of the User Group.

None

Content-Type: application/json

{
    GroupID : int, Name : string,
    DistinguishedName : string, 
    GroupType : string, 
    AccountAttribute : string, 
    MembershipAttribute : string,
    IsActive : bool
}

200 – Request successful. User Group in the response body.

[deprecated] DELETE UserGroups/{name}

This API has been deprecated and is available for backwards compatibility only. Use DELETE UserGroups?name={name} instead.

Deletes a User Group by name.

User Accounts Management (Read/Write)

name: Name of the User Group.

None

None

200 – Request successful.

Workgroups

[deprecated] GET Workgroups/{name}

This API has been deprecated and is available for backwards compatibility only. Use GET Workgroups?name={name} instead.

Returns a Workgroup by name.

Current user has permission to the Workgroup Organization. Asset Management (Read) or Scan Management (Read/Write)

name: Name of the Workgroup.

None

Content-Type: application/json

{
    OrganizationID : string,
    ID : int,
    Name : string
}

200 – Request successful. Workgroups in the response body.