Skip to content

Rotate a GitLab connector token

POST
/api/integrations/gitlab/connectors/{id}/token
curl --request POST \
--url https://gateway.example.com/api/integrations/gitlab/connectors/550e8400-e29b-41d4-a716-446655440000/token \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "token": "example" }'

Replaces the encrypted PAT. The raw token is accepted only in this request and is never returned.

id
required
string
>= 1 characters
Example
550e8400-e29b-41d4-a716-446655440000

JSON request body

Media typeapplication/json
object
token
required
string
>= 1 characters <= 4096 characters
Examplegenerated
{
"token": "example"
}

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
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"
}
}

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"
}
]
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}