CZERTAINLY Discovery API (2.13.1)
Download OpenAPI specification:Download
REST API for managing Discoveries in the platform
Create Discovery
Request Body schema: application/jsonrequired
| name required | string Discovery name |
required | Array of objects (RequestAttributeDto) List of Attributes for Discovery |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| connectorUuid required | string Discovery Provider UUID |
| kind required | string Discovery Kind |
| triggers | Array of strings <uuid> [ items <uuid > ] List of triggers to be triggered after the discovery is finished, triggers will be evaluated in given order |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "connectorUuid": "string",
- "kind": "string",
- "triggers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}Response samples
- 201
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "uuid": "string"
}Delete Multiple Discoveries
Request Body schema: application/jsonrequired
Discovery UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Schedule Discovery
Request Body schema: application/jsonrequired
| jobName | string |
| cronExpression | string |
| oneTime | boolean |
object (DiscoveryDto) |
Responses
Request samples
- Payload
Content type
application/json
{- "jobName": "string",
- "cronExpression": "string",
- "oneTime": true,
- "request": {
- "name": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "connectorUuid": "string",
- "kind": "string",
- "triggers": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
}Response samples
- 201
- 400
- 403
- 404
- 422
- 502
- 503
Content type
application/json
{- "uuid": "string"
}List Discovery
Request Body schema: application/jsonrequired
Array of objects (SearchFilterRequestDto) Certificate filter input | |
| itemsPerPage | integer <int32> <= 1000 Default: 10 Number of entries per page |
| pageNumber | integer <int32> Default: 1 Page number for the request |
Responses
Request samples
- Payload
Content type
application/json
{- "filters": [
- {
- "fieldSource": "meta",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": 10,
- "pageNumber": 1
}Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "discoveries": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "kind": "IP-HostName",
- "status": "inProgress",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "totalCertificatesDiscovered": 0,
- "connectorUuid": "string",
- "connectorName": "string"
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "kind": "IP-HostName",
- "status": "inProgress",
- "connectorStatus": "inProgress",
- "message": "Failed due to network connectivity issues",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "totalCertificatesDiscovered": 0,
- "connectorTotalCertificatesDiscovered": 0,
- "connectorUuid": "string",
- "connectorName": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "triggers": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "type": "event",
- "resource": "NONE",
- "ignoreTrigger": true,
- "event": "discoveryFinished",
- "eventResource": "NONE"
}
]
}Discovery Details
path Parameters
| uuid required | string Discovery UUID |
query Parameters
| newlyDiscovered | boolean |
| itemsPerPage | integer <int32> Default: 10 |
| pageNumber | integer <int32> Default: 0 |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "certificates": [
- {
- "uuid": "string",
- "inventoryUuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "fingerprint": "string",
- "certificateContent": "string",
- "newlyDiscovered": true,
- "processed": true,
- "processedError": "string"
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
[- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": { },
- "multiValue": true
}
]
}
]