import

import data from object store

Changed on
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
    • HTTP bearer
    • or HTTP basic
    • or API key in cookie internal_auth_session

Request body

forceboolean

Example request

{
  "commit": {
    "message": "Importing collections from S3"
  },
  "paths": [
    {
      "path": "s3://my-bucket/production/collections/",
      "destination": "collections/",
      "type": "common_prefix"
    },
    {
      "path": "s3://my-bucket/production/collections/file1",
      "destination": "collections/file1",
      "type": "object"
    }
  ]
}

Response

Import started

idstring required

The id of the import process

Changes

  • 27799ffec9a5Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

  • 3b10653a8013Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status