Delete a Checkpoint

The self-service console enables you to delete an existing checkpoint when it is no longer needed or becomes redundant. Removing unnecessary checkpoints can help free up space so that the remaining checkpoint is easier to manage and access.

To delete a checkpoint, send the following work request API using the POST method:

HTTP Method	POST
Base URL	http://<app-deployment-name>/workRequest/create/deletecheckpoint
Content-Type	application/json

Request Body Example

{
"<name>": <value>
}

Here, enter the checkpoint name that you want to delete in the following format:

CheckpointName"_"ApplicationVersion"-"CreationDate(YYYYMMDD). For example, "pol_test_3.22.1.0.2-20220926".

Verify the name of the checkpoint using the checkpoint/list API.

Response Example

The successful deletion of a checkpoint returns a 200 OK response.

Error Response

Besides, the 200 responses this endpoint can return the 4xx responses when any other checkpoint operation is in-progress.

Confirm the Delete Operation

To confirm the deletion of checkpoint, send the following GET request with the appropriate UUID:

HTTP Method	GET
Base URL	http://<app-deployment-name>/workRequest/confirm/{uuid}
Content-Type	application/json

Here, replace {uuid} with uuid value that is returned by POST http://<app-deployment-name>/workRequest/create/deletecheckPoint.

Response Example

{
    "uuid": "<uuid>",
    "requestType": "deletecheckpoint",
    "status": "COMPLETED",
    "requestInfo": "{<requestType>}",
    "createdBy": "<user_name>",
    "createdAt": "2022-05-17T06:02:14.908Z",
    "updatedBy": null,
    "lastUpdatedAt": "2022-05-17T06:16:54.409Z",
    "confirm": null,
    "cancel": null
}

You can also confirm the work request by clicking on the confirm URL return in the POST http://<app-deployment-name>/workRequest/create/checkpoint response body. It redirects you to the GET request body and then sends the request.

Cancel the Delete Operation

You can cancel the delete operation within ten minutes by sending the following GET request with the appropriate UUID:

HTTP Method	GET
Base URL	http://<app-deployment-name>/workRequest/cancel/{uuid}
Content-Type	application/json

Response Example

{
    "uuid": "<uuid>",
    "requestType": "deletecheckpoint",
    "status": "CANCELED",
    "requestInfo": "{<requestInfo>}",
    "createdBy": "<user_name>",
    "createdAt": "2022-05-17T06:02:14.908Z",
    "updatedBy": null,
    "lastUpdatedAt": "2022-05-17T06:16:54.409Z",
    "confirm": null,
    "cancel": null
}

Verify the Status

To verify that specific checkpoint is deleted, send the following GET request:

HTTP Method	GET
Base URL	http://<app-deployment-name>/checkPoint/list
Content-Type	application/json

Response Example

In response, the deleted checkpoint is not listed.

[
    "claim_test_3.22.1.0.2-20220926",
    "vbe_test_3.22.1.0.2-20220926",
    "rbe_test_3.22.1.0.2-20220926",

]