Skip to content
REST API Reference/
/
Software Container Delive...

Introduction to the Registry Service REST API (1.0)

Registry Service REST APIs to use with Flexnet Operations. Almost all of these APIs will require you to pass the tenant-id using x-publisherid request header.

Download OpenAPI description
softwarecontainerdelivery.json
softwarecontainerdelivery.yaml
Overview
URL
https://community.flexera.com/t5/FlexNet-Operations/ct-p/FlexNet-Operations
Flexera Software
support@flexerasoftware.com
License
Commercial
Languages
Servers
Mock server
https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery
Replace {siteID} with your FlexNet Operations instance. Replace {domainExtension} with the extension for your FlexNet Operations instance, such as com, eu, etc.
https://{siteID}.flexnetoperations.{domainExtension}/registry/api/v1

Software Container Delivery Public APIs

The Software Container Delivery REST API enables producers who distribute containerized applications using the Revenera registry to manage their projects directly, without using the Docker or Helm command-line interface (CLI). This allows producers to incorporate relevant functionality into their own portal implementations.

Operations

Get Download Logs

Request

Download a log showing a summary of the end-customers' download activity from all registry service instances.

Query
monthinteger(int32)

The calendar month for which data is requested. Format=mm, where mm is the two-digit month (01 - 12). If the month is the current month, then all data for that month up to the current time is returned.

pageinteger(int64)required

Retrieves a specific page.

pageSizeinteger(int64)required

Specifies how many data sets per page should be returned.

yearinteger(int32)required

The year of the calendar month for which data is requested. Format=yyyy.

Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/downloads?month=0&page=0&pageSize=0&year=0' \
  -H 'Authorization: string'

Responses

All OK

Bodyapplication/json
accountstring
artifactstring
idinteger(int32)
timestampstring
usernamestring
Response
application/json
{
  "account": "string",
  "artifact": "string",
  "id": 0,
  "timestamp": "string",
  "username": "string"
}

Get Processing Status of an Event

Request

Return the processing status of a specified entity. Currently, only entities of type USER are supported.

Path
entity_namestringrequired

The name of the entity (user ID) for which to return the processing status.

Query
entity_typestringrequired

The type of the entity (USER) for which to return the processing status.

Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/event/{entity_name}/status?entity_type=string' \
  -H 'Authorization: string'

Responses

OK

Bodyapplication/json
string
Response
application/json
"string"

List Projects

Request

List the projects that are currently stored in the Revenera registry. The list of projects is sorted alphabetically by the project name (which is identical with the Download Package ID). The list is paged, where the number of data sets per page can be configured using the "pageSize" parameter. A specific page of results can be requested by setting the "page" parameter.

Query
pageinteger(int64)

Retrieves a specific page.

Default 1
pageSizeinteger(int64)

The number of data sets per page

Default 10
Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/projects?page=1&pageSize=10' \
  -H 'Authorization: string'

Responses

All OK

Bodyapplication/json
project_idinteger(int32)

Download package id stored under Harbor

namestring

Name of the download package

repo_countinteger(int32)

The number of the repositories under this download package

chart_countinteger(int32)

The total number of charts under this download package

creation_timestring

The creation time of the download package

update_timestring

The update time of the download package

Response
application/json
{
  "project_id": 0,
  "name": "string",
  "repo_count": 0,
  "chart_count": 0,
  "creation_time": "string",
  "update_time": "string"
}

Get Projects, Repositories and Helm Charts

Request

This endpoint returns information about the project, repositories and helm charts associate with a specified project that is currently available to entitled end users. The name of the project must be passed in the {project_name} path parameter.

Path
project_namestringrequired

The project name

Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/projects/{project_name}' \
  -H 'Authorization: string'

Responses

Success

Bodyapplication/json
artifactsArray of objects(ArtifactResponse)

Artifacts

chartArray of objects(ChartResponse)

List out the charts corresponding to the Download package

download_package_idstring

Download package Id

download_package_namestring

Download package name

repositoriesArray of objects(RepositoryResponse)

Repositories

sys_download_package_idinteger(int64)

Sys download package Id

Response
application/json
{
  "artifacts": [
    { … }
  ],
  "chart": [
    { … }
  ],
  "download_package_id": "string",
  "download_package_name": "string",
  "repositories": [
    { … }
  ],
  "sys_download_package_id": 0
}

Get Chart Details

Request

Return detailed chart information.

Path
chart_namestringrequired

The chart name

project_namestringrequired

The project name

Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/projects/{project_name}/charts/{chart_name}' \
  -H 'Authorization: string'

Responses

OK

Bodyapplication/json
apiVersionstring

The API version of this chart

appVersionstring

The App version of this chart

createdstring

The created time of chart entry

descriptionstring

A one-sentence description of chart

digeststring

The digest value of the chart entry

