API
Start typing to search…

Activate a version

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

Activate the certificates for the version on the specified network.

Path Params
integer
required

Identifies each CA set.

integer
required

Version identifier on which to perform the desired operation.

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
string
required

Activates on the STAGING or PRODUCTION network. You should test on STAGING first.

Responses

Response body
object
integer | null
≥ 1

Read-only Uniquely identifies the activation request.

string | null

Read-only Hypermedia link to the activation or deactivation.

integer | null
≥ 1

Read-only Uniquely identifies the CA set.

string | null

Read-only Hypermedia link to the CA set.

string | null

Read-only The user who requested the activity.

date-time | null

Read-only When the activity was requested.

string | null

Read-only The user who completed the activity.

date-time | null

Read-only When the request was last modified, or null` if not yet modified.

string | null
required

Indicates the network for any activation-related activities, either STAGING or PRODUCTION.

STAGING PRODUCTION

string

Read-only Status of the current activity, either IN_PROGRESS, COMPLETE, or FAILED.

IN_PROGRESS COMPLETE FAILED

string

Read-only Type of requested activity, either ACTIVATE, DEACTIVATE, or DELETE.

ACTIVATE DEACTIVATE DELETE

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 each 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 long the user agent should wait before making a follow-up request.

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 9 months ago

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

Updated 9 months ago

Did this page help you?