Direct CA API v3.0
RESTful API for issuing Direct Certificate using Direct Trust Accrediated CA.
Query Direct Certificates
Query existing Direct Certificates.
Authentication
Access Token is required in order to access CA API functions.
Click here for OAuth2 authentication instruction.
Put a valid Access Token in each HTTP Request Header:
Authorization: Bearer {access_token}
Query Endpoint
GET https://directca.maxmddirect.com/api/certificate/query
HTTP Request Header
Authorization: Bearer {accessToken}
Content-Type: application/json
Request Parameters
| Name | Type | Description |
|---|---|---|
| commonNameIs | String | Query record.identifier = {commonNameIs} Ex: https://directca.maxmddirect.com/api/certificate/query?commonNameIs=direct.mydomain.com |
| commonNameLike | String | Query record.identifier LIKE {commonNameLike} Ex: https://directca.maxmddirect.com/api/certificate/query?commonNameLike=*.mydomain.com |
| signingSerialIs | String | Query record.signing_cert_serial = {signingSerialIs} Ex: https://directca.maxmddirect.com/api/certificate/query?signingSerialIs=19ef29624d73766f7e7ca0af3f2853e |
| encryptionSerialIs | String | Query record.encryption_cert_serial = {encryptionSerialIs} Ex: https://directca.maxmddirect.com/api/certificate/query?encryptionSerialIs=19ef29624d73766f7e7ca0af3f2853e |
HTTP Response Code
| HTTP Code | Description |
|---|---|
| 200 | Success. |
| 400 | Bad Request. Invalid action. Or some parameter is missing or invalid. |
| 401 | Unauthorized. No valid access token is found at request. |
| 403 | Forbidden. Permission denied for the requested action |
| 404 | Endpoint is not found |
| 500 | Server Error. |
Error Response Body (format: application/json)
| Name | Type | Description |
|---|---|---|
| error | String | Error message |
| description | String | Error description |
Success Response Body (format: application/json)
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| query | QueryObject | Query information with the following parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| records | CertificateObject[] | An array of Certificate Objects with the following parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||