Start a new offline transfer export

POST

/api/v4/offline_exports

• GitLab REST API

Initiates a new offline transfer export

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

entities

required

List of entities to export

Array<object>

nullable

object

full_path

required

Relative path of the entity to export

string

nullable

Example

'source/full/path' not 'https://example.com/source/full/path'

Responses

201

Created

400

Bad Request