Certificate
A set of methods for managing certificates.
JSON Representation
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"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",
// `challenges[]` 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`challenges[]`
}
],
"deletionProtection": true
}
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 text format. |
name | string Name of the certificate. The name is unique within the folder. |
description | string Description of the certificate. |
labels | object Certificate labels as |
type | string Type of the certificate. Supported certificate types.
|
domains[] | string Fully qualified domain names of the certificate. |
status | string Status of the certificate.
|
issuer | string Distinguished Name of the certificate authority that issued the certificate. |
subject | string Distinguished Name of the entity that is associated with the public key contained in the certificate. |
serial | string Serial number of the certificate. |
updatedAt | string (date-time) Time when the certificate is updated. String in RFC3339 text format. |
issuedAt | string (date-time) Time when the certificate is issued. String in RFC3339 text format. |
notAfter | string (date-time) Time after which the certificate is not valid. String in RFC3339 text format. |
notBefore | string (date-time) Time before which the certificate is not valid. String in RFC3339 text format. |
challenges[] | object Domains validation challenges of the certificate. Used only for managed certificates. |
challenges[]. domain |
string Domain of the challenge. |
challenges[]. type |
string Type of the challenge.
|
challenges[]. createdAt |
string (date-time) Time when the challenge is created. String in RFC3339 text format. |
challenges[]. updatedAt |
string (date-time) Time when the challenge is updated. String in RFC3339 text format. |
challenges[]. status |
string Status of the challenge.
|
challenges[]. message |
string Description of the challenge. |
challenges[]. error |
string Error of the challenge. |
challenges[]. dnsChallenge |
object challenges[] includes only one of the fields dnsChallenge , httpChallenge |
challenges[]. dnsChallenge. name |
string Name of the DNS record. |
challenges[]. dnsChallenge. type |
string Type of the DNS-record. |
challenges[]. dnsChallenge. value |
string Value of the DNS-record. |
challenges[]. httpChallenge |
object challenges[] includes only one of the fields dnsChallenge , httpChallenge |
challenges[]. httpChallenge. url |
string Location of the HTTP file. |
challenges[]. httpChallenge. content |
string Content of the HTTP file. |
deletionProtection | boolean (boolean) Flag that protects deletion of the certificate |
Methods
Method | Description |
---|---|
create | Creates a certificate in the specified folder. |
delete | Deletes the specified certificate. |
get | Returns the specified certificate. |
list | Returns the list of certificates in the specified folder. |
listAccessBindings | Lists existing access bindings for the specified certificate. |
listOperations | Lists operations for the specified certificate. |
listVersions | |
requestNew | Request a certificate in the specified folder. |
setAccessBindings | Sets access bindings for the certificate. |
update | Updates the specified certificate. |
updateAccessBindings | Updates access bindings for the specified certificate. |