Skip to main content

Initiates Configuration Objects Export Job.

This post will export objects from the tenant to a JSON configuration file. Request will need one of the following security scopes:

  • sp:config:read - sp:config:manage
Request Body required

Export options control what will be included in the export.

  • excludeTypes string[]

    Possible values: [SOURCE, RULE, TRIGGER_SUBSCRIPTION, TRANSFORM, IDENTITY_PROFILE]

    Object type names to be excluded from an sp-config export command.

  • includeTypes string[]

    Possible values: [SOURCE, RULE, TRIGGER_SUBSCRIPTION, TRANSFORM, IDENTITY_PROFILE]

    Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes.

  • objectOptions object

    Additional options targeting specific objects related to each item in the includeTypes field

  • property name* object
Responses

Export job accepted and queued for processing.


Schema
  • jobId string

    Unique id assigned to this job.

  • status string

    Possible values: [NOT_STARTED, IN_PROGRESS, COMPLETE, CANCELLED, FAILED]

    Status of the job.

  • type string

    Possible values: [EXPORT, IMPORT]

    Type of the job, either export or import.

  • message string

    This message contains additional information about the overall status of the job.

  • description string

    Optional user defined description/name for export job.

  • expiration date-time

    The time until which the artifacts will be available for download.

  • created date-time

    The time the job was started.

  • modified date-time

    The time of the last update to the job.

  • completed date-time

    The time the job was completed.

Loading...