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

ApplicationDeploymentRestrictionApi.md

Latest commit

 

History

History
240 lines (168 loc) · 8.42 KB

ApplicationDeploymentRestrictionApi.md

File metadata and controls

240 lines (168 loc) · 8.42 KB
Raw

QoveryApi.ApplicationDeploymentRestrictionApi

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

Method HTTP request Description
createApplicationDeploymentRestriction POST /application/{applicationId}/deploymentRestriction Create an application deployment restriction
deleteApplicationDeploymentRestriction DELETE /application/{applicationId}/deploymentRestriction/{deploymentRestrictionId} Delete an application deployment restriction
editApplicationDeploymentRestriction PUT /application/{applicationId}/deploymentRestriction/{deploymentRestrictionId} Edit an application deployment restriction
getApplicationDeploymentRestrictions GET /application/{applicationId}/deploymentRestriction Get application deployment restrictions

createApplicationDeploymentRestriction

ApplicationDeploymentRestriction createApplicationDeploymentRestriction(applicationId, opts)

Create an application deployment restriction

Create an application deployment restriction

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.ApplicationDeploymentRestrictionApi();
let applicationId = "applicationId_example"; // String | Application ID
let opts = {
  'applicationDeploymentRestrictionRequest': new QoveryApi.ApplicationDeploymentRestrictionRequest() // ApplicationDeploymentRestrictionRequest | 
};
apiInstance.createApplicationDeploymentRestriction(applicationId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
applicationId String Application ID
applicationDeploymentRestrictionRequest ApplicationDeploymentRestrictionRequest [optional]

Return type

ApplicationDeploymentRestriction

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

deleteApplicationDeploymentRestriction

deleteApplicationDeploymentRestriction(applicationId, deploymentRestrictionId)

Delete an application deployment restriction

Delete an application deployment restriction

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.ApplicationDeploymentRestrictionApi();
let applicationId = "applicationId_example"; // String | Application ID
let deploymentRestrictionId = "deploymentRestrictionId_example"; // String | Deployment Restriction ID
apiInstance.deleteApplicationDeploymentRestriction(applicationId, deploymentRestrictionId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
applicationId String Application ID
deploymentRestrictionId String Deployment Restriction ID

Return type

null (empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

editApplicationDeploymentRestriction

ApplicationDeploymentRestriction editApplicationDeploymentRestriction(applicationId, deploymentRestrictionId, opts)

Edit an application deployment restriction

Edit an application deployment restriction

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.ApplicationDeploymentRestrictionApi();
let applicationId = "applicationId_example"; // String | Application ID
let deploymentRestrictionId = "deploymentRestrictionId_example"; // String | Deployment Restriction ID
let opts = {
  'applicationDeploymentRestrictionRequest': new QoveryApi.ApplicationDeploymentRestrictionRequest() // ApplicationDeploymentRestrictionRequest | 
};
apiInstance.editApplicationDeploymentRestriction(applicationId, deploymentRestrictionId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
applicationId String Application ID
deploymentRestrictionId String Deployment Restriction ID
applicationDeploymentRestrictionRequest ApplicationDeploymentRestrictionRequest [optional]

Return type

ApplicationDeploymentRestriction

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

getApplicationDeploymentRestrictions

ApplicationDeploymentRestrictionResponseList getApplicationDeploymentRestrictions(applicationId)

Get application deployment restrictions

Get application deployment restrictions

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.ApplicationDeploymentRestrictionApi();
let applicationId = "applicationId_example"; // String | Application ID
apiInstance.getApplicationDeploymentRestrictions(applicationId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
applicationId String Application ID

Return type

ApplicationDeploymentRestrictionResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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