Skip to content

Latest commit

 

History

History
452 lines (294 loc) · 12.2 KB

DomainsAPI.md

File metadata and controls

452 lines (294 loc) · 12.2 KB

\DomainsAPI

All URIs are relative to https://api.azionapi.net

Method HTTP request Description
CreateDomain Post /domains /domains
DelDomain Delete /domains/{id} /domains/:id
GetDomain Get /domains/{id} /domains/:id
GetDomains Get /domains /domains
PutDomain Put /domains/{id} /domains:/:id
UpdateDomain Patch /domains/{id} /domains/:id

CreateDomain

DomainResponseWithResult CreateDomain(ctx).Accept(accept).ContentType(contentType).CreateDomainRequest(createDomainRequest).Execute()

/domains

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	accept := "application/json; version=3" // string |  (optional)
	contentType := "application/json" // string |  (optional)
	createDomainRequest := *openapiclient.NewCreateDomainRequest("Name_example", []string{"Cnames_example"}, int64(123)) // CreateDomainRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DomainsAPI.CreateDomain(context.Background()).Accept(accept).ContentType(contentType).CreateDomainRequest(createDomainRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DomainsAPI.CreateDomain``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateDomain`: DomainResponseWithResult
	fmt.Fprintf(os.Stdout, "Response from `DomainsAPI.CreateDomain`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
accept string
contentType string
createDomainRequest CreateDomainRequest

Return type

DomainResponseWithResult

Authorization

tokenAuth

HTTP request headers

  • Content-Type: application/json; version=3
  • Accept: application/json; version=3

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

DelDomain

DelDomain(ctx, id).Accept(accept).Execute()

/domains/:id

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	id := "id_example" // string | The id of the domain to be deleted. 
	accept := "application/json; version=3" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.DomainsAPI.DelDomain(context.Background(), id).Accept(accept).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DomainsAPI.DelDomain``: %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 The id of the domain to be deleted.

Other Parameters

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

Name Type Description Notes

accept | string | |

Return type

(empty response body)

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetDomain

DomainResponseWithResult GetDomain(ctx, id).Accept(accept).Execute()

/domains/:id

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	id := "id_example" // string | The id of the domain to be consulted. 
	accept := "application/json; version=3" // string |  (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string The id of the domain to be consulted.

Other Parameters

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

Name Type Description Notes

accept | string | |

Return type

DomainResponseWithResult

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; version=3

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

GetDomains

DomainResponseWithResults GetDomains(ctx).Page(page).PageSize(pageSize).Sort(sort).OrderBy(orderBy).Accept(accept).Execute()

/domains

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	page := int64(789) // int64 |  (optional)
	pageSize := int64(789) // int64 |  (optional)
	sort := "sort_example" // string |  (optional)
	orderBy := "orderBy_example" // string |  (optional)
	accept := "application/json; version=3" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DomainsAPI.GetDomains(context.Background()).Page(page).PageSize(pageSize).Sort(sort).OrderBy(orderBy).Accept(accept).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DomainsAPI.GetDomains``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDomains`: DomainResponseWithResults
	fmt.Fprintf(os.Stdout, "Response from `DomainsAPI.GetDomains`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
page int64
pageSize int64
sort string
orderBy string
accept string

Return type

DomainResponseWithResults

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; version=3

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

PutDomain

DomainResponseWithResult PutDomain(ctx, id).Accept(accept).ContentType(contentType).PutDomainRequest(putDomainRequest).Execute()

/domains:/:id

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	id := "id_example" // string | 
	accept := "application/json; version=3" // string |  (optional)
	contentType := "application/json" // string |  (optional)
	putDomainRequest := *openapiclient.NewPutDomainRequest("Name_example", []string{"Cnames_example"}, int64(123)) // PutDomainRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DomainsAPI.PutDomain(context.Background(), id).Accept(accept).ContentType(contentType).PutDomainRequest(putDomainRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DomainsAPI.PutDomain``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutDomain`: DomainResponseWithResult
	fmt.Fprintf(os.Stdout, "Response from `DomainsAPI.PutDomain`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

accept | string | | contentType | string | | putDomainRequest | PutDomainRequest | |

Return type

DomainResponseWithResult

Authorization

tokenAuth

HTTP request headers

  • Content-Type: application/json; version=3
  • Accept: application/json; version=3

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

UpdateDomain

DomainResponseWithResult UpdateDomain(ctx, id).Accept(accept).ContentType(contentType).UpdateDomainRequest(updateDomainRequest).Execute()

/domains/:id

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	id := "id_example" // string | 
	accept := "application/json; version=3" // string |  (optional)
	contentType := "application/json" // string |  (optional)
	updateDomainRequest := *openapiclient.NewUpdateDomainRequest() // UpdateDomainRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DomainsAPI.UpdateDomain(context.Background(), id).Accept(accept).ContentType(contentType).UpdateDomainRequest(updateDomainRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DomainsAPI.UpdateDomain``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateDomain`: DomainResponseWithResult
	fmt.Fprintf(os.Stdout, "Response from `DomainsAPI.UpdateDomain`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

accept | string | | contentType | string | | updateDomainRequest | UpdateDomainRequest | |

Return type

DomainResponseWithResult

Authorization

tokenAuth

HTTP request headers

  • Content-Type: application/json; version=3
  • Accept: application/json; version=3

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