Get repository policy

GET

/api/v1/system/repository-policy

const url = 'http://localhost:3000/api/v1/system/repository-policy';
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/system/repository-policy \
  --header 'X-API-Key: <X-API-Key>'

Retrieves the current repository policy configuration. Requires Super Admin privileges.

Authorizations

api-key
bearer

Responses

200

Repository policy retrieved successfully

application/json

object

required

Unique identifier of the policy

string format: uuid

allowTenantOverride

required

Allow tenants to override non-mandatory global repositories

boolean

allowTenantOnlyRepos

required

Allow tenants to create their own repositories

boolean

requireGlobalRepos

required

Global repositories are required and visible to all tenants

boolean

credentialRotationDays

required

Recommended credential rotation period in days

number

>= 1

syncIntervalMinMinutes

required

Minimum sync interval allowed in minutes

number

>= 1

syncIntervalMaxMinutes

required

Maximum sync interval allowed in minutes

number

>= 1

createdAt

required

Timestamp when the policy was created

string format: date-time

updatedAt

required

Timestamp when the policy was last updated

string format: date-time

Example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "allowTenantOverride": true,
  "allowTenantOnlyRepos": true,
  "requireGlobalRepos": false,
  "credentialRotationDays": 90,
  "syncIntervalMinMinutes": 15,
  "syncIntervalMaxMinutes": 1440,
  "createdAt": "2024-01-15T12:00:00.000Z",
  "updatedAt": "2024-01-15T12:00:00.000Z"
}

401

Unauthorized

403

Forbidden - requires Super Admin privileges

404

Repository policy not configured