Update Git registry

PATCH

/api/v1/registries/git/{id}

curl --request PATCH \
  --url http://localhost:3000/api/v1/registries/git/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "my-workloads-repo", "url": "https://github.com/org/workloads.git", "branch": "main", "path": "/workloads", "authType": "NONE", "credential": "ghp_xxxxxxxxxxxxxxxxxxxx", "syncIntervalMinutes": 60, "enabled": true }'

• Development
• Production

Updates an existing Git registry.

Authorizations

• api-key
• bearer

Parameters

Path Parameters

id

required

string format: uuid

Git registry UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Request Body^required

Media typeapplication/json

object

name

Unique name for the registry within the organization

string

>= 2 characters <= 100 characters

Example

my-workloads-repo

url

Git repository URL

string

Example

https://github.com/org/workloads.git

branch

Branch to use

string

Example

main

path

Path within the repository to scan for workloads

string

Example

/workloads

authType

Authentication type

string

Allowed values: NONE HTTPS_TOKEN SSH_KEY

Example

TOKEN

credential

Credential (token or SSH key) for authentication. Set to null to remove.

string

nullable

Example

ghp_xxxxxxxxxxxxxxxxxxxx

syncIntervalMinutes

Sync interval in minutes

number

>= 1 <= 1440

Example

60

enabled

Whether the registry is enabled

boolean

Example

true

Responses

200

Git registry updated successfully

Media typeapplication/json

object

id

required

Unique identifier

string

organizationId

required

Organization ID that owns this registry

string

name

required

Registry name

string

url

required

Git repository URL

string

branch

required

Branch to use

string

path

required

Path within the repository to scan

string

authType

required

Authentication type

string

Allowed values: NONE HTTPS_TOKEN SSH_KEY

hasCredentials

required

Whether credentials are configured

boolean

syncIntervalMinutes

required

Sync interval in minutes

number

lastSyncAt

Last successful sync timestamp

string format: date-time

nullable

lastSyncError

Last sync error message

string

nullable

lastSyncCommit

Last synced commit SHA

string

nullable

enabled

required

Whether the registry is enabled

boolean

createdAt

required

Creation timestamp

string format: date-time

updatedAt

required

Last update timestamp

string format: date-time

Example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440001",
  "name": "my-workloads-repo",
  "url": "https://github.com/org/workloads.git",
  "branch": "main",
  "path": "/workloads",
  "authType": "NONE",
  "hasCredentials": false,
  "syncIntervalMinutes": 60,
  "lastSyncAt": "2024-01-15T10:30:00Z",
  "lastSyncError": "Authentication failed",
  "lastSyncCommit": "abc123def456",
  "enabled": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

400

Invalid input data

401

Unauthorized

403

Forbidden

404

Git registry not found

409

Registry with this name already exists