AdminAPI.md

\AdminAPI

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

Method	HTTP request	Description
GetPublicServiceVersion	Get /engine/serviceVersion	Get a service version
ListUserSignUps	Get /admin/listUserSignUp	Search user signups
StoreCliDemoDebugLogs	Post /admin/demoDebugLog	Store CLI demo debug logs

GetPublicServiceVersion

EngineVersionResponse GetPublicServiceVersion(ctx).ServiceType(serviceType).Execute()

Get a service version

Example

package main

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

func main() {
	serviceType := "serviceType_example" // string | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
serviceType	string

Return type

EngineVersionResponse

Authorization

No authorization required

HTTP request headers

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

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

ListUserSignUps

UserSignUpResponseList ListUserSignUps(ctx).Search(search).Execute()

Search user signups

Example

package main

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

func main() {
	search := "search_example" // string | 

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
search	string

Return type

UserSignUpResponseList

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]

StoreCliDemoDebugLogs

StoreCliDemoDebugLogs(ctx).Organization(organization).ClusterName(clusterName).Body(body).Execute()

Store CLI demo debug logs

Example

package main

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

func main() {
	organization := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
	clusterName := "clusterName_example" // string | 
	body := os.NewFile(1234, "some_file") // *os.File |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AdminAPI.StoreCliDemoDebugLogs(context.Background()).Organization(organization).ClusterName(clusterName).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdminAPI.StoreCliDemoDebugLogs``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
organization	string
clusterName	string
body	*os.File

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

• Content-Type: application/octet-stream
• Accept: Not defined

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