Skip to content

Registry Repositories

Functionality is available in Enterprise and Atlas versions.


Description of the registry repositories functionality is available here.

Description of JSON Object Structures

Registry Repository
Field Type Description
title String Registry repository name
repositoryType String Registry repository type. Possible values: LOCAL, PROXY, LOCAL_CACHE, VIRTUAL, TRASH_CAN
repositoryUuid String Registry repository UUID
packageType String Registry repository package type. Possible values: generic, maven, npm, pypi, nuget, composer, opm, debian, container, helm, cran, rpm, rubygem, cargo, conda, conan, go
description String Registry repository description

Package
Field Type Description
id String Package UUID
name String Package name
version String Package version
groupId String Group identifier
artifactId String Artifact identifier
type String Package type. Possible values: generic, maven, npm, pypi, nuget, composer, container, opm, cran, deb, rpm, rubygem, cargo, conda, conan, go
ownerUuid String UUID of the repository where the package is located
ownerType String Owner type. Always returns REPOSITORY

Package Version
Field Type Description
id String Package version UUID
baseVersion String Package base version
version String Package version
lowerVersion String Package version in lower case
downloadCount Integer Package version download count
languageVersion String Programming language version
packageUploadType String Package upload method. Possible options: TRANSPORT, MANUALLY, API
packageFiles Object Object containing attached file information. Contents can be viewed here
internal Deprecated Deprecated parameter. Returns false by default

Package File
Field Type Description
id String Package file UUID
name String File name
size Integer File size in bytes
hashMd5 String Hash in Md5 format
hashSHA1 String Hash in Sha1 format
hashSHA256 String Hash in Sha256 format
packageUploadType String File upload method. Possible options: TRANSPORT, MANUALLY, API
createdAt ZonedDateTime File creation date and time
nodeUuid String UUID of the node (folder) where the file is located

Registry Repository Methods

Get All Registry Repositories

Project: GET /project/{ownerAlias}/{projectAlias}/repositories

Company: GET /company/{companyAlias}/repositories

Instance: GET /instance/repositories

Request returns a list of registry repositories for the specified owner, with the ability to configure number of displayed objects per page.

Path Variable Type Description
ownerAlias String Project owner alias
projectAlias String Project alias
companyAlias String Company alias

Responses

STATUS 200 - Registry repositories list successfully returned:

Response example
    
