Sign in
Certificates

Import certificate

Imports an externally-issued certificate together with its private key, and optionally its CA chain

post/api/certificates/import

Response

Certificate imported successfully

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

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.

certificateChainstring nullable required

The PEM bundle of intermediate/root CA certificates supplied when importing an externally-issued certificate. Null for self-signed certificates generated by OIBus.

Example response

{
  "id": "entity123",
  "createdBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "updatedBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "createdAt": "2023-10-31T12:34:56.789Z",
  "updatedAt": "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",
  "certificateChain": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAKoK/heBjcOuMA0GCSqGSIb3DQEBBQUAMEUx...\n-----END CERTIFICATE-----"
}

Changes