Request Structure
URL: /certificate/discovery/instance
Type: POST
| Name | Type | Description | Field Type | Constraints |
|---|---|---|---|---|
sessionId
|
Header | Session Id received after login |
String
|
Required if username and password are not provided |
username
|
Header | AppViewX login username |
String
|
Required if sessionId is not provided |
password
|
Header | AppViewX login password |
String
|
Required if sessionId is not provided |
Content-Type
|
Header | Specifies the nature of the data in the payload. |
String
|
The value of the param should be ‘application/json’ |
gwkey
|
Query | Tenant Key. This is needed only in case of multi tenant installations and can be ignored in other type of installations. |
String
|
NA |
gwsource
|
Query | Source from which the request is triggered (E.g. external). |
String
|
NA |
Payload
|
Body | Contains all the params to be sent in the request body for the post request |
Payload
|
NA |
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
discoveryType
|
Yes | Type of the discovery |
String
|
Possible values: ONDEMAND, SCHEDULED |
name
|
Yes | Name of the discovery instance to be created. |
String
|
NA |
description
|
No | Description of the discovery request |
String
|
NA |
groupName
|
Yes | Specifies the group under which the discovered certificate needs to be tagged. |
String
|
Not mandatory if the field rbacRuleProcessRequired is true |
source
|
Yes | Source of the certificates |
String
|
The value should be SERVER |
certStatus
|
Yes | Specifies the certificate status to be maintained in the inventory after discovering the certificates. |
String
|
Possible values are Managed, Monitored, None. If None certificates will not be moved to certificate inventory |
targetList
|
Yes | Name of the devices where the certificates need to be discovered |
List of String
|
Device names that are added already need to be specified |
coolingPeriod
|
Yes | Whether the discovery is sequential or parallel |
Number
|
0 - sequential >1 - parallel |
associatedRule
|
No | Name of the rule to be associated with the discovered certificates |
String
|
Rule name which is added already need to be specified |
rbacRuleProcessRequired
|
No | Whether Rbac rule process is required or not |
Boolean (true or false)
|
If true new certificates will be tagged under the group specified in the rule |