REST Resources

/api/space/config-file-management/delete-config-files

The following operation is supported on this resource:

  • POST - Job to delete device configuration files
POST /delete-config-filesVersion 2

Job to delete device configuration files.

Sample Usage

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

POST /delete-config-files?queue=<queue>&schedule=<schedule>


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


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
    schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:
    <delete-config-files-request>
         <config-files>
               <config-file href="/api/space/config-file-management/config-files/12345"/>
         </config-files>
    </delete-config-files-request>

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

  • Sample Input JSON:
    {
       "delete-config-files-request" : {
         "config-files" : [
             {
             "config-file" : {
               "@href" : "/api/space/config-file-management/config-files/12345"
             }
           }
         ]
       }
    }

  • Sample Output JSON:
     {
        "task": {
            "@href": "/api/space/job-management/jobs/1245208",
            "id": 1245208
        }
     }

    • Access Control

    The following capabilities are required to access this API: DeleteConfigFiles