Get Git registry by ID

GET

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

const url = 'http://localhost:3000/api/v1/registries/git/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', 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 GET \
  --url http://localhost:3000/api/v1/registries/git/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a Git registry by its unique identifier.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Git registry UUID

Responses

200

Git registry retrieved successfully

application/json

object

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

hasWebhook

required

Whether a webhook is configured

boolean

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",
  "hasWebhook": false,
  "enabled": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

401

Unauthorized

403

Forbidden

404

Git registry not found