> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/api/api-ja/bakkuappukaibu-api/export.md).

# Export

## Get backups available for export

> Returns terminal backups and archives that can be selected as an export source. Backups that are still in progress are excluded.

```json
{"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.8.7"},"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer <access_token>"}},"schemas":{"PaginatedDto":{"type":"object","properties":{"total":{"type":"number","description":"Total number of entities."},"items":{"type":"array","items":{"type":"string"}}},"required":["total","items"]},"FindBackupsResponseDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string","description":"Backup or archive name."},"jobId":{"type":"number"},"jobStatus":{"type":"string","enum":["In Progress","Exception","Completed","Aborted"]},"startedDate":{"format":"date-time","type":"string"},"duration":{"type":"string","nullable":true},"size":{"type":"number"},"records":{"type":"number"},"operationType":{"type":"string","enum":["Templated Archive","Templated Backup","Composite Backup","Composite & Sync Backup","Import Archive","Import Backup"]}},"required":["id","name","jobId","jobStatus","startedDate","duration","size","records","operationType"]},"ValidationExceptionDto":{"type":"object","properties":{"error":{"type":"string","nullable":true},"message":{"type":"array","items":{"type":"string"}},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["error","message","statusCode"]}}},"paths":{"/api/v1/connections/{connectionId}/exports/backups":{"get":{"description":"Returns terminal backups and archives that can be selected as an export source. Backups that are still in progress are excluded.","operationId":"ExportsController_findBackups_v1","parameters":[{"name":"connectionId","required":true,"in":"path","schema":{"type":"number"}},{"name":"search","required":false,"in":"query","description":"Search term (max 80)","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","description":"Number of page (min 1)","schema":{"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Limit of entities per page (min 1, max 2000)","schema":{"type":"number"}},{"name":"types","required":true,"in":"query","schema":{"type":"array","items":{"type":"string","enum":["full","full & sync","template","archive"]}}},{"name":"sortBy","required":false,"in":"query","schema":{"type":"string","enum":["jobId","name","startedDate"]}},{"name":"order","required":false,"in":"query","schema":{"type":"string","enum":["ASC","DESC"]}}],"responses":{"200":{"description":"Backups available as export sources","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FindBackupsResponseDto"}}}}]}}}},"400":{"description":"Invalid pagination, sorting, or search parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationExceptionDto"}}}}},"summary":"Get backups available for export","tags":["Export"]}}}}
```

## Get objects available for export from selected backup

> Returns the objects and record totals stored in the selected backup. Use an object name from this response as steps\[].objectApiName when creating an export.

```json
{"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.8.7"},"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer <access_token>"}},"schemas":{"FindObjectsResponseDto":{"type":"object","properties":{"totalData":{"allOf":[{"$ref":"#/components/schemas/FindObjectResponseDto"}]},"total":{"type":"number","description":"Total number of entities."},"items":{"type":"array","items":{"$ref":"#/components/schemas/FindObjectResponseDto"}}},"required":["totalData","total","items"]},"FindObjectResponseDto":{"type":"object","properties":{"name":{"type":"string"},"totalRecords":{"type":"number"},"addedRecordVersions":{"type":"number"},"changedRecordVersions":{"type":"number"},"deletedRecordVersions":{"type":"number"},"size":{"type":"number"}},"required":["name","totalRecords","addedRecordVersions","changedRecordVersions","deletedRecordVersions","size"]},"ValidationExceptionDto":{"type":"object","properties":{"error":{"type":"string","nullable":true},"message":{"type":"array","items":{"type":"string"}},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["error","message","statusCode"]},"NotFoundExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["message","error","statusCode"]},"ConflictExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["message","error","statusCode"]}}},"paths":{"/api/v1/connections/{connectionId}/exports/backups/{backupId}/objects":{"get":{"description":"Returns the objects and record totals stored in the selected backup. Use an object name from this response as steps[].objectApiName when creating an export.","operationId":"ExportsController_findBackupObjects_v1","parameters":[{"name":"connectionId","required":true,"in":"path","schema":{"type":"number"}},{"name":"backupId","required":true,"in":"path","description":"Backup or archive identifier","schema":{"type":"number"}},{"name":"search","required":false,"in":"query","description":"Search term (max 80)","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","description":"Number of page (min 1)","schema":{"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Limit of entities per page (min 1, max 2000)","schema":{"type":"number"}},{"name":"sortBy","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string","enum":["ASC","DESC"]}},{"name":"aiModifiedOnly","required":false,"in":"query","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"Objects available in the selected backup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindObjectsResponseDto"}}}},"400":{"description":"Invalid backup ID, pagination, sorting, or filtering parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationExceptionDto"}}}},"404":{"description":"Backup not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionDto"}}}},"409":{"description":"Backup is still in progress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictExceptionDto"}}}}},"summary":"Get objects available for export from selected backup","tags":["Export"]}}}}
```

