Create a Geo site

POST

/api/v4/geo_sites

• GitLab REST API

Creates a Geo site.

Authorizations

• http
• oauth2

Request Body ^required

Media type application/json

object

primary

Specifying whether this site will be primary. Defaults to false.

boolean

nullable

enabled

Specifying whether this site will be enabled. Defaults to true.

boolean

nullable

name

required

The unique identifier for the Geo site. Must match geo_node_name if it is set in gitlab.rb, otherwise it must match external_url

string

nullable

url

required

The user-facing URL for the Geo site

string

nullable

internal_url

The URL defined on the primary site that secondary site should use to contact it. Returns url if not set.

string

nullable

files_max_capacity

Control the maximum concurrency of LFS/attachment backfill for this secondary site. Defaults to 10.

integer

nullable

repos_max_capacity

Control the maximum concurrency of repository backfill for this secondary site. Defaults to 25.

integer

nullable

verification_max_capacity

Control the maximum concurrency of repository verification for this site. Defaults to 100.

integer

nullable

container_repositories_max_capacity

Control the maximum concurrency of container repository sync for this site. Defaults to 10.

integer

nullable

sync_object_storage

Flag indicating if the secondary Geo site will replicate blobs in Object Storage. Defaults to false.

boolean

nullable

selective_sync_type

Limit syncing to only specific groups, or shards. Valid values: "namespaces", "shards", or null

string

nullable

selective_sync_shards

The repository storages whose projects should be synced, if selective_sync_type == shards

Array<string>

nullable

selective_sync_namespace_ids

The IDs of groups that should be synced, if selective_sync_type == namespaces

Array<integer>

nullable

selective_sync_organization_ids

The IDs of organizations that should be synced, if selective_sync_type == organizations

Array<integer>

nullable

minimum_reverification_interval

The interval (in days) in which the repository verification is valid. Once expired, it will be reverified. This has no effect when set on a secondary site.

integer

nullable

blob_download_timeout

Maximum time (in seconds) for blob downloads during Geo sync. Defaults to 28800 (8 hours). Maximum is 86400 (24 hours).

integer

nullable

Example ^generated

{
  "primary": true,
  "enabled": true,
  "name": "example",
  "url": "example",
  "internal_url": "example",
  "files_max_capacity": 1,
  "repos_max_capacity": 1,
  "verification_max_capacity": 1,
  "container_repositories_max_capacity": 1,
  "sync_object_storage": true,
  "selective_sync_type": "example",
  "selective_sync_shards": [
    "example"
  ],
  "selective_sync_namespace_ids": [
    1
  ],
  "selective_sync_organization_ids": [
    1
  ],
  "minimum_reverification_interval": 1,
  "blob_download_timeout": 1
}

Responses

200

OK

Media type application/json

object

id

integer format: int64

name

string

url

string

internal_url

string

primary

boolean

enabled

boolean

current

boolean

files_max_capacity

integer

repos_max_capacity

integer

verification_max_capacity

integer

container_repositories_max_capacity

integer

selective_sync_type

string

selective_sync_shards

array

selective_sync_namespace_ids

array

selective_sync_organization_ids

array

minimum_reverification_interval

integer

blob_download_timeout

integer

sync_object_storage

boolean

web_edit_url

string

web_geo_replication_details_url

string

_links

object

Example ^generated

{
  "id": 1,
  "name": "example",
  "url": "example",
  "internal_url": "example",
  "primary": true,
  "enabled": true,
  "current": true,
  "files_max_capacity": 1,
  "repos_max_capacity": 1,
  "verification_max_capacity": 1,
  "container_repositories_max_capacity": 1,
  "selective_sync_type": "example",
  "selective_sync_shards": [
    "example"
  ],
  "selective_sync_namespace_ids": [
    "example"
  ],
  "selective_sync_organization_ids": [
    "example"
  ],
  "minimum_reverification_interval": 1,
  "blob_download_timeout": 1,
  "sync_object_storage": true,
  "web_edit_url": "example",
  "web_geo_replication_details_url": "example",
  "_links": {}
}

400

Validation error

401

401 Unauthorized

403

403 Forbidden