List Git registries

GET

/api/v1/registries/git

const url = 'http://localhost:3000/api/v1/registries/git?name=workloads&enabled=true&authType=NONE&search=github&limit=20&offset=0&cursor=550e8400-e29b-41d4-a716-446655440000';
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?name=workloads&enabled=true&authType=NONE&search=github&limit=20&offset=0&cursor=550e8400-e29b-41d4-a716-446655440000' \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a list of Git registries for the current organization.

Authorizations

api-key
bearer

Parameters

Query Parameters

name

string

Example

workloads

Filter by registry name (partial match)

enabled

boolean

Example

true

Filter by enabled status

authType

string

Allowed values: NONE HTTPS_TOKEN SSH_KEY

Example

TOKEN

Filter by authentication type

search

string

Example

github

Search across name and URL

limit

number

default: 20 >= 1 <= 100

Example

Maximum number of items to return

offset

number

Example

Number of items to skip

cursor

string

Example

550e8400-e29b-41d4-a716-446655440000

Cursor for pagination (registry ID)

Responses

200

Git registries retrieved successfully

application/json

object

items

required

List of Git registries

Array<object>

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

total

required

Total number of registries matching the query

number

limit

required

Number of items returned

number

offset

required

Number of items skipped

number

hasMore

required

Whether there are more items

boolean

nextCursor

Cursor for fetching next page

string

Example

{
  "items": [
    {
      "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"
    }
  ],
  "total": 10,
  "limit": 20,
  "offset": 0,
  "hasMore": false,
  "nextCursor": "550e8400-e29b-41d4-a716-446655440000"
}

401

Unauthorized

403

Forbidden