swagger

package module
v0.0.0-...-bdfd0c2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 7, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

README

Go API client for swagger

This api provides dns

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

$ go get github.com/stackitcloud/stackit-dns-api-client-go@latest

Documentation for API Endpoints

All URIs are relative to https://api.dns.stackit.cloud

Class Method HTTP request Description
HealthApi HealthzGet Get /healthz Health route
RecordSetApi V1ProjectsProjectIdZonesZoneIdRrsetsGet Get /v1/projects/{projectId}/zones/{zoneId}/rrsets All get selected RRSets
RecordSetApi V1ProjectsProjectIdZonesZoneIdRrsetsPost Post /v1/projects/{projectId}/zones/{zoneId}/rrsets Post record set
RecordSetApi V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdDelete Delete /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId} Delete a record set
RecordSetApi V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdGet Get /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId} Get a single rrset
RecordSetApi V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdPatch Patch /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId} Patch updates a record set
RecordSetApi V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRecordsPatch Patch /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/records PatchRecords updates a record in a rrset
RecordSetApi V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRestoresPost Post /v1/projects/{projectId}/zones/{zoneId}/rrsets/{rrSetId}/restores Restore record set
ZoneApi V1ProjectsProjectIdZonesGet Get /v1/projects/{projectId}/zones All get selected zones
ZoneApi V1ProjectsProjectIdZonesPost Post /v1/projects/{projectId}/zones Post create a new zone
ZoneApi V1ProjectsProjectIdZonesZoneIdDelete Delete /v1/projects/{projectId}/zones/{zoneId} Delete delete a zone
ZoneApi V1ProjectsProjectIdZonesZoneIdGet Get /v1/projects/{projectId}/zones/{zoneId} Get a single zone
ZoneApi V1ProjectsProjectIdZonesZoneIdPut Put /v1/projects/{projectId}/zones/{zoneId} Put update an existing zone
ZoneApi V1ProjectsProjectIdZonesZoneIdRestoresPost Post /v1/projects/{projectId}/zones/{zoneId}/restores Restore an inactive zone but will not restore the record sets

Documentation For Models

Documentation For Authorization

bearerAuth

Author

stackit-dns@mail.schwarz

Documentation

Overview

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* STACKIT DNS API * * This api provides dns * * API version: 1.0 * Contact: stackit-dns@mail.schwarz * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	HealthApi *HealthApiService

	RecordSetApi *RecordSetApiService

	ZoneApi *ZoneApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the STACKIT DNS API API v1.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type DomainRecord 

type DomainRecord struct {
	// content of the record
	Content string `json:"content"`
	// rr set id
	Id string `json:"id"`
}

Record.

type DomainRrSet 

type DomainRrSet struct {
	// if the record set is active or not
	Active bool `json:"active,omitempty"`
	// comment
	Comment string `json:"comment,omitempty"`
	// when record set creation finished
	CreationFinished string `json:"creationFinished"`
	// when record set creation started
	CreationStarted string `json:"creationStarted"`
	// Error shows error in case create/update/delete failed
	Error_ string `json:"error,omitempty"`
	// rr set id
	Id string `json:"id"`
	// name of the record which should be a valid domain according to rfc1035 Section 2.3.4
	Name string `json:"name"`
	// records
	Records []DomainRecord `json:"records"`
	// record set state
	State string `json:"state"`
	// time to live
	Ttl int32 `json:"ttl"`
	// record set type
	Type_ string `json:"type"`
	// when record set update/deletion finished
	UpdateFinished string `json:"updateFinished"`
	// when record set update/deletion started
	UpdateStarted string `json:"updateStarted"`
}

RRSet.

type DomainUpdateZone 

type DomainUpdateZone struct {
	// access control list
	Acl string `json:"acl,omitempty"`
	// contact e-mail for the zone
	ContactEmail string `json:"contactEmail,omitempty"`
	// default time to live
	DefaultTTL int32 `json:"defaultTTL,omitempty"`
	// description of the zone
	Description string `json:"description,omitempty"`
	// expire time
	ExpireTime int32 `json:"expireTime,omitempty"`
	// user given name
	Name string `json:"name"`
	// refresh time
	RefreshTime int32 `json:"refreshTime,omitempty"`
	// retry time
	RetryTime int32 `json:"retryTime,omitempty"`
}

type DomainZone 

