Skip to content
This repository was archived by the owner on Mar 14, 2024. It is now read-only.

HelmRepositoriesApi.md

Latest commit

 

History

History
338 lines (238 loc) · 10.5 KB

HelmRepositoriesApi.md

File metadata and controls

338 lines (238 loc) · 10.5 KB
Raw

QoveryApi.HelmRepositoriesApi

All URIs are relative to https://api.qovery.com

Method HTTP request Description
createHelmRepository POST /organization/{organizationId}/helmRepository Create a helm repository
deleteHelmRepository DELETE /organization/{organizationId}/helmRepository/{helmRepositoryId} Delete a helm repository
editHelmRepository PUT /organization/{organizationId}/helmRepository/{helmRepositoryId} Edit a helm repository
getHelmRepository GET /organization/{organizationId}/helmRepository/{helmRepositoryId} Get a helm repository
listAvailableHelmRepository GET /availableHelmRepository List supported helm repository
listHelmRepository GET /organization/{organizationId}/helmRepository List organization helm repositories

createHelmRepository

HelmRepositoryResponse createHelmRepository(organizationId, opts)

Create a helm repository

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.HelmRepositoriesApi();
let organizationId = "organizationId_example"; // String | Organization ID
let opts = {
  'helmRepositoryRequest': new QoveryApi.HelmRepositoryRequest() // HelmRepositoryRequest | 
};
apiInstance.createHelmRepository(organizationId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
helmRepositoryRequest HelmRepositoryRequest [optional]

Return type

HelmRepositoryResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteHelmRepository

deleteHelmRepository(organizationId, helmRepositoryId)

Delete a helm repository

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.HelmRepositoriesApi();
let organizationId = "organizationId_example"; // String | Organization ID
let helmRepositoryId = "helmRepositoryId_example"; // String | Helm chart repository ID
apiInstance.deleteHelmRepository(organizationId, helmRepositoryId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
helmRepositoryId String Helm chart repository ID

Return type

null (empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

editHelmRepository

HelmRepositoryResponse editHelmRepository(organizationId, helmRepositoryId, opts)

Edit a helm repository

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.HelmRepositoriesApi();
let organizationId = "organizationId_example"; // String | Organization ID
let helmRepositoryId = "helmRepositoryId_example"; // String | Helm chart repository ID
let opts = {
  'helmRepositoryRequest': new QoveryApi.HelmRepositoryRequest() // HelmRepositoryRequest | 
};
apiInstance.editHelmRepository(organizationId, helmRepositoryId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
helmRepositoryId String Helm chart repository ID
helmRepositoryRequest HelmRepositoryRequest [optional]

Return type

HelmRepositoryResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getHelmRepository

HelmRepositoryResponse getHelmRepository(organizationId, helmRepositoryId)

Get a helm repository

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.HelmRepositoriesApi();
let organizationId = "organizationId_example"; // String | Organization ID
let helmRepositoryId = "helmRepositoryId_example"; // String | Helm chart repository ID
apiInstance.getHelmRepository(organizationId, helmRepositoryId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID
helmRepositoryId String Helm chart repository ID

Return type

HelmRepositoryResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listAvailableHelmRepository

AvailableHelmRepositoryResponseList listAvailableHelmRepository()

List supported helm repository

List supported helm repository by Qovery and get the mandatory authentification configuration.

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.HelmRepositoriesApi();
apiInstance.listAvailableHelmRepository((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

AvailableHelmRepositoryResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listHelmRepository

HelmRepositoryResponseList listHelmRepository(organizationId)

List organization helm repositories

Example

import QoveryApi from 'qovery_api';
let defaultClient = QoveryApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';
// Configure Bearer (JWT) access token for authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

let apiInstance = new QoveryApi.HelmRepositoriesApi();
let organizationId = "organizationId_example"; // String | Organization ID
apiInstance.listHelmRepository(organizationId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationId String Organization ID

Return type

HelmRepositoryResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json