labelsArray of objects(LabelResponse)

The labels attached to the chart

namestring

The name of the chart

typestring
urlsArray of strings

The urls of the chart entry

versionstring

A SemVer 2 version of chart

Response
application/json
{
  "apiVersion": "string",
  "appVersion": "string",
  "created": "string",
  "description": "string",
  "digest": "string",
  "labels": [
    { … }
  ],
  "name": "string",
  "type": "string",
  "urls": [
    "string"
  ],
  "version": "string"
}

Delete Chart

Request

Delete a chart that is part of a project.

Path
chart_namestringrequired

The chart name

project_namestringrequired

The project name

Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X DELETE \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/projects/{project_name}/charts/{chart_name}' \
  -H 'Authorization: string'

Responses

OK

Bodyapplication/json
string
Response
application/json
"string"

Get Member Information for a Project

Request

Return a list of the members who have access to a particular project. To retrieve information about a particular member, specify their user name using the query parameter "user_id" (the "user_id" is identical with the "entityName" field in the response).

Path
project_namestringrequired

The name of the project for which information is requested.

Query
pageinteger(int64)

Retrieves a specific page. Must be a number.

Default 1
page_sizeinteger(int64)

Specifies how many records per page should be returned. Must be a number.

Default 10
user_idstring

Retrieves information about a particular member.

Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/projects/{project_name}/members?page=1&page_size=10&user_id=string' \
  -H 'Authorization: string'

Responses

OK

Bodyapplication/json
project_idinteger(int32)

The project Id which the member belongs to

role_namestring

Member role in Harbor

user_idstring

Member username in Harbor

Response
application/json
{
  "project_id": 0,
  "role_name": "string",
  "user_id": "string"
}

Delete Repository or Image

Request

Delete a repository or image that is part of a project.

Path
project_namestringrequired

The project name

Query
repository_namestringrequired

Name of the repository containing the image to be deleted

Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X DELETE \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/projects/{project_name}/repositories?repository_name=string' \
  -H 'Authorization: string'

Responses

OK

Bodyapplication/json
string
Response
application/json
"string"

List Artifacts

Request

List the details of artifacts that are included in a specific project and repository.

Path
project_namestringrequired

The project name

Query
pageinteger(int64)

Retrieves a specific page. Must be a number.

pageSizeinteger(int64)

The number of data sets per page

repositoryNamestringrequired

The name of the repository.

withImmutableStatusboolean

Specify whether the immutable status is included inside the tags of the returning artifacts

withLabelboolean

Specify whether the labels are included inside the returning artifacts

withScanOverviewboolean

Specify whether the scan overview is included inside the returning artifacts

withSignatureboolean

Specify whether the signature is included inside the tags of the returning artifacts

withTagboolean

Specify whether the tags are included inside the returning artifacts

Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/projects/{project_name}/repositories/artifacts?page=0&pageSize=0&repositoryName=string&withImmutableStatus=true&withLabel=true&withScanOverview=true&withSignature=true&withTag=true' \
  -H 'Authorization: string'

Responses

Success

Bodyapplication/json
artifactsArray of objects(ArtifactResponse)

Artifacts

chartArray of objects(ChartResponse)

List out the charts corresponding to the Download package

download_package_idstring

Download package Id

download_package_namestring

Download package name

repositoriesArray of objects(RepositoryResponse)

Repositories

sys_download_package_idinteger(int64)

Sys download package Id

Response
application/json
{
  "artifacts": [
    { … }
  ],
  "chart": [
    { … }
  ],
  "download_package_id": "string",
  "download_package_name": "string",
  "repositories": [
    { … }
  ],
  "sys_download_package_id": 0
}

Change the Registry Secret

Request

Remove the current secret for the logged-in user and replace it with a new value. If the "new-password" field is empty, a random secret will be generated for the logged-in user.

Headers
Authorizationstringrequired

Use Bearer token for authorization

Bodyapplication/json

userPasswordDTO

existing-passwordstring

Existing password (Base64 encoded)

new-passwordstring

New password (Base64 encoded). Pass an empty value to generate a random secret.

user-emailstring

User email

curl -i -X PUT \
  https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/secret \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "existing-password": "string",
    "new-password": "string",
    "user-email": "string"
  }'

Responses

OK

Bodyapplication/json
string
Response
application/json
"string"

Get Registry Secret

Request

Retrieve the registry secret for the logged-in user. The returned secret is Base64 encoded and must be decoded before it can be used to log into the registry.

Path
user-emailstringrequired

User email

Headers
Authorizationstringrequired

Use Bearer token for authorization

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/registry-service/softwarecontainerdelivery/api/v1/secret/{user-email}' \
  -H 'Authorization: string'

Responses

OK

Bodyapplication/json
string
Response
application/json
"string"

auth-controller

Auth Controller

Operations