Sign in
Data Exports

Create New Data Export

Creates a new data export for the provided department, if it's accessible via the used API_KEY.

post/v1/data_exports

Request body

entitystring required

The resource to be exported, it can only one of these values (organizations, credentials, credential_analytics, groups, designs).

department_idnumber required

The department ID where resources are exported from, it should be accessible via the given API_KEY.

Response

Created

department_idnumber

The department ID where resources are exported from, it should be accessible via the given API_KEY.

statusstring

It can be:

  • scheduled: Data export is not yet started

  • processing: Data is being exported

  • completed: Data has been exported

  • errored: Something went wrong while exporting the data.

Changes

Changed in 1 of the 30 revisions of this API.11

  • 98201e8dd1b411See the full diff
    • ●

      deleted the header request parameter Authorization

      request-parameter-removed

    • ○

      the endpoint scheme security ApiKeyAuth was added to the API

      api-security-added