Certificate Manager Private CA API, REST: PrivateCa.List
Lists the available Certificate Authorities (CAs).
HTTP request
GET https://private-ca.certificate-manager.api.cloud.yandex.net/privateca/v1/certificateAuthorities
Query parameters
List Certificate Authorities in specified folder.
This supports pagination.
|
Field |
Description |
|
folderId |
string Required field. The folder in which CA would be listed. |
|
pageSize |
string (int64) The maximum number of results to return per page. Couldn't exceed 100, default value is 100 |
|
pageToken |
string Token to retrieve the next page of results. |
Response
HTTP Code: 200 - OK
{
"certificateAuthorities": [
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"parentCertificateAuthorityId": "string",
"status": "string",
"issuedAt": "string",
"notAfter": "string",
"notBefore": "string",
"crlEndpoint": "string",
"endEntitiesTtlLimitDays": "string",
"deletionProtection": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
],
"nextPageToken": "string"
}
Response containing the Certificate Authorities list from the ListCertificateAuthorities request.
|
Field |
Description |
|
certificateAuthorities[] |
List of matching Certificate Authorities. |
|
nextPageToken |
string Token to retrieve the next page of results, if they were paginated. |
CertificateAuthority
A certificate authority (CA) used to sign certificates.
|
Field |
Description |
|
id |
string ID of the certificate authority. |
|
folderId |
string ID of the folder that the certificate authority belongs to. |
|
name |
string Name of the certificate authority. |
|
description |
string Description of the certificate authority. |
|
parentCertificateAuthorityId |
string ID of the parent certificate authority that signed this certificate authority if any. |
|
status |
enum (Status) Status of the certificate authority.
|
|
issuedAt |
string (date-time) Time when the certificate authority was issued. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
notAfter |
string (date-time) Time after which the certificate authority is not valid. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
notBefore |
string (date-time) Time before which the certificate authority is not valid. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
crlEndpoint |
string Endpoint of the certificate revocation list (CRL) for the certificate authority. |
|
endEntitiesTtlLimitDays |
string (int64) Maximum allowed TTL (in days) for end-entity certificates issued by this CA. |
|
deletionProtection |
boolean Flag that protects deletion of the certificate authority. |
|
createdAt |
string (date-time) Time when the certificate authority was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Time when the certificate authority was last updated. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |