CZERTAINLY Discovery API
Download OpenAPI specification:Download
REST API for managing Discoveries in the platform
Response samples
- 200
- 400
- 404
- 502
- 503
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",
- "certificate": [
- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "fingerprint": "string",
- "certificateContent": "string"
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "STRING",
- "content": { }
}
], - "meta": {
- "property1": { },
- "property2": { }
}
}
]Create Discovery
Request Body schema: application/json
| name required | string Discovery name |
required | Array of objects (RequestAttributeDto) List of Attributes for Discovery |
| 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": { }
}
], - "connectorUuid": "string",
- "kind": "string"
}Response samples
- 201
- 400
- 404
- 422
- 502
- 503
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
- 404
- 502
- 503
Content type
application/json
{- "message": "Error message"
}Response samples
- 200
- 400
- 404
- 502
- 503
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",
- "certificate": [
- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "fingerprint": "string",
- "certificateContent": "string"
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "STRING",
- "content": { }
}
], - "meta": {
- "property1": { },
- "property2": { }
}
}