All URIs are relative to https://api.qovery.com
| Method | HTTP request | Description |
|---|---|---|
| CheckApplicationCustomDomain | Get /application/{applicationId}/checkCustomDomain | Check Application Custom Domain |
| CreateApplicationCustomDomain | Post /application/{applicationId}/customDomain | Add custom domain to the application. |
| DeleteCustomDomain | Delete /application/{applicationId}/customDomain/{customDomainId} | Delete a Custom Domain |
| EditCustomDomain | Put /application/{applicationId}/customDomain/{customDomainId} | Edit a Custom Domain |
| GetCustomDomainStatus | Get /application/{applicationId}/customDomain/{customDomainId}/status | Get Custom Domain status |
| ListApplicationCustomDomain | Get /application/{applicationId}/customDomain | List application custom domains |
CheckedCustomDomainsResponse CheckApplicationCustomDomain(ctx, applicationId).Execute()
Check Application Custom Domain
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.ApplicationCustomDomainAPI.CheckApplicationCustomDomain(context.Background(), applicationId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCustomDomainAPI.CheckApplicationCustomDomain``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CheckApplicationCustomDomain`: CheckedCustomDomainsResponse
fmt.Fprintf(os.Stdout, "Response from `ApplicationCustomDomainAPI.CheckApplicationCustomDomain`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string | Application ID |
Other parameters are passed through a pointer to a apiCheckApplicationCustomDomainRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CustomDomain CreateApplicationCustomDomain(ctx, applicationId).CustomDomainRequest(customDomainRequest).Execute()
Add custom domain to the application.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/qovery/qovery-client-go"
)
func main() {
applicationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Application ID
customDomainRequest := *openapiclient.NewCustomDomainRequest("my.domain.tld", false) // CustomDomainRequest | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationCustomDomainAPI.CreateApplicationCustomDomain(context.Background(), applicationId).CustomDomainRequest(customDomainRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCustomDomainAPI.CreateApplicationCustomDomain``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateApplicationCustomDomain`: CustomDomain
fmt.Fprintf(os.Stdout, "Response from `ApplicationCustomDomainAPI.CreateApplicationCustomDomain`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string | Application ID |
Other parameters are passed through a pointer to a apiCreateApplicationCustomDomainRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
customDomainRequest | CustomDomainRequest | |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteCustomDomain(ctx, applicationId, customDomainId).Execute()
Delete a Custom Domain
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/qovery/qovery-client-go"
)
func main() {
applicationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Application ID
customDomainId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Custom Domain ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.ApplicationCustomDomainAPI.DeleteCustomDomain(context.Background(), applicationId, customDomainId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCustomDomainAPI.DeleteCustomDomain``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string | Application ID | |
| customDomainId | string | Custom Domain ID |
Other parameters are passed through a pointer to a apiDeleteCustomDomainRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CustomDomain EditCustomDomain(ctx, applicationId, customDomainId).CustomDomainRequest(customDomainRequest).Execute()
Edit a Custom Domain
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/qovery/qovery-client-go"
)
func main() {
applicationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Application ID
customDomainId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Custom Domain ID
customDomainRequest := *openapiclient.NewCustomDomainRequest("my.domain.tld", false) // CustomDomainRequest | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationCustomDomainAPI.EditCustomDomain(context.Background(), applicationId, customDomainId).CustomDomainRequest(customDomainRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCustomDomainAPI.EditCustomDomain``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `EditCustomDomain`: CustomDomain
fmt.Fprintf(os.Stdout, "Response from `ApplicationCustomDomainAPI.EditCustomDomain`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string | Application ID | |
| customDomainId | string | Custom Domain ID |
Other parameters are passed through a pointer to a apiEditCustomDomainRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
customDomainRequest | CustomDomainRequest | |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CustomDomain GetCustomDomainStatus(ctx, applicationId, customDomainId).Execute()
Get Custom Domain status
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/qovery/qovery-client-go"
)
func main() {
applicationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Application ID
customDomainId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Custom Domain ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ApplicationCustomDomainAPI.GetCustomDomainStatus(context.Background(), applicationId, customDomainId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCustomDomainAPI.GetCustomDomainStatus``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetCustomDomainStatus`: CustomDomain
fmt.Fprintf(os.Stdout, "Response from `ApplicationCustomDomainAPI.GetCustomDomainStatus`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string | Application ID | |
| customDomainId | string | Custom Domain ID |
Other parameters are passed through a pointer to a apiGetCustomDomainStatusRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CustomDomainResponseList ListApplicationCustomDomain(ctx, applicationId).Execute()
List application custom domains
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.ApplicationCustomDomainAPI.ListApplicationCustomDomain(context.Background(), applicationId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCustomDomainAPI.ListApplicationCustomDomain``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListApplicationCustomDomain`: CustomDomainResponseList
fmt.Fprintf(os.Stdout, "Response from `ApplicationCustomDomainAPI.ListApplicationCustomDomain`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| applicationId | string | Application ID |
Other parameters are passed through a pointer to a apiListApplicationCustomDomainRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]