Certificates
GET Certificates#
Gets all certificates.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/certificates |
| Headers | Authorization or X-API-Key |
| Parameters | projectId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "id": 0, "distributionId": "string", "sslCertificateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "domainName": "string", "additionalNames": "string", "certificateType": "string", "certificateStatus": "string", "scope": "string", "lastModified": "2021-10-27T15:38:30.649Z" } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| distributionId | string | "string" | The identifier for the distribution |
| sslCertificateId | string | "string" | The identifier for the certificate |
| domainName | string | "string" | Certificate domain name |
| additionalNames | string | "string" | Certificate additional domain names |
| certificateType | string | "string" | Type of certificate (Gjirafa Issued or Imported) |
| certificateStatus | string | "string" | Certificte Status (Active, Expired etc) |
| scope | string | "string" | Certificate Scope (Project or Organization) |
| lastModified | date | 2021-03-30 T 09:30:22.892Z | Returns the last modified date for the distributions |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Certificate#
Gets certificate by id.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/certificates/{id} |
| Headers | Authorization or X-API-Key |
| Parameters | projectId, version, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | Shows the id of certificate. |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| id | Yes | integer($int32) | 0 | Shows the id of specific Certificate. |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "scopeId": 0, "sslCertificateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "domainName": "string", "additionalNames": "string", "publicKeyInfo": "string", "signatureAlgorithm": "string", "issuer": "string", "certificateType": "string", "certificateStatus": "string", "certificateChallenge": "string", "serialNumber": "string", "dnsRecords": [ { "key": "string", "value": "string" } ], "notBefore": "2021-07-26T08:51:51.079Z", "notAfter": "2021-07-26T08:51:51.079Z", "scopeOptions": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| id | integer($int32) | 0 | Returns the id of certificate. |
| projectId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id. |
| scopeId | integer($int32) | 0 | Returns the scope id |
| sslCertificateId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the ssl certificate id. |
| domainName | string | "string" | Returns the domain name. |
| additionalNames | string | "string" | Returns the additional names. |
| publicKeyInfo | string | "string" | Returns the public key info. |
| signatureAlgorithm | string | "string" | Returns the signature algorithm. |
| issuer | string | "string" | Returns the signature issuer. |
| certificateType | string | "string" | Returns the certificate type. |
| certificateStatus | string | "string" | Returns the certificate status. |
| certificateChallenge | string | "string" | Returns the certificate challenge. |
| serialNumber | string | "string" | Returns the serial number. |
| dnsRecord | List\<object> | Returns the dns record. | |
| notBefore | DateTime | "2021-07-26T08:51:51.079Z" | Returns the starting date of certificate. |
| notAfter | DateTime | "2021-07-26T08:51:51.079Z" | Returns the ending date of certificate. |
| scopeOptions | Dictionary\<string, int> | Returns the name and value of the scope | |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 500 Internal Server Error
POST Certificate#
Post to create new certificate.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/certificates |
| Headers | Authorization or X-API-Key |
| Parameters | projectId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
Request body#
{ "domainName": "string", "additionalDomainNames": [ "string" ], "scopeId": 0}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| domainName | Yes | string | "string" | Send the domain name to create certificate. |
| additionalDomainNames | Yes | string | "string" | Send the additional domain names. |
| scopeId | Yes | integer($int32) | 0 | Send the scope id |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "scopeId": 0, "sslCertificateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "domainName": "string", "additionalNames": "string", "publicKeyInfo": "string", "signatureAlgorithm": "string", "issuer": "string", "certificateType": "string", "certificateStatus": "string", "certificateChallenge": "string", "serialNumber": "string", "dnsRecords": [ { "key": "string", "value": "string" } ], "notBefore": "2021-07-26T09:00:50.544Z", "notAfter": "2021-07-26T09:00:50.544Z", "scopeOptions": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| id | integer($int32) | 0 | Returns the id of certificate. |
| projectId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id. |
| scopeId | integer($int32) | 0 | Returns the scope id |
| sslCertificateId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the ssl certificate id. |
| domainName | string | "string" | Returns the domain name. |
| additionalNames | string | "string" | Returns the additional names. |
| publicKeyInfo | string | "string" | Returns the public key info. |
| signatureAlgorithm | string | "string" | Returns the signature algorithm. |
| issuer | string | "string" | Returns the signature issuer. |
| certificateType | string | "string" | Returns the certificate type. |
| certificateStatus | string | "string" | Returns the certificate status. |
| certificateChallenge | string | "string" | Returns the certificate challenge. |
| serialNumber | string | "string" | Returns the serial number. |
| dnsRecord | List\<object> | Returns the dns record. | |
| notBefore | DateTime | "2021-07-26T08:51:51.079Z" | Returns the starting date of certificate. |
| notAfter | DateTime | "2021-07-26T08:51:51.079Z" | Returns the ending date of certificate. |
| scopeOptions | Dictionary\<string, int> | Returns the name and value of the scope | |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 500 Internal Server Error
POST Certificate#
Post to import new certificate.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/certificates/import |
| Headers | Authorization or X-API-Key |
| Parameters | projectId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
Request body#
{ "certificateBody": "string", "certificatePrivateKey": "string", "certificateChain": "string", "scopeId": 0}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| certificateBody | Yes | string | "string" | Send the body of certificate. |
| certificatePrivateKey | Yes | string | "string" | Send the private key of certificate. |
| certificateChain | Yes | string | "string" | Send the chain of certificate. |
| scopeId | Yes | integer($int32) | 0 | Send the scope id |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "scopeId": 0, "sslCertificateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "domainName": "string", "additionalNames": "string", "publicKeyInfo": "string", "signatureAlgorithm": "string", "issuer": "string", "certificateType": "string", "certificateStatus": "string", "certificateChallenge": "string", "serialNumber": "string", "dnsRecords": [ { "key": "string", "value": "string" } ], "notBefore": "2021-07-26T09:00:50.544Z", "notAfter": "2021-07-26T09:00:50.544Z", "scopeOptions": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| id | integer($int32) | 0 | Returns the id of certificate. |
| projectId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id. |
| scopeId | integer($int32) | 0 | Returns the scope id |
| sslCertificateId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the ssl certificate id. |
| domainName | string | "string" | Returns the domain name. |
| additionalNames | string | "string" | Returns the additional names. |
| publicKeyInfo | string | "string" | Returns the public key info. |
| signatureAlgorithm | string | "string" | Returns the signature algorithm. |
| issuer | string | "string" | Returns the signature issuer. |
| certificateType | string | "string" | Returns the certificate type. |
| certificateStatus | string | "string" | Returns the certificate status. |
| certificateChallenge | string | "string" | Returns the certificate challenge. |
| serialNumber | string | "string" | Returns the serial number. |
| dnsRecord | List\<object> | Returns the dns record. | |
| notBefore | DateTime | "2021-07-26T08:51:51.079Z" | Returns the starting date of certificate. |
| notAfter | DateTime | "2021-07-26T08:51:51.079Z" | Returns the ending date of certificate. |
| scopeOptions | Dictionary\<string, int> | Returns the name and value of the scope | |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 500 Internal Server Error
PUT Certificate#
PUT to update existing certificate.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/certificates/{id} |
| Headers | Authorization or X-API-Key |
| Parameters | projectId, version, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | Shows the id of certificate |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Id | Yes | integer($int32) | 0 | Shows the if of certificate. |
Request body#
{ "scopeId": 0}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| scopeId | Yes | integer($int32) | 0 | Send the scope id |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "scopeId": 0, "sslCertificateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "domainName": "string", "additionalNames": "string", "publicKeyInfo": "string", "signatureAlgorithm": "string", "issuer": "string", "certificateType": "string", "certificateStatus": "string", "certificateChallenge": "string", "serialNumber": "string", "dnsRecords": [ { "key": "string", "value": "string" } ], "notBefore": "2021-10-28T07:41:59.563Z", "notAfter": "2021-10-28T07:41:59.563Z", "scopeOptions": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| id | integer($int32) | 0 | Returns the id of certificate. |
| projectId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id. |
| scopeId | integer($int32) | 0 | Returns the scope id |
| sslCertificateId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the ssl certificate id. |
| domainName | string | "string" | Returns the domain name. |
| additionalNames | string | "string" | Returns the additional names. |
| publicKeyInfo | string | "string" | Returns the public key info. |
| signatureAlgorithm | string | "string" | Returns the signature algorithm. |
| issuer | string | "string" | Returns the signature issuer. |
| certificateType | string | "string" | Returns the certificate type. |
| certificateStatus | string | "string" | Returns the certificate status. |
| certificateChallenge | string | "string" | Returns the certificate challenge. |
| serialNumber | string | "string" | Returns the serial number. |
| dnsRecord | List\<object> | Returns the dns record. | |
| notBefore | DateTime | "2021-07-26T08:51:51.079Z" | Returns the starting date of certificate. |
| notAfter | DateTime | "2021-07-26T08:51:51.079Z" | Returns the ending date of certificate. |
| scopeOptions | Dictionary\<string, int> | Returns the name and value of the scope | |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 500 Internal Server Error
PUT Certificate#
PUT to validate certificate challange.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/certificates/{id}/validate |
| Headers | Authorization or X-API-Key |
| Parameters | projectId, version, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | Shows the id of certificate |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Id | Yes | integer($int32) | 0 | Shows the if of certificate. |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "scopeId": 0, "sslCertificateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "domainName": "string", "additionalNames": "string", "publicKeyInfo": "string", "signatureAlgorithm": "string", "issuer": "string", "certificateType": "string", "certificateStatus": "string", "certificateChallenge": "string", "serialNumber": "string", "dnsRecords": [ { "key": "string", "value": "string" } ], "notBefore": "2021-10-28T07:44:22.048Z", "notAfter": "2021-10-28T07:44:22.048Z", "scopeOptions": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| id | integer($int32) | 0 | Returns the id of certificate. |
| projectId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id. |
| scopeId | integer($int32) | 0 | Returns the scope id |
| sslCertificateId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the ssl certificate id. |
| domainName | string | "string" | Returns the domain name. |
| additionalNames | string | "string" | Returns the additional names. |
| publicKeyInfo | string | "string" | Returns the public key info. |
| signatureAlgorithm | string | "string" | Returns the signature algorithm. |
| issuer | string | "string" | Returns the signature issuer. |
| certificateType | string | "string" | Returns the certificate type. |
| certificateStatus | string | "string" | Returns the certificate status. |
| certificateChallenge | string | "string" | Returns the certificate challenge. |
| serialNumber | string | "string" | Returns the serial number. |
| dnsRecord | List\<object> | Returns the dns record. | |
| notBefore | DateTime | "2021-07-26T08:51:51.079Z" | Returns the starting date of certificate. |
| notAfter | DateTime | "2021-07-26T08:51:51.079Z" | Returns the ending date of certificate. |
| scopeOptions | Dictionary\<string, int> | Returns the name and value of the scope | |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 500 Internal Server Error
DELETE Certificate#
Deletes the specified certificate.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/certificates/{id} |
| Headers | Authorization or X-API-Key |
| Parameters | projectId, version, id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | Shows the id of certificate |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projctId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| Id | Yes | integer($int32) | 0 | Shows the if of certificate. |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "scopeId": 0, "sslCertificateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "domainName": "string", "additionalNames": "string", "publicKeyInfo": "string", "signatureAlgorithm": "string", "issuer": "string", "certificateType": "string", "certificateStatus": "string", "certificateChallenge": "string", "serialNumber": "string", "dnsRecords": [ { "key": "string", "value": "string" } ], "notBefore": "2021-10-28T07:46:36.578Z", "notAfter": "2021-10-28T07:46:36.578Z", "scopeOptions": { "additionalProp1": 0, "additionalProp2": 0, "additionalProp3": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will get false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns an distribution object | |
| id | integer($int32) | 0 | Returns the id of certificate. |
| projectId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id. |
| scopeId | integer($int32) | 0 | Returns the scope id |
| sslCertificateId | Guid | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the ssl certificate id. |
| domainName | string | "string" | Returns the domain name. |
| additionalNames | string | "string" | Returns the additional names. |
| publicKeyInfo | string | "string" | Returns the public key info. |
| signatureAlgorithm | string | "string" | Returns the signature algorithm. |
| issuer | string | "string" | Returns the signature issuer. |
| certificateType | string | "string" | Returns the certificate type. |
| certificateStatus | string | "string" | Returns the certificate status. |
| certificateChallenge | string | "string" | Returns the certificate challenge. |
| serialNumber | string | "string" | Returns the serial number. |
| dnsRecord | List\<object> | Returns the dns record. | |
| notBefore | DateTime | "2021-07-26T08:51:51.079Z" | Returns the starting date of certificate. |
| notAfter | DateTime | "2021-07-26T08:51:51.079Z" | Returns the ending date of certificate. |
| scopeOptions | Dictionary\<string, int> | Returns the name and value of the scope | |
| resultInfo | object | Returs information about distribution | |
| totalCount | integer($int32) | 0 | Total number of objects in database |
| pageIndex | integer($int32) | 0 | Returns Current pageop paganed data |
| pageSize | integer($int32) | 0 | Returns Objects per page |
| totalPages | integer($int32) | 0 | Returns Total pages |
| hasNextPage | bool | true | Returns true if it has a next page, otherwise returns false |
| hasPreviousPage | bool | true | Returns true if it has a previous page, otherwise returns false |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 500 Internal Server Error