## Create export from selected backup

> Starts an asynchronous export for one or more objects from the selected backup and returns the job ID used to retrieve its status. For destination csv, the result is stored internally and can be downloaded when readyForDownload becomes true. For destination external-storage, storageId and path are required and the result is written directly to that storage. An object with no stored records can complete without generating a downloadable file. Object processing failures are reported asynchronously through the export status and public job logs.

```json
{"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.8.7"},"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer <access_token>"}},"schemas":{"CreateBackupExportBodyDto":{"type":"object","properties":{"steps":{"type":"array","items":{"$ref":"#/components/schemas/ExportStepDto"}},"destination":{"type":"string","enum":["csv","external-storage"],"description":"Export destination: csv stores the result internally for later download; external-storage writes it to a configured storage."},"path":{"type":"string","description":"Path prefix in the configured storage. Required for external-storage and not allowed for csv."},"storageId":{"type":"number","description":"Configured storage identifier. Required for external-storage and not allowed for csv."}},"required":["steps","destination"]},"ExportStepDto":{"type":"object","properties":{"objectApiName":{"type":"string","description":"Name of the object."},"declarativeFilter":{"type":"array","items":{"$ref":"#/components/schemas/ExportDeclarativeFilterLineDto"}},"declarativeFilterCustomLogic":{"type":"string"}},"required":["objectApiName","declarativeFilter"]},"ExportDeclarativeFilterLineDto":{"type":"object","properties":{"value":{"type":"string"},"field":{"type":"string","enum":["Name","Id"]},"option":{"type":"string","enum":["equals","in"]}},"required":["value","field","option"]},"CreateExportResponseDto":{"type":"object","properties":{"message":{"type":"string"},"jobId":{"type":"number","description":"Identifier used to retrieve the export status."}},"required":["message","jobId"]},"ValidationExceptionDto":{"type":"object","properties":{"error":{"type":"string","nullable":true},"message":{"type":"array","items":{"type":"string"}},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["error","message","statusCode"]},"NotFoundExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["message","error","statusCode"]},"ConflictExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["message","error","statusCode"]},"ExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["message","error","statusCode"]}}},"paths":{"/api/v1/connections/{connectionId}/exports/backups/{backupId}":{"post":{"description":"Starts an asynchronous export for one or more objects from the selected backup and returns the job ID used to retrieve its status. For destination csv, the result is stored internally and can be downloaded when readyForDownload becomes true. For destination external-storage, storageId and path are required and the result is written directly to that storage. An object with no stored records can complete without generating a downloadable file. Object processing failures are reported asynchronously through the export status and public job logs.","operationId":"ExportsController_createFromBackup_v1","parameters":[{"name":"connectionId","required":true,"in":"path","schema":{"type":"number"}},{"name":"backupId","required":true,"in":"path","description":"Backup or archive identifier","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBackupExportBodyDto"}}}},"responses":{"201":{"description":"Export job created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExportResponseDto"}}}},"400":{"description":"Invalid request or destination configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationExceptionDto"}}}},"404":{"description":"Backup or configured external storage not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionDto"}}}},"409":{"description":"Backup is still in progress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictExceptionDto"}}}},"429":{"description":"Monthly export limit reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionDto"}}}}},"summary":"Create export from selected backup","tags":["Export"]}}}}
```

## Get available storages for export

> Returns configured external storages. Pass the selected storage ID when destination is external-storage.

```json
{"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.8.7"},"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer <access_token>"}},"schemas":{"PaginatedDto":{"type":"object","properties":{"total":{"type":"number","description":"Total number of entities."},"items":{"type":"array","items":{"type":"string"}}},"required":["total","items"]},"FindStorageResponseDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"type":{"type":"string","enum":["Local","AWS_S3","AZURE_BLOB","GOOGLE_CLOUD_STORAGE"]}},"required":["id","name","type"]},"ValidationExceptionDto":{"type":"object","properties":{"error":{"type":"string","nullable":true},"message":{"type":"array","items":{"type":"string"}},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["error","message","statusCode"]}}},"paths":{"/api/v1/connections/{connectionId}/exports/storages":{"get":{"description":"Returns configured external storages. Pass the selected storage ID when destination is external-storage.","operationId":"ExportsController_findStorages_v1","parameters":[{"name":"connectionId","required":true,"in":"path","schema":{"type":"number"}},{"name":"search","required":false,"in":"query","description":"Search term (max 80)","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","description":"Number of page (min 1)","schema":{"type":"number"}},{"name":"limit","required":true,"in":"query","description":"Limit of entities per page (min 1, max 2000)","schema":{"type":"number"}},{"name":"orderBy","required":false,"in":"query","description":"Column to sort by","schema":{"default":"id","type":"string","enum":["id","name","type"]}},{"name":"sort","required":false,"in":"query","description":"Sort direction","schema":{"default":"DESC","type":"string","enum":["ASC","DESC"]}},{"name":"isDefault","required":false,"in":"query","description":"Filter by default storage flag. If true, returns only backup default storages. If false, returns only non-default.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Configured external storages","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/FindStorageResponseDto"}}}}]}}}},"400":{"description":"Invalid pagination, sorting, or filtering parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationExceptionDto"}}}}},"summary":"Get available storages for export","tags":["Export"]}}}}
```

