Create Repository

Creating a repository is split into three APIs: local, remote, and virtual.

Allowed Roles: Workspace Admin or System Admin • Authentication Required

Path Parameters

workspace-refstringRequired

Workspace ID or name.

Local Repository

POST https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/local

Create a repository that stores packages locally.

Body

namestringRequired

Repository name (2-30 chars, lowercase letters, numbers, -).

packageTypestringRequired

Package type stored by the repository. One of: cargo, composer, debian, docker, gems, go, helm, maven, npm, nuget, pypi, rpm, universal.

Request

Command Line

curl -sS -X POST "https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/local" \
  -H "Authorization: Bearer <accessToken>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "my-local-repo",
  "packageType": "npm"
}'

Response

{
  "id": "15f3c26d-fc44-4c6a-a2f7-1d27b04e799d",
  "name": "my-local-repo",
  "packageType": "npm",
  "status": "ACTIVE",
  "workspaceId": "0a8e6f52-3c44-4c9b-b0c5-9f2d7a1e6b3a"
}

Remote Repository

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

Proxy a remote repository and optionally enable caching.

Body

namestringRequired

Repository name (2-30 chars, only English letters, numbers, -).

packageTypestringRequired

Package type stored by the repository. One of: cargo, composer, debian, docker, gems, go, helm, maven, npm, nuget, pypi, rpm, universal.

remoteRepositoryUrlstringRequired

URL of the remote repository.

remoteRepositoryUsernamestringOptional

Username for the remote repository.

remoteRepositoryPasswordstringOptional

Password for the remote repository.

isRemoteCacheEnabledbooleanRequired

Whether caching is enabled.

fileCacheTimeTillRevalidationnumber | nullOptional

Milliseconds before cached files require revalidation (null for indefinite caching).

metadataCacheTimeTillRevalidationnumber | nullOptional

Milliseconds before cached metadata requires revalidation (null for indefinite caching).

Request

curl -sS -X POST "https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/remote" \
  -H "Authorization: Bearer <accessToken>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-remote-repo",
    "packageType": "npm",
    "remoteRepositoryUrl": "https://registry.npmjs.org",
    "isRemoteCacheEnabled": false
  }'

Response

{
  "id": "4d1f6b69-7ea5-4c22-8b80-fd481e0c9b57",
  "name": "my-remote-repo",
  "packageType": "npm",
  "status": "ACTIVE",
  "workspaceId": "0a8e6f52-3c44-4c9b-b0c5-9f2d7a1e6b3a",
  "remoteRepositoryUrl": "https://registry.npmjs.org",
  "isRemoteCacheEnabled": true,
  "fileCacheTimeTillRevalidation": 345600000,
  "metadataCacheTimeTillRevalidation": 86400000
}

Virtual Repository

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

Combine multiple repositories under one virtual repository and optionally set an upload target.

Body

namestringRequired

Repository name (2-30 chars, only English letters, numbers, -).

packageTypestringRequired

Package type stored by the repository. One of: cargo, composer, debian, docker, gems, go, helm, maven, npm, nuget, pypi, rpm, universal.

childRepositoryIdsstring[]Required

IDs of repositories included in the virtual repository.

uploadLocalRepositoryIdstringOptional

ID of a local repository where uploads will be stored (must also be in childRepositoryIds).

Request

curl -sS -X POST "https://api.repoflow.io/1/workspaces/<workspace-ref>/repositories/virtual" \
  -H "Authorization: Bearer <accessToken>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-virtual-repo",
    "packageType": "npm",
    "childRepositoryIds": ["<repo-id-1>", "<repo-id-2>"]
  }'

Response

{
  "id": "b2f0a2f3-0a7b-4f32-8df0-68c4e2b6c8b8",
  "name": "my-virtual-repo",
  "packageType": "npm",
  "status": "ACTIVE",
  "workspaceId": "0a8e6f52-3c44-4c9b-b0c5-9f2d7a1e6b3a",
  "uploadTargetLocalRepository": {
    "id": "repo-id-1",
    "name": "npm-local"
  },
  "childRepositories": [
    {
      "id": "repo-id-1",
      "name": "npm-local",
      "repositoryType": "local"
    },
    {
      "id": "repo-id-2",
      "name": "npm-remote",
      "repositoryType": "remote"
    }
  ]
}