Sign in
ds-tls-certification-authorities

update the DS TLS certification authority

Changed on
<h3>CS administrator edits the settings of a DS TLS certification authority.</h3>
patch/ds-tls-certification-authorities/{ds_tls_certification_authority_id}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/ds-tls-certification-authorities/{ds_tls_certification_authority_id}
  • Auth: API key in header Authorization

Request body

namestring text

DS TLS certification authority name

acme_server_directory_urlstring url

enables auto-enrollment from this CA's ACME server when set

ds_tls_certificate_profile_idstring text

certificate profile id some ACME servers need to know the DS TLS certificate usage type

Example request

{
  "name": "Let's Encrypt"
}

Response

the new state of the DS TLS certification authority

idinteger required

unique identifier

namestring text required

DS TLS certification authority name

issuer_distinguished_namestring text

certificate issuer distinguished name

subject_distinguished_namestring text

certificate subject distinguished name

not_afterstring date-time

certificate validity not after

not_beforestring date-time

certificate validity not before

acme_server_directory_urlstring url

enables auto-enrollment from this CA's ACME server when set

ds_tls_certificate_profile_idstring text

certificate profile id some ACME servers need to know the DS TLS certificate usage type

Example response

{
  "id": 123,
  "name": "Let's Encrypt",
  "issuer_distinguished_name": "issuer123",
  "subject_distinguished_name": "subject123",
  "not_after": "2022-01-17T00:00:00.001Z",
  "not_before": "2022-01-17T00:00:00.001Z"
}

Changes