Start a new offline transfer import

POST

/api/v4/offline_imports

• GitLab REST API

Initiates a new offline transfer import from object storage

Authorizations

• http
• oauth2

Request Body ^required

Media type application/json

object

bucket

required

Name of the object storage bucket where export data is stored

string

nullable

aws_s3_configuration

AWS S3 object storage configuration

object

aws_access_key_id

required

AWS S3 access key ID

string

nullable

aws_secret_access_key

required

AWS S3 secret access key

string

nullable

region

required

AWS S3 object storage region

string

nullable

path_style

Use path-style URLs instead of virtual-hosted-style URLs

boolean

nullable

s3_compatible_configuration

MinIO or other S3-compatible object storage configuration

object

aws_access_key_id

required

S3-compatible access key ID

string

nullable

aws_secret_access_key

required

S3-compatible secret access key

string

nullable

region

required

S3-compatible object storage region

string

nullable

endpoint

required

Object storage location endpoint

string

nullable

path_style

Use path-style URLs instead of virtual-hosted-style URLs

boolean

default: true nullable

gcs_configuration

Google Cloud Storage configuration using a service account JSON key

object

google_project

required

Google Cloud project ID

string

nullable

google_json_key_string

required

Google Cloud service account JSON key contents

string

nullable

gcs_hmac_configuration

Google Cloud Storage configuration using S3-interoperability HMAC keys

object

google_storage_access_key_id

required

GCS HMAC access key ID

string

nullable

google_storage_secret_access_key

required

GCS HMAC secret

string

nullable

region

required

GCS bucket region

string

nullable

path_style

Use path-style URLs instead of virtual-hosted-style URLs

boolean

default: true nullable

export_prefix

required

Prefix of the export within the bucket

string

nullable

entities

required

List of entities to import

Array<object>

nullable

object

source_type

required

Type of the entity to import

string

>= 1 characters

Allowed values: group_entity project_entity

source_full_path

required

Full path of the entity on the source instance

string

nullable

destination_namespace

required

Full path of the destination namespace

string

nullable

destination_slug

Destination slug for the imported entity

string

nullable

Responses

201

Created

Media type application/json

object

id

integer format: int64

status

string

source_type

string

source_url

string

created_at

string format: date-time

updated_at

string format: date-time

has_failures

boolean

Example

{
  "id": 1,
  "status": "finished",
  "source_type": "gitlab",
  "source_url": "https://source.gitlab.com/",
  "created_at": "2012-05-28T04:42:42-07:00",
  "updated_at": "2012-05-28T04:42:42-07:00",
  "has_failures": false
}

400

Bad request

401

Unauthorized

404

Not found

422

Unprocessable entity

429

Too many requests