Certificates

Create a new Certificate

Changed on

Create a new Certificate

post/v2/control-planes/{controlPlaneId}/core-entities/certificates

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/certificates
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

OR

Example request

{
  "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Response

Successfully created Certificate

certstring required

PEM-encoded public certificate chain of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

cert_altstring nullable

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

created_atinteger nullable

Unix epoch when the resource was created.

idstring nullable

A string representing a UUID (universally unique identifier).

keystring required

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

key_altstring nullable

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

snisstring[] nullable
tagsstring[] nullable

An optional set of strings associated with the Certificate for grouping and filtering.

updated_atinteger nullable

Unix epoch when the resource was last updated.

Example response

{
  "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      removed subschema #1 subschema #2 from the request property anyOf list

    • info

      added subschema #1: CertificateWithVault subschema #2: CertificateWithCertAndKey to the request property anyOf list

  • fbe6ce110ba4Revision changes
    • breaking

      the request property / became not nullable