RepositoriesApi

All URIs are relative to https://api.ionos.com/containerregistries

MethodHTTP requestDescription

DELETE /registries/{registryId}/repositories/{repositoryName}

Delete repository

GET /registries/{registryId}/repositories/{repositoryName}

Retrieve Repository

GET /registries/{registryId}/repositories

Retrieve all Repositories

registriesRepositoriesDelete

registriesRepositoriesDelete(registryId, repositoryName)

Delete repository

Delete all repository contents The registry V2 API allows manifests and blobs to be deleted individually but it is not possible to remove an entire repository. This operation is provided for convenience

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-container-registry');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.RepositoriesApi(config);
// Delete repository
api_instance
  .registriesRepositoriesDelete({
    registryId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    repositoryName: my-service
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

NameTypeDescriptionNotes

registryId

The unique ID of the registry

[default to undefined]

repositoryName

string

The name of the repository

[default to undefined]

Return type

nil (empty response body)

Authorization

basicAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: Not defined

registriesRepositoriesFindByName

registriesRepositoriesFindByName(registryId, repositoryName)

Retrieve Repository

Returns the Repository by Name.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-container-registry');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.RepositoriesApi(config);
// Retrieve Repository
api_instance
  .registriesRepositoriesFindByName({
    registryId: 1e41a73c-59d0-5507-86dd-fa2fc2501cfd,
    repositoryName: my-service
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

NameTypeDescriptionNotes

registryId

The ID (UUID) of the Registry.

[default to undefined]

repositoryName

string

The Name of the Repository that should be retrieved.

[default to undefined]

Return type

RepositoryRead

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

registriesRepositoriesGet

registriesRepositoriesGet(registryId, opts)

Retrieve all Repositories

This endpoint enables retrieving all Repositories using pagination and optional filters.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs-container-registry');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.RepositoriesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Retrieve all Repositories
api_instance
  .registriesRepositoriesGet({
    registryId: 1e41a73c-59d0-5507-86dd-fa2fc2501cfd,
    offset: 0,
    limit: 100,
    filterName: filterName_example,
    filterVulnerabilitySeverity: filterVulnerabilitySeverity_example,
    orderBy: orderBy_example, 
    maxResults: 2,
    filters: filterMap
    options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

NameTypeDescriptionNotes

registryId

The ID (UUID) of the Registry.

[default to undefined]

offset

number

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

[optional][default to 0]

limit

number

The maximum number of elements to return. Use together with offset for pagination.

[optional][default to 100]

filterName

string

Filter resources by name.

[optional][default to undefined]

filterVulnerabilitySeverity

string

Filter resources by vulnerability severity.

[optional][default to undefined]

orderBy

**'-lastPush'

'-lastPull'

'-artifactCount'

Return type

RepositoryReadList

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

Last updated