Multi-Server Administration Endpoints in REST API


The base URL for the API is:

https://serverName:portNumber/bca-networks-msa 

token

{{status subtle="false" colour="Green" title="POST"/}}

 
/token
Logs in a user


Parameters

Name

Located in

Description

Default

Schema

grant_type

formData

The type of login being performed


string
Enum: [
  "password"
]

username

formData

The username of who is logging in


string

password

formData

The password of who is logging in


string

Responses

Code

Description

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in

403

Forbidden: Not allowed to access web services

{{status subtle="false" colour="Red" title="DELETE"/}}

 
/token
Logs out a logged in user


Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string

Responses

Code

Description

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in

403

Forbidden: Not allowed to access web services

sites

{{status subtle="false" colour="Blue" title="GET"/}}

 /sites
Retrieves added sites


Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access web services


404

Not found: No matching view found


realms

{{status subtle="false" colour="Blue" title="GET"/}}

 /realms
Retrieves realms of the added sites


Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


string

Responses

Code

Description

Schema

200

successful operation

[
string
]

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access web services


404

Not found: No matching view found


{{status subtle="false" colour="Blue" title="GET"/}}

 /realms/filtered
Retrieves one realm by name


Parameters

Name

Located in

Description

Default

Schema

realmName

query

Name of the realm of interest


string

Authorization

header

Authorization token formatted as 'Bearer [token]'


string

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access web services


404

Not found: No matching view found


devices

{{status subtle="false" colour="Blue" title="GET"/}}

 /devices
Retrieves devices, matching any filter criteria or view, with the returned result being abbreviated or partially-detailed devices


Parameters

Name

Located in

Description

Default

Schema

searchString

query

Device Name or Address or DynamicField's Value of interest


string

searchFilter

query

Filter for devices matching criteria


string

Enum: [

  "name",
 "address",
 "dynamicFields"

 ]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of devices to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access web services


404

Not found: No matching view found


Object Definitions

Object

Schema

DeviceDTO

Abbreviated or summarized information about a device


{
    siteName: string
    The site's unique display name

     siteURL: string
    The site's unique URL

     deviceName: string
    The device's unique display name

     deviceKey: string
    The device's unique database key

      realm: string
     The name of the realm this device belongs to

      address: string
     The primary interface IP address, host name, or URL

      dynamicFields: [ 
      The dynamic fields 

     DynamicFieldValueDTO
    ]
}

DynamicFieldValueDTO

Abbreviated or summarized information about a dynamic field


{ 
    id: string 
    The database key of the dynamic field whose value this is (read-only) 

    name: string 
    The name of the dynamic field (read-only) 

    values: [ 
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types 

      string 
    ] 

    dynamicFieldDetailsLink: string 
    Link to get more detailed information about the dynamic field (read-only) 
}

GetRealmDTO

Abbreviated or summarized information about a realm

 { 
    id: string 
    The realm's unique database key 

    name: string 
    The realm's unique display name

  
fallbackConfigPurgeCriteria: PurgeCriteriaDTO
    
Fallback purge criteria for device configurations (those configurations not covered by the per-trail or per-device-type purge criteria)
    hardwareInventoryPurgeCriteria: PurgeCriteriaDTO
    Purge criteria for device hardware inventory

    purgeConfigsByDeviceTypes: {
   Per-device-type device configuration purge criteria; this is a map where the key is a device type GUID string and the value is a 
PurgeCriteriaDTO     }
    purgeConfigsByTrails: {
   Per-trail device configuration purge criteria; this is a map where the key is a configuration trail GUID string and the value is a 
PurgeCriteriaDTO     }

   
purgeDevicesByDaysFlags: boolean    Whether or not to purge (automatically delete) devices that are flagged as offline

   
purgeDevicesDays: integer    Number of days a device can be offline before it is purged away (automatically deleted from the system)
   siteName: string
    The site's unique display name

   
siteURL: string
    The site's unique URL

   
dynamicFields: [
    The dynamic fields

  
   DynamicFieldValueDTO(% class="ui-provider hc b c d e f g h i j k l m n o p q r s t u v w x y z ab ac ae af ag ah ai aj ak" %)     ]
}

PurgeCriteriaDTO

Abbreviated or summarized information about purge criteria


{ 
    deviceAdapterName: string 
 The device type or configuration trail that this purge criteria applies to; (read-only)

    purgeByCountFlag: boolean
    Whether or not to purge by count 

    purgeCount: integer
    The number of entities to be retained before the oldest are purged away
    purgeByDaysFlag: boolean
    Whether or not to purge by age

     purgeDays: integer
    The number of days an entity can age before it is purged away

}

SiteDTO


Abbreviated or summarized information about a site

{

      id: string
   The site's unique database key

  name: string
   The site's unique display name

  url: string
   The site's unique URL

  status: string
   The site's status (online/offline)

  description: string
   The site's description provide while adding site

  version: string
   The site's version. Returns "null"
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*