---
title: "import data from object store"
method: POST
path: "/repositories/{repository}/branches/{branch}/import"
tags: ["import"]
---

# import data from object store

`POST /repositories/{repository}/branches/{branch}/import`

## Request

- Base URL: `/api/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/repositories/{repository}/branches/{branch}/import`
- Auth: one of:
  - HTTP bearer
  - HTTP basic
  - API key in cookie `internal_auth_session`

## Request body

- ImportCreation
  - `paths` ImportLocation[], required
    - `type` 'common_prefix' | 'object', required: Path type, can either be 'common_prefix' or 'object'
    - `path` string, required: A source location to a 'common_prefix' or to a single object. Must match the lakeFS installation blockstore type.
    - `destination` string, required: Destination for the imported objects on the branch. Must be a relative path to the branch. If the type is an 'object', the destination is the exact object name under the branch. If the type is a 'common_prefix', the destination is the prefix under the branch.
  - `commit` CommitCreation, required
    - `message` string, required
    - `metadata` object
    - `date` integer: set date to override creation date in the commit (Unix Epoch in seconds)
    - `allow_empty` boolean: sets whether a commit can contain no changes
    - `force` boolean
  - `force` boolean

## Response `202`

Import started

- ImportCreationResponse
  - `id` string, required: The id of the import process

## Other responses

- `400`: Validation Error
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Resource Not Found
- `429`: too many requests
- `default`: Internal Server Error

## Changes

- **2025-07-29** `27799ffec9a5`: 2 info
  - added the non-success response with the status `429`
  - removed the non-success response with the status `420`
- **2024-09-17** `3b10653a8013`: 2 info
  - added the non-success response with the status `420`
  - removed the non-success response with the status `429`

[Operation history](https://skmtc.dev/treeverse/apis/lakefs-api/changes/repositories/:repository/branches/:branch/import/post.md)

---

[API](https://skmtc.dev/treeverse/apis/lakefs-api.md) - [All operations](https://skmtc.dev/treeverse/apis/lakefs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/treeverse/apis/lakefs-api/revisions/10a3acbbb1fd?raw)