Skip to content

Latest commit

 

History

History
398 lines (255 loc) · 11.6 KB

CustomDomainApiAPI.md

File metadata and controls

398 lines (255 loc) · 11.6 KB

\CustomDomainApiAPI

All URIs are relative to https://api.omnistrate.cloud

Method HTTP request Description
CustomDomainApiCreateCustomDomain Post /2022-09-01-00/customdomain CreateCustomDomain custom-domain-api
CustomDomainApiCustomDomainIdentityID Get /2022-09-01-00/customdomain/identityid CustomDomainIdentityID custom-domain-api
CustomDomainApiDeleteCustomDomain Delete /2022-09-01-00/customdomain/{id} DeleteCustomDomain custom-domain-api
CustomDomainApiDescribeCustomDomain Get /2022-09-01-00/customdomain/{id} DescribeCustomDomain custom-domain-api
CustomDomainApiListCustomDomain Get /2022-09-01-00/customdomain ListCustomDomain custom-domain-api
CustomDomainApiVerifyCustomDomain Post /2022-09-01-00/customdomain/verify/{id} VerifyCustomDomain custom-domain-api

CustomDomainApiCreateCustomDomain

string CustomDomainApiCreateCustomDomain(ctx).CreateCustomDomainRequest2(createCustomDomainRequest2).Execute()

CreateCustomDomain custom-domain-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	createCustomDomainRequest2 := *openapiclient.NewCreateCustomDomainRequest2("mydomain.dev", "Description of the domain", "Dev domain", *openapiclient.NewRoute53Configuration("123456789012")) // CreateCustomDomainRequest2 | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createCustomDomainRequest2 CreateCustomDomainRequest2

Return type

string

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/vnd.goa.error

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

CustomDomainApiCustomDomainIdentityID

CustomDomainIdentityIDResult CustomDomainApiCustomDomainIdentityID(ctx).Execute()

CustomDomainIdentityID custom-domain-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

CustomDomainIdentityIDResult

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.goa.error

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

CustomDomainApiDeleteCustomDomain

CustomDomainApiDeleteCustomDomain(ctx, id).Execute()

DeleteCustomDomain custom-domain-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	id := "cd-12345678" // string | custom domain ID to operate on

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CustomDomainApiAPI.CustomDomainApiDeleteCustomDomain(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CustomDomainApiAPI.CustomDomainApiDeleteCustomDomain``: %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.
id string custom domain ID to operate on

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.goa.error

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

CustomDomainApiDescribeCustomDomain

DescribeCustomDomainResult CustomDomainApiDescribeCustomDomain(ctx, id).Execute()

DescribeCustomDomain custom-domain-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	id := "cd-12345678" // string | custom domain ID to operate on

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string custom domain ID to operate on

Other Parameters

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

Name Type Description Notes

Return type

DescribeCustomDomainResult

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.goa.error

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

CustomDomainApiListCustomDomain

ListCustomDomainResult CustomDomainApiListCustomDomain(ctx).Execute()

ListCustomDomain custom-domain-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ListCustomDomainResult

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.goa.error

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

CustomDomainApiVerifyCustomDomain

CustomDomainApiVerifyCustomDomain(ctx, id).Execute()

VerifyCustomDomain custom-domain-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	id := "cd-12345678" // string | custom domain ID to operate on

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.CustomDomainApiAPI.CustomDomainApiVerifyCustomDomain(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CustomDomainApiAPI.CustomDomainApiVerifyCustomDomain``: %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.
id string custom domain ID to operate on

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.goa.error

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