{
    "_embedded": {
        "shortRegistryRepositoryDtoList": [
            {
                "title": "generic-local",
                "repositoryType": "LOCAL",
                "repositoryUuid": "b24769db-aaaa-aaaa-aaaa-a3006f0271f6",
                "packageType": "generic",
                "description": "Local generic registry repository",
            },
            {
                "title": "maven-proxy",
                "repositoryType": "PROXY",
                "repositoryUuid": "ddc72f64-aaaa-aaaa-aaaa-e212e088bffc",
                "packageType": "maven",
                "description": "Proxy maven registry repository",
            },
            {
                "title": "maven-proxy-cache",
                "repositoryType": "LOCAL_CACHE",
                "repositoryUuid": "fa6d59b5-aaaa-aaaa-aaaa-cf1806aa929c",
                "packageType": "maven",
                "description": null,
            }
            {
                "title": "maven-virtual",
                "repositoryType": "VIRTUAL",
                "repositoryUuid": "3cd7ccd1-aaaa-aaaa-aaaa-a1bfd03f9801",
                "packageType": "maven",
                "description": "Virtual maven registry repository",
            },
            {
                "title": "trashCan",
                "repositoryType": "TRASH_CAN",
                "repositoryUuid": "e510b751-aaaa-aaaa-aaaa-737daa2e7210",
                "packageType": "generic",
                "description": null,
            },
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 5,
        "totalPages": 1,
        "number": 0
    }
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Get Single Registry Repository by UUID

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{registryRepositoryUuid}

Company: GET /company/{companyAlias}/repositories/{registryRepositoryUuid}

Instance: GET /instance/repositories/{registryRepositoryUuid}

Request returns a registry repository for the specified owner by the specified UUID.

Path Variable Type Description
ownerAlias String Project owner alias
projectAlias String Project alias
companyAlias String Company alias
registryRepositoryUuid String Registry repository UUID

Responses

STATUS 200 - Registry repository successfully returned:

Response example
    
{
    "title": "generic-local",
    "repositoryType": "LOCAL",
    "repositoryUuid": "b24769db-aaaa-aaaa-aaaa-a3006f0271f6",
    "packageType": "generic",
    "description": "Local generic registry repository",
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Create Registry Repository

Project: POST /project/{ownerAlias}/{projectAlias}/repositories

Company: POST /company/{companyAlias}/repositories

Instance: POST /instance/repositories

Request creates a registry repository owned by the specified entity and returns its UUID.

Path Variable Type Description
ownerAlias String Project owner alias
projectAlias String Project alias
companyAlias String Company alias

Request

Supported JSON format

Depending on the set of fields passed in the request body, it's possible to create local, proxy, or virtual repository.

Create Local Repository
Parameter Type Description
type String Registry repository type. To create a local repository, specify value LOCAL
repositoryName String Registry repository name
description String Optional. Registry repository description
packageType String Registry repository package type. Possible values: generic, maven, npm, pypi, nuget, composer, opm, debian, container, helm, cran, rpm
settings Object Object with fields describing local repository settings

Set of fields describing local repository settings:

Parameter Type Description
hasAnonymousAccess Boolean Optional. Anonymous access allowed true or denied false (by default)
isDeletePackageAllowed Boolean Optional. Package deletion allowed true or denied false (by default)
packageReuploadType String Optional. Package overwrite type. Possible values: NONE - overwrite prohibited or OVERRIDE - file overwrite (by default)

JSON Object Example

{
  "type" : "LOCAL",
  "repositoryName": "generic-local",
  "description": "Local generic registry repository",
  "packageType": "generic",
  "settings": {
    "hasAnonymousAccess": true,
    "isDeletePackageAllowed": true,
    "packageReuploadType": "OVERRIDE"
  }
}
Responses

STATUS 201 - Local registry repository successfully created:

Response example
    
{
    "title": "generic-local",
    "repositoryType": "LOCAL",
    "repositoryUuid": "b24769db-aaaa-aaaa-aaaa-a3006f0271f6",
    "packageType": "generic",
    "description": "Local generic registry repository",
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

Create Proxy Repository
Parameter Type Description
type String Registry repository type. To create a proxy repository, specify value PROXY
repositoryName String Registry repository name
description String Optional. Registry repository description
packageType String Registry repository package type. Possible values: maven, npm, pypi, nuget, container
proxySettings Object Object with fields describing proxy repository settings

Set of fields describing proxy repository settings:

Parameter Type Description
url String Link to external registry where requests will be proxied
username String Optional. Username for authentication in external registry
token String Optional. Token or password for authentication in external registry
isCaching Boolean Optional. Repository will save cached artifacts locally true or not false (by default)
isOffline Boolean Optional. Artifact retrieval possible only from local cache true or not false (by default)
expireHours Integer Optional. Unused artifacts lifetime (in hours). Value 0 (by default) indicates no limit.
metadataRetrievalIntervalSeconds Integer Optional. Artifact metadata caching period (in seconds). Value 0 indicates no caching. Default is 7200.

JSON Object Example

{
  "type" : "PROXY",
  "repositoryName": "maven-proxy",
  "description": "Proxy maven registry repository",
  "packageType": "maven",
  "proxySettings": {
    "url": "https://repo.maven.apache.org/maven2/",
    "username": "username",
    "isCaching": true,
    "token": "qwerty123",
    "isOffline": false,
    "expireHours": 24,
    "metadataRetrievalIntervalSeconds": 7200
  }
}

Responses

STATUS 201 - Proxy registry repository successfully created:

Response example
    
{
    "title": "maven-proxy",
    "repositoryType": "PROXY",
    "repositoryUuid": "ddc72f64-aaaa-aaaa-aaaa-e212e088bffc",
    "packageType": "maven",
    "description": "Proxy maven registry repository",
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

Create Virtual Repository
Parameter Type Description
type String Registry repository type. To create a virtual repository, specify value VIRTUAL
repositoryName String Registry repository name
description String Optional. Registry repository description
packageType String Registry repository package type. Possible values: generic, maven, npm, pypi, nuget, composer, opm, debian, container, helm, cran, rpm
virtualSettings Object Object with fields describing virtual repository settings

Virtual repository settings:

Parameter Type Description
includedRepositoryUuids Array Array containing UUIDs of registry repositories to be included in the created virtual repository
allowRemoteProxying Boolean Optional. Requests to proxy repositories can fetch proxied packages true or cannot false (by default)
deploymentRepositoryUuid String Optional. UUID of local registry repository selected as default deployment repository

JSON Object Example

{
  "type" : "VIRTUAL",
  "repositoryName": "maven-virtual",
  "description": "Virtual maven registry repository",
  "packageType": "maven",
  "virtualSettings": {
    "includedRepositoryUuids": [
      "ddc72f64-aaaa-aaaa-aaaa-e212e088bffc",
      "fa6d59b5-aaaa-aaaa-aaaa-cf1806aa929c"
    ]
    "allowRemoteProxying": true
    "deploymentRepositoryUuid": "fa6d59b5-aaaa-aaaa-aaaa-cf1806aa929c"
  }
}

Responses

STATUS 201 - Virtual registry repository successfully created:

Response example
    
{
    "title": "maven-virtual",
    "repositoryType": "VIRTUAL",
    "repositoryUuid": "3cd7ccd1-aaaa-aaaa-aaaa-a1bfd03f9801",
    "packageType": "maven",
    "description": "Virtual maven registry repository",
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Edit Registry Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{registryRepositoryUuid}

Company: PUT /company/{companyAlias}/repositories/{registryRepositoryUuid}

Instance: PUT /instance/repositories/{registryRepositoryUuid}

Request modifies the specified registry repository of the specified owner and returns its UUID.

Path Variable Type Description
ownerAlias String Project owner alias
projectAlias String Project alias
companyAlias String Company alias
registryRepositoryUuid String Registry repository UUID

Request

Supported JSON format

Depending on the set of fields passed in the request body, it's possible to modify local, proxy, or virtual repository.

Edit Local Repository
Parameter Type Description
type String Registry repository type. To edit a local repository, specify value LOCAL
description String Optional. Registry repository description
settings Object Object with fields describing local repository settings

Set of fields describing local repository settings:

Parameter Type Description
hasAnonymousAccess Boolean Optional. Anonymous access allowed true or denied false (by default)
isDeletePackageAllowed Boolean Optional. Package deletion allowed true or denied false (by default)
packageReuploadType String Optional. Package overwrite type. Possible values: NONE - overwrite prohibited or OVERRIDE - file overwrite

JSON Object Example

{
  "type" : "LOCAL",
  "description": "Local generic registry repository",
  "settings": {
    "hasAnonymousAccess": true,
    "isDeletePackageAllowed": true,
    "packageReuploadType": "OVERRIDE"
  }
}

Responses

STATUS 200 - Local registry repository successfully modified:

Response example
    
{
    "title": "generic-local",
    "repositoryType": "LOCAL",
    "repositoryUuid": "b24769db-aaaa-aaaa-aaaa-a3006f0271f6",
    "packageType": "generic",
    "description": "Local generic registry repository",
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

Edit Proxy Repository
Parameter Type Description
type String Registry repository type. To edit a proxy repository, specify value PROXY
description String Optional. Registry repository description
proxySettings Object Object with fields describing proxy repository settings

Set of fields describing proxy repository settings:

Parameter Type Description
url String Optional. Link to external registry where requests will be proxied
username String Optional. Username for authentication in external registry
token String Optional. Token or password for authentication in external registry
isCaching Boolean Optional. Repository will save cached artifacts locally true or not false
isOffline Boolean Optional. Artifact retrieval possible only from local cache true or not false (by default)
expireHours Integer Optional. Unused artifacts lifetime (in hours)
metadataRetrievalIntervalSeconds Integer Optional. Artifact metadata caching period (in seconds)

JSON Object Example

{
  "type" : "PROXY",
  "description": "Proxy maven registry repository",
  "proxySettings": {
    "url": "https://repo.maven.apache.org/maven2/",
    "username": "username",
    "isCaching": true,
    "token": "qwerty123",
    "isOffline": false,
    "expireHours": 24,
    "metadataRetrievalIntervalSeconds": 7200
  }
}

Responses

STATUS 200 - Proxy registry repository successfully modified:

Response example
    
{
    "title": "maven-proxy",
    "repositoryType": "PROXY",
    "repositoryUuid": "ddc72f64-aaaa-aaaa-aaaa-e212e088bffc",
    "packageType": "maven",
    "description": "Proxy maven registry repository",
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

Edit Virtual Repository
Parameter Type Description
type String Registry repository type. To edit a virtual repository, specify value VIRTUAL
description String Optional. Registry repository description
virtualSettings Object Object with fields describing virtual repository settings

Virtual repository settings:

Parameter Type Description
includedRepositoryUuids Array Optional. Array containing UUIDs of registry repositories to be included in the modified virtual repository
allowRemoteProxying Boolean Optional. Requests to proxy repositories can fetch proxied packages true or cannot false (by default)
deploymentRepositoryUuid String Optional. UUID of local registry repository selected as default deployment repository

When modifying either deploymentRepositoryUuid or includedRepositoryUuids field, both must be provided.

JSON Object Example

{
  "type" : "VIRTUAL",
  "description": "Virtual maven registry repository",
  "virtualSettings": {
    "includedRepositoryUuids": [
      "ddc72f64-aaaa-aaaa-aaaa-e212e088bffc",
      "fa6d59b5-aaaa-aaaa-aaaa-cf1806aa929c"
    ]
    "allowRemoteProxying": true
    "deploymentRepositoryUuid": "fa6d59b5-aaaa-aaaa-aaaa-cf1806aa929c"
  }
}

Responses

STATUS 200 - Virtual registry repository successfully modified:

Response example
    
{
    "title": "maven-virtual",
    "repositoryType": "VIRTUAL",
    "repositoryUuid": "3cd7ccd1-aaaa-aaaa-aaaa-a1bfd03f9801",
    "packageType": "maven",
    "description": "Virtual maven registry repository",
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Delete Registry Repository

Project: DELETE /project/{ownerAlias}/{projectAlias}/repositories/{registryRepositoryUuid}

Company: DELETE /company/{companyAlias}/repositories/{registryRepositoryUuid}

Instance: DELETE /instance/repositories/{registryRepositoryUuid}

Request deletes the specified registry repository of the project.

Path Variable Type Description
ownerAlias String Project owner alias
projectAlias String Project alias
companyAlias String Company alias
registryRepositoryUuid String Registry repository UUID

Responses

STATUS 204 - Registry repository successfully deleted.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


General Registry Repository Package Methods

Get Repository Packages List

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/packages

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/packages

Instance: GET /instance/repositories/{repositoryUuid}/packages

Request returns a list of packages for the specified registry repository, with the ability to configure number of displayed objects per page.

Path Variable Type Description
repositoryUuid String UUID of the registry repository whose packages list needs to be obtained
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Repository packages list successfully returned:

Response example
    
{
    "_embedded": {
        "simplePackageInfoModelList": [
            {
                "id": "3cf3829a-aaaa-aaaa-aaaa-d4bba49cf7f3",
                "name": "package-name",
                "version": "1.0.0",
                "groupId": "package-group-id",
                "artifactId": "package-artifact-id",
                "type": "maven",
                "ownerUuid": "5e704785-aaaa-aaaa-aaaa-dd98f2eeb5a6",
                "ownerType": "REPOSITORY"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Get Repository Package

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/packages/{packageUuid}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/packages/{packageUuid}

Instance: GET /instance/repositories/{repositoryUuid}/packages/{packageUuid}

Request returns a package for the specified registry repository.

Path Variable Type Description
repositoryUuid String UUID of the registry repository whose package needs to be obtained
packageUuid String UUID of the package that needs to be obtained
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Repository package successfully returned:

Response example
    
{
    "id": "3cf3829a-aaaa-aaaa-aaaa-d4bba49cf7f3",
    "name": "package-name",
    "version": "1.0.0",
    "groupId": "package-group-id",
    "artifactId": "package-artifact-id",
    "type": "maven",
    "ownerUuid": "5e704785-aaaa-aaaa-aaaa-dd98f2eeb5a6",
    "ownerType": "REPOSITORY"
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Get Repository Package Versions List

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/version-list

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/version-list

Instance: GET /instance/repositories/{repositoryUuid}/packages/{packageUuid}/version-list

Request returns a list of versions for the package of the specified registry repository, with the ability to configure number of displayed objects per page.

Path Variable Type Description
repositoryUuid String UUID of the registry repository whose package versions list needs to be obtained
packageUuid String UUID of the package whose versions list needs to be obtained
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Package versions list successfully returned:

Response example
    
{
    "_embedded": {
        "repositoryPackageVersionModelList": [
            {
                "id": "dc5fd45e-aaaa-aaaa-aaaa-a85421f614b4",
                "baseVersion": "1.0.0",
                "version": "1.0.0",
                "lowerVersion": "1.0.0",
                "downloadCount": 10,
                "languageVersion": null,
                "packageUploadType": "TRANSPORT",
                "packageFiles": [
                    {
                        "id": "f54229e0-aaaa-aaaa-aaaa-7b28d4cba269",
                        "name": "package-name-1.0.0",
                        "size": 5000,
                        "hashMd5": "99bad348daaaaaaaaaaaa8bfd64a6b36",
                        "hashSHA1": "eff19953294243aaaaaaaaaaaa198276da1d6b08",
                        "hashSHA256": "d7a08a99b2502f0bb68cd4e1f9aaaaaaaaaaaad3208bd0f73366c03fc3548a42",
                        "hashSHA512": "ec795b2f32982c1af8dccef57553aa9d959c13ee829aebd6459ba22b4eaaaaaaaaaaaaa89f63ad2f0d8c45d59cd020a15cd976ddb4bf20f1044b492a406e029e",
                        "packageUploadType": "TRANSPORT",
                        "createdAt": "2025-01-01T12:00:00.000000",
                        "nodeUuid": "5b359e3a-aaaa-aaaa-aaaa-66ea4c74f3f3"
                    }
                ],
                "internal": false
            },
            {
                "id": "147d89fd-aaaa-aaaa-aaaa-742c2101a997",
                "baseVersion": "1.0.1",
                "version": "1.0.1",
                "lowerVersion": "1.0.1",
                "downloadCount": 17,
                "languageVersion": null,
                "packageUploadType": "TRANSPORT",
                "packageFiles": [
                    {
                        "id": "0d66c254-aaaa-aaaa-aaaa-a629539389a4",
                        "name": "package-name-1.0.1",
                        "size": 5005,
                        "hashMd5": "2abd6856baaaaaaaaaaaadfb52f4df68",
                        "hashSHA1": "4a2b7185be9155aaaaaaaaaaaaef2f15e0f4fffd",
                        "hashSHA256": "fa68451ea830572ed43ffe51d7aaaaaaaaaaaa65a602a51f49d6be02063a65f3",
                        "hashSHA512": "e1c4acc68f7114cd501754d07e51a9345bc1106623ea9e38cd6d40b188aaaaaaaaaaaa27da9d71da608b6691ef1f9d75d11253567350fbb4a949770a1cb7023e",
                        "packageUploadType": "TRANSPORT",
                        "createdAt": "2025-01-10T12:00:00.000000",
                        "nodeUuid": "ab2ca6ba-aaaa-aaaa-aaaa-d733290b6f7d"
                    }
                ],
                "internal": false
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Get Repository Package Version

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/version-list/{packageVersion}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/version-list/{packageVersion}

Instance: GET /instance/repositories/{repositoryUuid}/packages/{packageUuid}/version-list/{packageVersion}

Request returns a version for the package of the specified registry repository.

Path Variable Type Description
repositoryUuid String UUID of the registry repository whose package version needs to be obtained
packageUuid String UUID of the package whose version needs to be obtained
packageVersion String Package version that needs to be obtained
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Package version successfully returned:

Response example
    
{
    "id": "147d89fd-aaaa-aaaa-aaaa-742c2101a997",
    "baseVersion": "1.0.1",
    "version": "1.0.1",
    "lowerVersion": "1.0.1",
    "downloadCount": 17,
    "languageVersion": null,
    "packageUploadType": "TRANSPORT",
    "packageFiles": [
        {
            "id": "0d66c254-aaaa-aaaa-aaaa-a629539389a4",
            "name": "package-name-1.0.1",
            "size": 5005,
            "hashMd5": "2abd6856baaaaaaaaaaaadfb52f4df68",
            "hashSHA1": "4a2b7185be9155aaaaaaaaaaaaef2f15e0f4fffd",
            "hashSHA256": "fa68451ea830572ed43ffe51d7aaaaaaaaaaaa65a602a51f49d6be02063a65f3",
            "hashSHA512": "e1c4acc68f7114cd501754d07e51a9345bc1106623ea9e38cd6d40b188aaaaaaaaaaaa27da9d71da608b6691ef1f9d75d11253567350fbb4a949770a1cb7023e",
            "packageUploadType": "TRANSPORT",
            "createdAt": "2025-01-10T12:00:00.000000",
            "nodeUuid": "ab2ca6ba-aaaa-aaaa-aaaa-d733290b6f7d"
        }
    ],
    "internal": false
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Get Repository Package Files List

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/package-file

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/package-file

Instance: GET /instance/repositories/{repositoryUuid}/packages/{packageUuid}/package-file

Request returns a list of files for the package of the specified registry repository, with the ability to configure number of displayed objects per page.

Path Variable Type Description
repositoryUuid String UUID of the registry repository whose package files list needs to be obtained
packageUuid String UUID of the package whose files list needs to be obtained
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Package files list successfully returned:

Response example
    
{
    "_embedded": {
        "repositoryPackageFileModelList": [
            {
                "id": "f54229e0-aaaa-aaaa-aaaa-7b28d4cba269",
                "name": "package-name-1.0.0",
                "size": 5000,
                "hashMd5": "99bad348daaaaaaaaaaaa8bfd64a6b36",
                "hashSHA1": "eff19953294243aaaaaaaaaaaa198276da1d6b08",
                "hashSHA256": "d7a08a99b2502f0bb68cd4e1f9aaaaaaaaaaaad3208bd0f73366c03fc3548a42",
                "hashSHA512": "ec795b2f32982c1af8dccef57553aa9d959c13ee829aebd6459ba22b4eaaaaaaaaaaaaa89f63ad2f0d8c45d59cd020a15cd976ddb4bf20f1044b492a406e029e",
                "packageUploadType": "TRANSPORT",
                "createdAt": "2025-01-01T12:00:00.000000",
                "nodeUuid": "5b359e3a-aaaa-aaaa-aaaa-66ea4c74f3f3"
            },
            {
                "id": "0d66c254-aaaa-aaaa-aaaa-a629539389a4",
                "name": "package-name-1.0.1",
                "size": 5005,
                "hashMd5": "2abd6856baaaaaaaaaaaadfb52f4df68",
                "hashSHA1": "4a2b7185be9155aaaaaaaaaaaaef2f15e0f4fffd",
                "hashSHA256": "fa68451ea830572ed43ffe51d7aaaaaaaaaaaa65a602a51f49d6be02063a65f3",
                "hashSHA512": "e1c4acc68f7114cd501754d07e51a9345bc1106623ea9e38cd6d40b188aaaaaaaaaaaa27da9d71da608b6691ef1f9d75d11253567350fbb4a949770a1cb7023e",
                "packageUploadType": "TRANSPORT",
                "createdAt": "2025-01-10T12:00:00.000000",
                "nodeUuid": "ab2ca6ba-aaaa-aaaa-aaaa-d733290b6f7d"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}
    
  

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Delete Repository Package

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/delete

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/delete

Instance: GET /instance/repositories/{repositoryUuid}/packages/{packageUuid}/delete

Request deletes the package of the specified registry repository.

Path Variable Type Description
repositoryUuid String UUID of the registry repository whose package needs to be deleted
packageUuid String UUID of the package that needs to be deleted
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Repository package successfully deleted.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Delete Repository Package Version

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/{packageVersion}/delete

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/packages/{packageUuid}/{packageVersion}/delete

Instance: GET /instance/repositories/{repositoryUuid}/packages/{packageUuid}/{packageVersion}/delete

Request deletes the package of the specified registry repository.

Path Variable Type Description
repositoryUuid String UUID of the registry repository whose package version needs to be deleted
packageUuid String UUID of the package whose version needs to be deleted
packageVersion String Package version that needs to be deleted
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Package version successfully deleted.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Specific Registry Repository Package Methods

Publish Generic Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/generic/{packageName}/{packageVersion}/{fileName}?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/generic/{packageName}/{packageVersion}/{fileName}?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/generic/{packageName}/{packageVersion}/{fileName}?nodePath={path/to/node}

Request uploads an attached file to a registry repository with Generic type. By default, the path within the repository is formed based on the fields packageName, packageVersion and fileName. To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
packageName String Name with which the artifact will be published
packageVersion String Version with which the artifact will be published
fileName String File name with which the artifact will be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 400 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.


Download Generic Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/generic/{packageName}/{packageVersion}/{fileName}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/generic/{packageName}/{packageVersion}/{fileName}

Instance: GET /instance/repositories/{repositoryUuid}/generic/{packageName}/{packageVersion}/{fileName}

Request downloads an artifact from a registry repository with Generic type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
packageName String Name of the artifact to be downloaded
packageVersion String Version of the artifact to be downloaded
fileName String File name of the artifact to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish Maven Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/maven/{groupId}/{artifactId}/{packageVersion}/{fileName}?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/maven/{groupId}/{artifactId}/{packageVersion}/{fileName}?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/maven/{groupId}/{artifactId}/{packageVersion}/{fileName}?nodePath={path/to/node}

Request uploads an attached file to a registry repository with Maven type. By default, the path within the repository is formed based on the fields groupId, artifactId, packageVersion and fileName. To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
groupId String Group identifier with which the artifact will be published
artifactId String Artifact identifier with which it will be published
packageVersion String File version with which the artifact will be published
fileName String File name with which the artifact will be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 400 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.


Download Maven Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/maven/{packageUuid}/{packageVersion}/{fileUuid}/download

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/maven/{packageUuid}/{packageVersion}/{fileUuid}/download

Instance: GET /instance/repositories/{repositoryUuid}/maven/{packageUuid}/{packageVersion}/{fileUuid}/download

Request downloads an artifact from a registry repository with Maven type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
packageUuid String UUID of the artifact to be downloaded
packageVersion String Version of the artifact to be downloaded
fileUuid String UUID of the artifact file to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish NPM Package to Repository

Depending on the presence of package group scope, one of the following methods should be used:

  • Publish package without specified scope group to repository:

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/npm/{packageName}/{packageVersion}/{fileName}?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/npm/{packageName}/{packageVersion}/{fileName}?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/npm/{packageName}/{packageVersion}/{fileName}?nodePath={path/to/node}

  • Publish package with specified scope group to repository:

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/npm/{packageName}/{scope}/{packageVersion}/{fileName}?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/npm/{packageName}/{scope}/{packageVersion}/{fileName}?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/npm/{packageName}/{scope}/{packageVersion}/{fileName}?nodePath={path/to/node}

Request uploads an attached file to a registry repository with NPM type. By default, the path within the repository is formed based on the fields packageName, scope (if present), packageVersion and fileName. To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
packageName String Package name with which the artifact will be published
scope String Artifact group with which it will be published
packageVersion String File version with which the artifact will be published
fileName String File name with which the artifact will be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 400 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.


Download NPM Package from Repository

Depending on the presence of package group scope, one of the following methods should be used:

  • Download package without specified scope group from repository:

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/npm/{packageName}/{packageVersion}/{fileName}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/npm/{packageName}/{packageVersion}/{fileName}

Instance: GET /instance/repositories/{repositoryUuid}/npm/{packageName}/{packageVersion}/{fileName}

  • Download package with specified scope group from repository:

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/npm/{packageName}/{scope}/{packageVersion}/{fileName}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/npm/{packageName}/{scope}/{packageVersion}/{fileName}

Instance: GET /instance/repositories/{repositoryUuid}/npm/{packageName}/{scope}/{packageVersion}/{fileName}

Request downloads an artifact from a registry repository with NPM type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
packageName String Name of the artifact to be downloaded
scope String Group of the artifact to be downloaded
packageVersion String Version of the artifact to be downloaded
fileUuid String UUID of the artifact file to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish PyPi Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/pypi/{packageName}/{packageVersion}/{fileName}?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/pypi/{packageName}/{packageVersion}/{fileName}?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/pypi/{packageName}/{packageVersion}/{fileName}?nodePath={path/to/node}

Request uploads an attached file to a registry repository with PyPi type. By default, the path within the repository is formed based on the fields packageName, packageVersion and fileName. To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
packageName String Package name with which the artifact will be published
packageVersion String File version with which the artifact will be published
fileName String File name with which the artifact will be published. Must specify file name in format [name]-[version].tar.gz or [name]_[version].whl
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 400 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.


Download PyPi Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/pypi/{packageName}/{packageVersion}/{fileName}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/pypi/{packageName}/{packageVersion}/{fileName}

Instance: GET /instance/repositories/{repositoryUuid}/pypi/{packageName}/{packageVersion}/{fileName}

Request downloads an artifact from a registry repository with PyPi type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
packageName String Name of the artifact to be downloaded
packageVersion String Version of the artifact to be downloaded
fileName String File name of the artifact to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish NuGet Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/nuget?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/nuget?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/nuget?nodePath={path/to/node}

Request uploads an attached file to a registry repository with NuGet type. By default, the path within the repository is formed based on the internal meta-information of the package (packageName, packageVersion and fileName). To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 400 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.


Download NuGet Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/nuget/{packageName}/{packageVersion}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/nuget/{packageName}/{packageVersion}

Instance: GET /instance/repositories/{repositoryUuid}/nuget/{packageName}/{packageVersion}

Request downloads an artifact from a registry repository with NuGet type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
packageName String Name of the artifact to be downloaded
packageVersion String Version of the artifact to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish Composer Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/composer/{packageVersion}?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/composer/{packageVersion}?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/composer/{packageVersion}?nodePath={path/to/node}

Request uploads an attached file to a registry repository with Composer type. By default, the path within the repository is formed based on packageName (obtained from the internal meta-information of the package) and packageVersion. If the package version specified in the request does not match the version from the package's meta-information, the package will be uploaded with the version from the internal information of the package itself. To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
packageVersion String Version of the artifact to be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 400 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.


Download Composer Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/composer/{packageName}/{packageVersion}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/composer/{packageName}/{packageVersion}

Instance: GET /instance/repositories/{repositoryUuid}/composer/{packageName}/{packageVersion}

Request downloads an artifact from a registry repository with Composer type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
packageName String Name of the artifact to be downloaded. Expected most common Composer package name format - two parts separated by / character
packageVersion String Version of the artifact to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish OPM Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/opm/{fileName}?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/opm/{fileName}?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/opm/{fileName}?nodePath={path/to/node}

Request uploads an attached file to a registry repository with OPM type. By default, the path within the repository is formed based on packageName, packageVersion (obtained from the internal meta-information of the package) and fileName. To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
fileName String File name with which the artifact will be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 400 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.


Download OPM Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/opm/{packageName}/{packageVersion}/{fileName}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/opm/{packageName}/{packageVersion}/{fileName}

Instance: GET /instance/repositories/{repositoryUuid}/opm/{packageName}/{packageVersion}/{fileName}

Request downloads an artifact from a registry repository with OPM type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
packageName String Name of the artifact to be downloaded
packageVersion String Version of the artifact to be downloaded
fileName String File name of the artifact to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish Cran Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/cran/{languageVersion}/{fileName}?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/cran/{languageVersion}/{fileName}?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/cran/{languageVersion}/{fileName}?nodePath={path/to/node}

Request uploads an attached file to a registry repository with Cran type. By default, the path within the repository is formed based on packageName, packageVersion (obtained from the internal meta-information of the package) and fileName. To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
languageVersion String R language version with which the artifact will be published
fileName String File name with which the artifact will be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 400 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.


Download Cran Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/cran/{fileName}?languageVersion={languageVersion}&platform={platform}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/cran/{fileName}?languageVersion={languageVersion}&platform={platform}

Instance: GET /instance/repositories/{repositoryUuid}/cran/{fileName}?languageVersion={languageVersion}&platform={platform}

Request downloads an artifact from a registry repository with Cran type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
fileName String File name of the artifact to be downloaded
languageVersion String R language version with which the artifact will be downloaded
platform String Platform for which the package was created. Required only for downloading files in .tgz and .zip formats. Can take following values: macosx, windows
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish Gem Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/rubygem?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/rubygem?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/rubygem?nodePath={path/to/node}

Request uploads an attached file to a registry repository with Gem type. By default, the path within the repository is formed based on the internal meta-information of the package (packageName, packageVersion and fileName). To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.

STATUS 409 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.


Download Gem Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/rubygem/{packageName}/{packageVersion}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/rubygem/{packageName}/{packageVersion}

Instance: GET /instance/repositories/{repositoryUuid}/rubygem/{packageName}/{packageVersion}

Request downloads an artifact from a registry repository with Gem type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
packageName String Name of the artifact to be downloaded
packageVersion String Version of the artifact to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish Cargo Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/cargo?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/cargo?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/cargo?nodePath={path/to/node}

Request uploads an attached file to a registry repository with Cargo type. By default, the path within the repository is formed based on the internal meta-information of the package (packageName, packageVersion and fileName). To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.

STATUS 409 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.


Download Cargo Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/cargo/{packageName}/{packageVersion}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/cargo/{packageName}/{packageVersion}

Instance: GET /instance/repositories/{repositoryUuid}/cargo/{packageName}/{packageVersion}

Request downloads an artifact from a registry repository with Cargo type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
packageName String Name of the artifact to be downloaded
packageVersion String Version of the artifact to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.


Publish Conda Package to Repository

Project: PUT /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/conda/{fileName}?nodePath={path/to/node}

Company: PUT /company/{companyAlias}/repositories/{repositoryUuid}/conda/{fileName}?nodePath={path/to/node}

Instance: PUT /instance/repositories/{repositoryUuid}/conda/{fileName}?nodePath={path/to/node}

Request uploads an attached file to a registry repository with Conda type. By default, the path within the repository is formed based on the internal meta-information of the package (packageChannel, packageName, packageVersion and fileName). To upload an artifact to a target path, the optional parameter nodePath must be passed in the request. To publish an artifact to a virtual repository, it must have a default deployment repository specified.

Path Variable Type Description
repositoryUuid String UUID of the registry repository where the artifact needs to be published
fileName String File name with which the artifact will be published
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully published.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

STATUS 405 - Attempt to upload artifact to a virtual repository without a default deployment repository.

STATUS 409 - Attempt to upload artifact to an existing path in a repository with overwrite disabled.


Download Conda Package from Repository

Project: GET /project/{ownerAlias}/{projectAlias}/repositories/{repositoryUuid}/conda/{platform}/{fileName}

Company: GET /company/{companyAlias}/repositories/{repositoryUuid}/conda/{platform}/{fileName}

Instance: GET /instance/repositories/{repositoryUuid}/conda/{platform}/{fileName}

Request downloads an artifact from a registry repository with Conda type.

Path Variable Type Description
repositoryUuid String UUID of the registry repository from which the artifact will be downloaded
platform String Platform for which the artifact was built, to be downloaded
fileName String File name of the artifact to be downloaded
ownerAlias String Project owner alias where the registry repository is located
projectAlias String Project alias where the registry repository is located
companyAlias String Company alias where the registry repository is located

Responses

STATUS 200 - Artifact successfully downloaded.

STATUS 403 - No access rights.

STATUS 404 - Requested data not found.

Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.