\ContainerEnvironmentVariableAPI

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

Method	HTTP request	Description
CreateContainerEnvironmentVariable	Post /container/{containerId}/environmentVariable	Add an environment variable to the container
CreateContainerEnvironmentVariableAlias	Post /container/{containerId}/environmentVariable/{environmentVariableId}/alias	Create an environment variable alias at the container level
CreateContainerEnvironmentVariableOverride	Post /container/{containerId}/environmentVariable/{environmentVariableId}/override	Create an environment variable override at the container level
DeleteContainerEnvironmentVariable	Delete /container/{containerId}/environmentVariable/{environmentVariableId}	Delete an environment variable from a container
EditContainerEnvironmentVariable	Put /container/{containerId}/environmentVariable/{environmentVariableId}	Edit an environment variable belonging to the container
ImportContainerEnvironmentVariable	Post /container/{containerId}/environmentVariable/import	Import variables
ListContainerEnvironmentVariable	Get /container/{containerId}/environmentVariable	List environment variables

CreateContainerEnvironmentVariable

EnvironmentVariable CreateContainerEnvironmentVariable(ctx, containerId).EnvironmentVariableRequest(environmentVariableRequest).Execute()

Add an environment variable to the container

Example

package main

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

func main() {
	containerId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container ID
	environmentVariableRequest := *openapiclient.NewEnvironmentVariableRequest("Key_example") // EnvironmentVariableRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

environmentVariableRequest | EnvironmentVariableRequest | |

Return type

EnvironmentVariable

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]

CreateContainerEnvironmentVariableAlias

EnvironmentVariable CreateContainerEnvironmentVariableAlias(ctx, containerId, environmentVariableId).Key(key).Execute()

Create an environment variable alias at the container level

Example

package main

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

func main() {
	containerId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container ID
	environmentVariableId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment Variable ID
	key := *openapiclient.NewKey("Key_example") // Key |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ContainerEnvironmentVariableAPI.CreateContainerEnvironmentVariableAlias(context.Background(), containerId, environmentVariableId).Key(key).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ContainerEnvironmentVariableAPI.CreateContainerEnvironmentVariableAlias``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateContainerEnvironmentVariableAlias`: EnvironmentVariable
	fmt.Fprintf(os.Stdout, "Response from `ContainerEnvironmentVariableAPI.CreateContainerEnvironmentVariableAlias`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
containerId	string	Container ID
environmentVariableId	string	Environment Variable ID

Other Parameters

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

Name	Type	Description	Notes

key | Key | |

Return type

EnvironmentVariable

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]

CreateContainerEnvironmentVariableOverride

EnvironmentVariable CreateContainerEnvironmentVariableOverride(ctx, containerId, environmentVariableId).Value(value).Execute()

Create an environment variable override at the container level

Example

package main

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

func main() {
	containerId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container ID
	environmentVariableId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment Variable ID
	value := *openapiclient.NewValue() // Value |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ContainerEnvironmentVariableAPI.CreateContainerEnvironmentVariableOverride(context.Background(), containerId, environmentVariableId).Value(value).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ContainerEnvironmentVariableAPI.CreateContainerEnvironmentVariableOverride``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateContainerEnvironmentVariableOverride`: EnvironmentVariable
	fmt.Fprintf(os.Stdout, "Response from `ContainerEnvironmentVariableAPI.CreateContainerEnvironmentVariableOverride`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
containerId	string	Container ID
environmentVariableId	string	Environment Variable ID

Other Parameters

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

Name	Type	Description	Notes

value | Value | |

Return type

EnvironmentVariable

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]

DeleteContainerEnvironmentVariable

DeleteContainerEnvironmentVariable(ctx, containerId, environmentVariableId).Execute()

Delete an environment variable from a container

Example

package main

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

func main() {
	containerId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container ID
	environmentVariableId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment Variable ID

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
containerId	string	Container ID
environmentVariableId	string	Environment Variable ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteContainerEnvironmentVariableRequest 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]

EditContainerEnvironmentVariable

EnvironmentVariable EditContainerEnvironmentVariable(ctx, containerId, environmentVariableId).EnvironmentVariableEditRequest(environmentVariableEditRequest).Execute()

Edit an environment variable belonging to the container

Example

package main

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

func main() {
	containerId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container ID
	environmentVariableId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment Variable ID
	environmentVariableEditRequest := *openapiclient.NewEnvironmentVariableEditRequest("Key_example") // EnvironmentVariableEditRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ContainerEnvironmentVariableAPI.EditContainerEnvironmentVariable(context.Background(), containerId, environmentVariableId).EnvironmentVariableEditRequest(environmentVariableEditRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ContainerEnvironmentVariableAPI.EditContainerEnvironmentVariable``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `EditContainerEnvironmentVariable`: EnvironmentVariable
	fmt.Fprintf(os.Stdout, "Response from `ContainerEnvironmentVariableAPI.EditContainerEnvironmentVariable`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
containerId	string	Container ID
environmentVariableId	string	Environment Variable ID

Other Parameters

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

Name	Type	Description	Notes

environmentVariableEditRequest | EnvironmentVariableEditRequest | |

Return type

EnvironmentVariable

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]

ImportContainerEnvironmentVariable

VariableImport ImportContainerEnvironmentVariable(ctx, containerId).VariableImportRequest(variableImportRequest).Execute()

Import variables

Example

package main

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

func main() {
	containerId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container ID
	variableImportRequest := *openapiclient.NewVariableImportRequest(false, []openapiclient.VariableImportRequestVarsInner{*openapiclient.NewVariableImportRequestVarsInner("Name_example", "Value_example", openapiclient.APIVariableScopeEnum("APPLICATION"), false)}) // VariableImportRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

variableImportRequest | VariableImportRequest | |

Return type

VariableImport

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]

ListContainerEnvironmentVariable

EnvironmentVariableResponseList ListContainerEnvironmentVariable(ctx, containerId).Execute()

List environment variables

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

EnvironmentVariableResponseList

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]

FilesExpand file tree

ContainerEnvironmentVariableAPI.md

Latest commit

History

ContainerEnvironmentVariableAPI.md

File metadata and controls

\ContainerEnvironmentVariableAPI

CreateContainerEnvironmentVariable

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateContainerEnvironmentVariableAlias

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateContainerEnvironmentVariableOverride

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteContainerEnvironmentVariable

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

EditContainerEnvironmentVariable

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ImportContainerEnvironmentVariable

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListContainerEnvironmentVariable

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers