Method list
Returns the list of certificates in the specified folder.
HTTP request
GET https://certificate-manager.api.cloud.yandex.net/certificate-manager/v1/certificates
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list certificate in. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 100. |
view | The output type of the certificate.
|
Response
HTTP Code: 200 - OK
{
"certificates": [
{
"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",
// `certificates[].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`certificates[].challenges[]`
}
]
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
certificates[] | object A certificate. For details about the concept, see documentation. |
certificates[]. id |
string ID of the certificate. Generated at creation time. |
certificates[]. folderId |
string ID of the folder that the certificate belongs to. |
certificates[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. |
certificates[]. name |
string Name of the certificate. The name is unique within the folder. |
certificates[]. description |
string Description of the certificate. |
certificates[]. labels |
object Certificate labels as |
certificates[]. type |
string Type of the certificate. Supported certificate types.
|
certificates[]. domains[] |
string Fully qualified domain names of the certificate. |
certificates[]. status |
string Status of the certificate.
|
certificates[]. issuer |
string Distinguished Name of the certificate authority that issued the certificate. |
certificates[]. subject |
string Distinguished Name of the entity that is associated with the public key contained in the certificate. |
certificates[]. serial |
string Serial number of the certificate. |
certificates[]. updatedAt |
string (date-time) Time when the certificate is updated. String in RFC3339 text format. |
certificates[]. issuedAt |
string (date-time) Time when the certificate is issued. String in RFC3339 text format. |
certificates[]. notAfter |
string (date-time) Time after which the certificate is not valid. String in RFC3339 text format. |
certificates[]. notBefore |
string (date-time) Time before which the certificate is not valid. String in RFC3339 text format. |
certificates[]. challenges[] |
object Domain validation challenge. |
certificates[]. challenges[]. domain |
string Domain of the challenge. |
certificates[]. challenges[]. type |
string Type of the challenge. Supported domain validation types.
|
certificates[]. challenges[]. createdAt |
string (date-time) Time when the challenge is created. String in RFC3339 text format. |
certificates[]. challenges[]. updatedAt |
string (date-time) Time when the challenge is updated. String in RFC3339 text format. |
certificates[]. challenges[]. status |
string Status of the challenge.
|
certificates[]. challenges[]. message |
string Description of the challenge. |
certificates[]. challenges[]. error |
string Error of the challenge. |
certificates[]. challenges[]. dnsChallenge |
object DNS-record. certificates[].challenges[] includes only one of the fields dnsChallenge , httpChallenge |
certificates[]. challenges[]. dnsChallenge. name |
string Name of the DNS record. |
certificates[]. challenges[]. dnsChallenge. type |
string Type of the DNS-record. |
certificates[]. challenges[]. dnsChallenge. value |
string Value of the DNS-record. |
certificates[]. challenges[]. httpChallenge |
object HTTP-file. certificates[].challenges[] includes only one of the fields dnsChallenge , httpChallenge |
certificates[]. challenges[]. httpChallenge. url |
string Location of the HTTP file. |
certificates[]. challenges[]. httpChallenge. content |
string Content of the HTTP file. |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is greater than the specified pageSize, use the |