API
Start typing to search…

Create a version

post https://{hostname}/mtls-edge-truststore/v1/ca-sets//versions

Create a new CA set version in the CA set specified by caSetId. When creating a new version, the API compares the certificates and SHA-1 provided in the request with the existing versions in the CA set. If another version exists with fingerprints for the same certificates, a 422 response provides a link to the version. If the allowInsecureSha1 option differs between the versions with the same certificates, they're still considered the same CA set version. This prevents creating duplicate CA set versions.

Path Params
integer
required

Identifies each CA set.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
boolean
Defaults to false

By default, the version's certificates need a signature algorithm of SHA-256 or better. Enabling this allows certificates with SHA-1 signatures.

certificates
array of objects
required
length ≥ 1

The certificates that are valid, non-expired, root, or intermediate.

certificates*
string
required
length ≥ 0

The certificate in PEM format, as found in a Base64 ASCII encoded file.

string | null

Any additional comments you can provide while creating or updating the CA set version.

Responses

Response body
object
boolean | null

By default, all certificates in the version need a signature algorithm of SHA-256 or better. Enabling this allows certificates with SHA-1 signatures.

certificates
array of objects
required
length ≥ 0

The certificates that are valid, non-expired, root, or intermediate.

certificates*
object
integer
≥ 1

Read-only Uniquely identifies the certificate.

string
required
length ≥ 1

The certificate in PEM format, as found in a Base64 ASCII encoded file.

string
length ≥ 1

Read-only The user who created this CA certificate.

date-time

Read-only When the CA certificate was created.

date-time

Read-only The certificate's ISO 8601 formatted expiration date.

string
length ≥ 1

Read-only The fingerprint of the certificate.

string
length ≥ 1

Read-only The certificate's issuer.

string
length ≥ 1

Read-only The unique serial number of the certificate.

string
length ≥ 1

Read-only The signature algorithm of the CA certificate.

date-time

Read-only The start date of the certificate.

string
length ≥ 1

Read-only The certificate's subject field.

string | null

Any additional comments you can provide while creating or updating the CA set version.

string | null

Read-only The user who created the CA set version.

date-time | null

Read-only When the CA set version was created.

string | null

Read-only The user who last modified the CA set version.

date-time | null

Read-only When the CA set version was last modified.

string | null

Read-only The CA set version's status on the production network, either ACTIVE or INACTIVE.

ACTIVE INACTIVE

string | null

Read-only The CA set version's status on the staging network, either ACTIVE or INACTIVE.

ACTIVE INACTIVE

object | null

Read-only Validation results that display any errors, warnings, or notices.

errors
array of objects
required
length ≥ 0

Read-only Any kind of validation errors you need to fix for the request to succeed. For example, creating or updating a CA set version with expired or malformed certificates.

errors*
object
string
length ≥ 1

Read-only Explains the problem with any guidance on how to fix it.

errors
array of objects
length ≥ 1

Read-only The problem type errors.

errors
object
string
length ≥ 1

Read-only Non-navigable URI that identifies each occurrence of the problem.

integer
≥ 1

Read-only The HTTP status code.

string
length ≥ 1

Read-only Human readable summary of each error case.

string
required
length ≥ 1

Read-only Non-navigable URI that identifies each error case.

notices
array of objects
required
length ≥ 0

Read-only Any kind of validation notices only to make you aware. No corrective action required.

notices*
object
string
length ≥ 1

Read-only Explains the problem with any guidance on how to fix it.

errors
array of objects
length ≥ 1

Read-only The problem type errors.

errors
object
string
length ≥ 1

Read-only Non-navigable URI that identifies each occurrence of the problem.

integer
≥ 1

Read-only The HTTP status code.

string
length ≥ 1

Read-only Human readable summary of each error case.

string
required
length ≥ 1

Read-only Non-navigable URI that identifies each error case.

warnings
array of objects
required
length ≥ 0

Read-only Any kind of validation warnings where you can fix the request. For example, creating or updating CA set version with duplicated certificates.

warnings*
object
string
length ≥ 1

Read-only Explains the problem with any guidance on how to fix it.

errors
array of objects
length ≥ 1

Read-only The problem type errors.

errors
object
string
length ≥ 1

Read-only Non-navigable URI that identifies each occurrence of the problem.

integer
≥ 1

Read-only The HTTP status code.

string
length ≥ 1

Read-only Human readable summary of each error case.

string
required
length ≥ 1

Read-only Non-navigable URI that identifies each error case.

integer | null
≥ 1

Read-only Uniquely identifies the CA set version.

string | null

Read-only Hypermedia link to the CA set version.

integer | null
≥ 1

Read-only The CA set's incremental version number.

Headers
object
string

Hypermedia link to the newly created version.

integer

Indicates how many total requests you are allowed to make in the current time window. You can't make more requests than this value. See Rate Limiting.

integer

Indicates how many remaining requests you can make in the current time window. See Rate Limiting.

string

Indicates the time of resetting the number of your remaining requests to the full limit indicated by X-RateLimit-Limit. See Rate Limiting.

Content-Type header.

Updated 11 months ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated 11 months ago

Did this page help you?