/api/space/configuration-management/push-configuration

The following operation is supported on this resource:

  • POST - Push Configuration Rest
POST /push-configurationVersion 5

Push Configuration Rest.

Sample Usage

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

POST /push-configuration?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:
    <push-configuration-request>
         <configuration-to-push>
               <device-config-mapping>
                   <configs total="Integer">
                         <config><![CDATA[String]]></config>
                   </configs>
                   <device-id>Integer</device-id>
               </device-config-mapping>
         </configuration-to-push>
         <space-based-device-lock>Boolean</space-based-device-lock>
    </push-configuration-request>

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

  • Sample Input JSON:
    {
      "push-configuration-request": {
        "configuration-to-push": {
          "device-config-mapping": {
            "configs": {
              "@total": "Integer",
              "config": [
                "String"
              ]
            },
            "device-id": "Integer"
          }
        },
        "space-based-device-lock": "Boolean"
      }
    }

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

  • Access Control

    The following capabilities are required to access this API: ModifyUnmanagedDevice