Skip to content

DefaultAPI.md

Latest commit

 

History

History
144 lines (93 loc) · 4.47 KB

DefaultAPI.md

File metadata and controls

144 lines (93 loc) · 4.47 KB
Raw

\DefaultAPI

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

Method HTTP request Description
GetClusterTokenByClusterId Get /cluster/{clusterId}/token Get cluster token by clusterId
GetDeploymentStatusByDeploymentRequestId Get /environment/deploymentStatus Get Deployment Status By DeploymentRequestId

GetClusterTokenByClusterId

GetClusterTokenByClusterId200Response GetClusterTokenByClusterId(ctx, clusterId).ReadOnly(readOnly).Execute()

Get cluster token by clusterId

Example

package main

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

func main() {
	clusterId := "clusterId_example" // string | 
	readOnly := true // bool | If true, returns a short-lived token for the qovery-readonly ServiceAccount (bound to view ClusterRole) generated by the cluster-agent (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

readOnly | bool | If true, returns a short-lived token for the qovery-readonly ServiceAccount (bound to view ClusterRole) generated by the cluster-agent |

Return type

GetClusterTokenByClusterId200Response

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]

GetDeploymentStatusByDeploymentRequestId

EnvDeploymentStatus GetDeploymentStatusByDeploymentRequestId(ctx).DeploymentRequestId(deploymentRequestId).Execute()

Get Deployment Status By DeploymentRequestId

Example

package main

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

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

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

Path Parameters

Other Parameters

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

Name Type Description Notes
deploymentRequestId string

Return type

EnvDeploymentStatus

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]