Set global Git registry mandatory status

POST

/api/v1/global-registries/git/{id}/set-mandatory

const url = 'http://localhost:3000/api/v1/global-registries/git/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/set-mandatory';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/global-registries/git/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/set-mandatory \
  --header 'X-API-Key: <X-API-Key>'

Sets whether a global Git registry is mandatory for all tenants. Requires Super Admin privileges.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Git registry UUID

Responses

200

Git registry mandatory status updated successfully

application/json

object

required

Registry unique identifier

string format: uuid

name

required

Unique name for the registry

string

description

Description of the registry purpose

string

url

required

Git repository URL

string

branch

required

Branch to sync from

string

path

required

Subpath 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

lastSyncError

Error message from last sync attempt

string

lastSyncCommit

Last synced commit hash

string

hasWebhook

required

Whether webhook is configured

boolean

enabled

required

Whether the registry is enabled

boolean

mandatory

required

Whether this registry is mandatory for all tenants

boolean

priority

required

Priority in the combined registry list

number

createdAt

required

Creation timestamp

string format: date-time

updatedAt

required

Last update timestamp

string format: date-time

Example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "margo-official-workloads",
  "description": "Official Margo workload definitions",
  "url": "https://github.com/margo-org/workloads.git",
  "branch": "main",
  "path": "/workloads",
  "authType": "NONE",
  "hasCredentials": false,
  "syncIntervalMinutes": 60,
  "lastSyncError": "Authentication failed",
  "lastSyncCommit": "abc123def456",
  "hasWebhook": false,
  "enabled": true,
  "mandatory": false,
  "priority": 0
}

401

Unauthorized

403

Forbidden - Super Admin required

404

Git registry not found