CZERTAINLY Discovery API (2.9.0)

Download OpenAPI specification:Download

CZERTAINLY: getinfo@czertainly.com URL: https://www.czertainly.com License: MIT License

REST API for managing Discoveries in the platform

Discovery Management

Discovery Management API

Create Discovery

Request Body schema: application/json

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

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"connectorUuid": "string",
"kind": "string"
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete Multiple Discoveries

Request Body schema: application/json

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/json

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",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"connectorUuid": "string",
"kind": "string"
}
}

Response samples

Content type

application/json

{"uuid": "string"
}

List Discovery

Request Body schema: application/json

	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": [{"searchGroup": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": { }
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

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
}

Discovery Details

path Parameters

uuid

required

string

Discovery UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "IP-HostName",
"status": "inProgress",
"message": "Failed due to network connectivity issues",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"totalCertificatesDiscovered": 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",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}

Delete Discovery

path Parameters

uuid

required

string

Discovery UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

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

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
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Get Discovery searchable fields information

Responses

Response samples

Content type

application/json

[{"searchGroup": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"value": { },
"multiValue": true
}
]
}
]