Develop > API calls > Scheduler APIs > Create cleanup scheduler

Create cleanup scheduler

This API creates schedules for cleaning up the old deployments and packages.

Users with 'Application Architect' or 'Admin' roles only can create cleanup schedules.
URI Method Parameters Returns
/codar/app/scheduler/{designId}/lifecyclestage/{stageName}/cleanup POST

designId: The application design IDfor which the cleanup actions need to be defined.

stageName: The lifecycle stage name for which the cleanup action need to be defined .

200 - updated
400 - bad request
404 - not found

Examples

The following URL was sent:

https://localhost:8444/csa/api/codar/app/scheduler/{designId}/lifecyclestage/{stageName}/cleanup?designId=9dac9358-09a3-4e29-bbdd-45f36c27245f&stageName=DEVELOPMENT

The following JSON was sent:


{
    "cleanupSchedules":[
    {
        "actionType":"CLEAN_UP_DEPLOYMENTS",
        "scheduledJobName":"name",
        "cleanupInterval":20,
        "advanceNotificationInterval":1,
        "recurInterval":1,
        "scheduledOn":"04/01/2016 2:30 PM"
    },
    {
        "actionType":"CLEAN_UP_PACKAGES",
        "scheduledJobName":"name",
        "cleanupInterval":20,
        "advanceNotificationInterval":1,
        "recurInterval":1,
        "scheduledOn":"04/01/2016 2:30 PM"
    }]}

The following JSON was returned:


{
    "cleanupSchedules": [
    {
        "@self": "/csa/api/codar/app/scheduler/d046255c-85b9-4808-99e8-29e81505cc46",
        "@type": "urn:x-hp:2012:software:cloud:data_model:scheduler",
        "id": "d046255c-85b9-4808-99e8-29e81505cc46",
        "name": "name",
        "scheduledOn": "2016-04-20T09:00:00.000Z",
        "status": "PENDING",
        "eventType": "RECURRING",
        "type": "CLEAN_UP_DEPLOYMENTS",
        "createdBy": "admin",
        "createdOn": "2016-04-19T09:35:59.787Z",
        "cleanupSchedule": {
          "lifecycleStage": "TESTING",
          "modelId": "b1e98106-5f8d-46cb-90d0-3785ef7ef45a",
          "cleanupInterval": 20,
          "advanceNotificationInterval": 1,
          "recurInterval": 0
      }
    },
    {
        "@self": "/csa/api/codar/app/scheduler/d563df33-836f-4400-b866-9700c743984f",
        "@type": "urn:x-hp:2012:software:cloud:data_model:scheduler",
        "id": "d563df33-836f-4400-b866-9700c743984f",
        "name": "name",
        "scheduledOn": "2016-04-20T09:00:00.000Z",
        "status": "PENDING",
        "eventType": "RECURRING",
        "type": "CLEAN_UP_PACKAGES",
        "createdBy": "admin",
        "createdOn": "2016-04-19T09:35:59.792Z",
        "cleanupSchedule": {
          "modelId": "b1e98106-5f8d-46cb-90d0-3785ef7ef45a",
          "cleanupInterval": 20,
          "advanceNotificationInterval": 1,
          "recurInterval": 0
       }}]}

Send Help Center feedback