Update Repository Settings

This page includes two endpoints:

• Update remote repository settings
• Update virtual repository settings

Updating local repositories is not available. Repository names are immutable and cannot be updated.

Update Remote Repository Settings

PATCH https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/<repository-ref>/remote

Update settings for a remote repository. At least one field must be provided.

Allowed Roles: Workspace Admin or System Admin • Authentication Required

Path Parameters

workspace-refstringRequired

Workspace ID or name.

repository-refstringRequired

Repository ID or name (must be a remote repository).

Body

remoteRepositoryUrlstringOptional

Remote repository URL (must include protocol, for example https://...).

remoteRepositoryUsernamestring | nullOptional

Remote repository username, use null to clear.

remoteRepositoryPasswordstring | nullOptional

Remote repository password, use null to clear.

isRemoteCacheEnabledbooleanOptional

Enable or disable remote cache.

fileCacheTimeTillRevalidationnumber | nullOptional

File cache revalidation time (integer >= 0), use null to clear.

metadataCacheTimeTillRevalidationnumber | nullOptional

Metadata cache revalidation time (integer >= 0), use null to clear.

Request

Command Line

curl -sS -X PATCH "https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/<repository-ref>/remote" \
  -H "Authorization: Bearer <accessToken>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "remoteRepositoryUrl": "https://example.com/repository",
    "remoteRepositoryUsername": "username",
    "remoteRepositoryPassword": "password",
    "isRemoteCacheEnabled": true,
    "fileCacheTimeTillRevalidation": 3600000,
    "metadataCacheTimeTillRevalidation": 3600000
  }'

Response

{
  "id": "15f3c26d-fc44-4c6a-a2f7-1d27b04e799d",
  "name": "remote-repo",
  "packageType": "npm",
  "repositoryType": "remote",
  "status": "ACTIVE",
  "workspaceId": "0a8e6f52-3c44-4c9b-b0c5-9f2d7a1e6b3a",
  "uploadTargetLocalRepository": null,
  "childRepositories": null,
  "remoteRepositoryUrl": "https://example.com/repository",
  "isRemoteCacheEnabled": true,
  "fileCacheTimeTillRevalidation": 3600000,
  "metadataCacheTimeTillRevalidation": 3600000
}

Update Virtual Repository Settings

PATCH https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/<repository-ref>/virtual

Update settings for a virtual repository. At least one field must be provided.

If you set uploadLocalRepositoryId, it must:

• be included in childRepositoryIds
• point to a local repository

Allowed Roles: Workspace Admin or System Admin • Authentication Required

Path Parameters

workspace-refstringRequired

Workspace ID or name.

repository-refstringRequired

Repository ID or name (must be a virtual repository).

Body

childRepositoryIdsstring[]Optional

Child repository IDs (UUIDs). Order is preserved. Must contain at least one ID.

uploadLocalRepositoryIdstring | nullOptional

Local repository ID (UUID) used as the upload target, use null to clear.

Request

Command Line

curl -sS -X PATCH "https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/<repository-ref>/virtual" \
  -H "Authorization: Bearer <accessToken>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "childRepositoryIds": [
      "11111111-1111-1111-1111-111111111111",
      "22222222-2222-2222-2222-222222222222"
    ],
    "uploadLocalRepositoryId": "11111111-1111-1111-1111-111111111111"
  }'

Response

{
  "id": "15f3c26d-fc44-4c6a-a2f7-1d27b04e799d",
  "name": "virtual-repo",
  "packageType": "npm",
  "repositoryType": "virtual",
  "status": "ACTIVE",
  "workspaceId": "0a8e6f52-3c44-4c9b-b0c5-9f2d7a1e6b3a",
  "uploadTargetLocalRepository": {
    "id": "11111111-1111-1111-1111-111111111111",
    "name": "local-repo"
  },
  "childRepositories": [
    { "id": "11111111-1111-1111-1111-111111111111", "name": "local-repo", "repositoryType": "local" },
    { "id": "22222222-2222-2222-2222-222222222222", "name": "remote-repo", "repositoryType": "remote" }
  ],
  "remoteRepositoryUrl": null,
  "isRemoteCacheEnabled": null,
  "fileCacheTimeTillRevalidation": null,
  "metadataCacheTimeTillRevalidation": null
}