REST Resources

/api/space/job-management/archive-purge-jobs

The following operations are supported on this resource:

  • POST - This API is used to archive and purge jobs in remote mode
  • POST - This API is used to archive and purge jobs in local VIP node
POST /archive-purge-jobs Version 3

This API is used to archive and purge jobs in remote mode.
Jobs will be initially archived to VIP node and then copied to Remote server's directory using SCP protocol.

Sample Usage

This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

POST /archive-purge-jobs?queue=<queue>&schedule=<schedule>


Note: The queue URL denoted by <queue> must have been created already.


  • Parameters:
    Name Type URI Type Description Required
    queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
    schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
    <archive-purge-jobs-remote-request>
         <archive-jobs-before>Long</archive-jobs-before>
         <job-type>String</job-type>
         <purge-from-all-domains>Boolean</purge-from-all-domains>
         <user>String</user>
         <password>String</password>
         <ip>String</ip>
         <path>String</path>
    </archive-purge-jobs-remote-request>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/2523149">
         <id>2523149</id>
    </task>

  • Sample Input JSON:
    {
       "archive-purge-jobs-remote-request" : {
         "archive-jobs-before" : "Long" ,
         "job-type" : "String" ,
         "purge-from-all-domains" : "Boolean" ,
         "user" : "String" ,
         "password" : "String" ,
         "ip" : "String" ,
         "path" : "String"
       }
    }

  • Sample Output JSON:

    {
        "task": {
          "@href" : "/api/space/job-management/jobs/2523149",
          "id" : 2523149
        }
    }

    • Access Control

    The following capabilities are required to access this API: PurgeJobs

    POST /archive-purge-jobs Version 3

    This API is used to archive and purge jobs in local VIP node.
    Jobs will be archived to VIP node in /var/lib/mysql/archive/ directory.

    Sample Usage

    This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

    POST /archive-purge-jobs?queue=<queue>&schedule=<schedule>


    Note: The queue URL denoted by <queue> must have been created already.


    • Parameters:
      Name Type URI Type Description Required
      queue Queue URL Query A fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage) N
      schedule cron-like-expression Query Schedule this API in the future, by specifying a cron-like-expression (See Job Scheduling) N
  • Sample Input XML:
    <archive-purge-jobs-local-request>
         <purge-from-all-domains>Boolean</purge-from-all-domains>
         <archive-job-before-purge>Boolean</archive-job-before-purge>
         <archive-jobs-before>Long</archive-jobs-before>
         <job-type>String</job-type>
    </archive-purge-jobs-local-request>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/2523149">
         <id>2523149</id>
    </task>

  • Sample Input JSON:
    {
       "archive-purge-jobs-local-request" : {
         "purge-from-all-domains" : "Boolean" ,
         "archive-job-before-purge" : "Boolean" ,
         "archive-jobs-before" : "Long" ,
         "job-type" : "String"
       }
    }

  • Sample Output JSON:

    {
        "task": {
          "@href" : "/api/space/job-management/jobs/2523149",
          "id" : 2523149
        }
    }

    • Access Control

    The following capabilities are required to access this API: PurgeJobs