Jump to

• Request
• Response

Update a SSL certificate

patch

https://{your_site_interface}/opa-hub/api/12.2.40/sslcertificates/{SSL-certificate-name}

This operation will update a SSL certificate.

Request

Path Parameters

• SSL-certificate-name(required): string
  The certificate name.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• certificate: string
  The certificate data, starting with -----BEGIN CERTIFICATE----- and ending with -----END CERTIFICATE-----.
• name: string
  The certificate name.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The certificate name."
        },
        "certificate":{
            "type":"string",
            "description":"The certificate data, starting with -----BEGIN CERTIFICATE----- and ending with -----END CERTIFICATE-----."
        }
    },
    "additionalProperties":false
}

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : sslCertificate

Type: object

Show Source

• certificate(required): string
  The certificate data, starting with -----BEGIN CERTIFICATE----- and ending with -----END CERTIFICATE-----.
• fingerprintSHA1: string
  Read Only: true

  The certificate SHA-1 fingerprint, as a hexadecimal-encoded, colon separated value.
• fingerprintSHA256: string
  Read Only: true

  The certificate SHA-256 fingerprint, as a hexadecimal-encoded, colon separated value.
• issuer: string
  Read Only: true

  The distinguished name of the certificate issuer.
• name(required): string
  The certificate name.
• subject: string
  Read Only: true

  The distinguished name of the certificate subject.
• validFrom: string (date-time)
  Read Only: true

  The date and time this certificate is valid from.
• validTo: string (date-time)
  Read Only: true

  The date and time this certificate is valid to.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The certificate name."
        },
        "certificate":{
            "type":"string",
            "description":"The certificate data, starting with -----BEGIN CERTIFICATE----- and ending with -----END CERTIFICATE-----."
        },
        "fingerprintSHA256":{
            "type":"string",
            "description":"The certificate SHA-256 fingerprint, as a hexadecimal-encoded, colon separated value.",
            "readOnly":true
        },
        "fingerprintSHA1":{
            "type":"string",
            "description":"The certificate SHA-1 fingerprint, as a hexadecimal-encoded, colon separated value.",
            "readOnly":true
        },
        "validFrom":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time this certificate is valid from.",
            "readOnly":true
        },
        "validTo":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time this certificate is valid to.",
            "readOnly":true
        },
        "issuer":{
            "type":"string",
            "description":"The distinguished name of the certificate issuer.",
            "readOnly":true
        },
        "subject":{
            "type":"string",
            "description":"The distinguished name of the certificate subject.",
            "readOnly":true
        }
    },
    "additionalProperties":false,
    "required":[
        "name",
        "certificate"
    ]
}

400 Response

The request could not be processed because it contains missing or invalid information.

404 Response

The requested resource does not exist.

409 Response

A duplicate name or certificate is already present.

Back to Top