## Get export status by job ID

> Returns the current export status and destination. Poll while jobStatus is In Progress. For an internal csv export, download the result when readyForDownload is true. External-storage exports are never available through the internal download endpoint. For Exception or Aborted jobs, use the public job log endpoints to retrieve failure details.

```json
{"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.8.7"},"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer <access_token>"}},"schemas":{"FindOneExportJobResponseDto":{"type":"object","properties":{"jobId":{"type":"number"},"operation":{"type":"string"},"exportType":{"type":"string"},"asOfDate":{"format":"date-time","type":"string","nullable":true},"fromDate":{"format":"date-time","type":"string","nullable":true},"toDate":{"format":"date-time","type":"string","nullable":true},"backupId":{"type":"number","nullable":true},"jobStatus":{"type":"string","enum":["In Progress","Exception","Completed","Aborted"]},"startedDate":{"format":"date-time","type":"string"},"duration":{"type":"string","nullable":true},"readyForDownload":{"type":"boolean","default":false,"description":"True only when an internally stored export has completed and contains downloadable data."},"recordsSuccessCount":{"type":"number","nullable":true},"endDate":{"format":"date-time","type":"string","nullable":true},"path":{"type":"string","nullable":true,"description":"Configured path for external-storage exports; null for internal exports."},"destination":{"type":"string","enum":["csv","external-storage"],"description":"csv is internal storage; external-storage writes to a configured storage."}},"required":["jobId","operation","exportType","asOfDate","fromDate","toDate","backupId","jobStatus","startedDate","duration","readyForDownload","recordsSuccessCount","endDate","path","destination"]},"ValidationExceptionDto":{"type":"object","properties":{"error":{"type":"string","nullable":true},"message":{"type":"array","items":{"type":"string"}},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["error","message","statusCode"]},"NotFoundExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["message","error","statusCode"]}}},"paths":{"/api/v1/connections/{connectionId}/exports/{jobId}":{"get":{"description":"Returns the current export status and destination. Poll while jobStatus is In Progress. For an internal csv export, download the result when readyForDownload is true. External-storage exports are never available through the internal download endpoint. For Exception or Aborted jobs, use the public job log endpoints to retrieve failure details.","operationId":"ExportsController_findOne_v1","parameters":[{"name":"connectionId","required":true,"in":"path","schema":{"type":"number"}},{"name":"jobId","required":true,"in":"path","description":"Export job identifier","schema":{"type":"number"}}],"responses":{"200":{"description":"Export status and download readiness","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindOneExportJobResponseDto"}}}},"400":{"description":"Invalid job ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationExceptionDto"}}}},"404":{"description":"Export not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionDto"}}}}},"summary":"Get export status by job ID","tags":["Export"]}}}}
```

## Download an internally stored export

> Downloads the generated ZIP for a csv export when its status response has readyForDownload set to true. External-storage exports cannot be downloaded through this endpoint.

```json
{"openapi":"3.0.0","info":{"title":"Flosum Backup API Service","version":"4.8.7"},"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer <access_token>"}},"schemas":{"ValidationExceptionDto":{"type":"object","properties":{"error":{"type":"string","nullable":true},"message":{"type":"array","items":{"type":"string"}},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["error","message","statusCode"]},"ExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["message","error","statusCode"]},"NotFoundExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"error":{"type":"string","nullable":true},"statusCode":{"type":"number","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,210,300,301,302,303,304,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,421,422,423,424,428,429,456,500,501,502,503,504,505,507,508]}},"required":["message","error","statusCode"]}}},"paths":{"/api/v1/connections/{connectionId}/exports/{jobId}/download":{"get":{"description":"Downloads the generated ZIP for a csv export when its status response has readyForDownload set to true. External-storage exports cannot be downloaded through this endpoint.","operationId":"ExportsController_download_v1","parameters":[{"name":"connectionId","required":true,"in":"path","schema":{"type":"number"}},{"name":"jobId","required":true,"in":"path","description":"Export job identifier","schema":{"type":"number"}}],"responses":{"200":{"description":"ZIP archive containing the exported CSV files","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid job ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationExceptionDto"}}}},"403":{"description":"Export is not ready, has failed, was cleared, contains no downloadable data, or uses external storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionDto"}}}},"404":{"description":"Export not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundExceptionDto"}}}}},"summary":"Download an internally stored export","tags":["Export"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flosum.com/api/api-ja/bakkuappukaibu-api/export.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
