Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Intertech Services AG
Yandex Certificate Manager
  • Getting started
  • Step-by-step guides
  • Tutorials
  • Concepts
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
    • REST
      • Overview
      • CertificateContent
      • Certificate
        • Overview
        • create
        • delete
        • get
        • list
        • listAccessBindings
        • listOperations
        • listVersions
        • requestNew
        • setAccessBindings
        • update
        • updateAccessBindings
  • Questions and answers
  1. API reference
  2. REST
  3. Certificate
  4. create

Certificate Manager API, REST: Certificate.create

Written by
Yandex Cloud
  • HTTP request
  • Body parameters
  • Response

Creates a certificate in the specified folder.

HTTP request

POST https://certificate-manager.api.cloud.yandex.net/certificate-manager/v1/certificates

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "certificate": "string",
  "chain": "string",
  "privateKey": "string",
  "deletionProtection": true
}
Field Description
folderId string

Required. ID of the folder to create a certificate in.

The maximum string length in characters is 50.

name string

Name of the certificate. The name must be unique within the folder.

Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

description string

Description of the certificate.

The maximum string length in characters is 1024.

labels object

Labels for the certificate as key:value pairs.

No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*.

certificate string

PEM-encoded certificate content of the certificate.

The maximum string length in characters is 32768.

chain string

PEM-encoded certificate chain content of the certificate.

The maximum string length in characters is 2097152.

privateKey string

Required. PEM-encoded private key content of the certificate.

The string length in characters must be 1-524288.

deletionProtection boolean (boolean)

Flag that protects deletion of the certificate

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // 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 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code
integer (int32)

Error code. An enum value of google.rpc.Code.

error.
message
string

An error message.

error.
details[]
object

A list of messages that carry the error details.

response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

Was the article helpful?

Language / Region
Yandex project
© 2023 Intertech Services AG
In this article:
  • HTTP request
  • Body parameters
  • Response