Certificates

Create certificate

Creates a new certificate with the provided details

post/api/certificates

Request body

namestring required

The name of the certificate.

descriptionstring required

A description of the certificate's purpose or usage.

regenerateCertificateboolean required

Whether to regenerate the certificate.

Example request

{
  "name": "New Server SSL Certificate",
  "description": "New SSL certificate for securing server communications",
  "options": {
    "commonName": "example.com",
    "countryName": "FR",
    "stateOrProvinceName": "Savoie",
    "localityName": "Chambéry",
    "organizationName": "Example Inc.",
    "keySize": 2048,
    "daysBeforeExpiry": 365
  }
}

Response

Certificate created successfully

idstring required

The unique identifier of the entity.

creationDatestring

Represents an instant in time as an ISO 8601 string.

lastEditInstantstring

Represents an instant in time as an ISO 8601 string.

namestring required

The name of the certificate.

descriptionstring required

A description of the certificate's purpose or usage.

publicKeystring required

The public key of the certificate in PEM format.

certificatestring required

The certificate in PEM format.

expirystring required

Represents an instant in time as an ISO 8601 string.

Example response

{
  "id": "entity123",
  "creationDate": "2023-10-31T12:34:56.789Z",
  "lastEditInstant": "2023-10-31T12:34:56.789Z",
  "name": "Server SSL Certificate",
  "description": "SSL certificate for securing server communications",
  "publicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAKoK/heBjcOuMA0GCSqGSIb3DQEBBQUAMEUx...",
  "expiry": "2023-10-31T12:34:56.789Z"
}

Changes