type DomainZone struct {
	// access control list
	Acl string `json:"acl"`
	// contact email from soa record
	ContactEmail string `json:"contactEmail,omitempty"`
	// when zone creation finished
	CreationFinished string `json:"creationFinished"`
	// when zone creation started
	CreationStarted string `json:"creationStarted"`
	// default time to live
	DefaultTTL int32 `json:"defaultTTL"`
	// description of the zone
	Description string `json:"description"`
	// zone name
	DnsName string `json:"dnsName"`
	// Error shows error in case create/update/delete failed
	Error_ string `json:"error,omitempty"`
	// expire time
	ExpireTime int32 `json:"expireTime"`
	// zone id
	Id string `json:"id"`
	// if the zone is a reverse zone or not
	IsReverseZone bool `json:"isReverseZone,omitempty"`
	// user given name
	Name string `json:"name"`
	// negative caching
	NegativeCache int32 `json:"negativeCache"`
	// primary name server for secondary zone
	Primaries []string `json:"primaries,omitempty"`
	// primary name server. FQDN
	PrimaryNameServer string `json:"primaryNameServer"`
	// record count how many records are in the zone
	RecordCount int32 `json:"recordCount,omitempty"`
	// refresh time
	RefreshTime int32 `json:"refreshTime"`
	// retry time
	RetryTime int32 `json:"retryTime"`
	// serial number
	SerialNumber int32 `json:"serialNumber"`
	// zone state
	State string `json:"state"`
	// zone type
	Type_ string `json:"type"`
	// when zone update/deletion finished
	UpdateFinished string `json:"updateFinished"`
	// when zone update/deletion started
	UpdateStarted string `json:"updateStarted"`
	// visibility of the zone
	Visibility string `json:"visibility"`
}

Zone.

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type HealthApiService 

type HealthApiService service

func (*HealthApiService) HealthzGet 

func (a *HealthApiService) HealthzGet(ctx context.Context) (SerializerMessage, *http.Response, error)

HealthApiService Health route Health route

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SerializerMessage

type RecordSetApiService 

type RecordSetApiService service

