Powered by Redocly

FlexNet Operations Registry Service (1.0)

Download OpenAPI specification:Download

Flexera Software: support@flexerasoftware.com URL: https://community.flexera.com/t5/FlexNet-Operations/ct-p/FlexNet-Operations License: Commercial

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.

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.

Get Download Logs

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

Security
Request
query Parameters
month
integer <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.

page
required
integer <int64>

Retrieves a specific page.

pageSize
required
integer <int64>

Specifies how many data sets per page should be returned.

year
required
integer <int32>

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

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

All OK

400

Bad request format.

401

Unauthorized

403

Authentication failed.

500

Internal server error.

get/api/v1/downloads
Response samples
application/json
{
  • "account": "string",
  • "artifact": "string",
  • "id": 0,
  • "timestamp": "string",
  • "username": "string"
}

Get Processing Status of an Event

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

Security
Request
path Parameters
entity_name
required
string

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

query Parameters
entity_type
required
string

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

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

OK

400

Bad request

401

Unauthorized

500

Internal server error

get/api/v1/event/{entity_name}/status
Response samples
application/json
"string"

List Projects

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.

Security
Request
query Parameters
page
integer <int64>
Default: 1

Retrieves a specific page.

pageSize
integer <int64>
Default: 10

The number of data sets per page

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

All OK

400

Bad request format.

401

Unauthorized

500

Internal server error.

get/api/v1/projects
Response samples
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

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.

Security
Request
path Parameters
project_name
required
string

The project name

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

Success

401

Unauthorized

403

Forbidden

404

Project not found

500

Internal server error

get/api/v1/projects/{project_name}
Response samples
application/json
{
  • "artifacts": [
    ],
  • "chart": [
    ],
  • "download_package_id": "string",
  • "download_package_name": "string",
  • "repositories": [
    ],
  • "sys_download_package_id": 0
}

Get Chart Details

Return detailed chart information.

Security
Request
path Parameters
chart_name
required
string

The chart name

project_name
required
string

The project name

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

OK

400

Bad request

401

Unauthorized

500

Internal server error

get/api/v1/projects/{project_name}/charts/{chart_name}
Response samples
application/json
{
  • "apiVersion": "string",
  • "appVersion": "string",
  • "created": "string",
  • "description": "string",
  • "digest": "string",
  • "labels": [
    ],
  • "name": "string",
  • "type": "string",
  • "urls": [
    ],
  • "version": "string"
}

Delete Chart

Delete a chart that is part of a project.

Security
Request
path Parameters
chart_name
required
string

The chart name

project_name
required
string

The project name

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

OK

400

Bad request

401

Unauthorized

500

Internal server error

delete/api/v1/projects/{project_name}/charts/{chart_name}
Response samples
application/json
"string"

Get Member Information for a Project

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).

Security
Request
path Parameters
project_name
required
string

The name of the project for which information is requested.

query Parameters
page
integer <int64>
Default: 1

Retrieves a specific page. Must be a number.

page_size
integer <int64>
Default: 10

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

user_id
string

Retrieves information about a particular member.

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

OK

400

Bad request

401

Unauthorized

500

Internal server error

get/api/v1/projects/{project_name}/members
Response samples
application/json
{
  • "project_id": 0,
  • "role_name": "string",
  • "user_id": "string"
}

Delete Repository or Image

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

Security
Request
path Parameters
project_name
required
string

The project name

query Parameters
repository_name
required
string

Name of the repository containing the image to be deleted

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

OK

400

Bad request

401

Unauthorized

500

Internal server error

delete/api/v1/projects/{project_name}/repositories
Response samples
application/json
"string"

List Artifacts

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

Security
Request
path Parameters
project_name
required
string

The project name

query Parameters
page
integer <int64>

Retrieves a specific page. Must be a number.

pageSize
integer <int64>

The number of data sets per page

repositoryName
required
string

The name of the repository.

withImmutableStatus
boolean

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

withLabel
boolean

Specify whether the labels are included inside the returning artifacts

withScanOverview
boolean

Specify whether the scan overview is included inside the returning artifacts

withSignature
boolean

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

withTag
boolean

Specify whether the tags are included inside the returning artifacts

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

Success

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error

get/api/v1/projects/{project_name}/repositories/artifacts
Response samples
application/json
{
  • "artifacts": [
    ],
  • "chart": [
    ],
  • "download_package_id": "string",
  • "download_package_name": "string",
  • "repositories": [
    ],
  • "sys_download_package_id": 0
}

Change the Registry Secret

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.

Security
Request
header Parameters
Authorization
required
string

Use Bearer token for authorization

Request Body schema: application/json

userPasswordDTO

existing-password
string

Existing password (Base64 encoded)

new-password
string

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

user-email
string

User email

Responses
200

OK

400

Bad Request Format.

put/api/v1/secret
Request samples
application/json
{
  • "existing-password": "string",
  • "new-password": "string",
  • "user-email": "string"
}
Response samples
application/json
"string"

Get Registry Secret

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.

Security
Request
path Parameters
user-email
required
string

User email

header Parameters
Authorization
required
string

Use Bearer token for authorization

Responses
200

OK

400

Bad Request Format.

get/api/v1/secret/{user-email}
Response samples
application/json
"string"

auth-controller

Auth Controller

Get JWT Token for a User

When calling the Software Container Delivery REST API, a producer user must authenticate themselves, using the "/authenticate" endpoint. The FlexNet Operations producers pass their credentials to the "/authenticate" endpoint, which creates a JSON Web Token (JWT) that can be used to authorize access to any endpoint of the Software Container Delivery REST API. Credentials are a Base64-encoded combination of the producer's user name and password separated by a colon (:).

Security
Request
header Parameters
Authorization
required
string

Authorization

Responses
200

All OK

400

Bad request format.

403

Authentication failed.

500

Internal server error.

get/api/v1/authenticate
Response samples
application/json
{
  • "data": { },
  • "statusCode": 0,
  • "statusMessage": "string"
}