Skip to content

Latest commit

 

History

History
300 lines (190 loc) · 10.7 KB

ApplicationDeploymentRestrictionAPI.md

File metadata and controls

300 lines (190 loc) · 10.7 KB
Raw

\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(ctx, applicationId).ApplicationDeploymentRestrictionRequest(applicationDeploymentRestrictionRequest).Execute()

Create an application deployment restriction

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	applicationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Application ID
	applicationDeploymentRestrictionRequest := *openapiclient.NewApplicationDeploymentRestrictionRequest(openapiclient.DeploymentRestrictionModeEnum("EXCLUDE"), openapiclient.DeploymentRestrictionTypeEnum("PATH"), "application1/src/") // ApplicationDeploymentRestrictionRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationDeploymentRestrictionAPI.CreateApplicationDeploymentRestriction(context.Background(), applicationId).ApplicationDeploymentRestrictionRequest(applicationDeploymentRestrictionRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDeploymentRestrictionAPI.CreateApplicationDeploymentRestriction``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateApplicationDeploymentRestriction`: ApplicationDeploymentRestriction
	fmt.Fprintf(os.Stdout, "Response from `ApplicationDeploymentRestrictionAPI.CreateApplicationDeploymentRestriction`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId string Application ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateApplicationDeploymentRestrictionRequest struct via the builder pattern

Name Type Description Notes

applicationDeploymentRestrictionRequest | ApplicationDeploymentRestrictionRequest | |

Return type

ApplicationDeploymentRestriction

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteApplicationDeploymentRestriction

DeleteApplicationDeploymentRestriction(ctx, applicationId, deploymentRestrictionId).Execute()

Delete an application deployment restriction

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	applicationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Application ID
	deploymentRestrictionId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Deployment Restriction ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ApplicationDeploymentRestrictionAPI.DeleteApplicationDeploymentRestriction(context.Background(), applicationId, deploymentRestrictionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDeploymentRestrictionAPI.DeleteApplicationDeploymentRestriction``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId string Application ID
deploymentRestrictionId string Deployment Restriction ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteApplicationDeploymentRestrictionRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditApplicationDeploymentRestriction

ApplicationDeploymentRestriction EditApplicationDeploymentRestriction(ctx, applicationId, deploymentRestrictionId).ApplicationDeploymentRestrictionRequest(applicationDeploymentRestrictionRequest).Execute()

Edit an application deployment restriction

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	applicationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Application ID
	deploymentRestrictionId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Deployment Restriction ID
	applicationDeploymentRestrictionRequest := *openapiclient.NewApplicationDeploymentRestrictionRequest(openapiclient.DeploymentRestrictionModeEnum("EXCLUDE"), openapiclient.DeploymentRestrictionTypeEnum("PATH"), "application1/src/") // ApplicationDeploymentRestrictionRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationDeploymentRestrictionAPI.EditApplicationDeploymentRestriction(context.Background(), applicationId, deploymentRestrictionId).ApplicationDeploymentRestrictionRequest(applicationDeploymentRestrictionRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDeploymentRestrictionAPI.EditApplicationDeploymentRestriction``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `EditApplicationDeploymentRestriction`: ApplicationDeploymentRestriction
	fmt.Fprintf(os.Stdout, "Response from `ApplicationDeploymentRestrictionAPI.EditApplicationDeploymentRestriction`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId string Application ID
deploymentRestrictionId string Deployment Restriction ID

Other Parameters

Other parameters are passed through a pointer to a apiEditApplicationDeploymentRestrictionRequest struct via the builder pattern

Name Type Description Notes

applicationDeploymentRestrictionRequest | ApplicationDeploymentRestrictionRequest | |

Return type

ApplicationDeploymentRestriction

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetApplicationDeploymentRestrictions

ApplicationDeploymentRestrictionResponseList GetApplicationDeploymentRestrictions(ctx, applicationId).Execute()

Get application deployment restrictions

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	applicationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Application ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationDeploymentRestrictionAPI.GetApplicationDeploymentRestrictions(context.Background(), applicationId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationDeploymentRestrictionAPI.GetApplicationDeploymentRestrictions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetApplicationDeploymentRestrictions`: ApplicationDeploymentRestrictionResponseList
	fmt.Fprintf(os.Stdout, "Response from `ApplicationDeploymentRestrictionAPI.GetApplicationDeploymentRestrictions`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId string Application ID

Other Parameters

Other parameters are passed through a pointer to a apiGetApplicationDeploymentRestrictionsRequest struct via the builder pattern

Name Type Description Notes

Return type

ApplicationDeploymentRestrictionResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]