Certificate Manager API, REST: Certificate.RequestNew
Request a certificate in the specified folder.
HTTP request
POST https://certificate-manager.api.cloud.yandex.net/certificate-manager/v1/certificates/requestNew
Body parameters
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "string",
"domains": [
"string"
],
"challengeType": "string",
"deletionProtection": "boolean"
}
Field |
Description |
folderId |
string Required field. ID of the folder to create a certificate in. |
name |
string Name of the certificate. |
description |
string Description of the certificate. |
labels |
string Labels for the certificate as |
domains[] |
string Fully qualified domain names of the certificate. |
challengeType |
enum (ChallengeType) Type of the domain validation challenge.
|
deletionProtection |
boolean Flag that protects deletion of the certificate |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"certificateId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"type": "string",
"domains": [
"string"
],
"status": "string",
"issuer": "string",
"subject": "string",
"serial": "string",
"updatedAt": "string",
"issuedAt": "string",
"notAfter": "string",
"notBefore": "string",
"challenges": [
{
"domain": "string",
"type": "string",
"createdAt": "string",
"updatedAt": "string",
"status": "string",
"message": "string",
"error": "string",
// Includes only one of the fields `dnsChallenge`, `httpChallenge`
"dnsChallenge": {
"name": "string",
"type": "string",
"value": "string"
},
"httpChallenge": {
"url": "string",
"content": "string"
}
// end of the list of possible fields
}
],
"deletionProtection": "boolean",
"incompleteChain": "boolean"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
RequestNewCertificateMetadata
Field |
Description |
certificateId |
string ID of the certificate that is being requested. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
Certificate
A certificate. For details about the concept, see documentation.
Field |
Description |
id |
string ID of the certificate. Generated at creation time. |
folderId |
string ID of the folder that the certificate belongs to. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the certificate. |
description |
string Description of the certificate. |
labels |
string Certificate labels as |
type |
enum (CertificateType) Type of the certificate.
|
domains[] |
string Fully qualified domain names of the certificate. |
status |
enum (Status) Status of the certificate.
|
issuer |
string Distinguished Name |
subject |
string Distinguished Name |
serial |
string Serial number of the certificate. |
updatedAt |
string (date-time) Time when the certificate is updated. String in RFC3339 To work with values in this field, use the APIs described in the |
issuedAt |
string (date-time) Time when the certificate is issued. String in RFC3339 To work with values in this field, use the APIs described in the |
notAfter |
string (date-time) Time after which the certificate is not valid. String in RFC3339 To work with values in this field, use the APIs described in the |
notBefore |
string (date-time) Time before which the certificate is not valid. String in RFC3339 To work with values in this field, use the APIs described in the |
challenges[] |
Domains validation challenges of the certificate. Used only for managed certificates. |
deletionProtection |
boolean Flag that protects deletion of the certificate |
incompleteChain |
boolean Mark imported certificates without uploaded chain or with chain which not lead to root certificate |
Challenge
Domain validation challenge.
Field |
Description |
domain |
string Domain of the challenge. |
type |
enum (ChallengeType) Type of the challenge.
|
createdAt |
string (date-time) Time when the challenge is created. String in RFC3339 To work with values in this field, use the APIs described in the |
updatedAt |
string (date-time) Time when the challenge is updated. String in RFC3339 To work with values in this field, use the APIs described in the |
status |
enum (Status) Status of the challenge.
|
message |
string Description of the challenge. |
error |
string Error of the challenge. |
dnsChallenge |
DNS-record. Includes only one of the fields Data of the challenge. |
httpChallenge |
HTTP-file. Includes only one of the fields Data of the challenge. |
DnsRecord
Field |
Description |
name |
string Name of the DNS record. |
type |
string Type of the DNS-record. |
value |
string Value of the DNS-record. |
HttpFile
Field |
Description |
url |
string Location of the HTTP file. |
content |
string Content of the HTTP file. |