POST
/
environments
/
{environmentId}
/
exports
Create a new export request for the project environment
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/exports \
  --header 'Content-Type: application/json' \
  --data '{
  "format": "csv",
  "model": "users"
}'
{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "format": "csv",
  "model": "users",
  "status": "completed",
  "createdAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "downloadUrl": "<string>",
  "error": "<string>"
}

Path Parameters

​
environmentId
string
required

ID of the environment

Required string length: 36
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

Request body to create a new export.

​
format
enum<string>
required
Available options:
csv
​
model
enum<string>
required
Available options:
users,
visits

Response

Successfully created export

​
id
string
required
Required string length: 36
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
format
enum<string>
required
Available options:
csv
​
model
enum<string>
required
Available options:
users,
visits
​
status
enum<string>
required
Available options:
completed,
failed,
pending
​
createdAt
string<date-time>
required
​
startedAt
string<date-time> | null
​
completedAt
string<date-time> | null
​
downloadUrl
string<url>
​
error
string

When defined, this is the error message and stack trace received when attempting to process the export.