Update a GitLab connector

PATCH

/api/integrations/gitlab/connectors/{id}

curl --request PATCH \
  --url https://gateway.example.com/api/integrations/gitlab/connectors/550e8400-e29b-41d4-a716-446655440000 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "baseUrl": "https://example.com", "enabled": true, "token": "example", "allowlistMode": "selected", "settings": { "autoSyncEnabled": true, "autoSyncIntervalSeconds": 900, "cloneShallow": true, "cloneDepth": 1, "cloneLfs": false, "cloneSubmodules": false, "cloneMaxSizeMb": 1024, "cloneTimeoutSeconds": 300 }, "allowlistEntries": [ { "entryType": "group", "remoteId": "example", "fullPath": "example", "name": "example", "webUrl": "https://example.com" } ] }'

• Your Gateway instance

Updates connector metadata, allowlist, database-backed runtime settings, and optionally replaces the PAT.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body^required

JSON request body

Media typeapplication/json

object

name

string

>= 1 characters <= 255 characters

baseUrl

string format: uri

<= 2048 characters

enabled

boolean

token

string

>= 1 characters <= 4096 characters

allowlistMode

string

Allowed values: selected all_visible

settings

object

autoSyncEnabled

boolean

default: true

autoSyncIntervalSeconds

integer

default: 900 >= 300 <= 86400

cloneShallow

boolean

default: true

cloneDepth

integer

default: 1 >= 1 <= 100

cloneLfs

boolean

cloneSubmodules

boolean

cloneMaxSizeMb

integer

default: 1024 >= 1 <= 102400

cloneTimeoutSeconds

integer

default: 300 >= 10 <= 3600

allowlistEntries

Array<object>

<= 1000 items

object

entryType

required

string

Allowed values: group project

remoteId

required

string

>= 1 characters <= 128 characters

fullPath

required

string

>= 1 characters <= 2048 characters

name

string

>= 1 characters <= 1024 characters

webUrl

string | null format: uri

<= 2048 characters

Responses

200

Successful response

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

provider

required

string

Allowed values: gitlab

name

required

string

baseUrl

required

string

enabled

required

boolean

allowlistMode

required

string

Allowed values: selected all_visible

settings

required

object

autoSyncEnabled

required

boolean

autoSyncIntervalSeconds

required

number

cloneShallow

required

boolean

cloneDepth

required

number

cloneLfs

required

boolean

cloneSubmodules

required

boolean

cloneMaxSizeMb

required

number

cloneTimeoutSeconds

required

number

capabilities

required

object

key

additional properties

boolean

syncStatus

required

string

Allowed values: never idle running success error

syncLastError

string | null

syncFailureCount

required

number

syncStartedAt

string | null

syncFinishedAt

string | null

syncLastOverlapAt

string | null

syncNextRetryAt

string | null

testedAt

string | null

createdAt

required

string

updatedAt

required

string

hasToken

required

boolean

tokenMasked

required

string | null

allowlistEntries

required

Array<object>

object

entryType

required

string

Allowed values: group project

remoteId

required

string

fullPath

required

string

name

string | null

webUrl

string | null

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}