REST Resources

/api/space/managed-domain/export-ctp-interface

The following operation is supported on this resource:

  • POST - Export Ctp Interface
POST /export-ctp-interfaceVersion 1

Export Ctp Interface.

Sample Usage

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

POST /export-ctp-interface?queue=<queue>&schedule=<schedule>&filter-string=<filter-string>


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
    filter-stringStringQueryFilter StringY
  • Sample Input XML:
    <export-ctp-interface-request>
        <device-list>
          <device href="/api/space/device-management/devices/8814608"/>
        </device-list>
    </export-ctp-interface-request>

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

  • Sample Input JSON:
    {
       "export-ctp-interface-request":{
          "device-list":{
             "device":{
                "href":"/api/space/device-management/devices/8814608"
          }
        }
      }
    }

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

    • Access Control

    The following capabilities are required to access this API: ViewLogicalInterfaces