Security Controls REST API

Home 

Vendor Family Product Metadata

Provides metadata information for supported vendor, family and product information referenced from scan templates.

Base URL

        https://<consoleFQDN:port>/st/console/api/v1.0/metadata/vendors

Supported Requests

Method URL Input Return

GET

https://<consoleFQDN:port>/st/console/api/v1.0/metadata/vendors

URL Parameters

 

Input Model

URL Parameters

Name Type Description

count

Integer

Provide the count of items to return. The maximum value is 50.

start

Integer

Sets the starting point.

Example

Find the hierarchies for the 7th and 8th listed vendors

GET Request

https://<consoleFQDN:port>/st/console/api/v1.0/metadata/vendors?start=7&count=2

Sample Response

{

"count": 2,

"links": {

"next": {

"href": "https://device-name.fakedomain.com:3121/st/console/api/v1.0/metadata/vendors?count=2&start=9"

}

},

"value": [

{

"families": [

{

"products": [

{

"id": 111,

"name": "Apache 1.3"

},

{

"id": 112,

"name": "Apache 2"

}

],

"id": 58,

"name": "Apache"

},

{

"products": [

{

"id": 868,

"name": "Tomcat 5.5"

},

{

"id": 869,

"name": "Tomcat 6"

},

{

"id": 870,

"name": "Tomcat 7"

},

{

"id": 871,

"name": "Tomcat 8"

},

{

"id": 1328,

"name": "Tomcat 8.5"

},

{

"id": 1590,

"name": "Tomcat 9"

}

],

"id": 148,

"name": "Tomcat"

}

],

"id": 7,

"name": "Apache Software Foundation"

},

{

"families": [

{

"products": [

{

"id": 468,

"name": "Java 1.4"

},

{

"id": 469,

"name": "Java 5.0"

},

{

"id": 470,

"name": "Java 6.0"

},

{

"id": 471,

"name": "Java 7.0"

},

{

"id": 472,

"name": "Java 8.0"

},

{

"id": 1525,

"name": "Java 9.0"

},

{

"id": 1603,

"name": "Java 10.0"

}

],

"id": 102,

"name": "Java"

}

],

"id": 8,

"name": "Sun Microsystems"

}

]

}

 

Output Models

Vendor List

Name Type Description

id

Integer

The ID of the vendor. Used for including or excluding vendors in the patch scan template.

name

String

The name of the vendor.

family list

FamilyList[]

The list of families for this vendor.

Family List

Name Type Description

id

Integer

The ID of the family. Used for including or excluding families in the patch scan template.

name

String

The name of the family.

products

ProductList[]

The list of products for this family.

Product List

Name Type Description

id

Integer

The unique ID used to identify a particular product version. Used for including or excluding products in the patch scan template.

name

String

The product name and version number.

 


Was this article useful?    

The topic was:

Inaccurate

Incomplete

Not what I expected

Other