Skip to main content
Version: Next

Issue Certificate

This method is used to issue a certificate for a specified domain.

info

This method issues a free certificate from Let's Encrypt.

info

Upon a successful request, a task will be created. You can track its progress using the Tasks API.

Request Parameters

GET /api/clients/v1/domains/{id}/issueCertificate/

Headers

  • Content-Type: application/json
  • Authorization: Bearer $access_token

Path

ParameterTypeConstraintsDescriptionExample
idinteger> 0, requiredDomain ID1

Response Parameters

JSON body

ParameterTypeDescription
task_idstringTask ID

Examples

200 OK

Task ID for certificate issuance for the domain

{
"task_id": "bb4dcd80-01a5-4a73-8c2b-62c5027a9b72"
}
400 Bad Request

Invalid path parameters provided

{
"id": [
"A valid integer is required."
]
}
401 Unauthorized

Authentication credentials are missing or invalid

{
"detail": "Given token not valid for any token type",
"code": "token_not_valid",
"messages": [
{
"token_class": "AccessToken",
"token_type": "access",
"message": "Token is invalid or expired"
}
]
}
403 Forbidden

Only project participants can issue certificates for the domain

{
"detail": "Only project participants can issue certificates"
}
404 Not Found

Domain with the given ID not found

{
"detail": "Domain not found"
}