/api/space/domain-management/domains/{id}/export-domain

The following operation is supported on this resource:

  • POST - Export the domain data as a .csv file
POST /domains/{id}/export-domain Version 1

Export the domain data as a .csv file.

Sample Usage

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

POST /domains/{id}/export-domain?queue=<queue>&schedule=<schedule>


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


  • Parameters:
    Name Type URI Type Description Required
    id Integer Path ID Y
    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 Output XML:
    <task href="/api/space/job-management/jobs/688128">
      <id>688128</id>
    </task>

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

  • Access Control

    The following capabilities are required to access this API: ExportDomain