Skip to content

Latest commit

 

History

History
450 lines (288 loc) · 15 KB

EnvironmentVariableAPI.md

File metadata and controls

450 lines (288 loc) · 15 KB

\EnvironmentVariableAPI

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

Method HTTP request Description
CreateEnvironmentEnvironmentVariable Post /environment/{environmentId}/environmentVariable Add an environment variable to the environment
CreateEnvironmentEnvironmentVariableAlias Post /environment/{environmentId}/environmentVariable/{environmentVariableId}/alias Create an environment variable alias at the environment level
CreateEnvironmentEnvironmentVariableOverride Post /environment/{environmentId}/environmentVariable/{environmentVariableId}/override Create an environment variable override at the environment level
DeleteEnvironmentEnvironmentVariable Delete /environment/{environmentId}/environmentVariable/{environmentVariableId} Delete an environment variable from an environment
EditEnvironmentEnvironmentVariable Put /environment/{environmentId}/environmentVariable/{environmentVariableId} Edit an environment variable belonging to the environment
ListEnvironmentEnvironmentVariable Get /environment/{environmentId}/environmentVariable List environment variables

CreateEnvironmentEnvironmentVariable

EnvironmentVariable CreateEnvironmentEnvironmentVariable(ctx, environmentId).EnvironmentVariableRequest(environmentVariableRequest).Execute()

Add an environment variable to the environment

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

CreateEnvironmentEnvironmentVariableAlias

EnvironmentVariable CreateEnvironmentEnvironmentVariableAlias(ctx, environmentId, environmentVariableId).Key(key).Execute()

Create an environment variable alias at the environment level

Example

package main

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

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment 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.EnvironmentVariableAPI.CreateEnvironmentEnvironmentVariableAlias(context.Background(), environmentId, environmentVariableId).Key(key).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentVariableAPI.CreateEnvironmentEnvironmentVariableAlias``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateEnvironmentEnvironmentVariableAlias`: EnvironmentVariable
	fmt.Fprintf(os.Stdout, "Response from `EnvironmentVariableAPI.CreateEnvironmentEnvironmentVariableAlias`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

CreateEnvironmentEnvironmentVariableOverride

EnvironmentVariable CreateEnvironmentEnvironmentVariableOverride(ctx, environmentId, environmentVariableId).Value(value).Execute()

Create an environment variable override at the environment level

Example

package main

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

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment 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.EnvironmentVariableAPI.CreateEnvironmentEnvironmentVariableOverride(context.Background(), environmentId, environmentVariableId).Value(value).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentVariableAPI.CreateEnvironmentEnvironmentVariableOverride``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateEnvironmentEnvironmentVariableOverride`: EnvironmentVariable
	fmt.Fprintf(os.Stdout, "Response from `EnvironmentVariableAPI.CreateEnvironmentEnvironmentVariableOverride`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

DeleteEnvironmentEnvironmentVariable

DeleteEnvironmentEnvironmentVariable(ctx, environmentId, environmentVariableId).Execute()

Delete an environment variable from an environment

Example

package main

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

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

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.EnvironmentVariableAPI.DeleteEnvironmentEnvironmentVariable(context.Background(), environmentId, environmentVariableId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentVariableAPI.DeleteEnvironmentEnvironmentVariable``: %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.
environmentId string Environment ID
environmentVariableId string Environment Variable ID

Other Parameters

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

EditEnvironmentEnvironmentVariable

EnvironmentVariable EditEnvironmentEnvironmentVariable(ctx, environmentId, environmentVariableId).EnvironmentVariableEditRequest(environmentVariableEditRequest).Execute()

Edit an environment variable belonging to the environment

Example

package main

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

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment 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.EnvironmentVariableAPI.EditEnvironmentEnvironmentVariable(context.Background(), environmentId, environmentVariableId).EnvironmentVariableEditRequest(environmentVariableEditRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentVariableAPI.EditEnvironmentEnvironmentVariable``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `EditEnvironmentEnvironmentVariable`: EnvironmentVariable
	fmt.Fprintf(os.Stdout, "Response from `EnvironmentVariableAPI.EditEnvironmentEnvironmentVariable`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

ListEnvironmentEnvironmentVariable

EnvironmentVariableResponseList ListEnvironmentEnvironmentVariable(ctx, environmentId).Execute()

List environment variables

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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