func (*RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsGet 

func (a *RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsGet(ctx context.Context, projectId string, zoneId string, localVarOptionals *RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsGetOpts) (RrsetResponseRrSetAll, *http.Response, error)

func (*RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsPost 

func (a *RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsPost(ctx context.Context, body RrsetRrSetPost, projectId string, zoneId string) (RrsetResponseRrSet, *http.Response, error)

RecordSetApiService Post record set Post record set

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body record set to create
  • @param projectId project id
  • @param zoneId zone id

@return RrsetResponseRrSet

func (*RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdDelete 

func (a *RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdDelete(ctx context.Context, projectId string, zoneId string, rrSetId string) (SerializerMessage, *http.Response, error)

RecordSetApiService Delete a record set Delete a record set

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId project id
  • @param zoneId zone id
  • @param rrSetId record set id

@return SerializerMessage

func (*RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdGet 

func (a *RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdGet(ctx context.Context, projectId string, zoneId string, rrSetId string) (RrsetResponseRrSet, *http.Response, error)

RecordSetApiService Get a single rrset Get rrset

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId project id
  • @param zoneId zone id
  • @param rrSetId record set id

@return RrsetResponseRrSet

func (*RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdPatch 

func (a *RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdPatch(ctx context.Context, body RrsetRrSetPatch, projectId string, zoneId string, rrSetId string) (RrsetResponseRrSet, *http.Response, error)

RecordSetApiService Patch updates a record set Patch record set

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body record set to patch
  • @param projectId project id
  • @param zoneId zone id
  • @param rrSetId record set id

@return RrsetResponseRrSet

func (*RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRecordsPatch 

func (a *RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRecordsPatch(ctx context.Context, body RrsetRecordPatch, projectId string, zoneId string, rrSetId string) (RrsetResponseRrSet, *http.Response, error)

RecordSetApiService PatchRecords updates a record in a rrset PatchRecords rrset updates a record in a rrset

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body rrset to update
  • @param projectId project id
  • @param zoneId zone id
  • @param rrSetId record set id

@return RrsetResponseRrSet

func (*RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRestoresPost 

func (a *RecordSetApiService) V1ProjectsProjectIdZonesZoneIdRrsetsRrSetIdRestoresPost(ctx context.Context, projectId string, zoneId string, rrSetId string) (SerializerMessage, *http.Response, error)

RecordSetApiService Restore record set Restore record set

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId project id
  • @param zoneId zone id
  • @param rrSetId record set id

@return SerializerMessage

type RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsGetOpts 

type RecordSetApiV1ProjectsProjectIdZonesZoneIdRrsetsGetOpts struct {
	Page                    optional.Int32
	PageSize                optional.Int32
	NameEq                  optional.String
	NameLike                optional.String
	TypeEq                  optional.String
	ActiveEq                optional.Bool
	CreationStartedGt       optional.String
	CreationStartedLt       optional.String
	CreationStartedGte      optional.String
	CreationStartedLte      optional.String
	CreationFinishedGt      optional.String
	CreationFinishedLt      optional.String
	CreationFinishedGte     optional.String
	CreationFinishedLte     optional.String
	UpdateStartedGt         optional.String
	UpdateStartedLt         optional.String
	UpdateStartedGte        optional.String
	UpdateStartedLte        optional.String
	UpdateFinishedGt        optional.String
	UpdateFinishedLt        optional.String
	UpdateFinishedGte       optional.String
	UpdateFinishedLte       optional.String
	OrderByName             optional.String
	OrderByCreationStarted  optional.String
	OrderByCreationFinished optional.String
	OrderByUpdateStarted    optional.String
	OrderByUpdateFinished   optional.String
}

type RrsetRecordPatch 

type RrsetRecordPatch struct {
	Action string `json:"action"`
	// records
	Records []RrsetRecordPost `json:"records"`
}

RecordPatch for record patch in record set.

type RrsetRecordPost 

type RrsetRecordPost struct {
	// content of the record
	Content string `json:"content"`
}

RecordPost for rr set info.

type RrsetResponseRrSet 

type RrsetResponseRrSet struct {
	Message string       `json:"message,omitempty"`
	Rrset   *DomainRrSet `json:"rrset"`
}

ResponseRRSet for rr set info.

type RrsetResponseRrSetAll 

type RrsetResponseRrSetAll struct {
	ItemsPerPage int32         `json:"itemsPerPage"`
	Message      string        `json:"message,omitempty"`
	RrSets       []DomainRrSet `json:"rrSets"`
	TotalItems   int32         `json:"totalItems"`
	TotalPages   int32         `json:"totalPages"`
}

ResponseRRSetAll.

type RrsetRrSetPatch 

type RrsetRrSetPatch struct {
	// user comment
	Comment string `json:"comment,omitempty"`
	// rfc1035 Section 2.3.4
	Name string `json:"name,omitempty"`
	// records
	Records []RrsetRecordPost `json:"records,omitempty"`
	// time to live
	Ttl int32 `json:"ttl,omitempty"`
}

RRSetPatch for rr patch set info.

type RrsetRrSetPost 

type RrsetRrSetPost struct {
	// user comment
	Comment string `json:"comment,omitempty"`
	// name of the record which should be a valid domain according to rfc1035 Section 2.3.4
	Name string `json:"name"`
	// records
	Records []RrsetRecordPost `json:"records"`
	// time to live
	Ttl int32 `json:"ttl"`
	// record set type
	Type_ string `json:"type"`
}

RRSetPost for rr set info.

type SerializerMessage 

type SerializerMessage struct {
	Message string `json:"message,omitempty"`
}

type ZoneApiService 

type ZoneApiService service

func (*ZoneApiService) V1ProjectsProjectIdZonesGet 

func (a *ZoneApiService) V1ProjectsProjectIdZonesGet(ctx context.Context, projectId string, localVarOptionals *ZoneApiV1ProjectsProjectIdZonesGetOpts) (ZoneResponseZoneAll, *http.Response, error)

func (*ZoneApiService) V1ProjectsProjectIdZonesPost 

func (a *ZoneApiService) V1ProjectsProjectIdZonesPost(ctx context.Context, body ZoneZonePost, projectId string) (ZoneResponseZone, *http.Response, error)

ZoneApiService Post create a new zone Post zone create a new zone

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body zone to create
  • @param projectId project id

@return ZoneResponseZone

func (*ZoneApiService) V1ProjectsProjectIdZonesZoneIdDelete 

func (a *ZoneApiService) V1ProjectsProjectIdZonesZoneIdDelete(ctx context.Context, projectId string, zoneId string) (SerializerMessage, *http.Response, error)

ZoneApiService Delete delete a zone Delete delete a zone

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId project id
  • @param zoneId zone id

@return SerializerMessage

func (*ZoneApiService) V1ProjectsProjectIdZonesZoneIdGet 

func (a *ZoneApiService) V1ProjectsProjectIdZonesZoneIdGet(ctx context.Context, projectId string, zoneId string) (ZoneResponseZone, *http.Response, error)

ZoneApiService Get a single zone Get zone

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId project id
  • @param zoneId zone id

@return ZoneResponseZone

func (*ZoneApiService) V1ProjectsProjectIdZonesZoneIdPut 

func (a *ZoneApiService) V1ProjectsProjectIdZonesZoneIdPut(ctx context.Context, body DomainUpdateZone, projectId string, zoneId string) (ZoneResponseZone, *http.Response, error)

ZoneApiService Put update an existing zone Put update an existing zone

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body zone to update
  • @param projectId project id
  • @param zoneId zone id

@return ZoneResponseZone

func (*ZoneApiService) V1ProjectsProjectIdZonesZoneIdRestoresPost 

func (a *ZoneApiService) V1ProjectsProjectIdZonesZoneIdRestoresPost(ctx context.Context, projectId string, zoneId string) (SerializerMessage, *http.Response, error)

ZoneApiService Restore an inactive zone but will not restore the record sets Restore an inactive zone but will not restore the record sets

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId project id
  • @param zoneId zone id

@return SerializerMessage

type ZoneApiV1ProjectsProjectIdZonesGetOpts 

type ZoneApiV1ProjectsProjectIdZonesGetOpts struct {
	Page                    optional.Int32
	PageSize                optional.Int32
	DnsNameEq               optional.String
	DnsNameLike             optional.String
	TypeEq                  optional.String
	PrimaryNameServerEq     optional.String
	PrimaryNameServerLike   optional.String
	IsReverseZoneEq         optional.Bool
	ActiveEq                optional.Bool
	CreationStartedGt       optional.String
	CreationStartedLt       optional.String
	CreationStartedGte      optional.String
	CreationStartedLte      optional.String
	CreationFinishedGt      optional.String
	CreationFinishedLt      optional.String
	CreationFinishedGte     optional.String
	CreationFinishedLte     optional.String
	UpdateStartedGt         optional.String
	UpdateStartedLt         optional.String
	UpdateStartedGte        optional.String
	UpdateStartedLte        optional.String
	UpdateFinishedGt        optional.String
	UpdateFinishedLt        optional.String
	UpdateFinishedGte       optional.String
	UpdateFinishedLte       optional.String
	OrderByDnsName          optional.String
	OrderByCreationStarted  optional.String
	OrderByCreationFinished optional.String
	OrderByUpdateStarted    optional.String
	OrderByUpdateFinished   optional.String
}

type ZoneResponseZone 

type ZoneResponseZone struct {
	Message string      `json:"message,omitempty"`
	Zone    *DomainZone `json:"zone"`
}

ResponseZone for user info.

type ZoneResponseZoneAll 

type ZoneResponseZoneAll struct {
	ItemsPerPage int32        `json:"ItemsPerPage"`
	Message      string       `json:"message,omitempty"`
	TotalItems   int32        `json:"totalItems"`
	TotalPages   int32        `json:"totalPages"`
	Zones        []DomainZone `json:"zones"`
}

ResponseZoneAll for filtered zones.

type ZoneZonePost 

type ZoneZonePost struct {
	// access control list
	Acl string `json:"acl,omitempty"`
	// contact e-mail for the zone
	ContactEmail string `json:"contactEmail,omitempty"`
	// default time to live
	DefaultTTL int32 `json:"defaultTTL,omitempty"`
	// description of the zone
	Description string `json:"description,omitempty"`
	// zone name
	DnsName string `json:"dnsName"`
	// expire time
	ExpireTime int32 `json:"expireTime,omitempty"`
	// if the zone is a reverse zone or not
	IsReverseZone bool `json:"isReverseZone,omitempty"`
	// user given name
	Name string `json:"name"`
	// primary name server for secondary zone
	Primaries []string `json:"primaries,omitempty"`
	// primary name server. FQDN
	PrimaryNameServer string `json:"primaryNameServer,omitempty"`
	// refresh time
	RefreshTime int32 `json:"refreshTime,omitempty"`
	// retry time
	RetryTime int32 `json:"retryTime,omitempty"`
	// zone type
	Type_ string `json:"type,omitempty"`
}

Zone to create.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.