Activate a key collection versionpost https://{hostname}/jwt-api/v1/activationsDeploys the version of a key collection in the staging or production environment. Note that a key collection uses the public keys from its active version to validate JWTs in client requests. See API concepts.RecipesActivate a key collection versionOpen RecipeQuery ParamsaccountSwitchKeystringFor 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 Paramsenvironmentstringrequiredlength ≥ 1The environment where you want to activate the version of the key collection, either STAGING or PRODUCTION.STAGINGPRODUCTIONkeyCollectionVersionIdintegerrequired≥ 1Identifies the key collection version to activate.Responses 201Successful response.Response bodyobjectactivatedBystringrequiredlength ≥ 1The username who sent the activation request.environmentstringrequiredlength ≥ 1The environment where you're activating the key collection version, either STAGING or PRODUCTION. STAGING PRODUCTIONidintegerrequired≥ 1The identifier of the activation.keyCollectionVersionIdintegerrequired≥ 1The identifier of the key collection version that you're activating.keyCollectionVersionNointegerrequired≥ 1The number of the version within the key collection. With each new version of this key collection, this number increments by 1.startTimeintegerrequired≥ 0An epoch timestamp when the activation started.statestringrequiredlength ≥ 1The status of the activation across the platform. These values are available: PREPARED when the system is ready to propagate the activation, IN_PROGRESS when the system is already propagating the activation, DONE when the system has successfully propagated the activation, NOT_AVAILABLE when the system has been unable to access data for the activation, or ERROR when the system has failed to propagate the activation. To fix the ERROR and NOT_AVAILABLE states, send another activation request. If it fails, contact support. PREPARED IN_PROGRESS DONE NOT_AVAILABLE ERROR 401Unauthorized.Response bodyobjectcodestringrequiredlength ≥ 1Unique code for an error.incidentIdstringlength ≥ 1A logging key useful when communicating about problems with Technical Support representatives.solutionstringlength ≥ 1A short, human-readable problem solution.titlestringrequiredlength ≥ 1A short, human-readable summary of the problem type.typestringType of error.View Additional Properties 403Forbidden. Not authorized to access the data that the request was made against.Response bodyobjectcodestringlength ≥ 1Unique code for an error.detailstringlength ≥ 1A human-readable explanation specific to the problem.detailsarray of objectslength ≥ 1A list of HTTP problem details. This field exists if there are many problems with a single request and you want to call them each out explicitly.detailsobjectcodestringlength ≥ 1Unique code for an error.detailstringlength ≥ 1A human-readable explanation specific to the problem. Consumers should not parse the detail member for information; extensions are more suitable and less error-prone ways to obtain such information.incidentIdstringlength ≥ 1A logging key useful when communicating about problems with Technical Support representatives.instanceuriA non-navigable URI that identifies each error instance.statusinteger≥ 0The HTTP error code.titlestringrequiredlength ≥ 1A short, human-readable summary of the problem type.typeurirequiredA non-navigable URI that identifies each error case.View Additional PropertiesincidentIdstringlength ≥ 1A logging key useful when communicating about problems with Technical Support representatives.instanceuriA non-navigable URI that identifies each error instance.statusinteger≥ 0The HTTP error code.titlestringrequiredlength ≥ 1A short, human-readable summary of the problem type.typeurirequiredA non-navigable URI that identifies each error case.View Additional Properties 404Not found. Requested resource not found.Response bodyobjectcodestringlength ≥ 1Unique code for an error.detailstringlength ≥ 1A human-readable explanation specific to the problem.detailsarray of objectslength ≥ 1A list of HTTP problem details. This field exists if there are many problems with a single request and you want to call them each out explicitly.detailsobjectcodestringlength ≥ 1Unique code for an error.detailstringlength ≥ 1A human-readable explanation specific to the problem. Consumers should not parse the detail member for information; extensions are more suitable and less error-prone ways to obtain such information.incidentIdstringlength ≥ 1A logging key useful when communicating about problems with Technical Support representatives.instanceuriA non-navigable URI that identifies each error instance.statusinteger≥ 0The HTTP error code.titlestringrequiredlength ≥ 1A short, human-readable summary of the problem type.typeurirequiredA non-navigable URI that identifies each error case.View Additional PropertiesincidentIdstringlength ≥ 1A logging key useful when communicating about problems with Technical Support representatives.instanceuriA non-navigable URI that identifies each error instance.statusinteger≥ 0The HTTP error code.titlestringrequiredlength ≥ 1A short, human-readable summary of the problem type.typeurirequiredA non-navigable URI that identifies each error case.View Additional Properties 406Not Acceptable. Wrong Accept header.Response bodyobjectcodestringlength ≥ 1Unique code for an error.detailstringlength ≥ 1A human-readable explanation specific to the problem.detailsarray of objectslength ≥ 1A list of HTTP problem details. This field exists if there are many problems with a single request and you want to call them each out explicitly.detailsobjectcodestringlength ≥ 1Unique code for an error.detailstringlength ≥ 1A human-readable explanation specific to the problem. Consumers should not parse the detail member for information; extensions are more suitable and less error-prone ways to obtain such information.incidentIdstringlength ≥ 1A logging key useful when communicating about problems with Technical Support representatives.instanceuriA non-navigable URI that identifies each error instance.statusinteger≥ 0The HTTP error code.titlestringrequiredlength ≥ 1A short, human-readable summary of the problem type.typeurirequiredA non-navigable URI that identifies each error case.View Additional PropertiesincidentIdstringlength ≥ 1A logging key useful when communicating about problems with Technical Support representatives.instanceuriA non-navigable URI that identifies each error instance.statusinteger≥ 0The HTTP error code.titlestringrequiredlength ≥ 1A short, human-readable summary of the problem type.typeurirequiredA non-navigable URI that identifies each error case.View Additional Properties 415Unsupported Media Type. Use the valid content type request body.Response bodyobjectcodestringlength ≥ 1Unique code for an error.detailstringlength ≥ 1A human-readable explanation specific to the problem.detailsarray of objectslength ≥ 1A list of HTTP problem details. This field exists if there are many problems with a single request and you want to call them each out explicitly.detailsobjectcodestringlength ≥ 1Unique code for an error.detailstringlength ≥ 1A human-readable explanation specific to the problem. Consumers should not parse the detail member for information; extensions are more suitable and less error-prone ways to obtain such information.incidentIdstringlength ≥ 1A logging key useful when communicating about problems with Technical Support representatives.instanceuriA non-navigable URI that identifies each error instance.statusinteger≥ 0The HTTP error code.titlestringrequiredlength ≥ 1A short, human-readable summary of the problem type.typeurirequiredA non-navigable URI that identifies each error case.View Additional PropertiesincidentIdstringlength ≥ 1A logging key useful when communicating about problems with Technical Support representatives.instanceuriA non-navigable URI that identifies each error instance.statusinteger≥ 0The HTTP error code.titlestringrequiredlength ≥ 1A short, human-readable summary of the problem type.typeurirequiredA non-navigable URI that identifies each error case.View Additional PropertiesUpdated over 1 year ago 500List activations