Deletions and revocations

Deleting the data history (5) (optional)

Deleting historical data allows for the removal of the data used to generate certificates. Certificates for which historical data has been deleted will remain accessible. This should not be confused with the deletion of the certificates themselves, as documented below.

Warning

Please note that the deletion of the history data is irreversible.

“Delete” service is accessible through a DELETE call to the [API-URL]/admin/campaign?campaignId=XXX endpoint with XXX is the campaign ID given in response to the “Pull” webservice.

The response will have a 204 status if everything went well.

Deleting/revoking certificates

You can delete one or more certificates via API.

Warning

Be careful, the deletion of a certificate is irreversible: the certificates thus deleted will be inaccessible forever.

The certificate deletion web service is accessible by a DELETE call at the [API-URL]/admin/keys endpoint.

Mandatory HTTP header: Content-Type: application/json

The body of the certificate deletion request must contain the certificates identifiers (key field of the campaign data) within a JSON structure.

Example:

[
"12DC1EBEFDC201FF016C34680C411E85C3EBEB190F1C175327426A4F799A5834cUxBYXA3Q1pzcmh4OUJRV2Z3YVRhbjRCeG00SU9DNnFjYmMvbFk4MUFMeW5qZFlK",
"EE064BB1D32EA96869818860B42C5499B9562B9A35D0C99E9F58E6578D87E5B1WWg2YzJEVFNobS9BZmIyNGYzWkU1aVF5V3lEUEtOS0J3UDlMODd5bFlXektlNnNh"
]

The response will have a 200 status if everything went well.

Disabling/reactivating certificates

You can temporarily disable one or more certificates via API, and re-enable them later.

The certificate disabling/reactivating web service is accessible by a PUT call to the [API-URL]/admin/keys endpoint.

Mandatory HTTP header: Content-Type: application/json

The body of the request is a JSON formatted string containing the following fields:

  • ids: an array of the certificates keys for which certificates should be disabled/enabled;
  • campaignId : the identifier of the campaign whose certificates we want to disable/enable.

One of the two parameters above is mandatory.

  • enable : false to disable, true to re-enable, mandatory.

Example to disable 2 certificates:

{
  "ids": [
    "12DC1EBEFDC201FF016C34680C411E85C3EBEB190F1C175327426A4F799A5834cUxBYXA3Q1pzcmh4OUJRV2Z3YVRhbjRCeG00SU9DNnFjYmMvbFk4MUFMeW5qZFlK",
    "EE064BB1D32EA96869818860B42C5499B9562B9A35D0C99E9F58E6578D87E5B1WWg2YzJEVFNobS9BZmIyNGYzWkU1aVF5V3lEUEtOS0J3UDlMODd5bFlXektlNnNh"
  ],
  "enable": false
}

and to reactivate them:

{
  "ids": [
    "12DC1EBEFDC201FF016C34680C411E85C3EBEB190F1C175327426A4F799A5834cUxBYXA3Q1pzcmh4OUJRV2Z3YVRhbjRCeG00SU9DNnFjYmMvbFk4MUFMeW5qZFlK",
    "EE064BB1D32EA96869818860B42C5499B9562B9A35D0C99E9F58E6578D87E5B1WWg2YzJEVFNobS9BZmIyNGYzWkU1aVF5V3lEUEtOS0J3UDlMODd5bFlXektlNnNh"
  ],
  "enable": true
}

The response will have a 200 status if everything went well.