Documentation
¶
Index ¶
- type DNSSECDNSSEC
- type DNSSECDNSSECStatus
- type DNSSECDeleteParams
- type DNSSECDeleteResponse
- type DNSSECDeleteResponseEnvelope
- type DNSSECDeleteResponseEnvelopeErrors
- type DNSSECDeleteResponseEnvelopeMessages
- type DNSSECDeleteResponseEnvelopeSuccess
- type DNSSECEditParams
- type DNSSECEditParamsStatus
- type DNSSECEditResponseEnvelope
- type DNSSECEditResponseEnvelopeErrors
- type DNSSECEditResponseEnvelopeMessages
- type DNSSECEditResponseEnvelopeSuccess
- type DNSSECGetParams
- type DNSSECGetResponseEnvelope
- type DNSSECGetResponseEnvelopeErrors
- type DNSSECGetResponseEnvelopeMessages
- type DNSSECGetResponseEnvelopeSuccess
- type DNSSECService
- func (r *DNSSECService) Delete(ctx context.Context, body DNSSECDeleteParams, opts ...option.RequestOption) (res *DNSSECDeleteResponse, err error)
- func (r *DNSSECService) Edit(ctx context.Context, params DNSSECEditParams, opts ...option.RequestOption) (res *DNSSECDNSSEC, err error)
- func (r *DNSSECService) Get(ctx context.Context, query DNSSECGetParams, opts ...option.RequestOption) (res *DNSSECDNSSEC, err error)
- type Error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DNSSECDNSSEC ¶
type DNSSECDNSSEC struct {
// Algorithm key code.
Algorithm string `json:"algorithm,nullable"`
// Digest hash.
Digest string `json:"digest,nullable"`
// Type of digest algorithm.
DigestAlgorithm string `json:"digest_algorithm,nullable"`
// Coded type for digest algorithm.
DigestType string `json:"digest_type,nullable"`
// If true, multi-signer DNSSEC is enabled on the zone, allowing multiple providers
// to serve a DNSSEC-signed zone at the same time. This is required for DNSKEY
// records (except those automatically generated by Cloudflare) to be added to the
// zone.
//
// See
// [Multi-signer DNSSEC](https://developers.cloudflare.com/dns/dnssec/multi-signer-dnssec/)
// for details.
DNSSECMultiSigner bool `json:"dnssec_multi_signer"`
// If true, allows Cloudflare to transfer in a DNSSEC-signed zone including
// signatures from an external provider, without requiring Cloudflare to sign any
// records on the fly.
//
// Note that this feature has some limitations. See
// [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup/#dnssec)
// for details.
DNSSECPresigned bool `json:"dnssec_presigned"`
// Full DS record.
DS string `json:"ds,nullable"`
// Flag for DNSSEC record.
Flags float64 `json:"flags,nullable"`
// Code for key tag.
KeyTag float64 `json:"key_tag,nullable"`
// Algorithm key type.
KeyType string `json:"key_type,nullable"`
// When DNSSEC was last modified.
ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
// Public key for DS record.
PublicKey string `json:"public_key,nullable"`
// Status of DNSSEC, based on user-desired state and presence of necessary records.
Status DNSSECDNSSECStatus `json:"status"`
JSON dnssecdnssecJSON `json:"-"`
}
func (*DNSSECDNSSEC) UnmarshalJSON ¶
func (r *DNSSECDNSSEC) UnmarshalJSON(data []byte) (err error)
type DNSSECDNSSECStatus ¶
type DNSSECDNSSECStatus string
Status of DNSSEC, based on user-desired state and presence of necessary records.
const ( DNSSECDNSSECStatusActive DNSSECDNSSECStatus = "active" DNSSECDNSSECStatusPending DNSSECDNSSECStatus = "pending" DNSSECDNSSECStatusDisabled DNSSECDNSSECStatus = "disabled" DNSSECDNSSECStatusPendingDisabled DNSSECDNSSECStatus = "pending-disabled" DNSSECDNSSECStatusError DNSSECDNSSECStatus = "error" )
func (DNSSECDNSSECStatus) IsKnown ¶
func (r DNSSECDNSSECStatus) IsKnown() bool
type DNSSECDeleteParams ¶
type DNSSECDeleteResponse ¶
type DNSSECDeleteResponse interface {
ImplementsDNSSECDNSSECDeleteResponse()
}
Union satisfied by dnssec.DNSSECDeleteResponseUnknown or shared.UnionString.
type DNSSECDeleteResponseEnvelope ¶
type DNSSECDeleteResponseEnvelope struct {
Errors []DNSSECDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []DNSSECDeleteResponseEnvelopeMessages `json:"messages,required"`
Result DNSSECDeleteResponse `json:"result,required"`
// Whether the API call was successful
Success DNSSECDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON dnssecDeleteResponseEnvelopeJSON `json:"-"`
}
func (*DNSSECDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSECDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSECDeleteResponseEnvelopeErrors ¶
type DNSSECDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON dnssecDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DNSSECDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *DNSSECDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DNSSECDeleteResponseEnvelopeMessages ¶
type DNSSECDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON dnssecDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DNSSECDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *DNSSECDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DNSSECDeleteResponseEnvelopeSuccess ¶
type DNSSECDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
DNSSECDeleteResponseEnvelopeSuccessTrue DNSSECDeleteResponseEnvelopeSuccess = true
)
func (DNSSECDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r DNSSECDeleteResponseEnvelopeSuccess) IsKnown() bool
type DNSSECEditParams ¶
type DNSSECEditParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
// If true, multi-signer DNSSEC is enabled on the zone, allowing multiple providers
// to serve a DNSSEC-signed zone at the same time. This is required for DNSKEY
// records (except those automatically generated by Cloudflare) to be added to the
// zone.
//
// See
// [Multi-signer DNSSEC](https://developers.cloudflare.com/dns/dnssec/multi-signer-dnssec/)
// for details.
DNSSECMultiSigner param.Field[bool] `json:"dnssec_multi_signer"`
// If true, allows Cloudflare to transfer in a DNSSEC-signed zone including
// signatures from an external provider, without requiring Cloudflare to sign any
// records on the fly.
//
// Note that this feature has some limitations. See
// [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup/#dnssec)
// for details.
DNSSECPresigned param.Field[bool] `json:"dnssec_presigned"`
// Status of DNSSEC, based on user-desired state and presence of necessary records.
Status param.Field[DNSSECEditParamsStatus] `json:"status"`
}
func (DNSSECEditParams) MarshalJSON ¶
func (r DNSSECEditParams) MarshalJSON() (data []byte, err error)
type DNSSECEditParamsStatus ¶
type DNSSECEditParamsStatus string
Status of DNSSEC, based on user-desired state and presence of necessary records.
const ( DNSSECEditParamsStatusActive DNSSECEditParamsStatus = "active" DNSSECEditParamsStatusDisabled DNSSECEditParamsStatus = "disabled" )
func (DNSSECEditParamsStatus) IsKnown ¶
func (r DNSSECEditParamsStatus) IsKnown() bool
type DNSSECEditResponseEnvelope ¶
type DNSSECEditResponseEnvelope struct {
Errors []DNSSECEditResponseEnvelopeErrors `json:"errors,required"`
Messages []DNSSECEditResponseEnvelopeMessages `json:"messages,required"`
Result DNSSECDNSSEC `json:"result,required"`
// Whether the API call was successful
Success DNSSECEditResponseEnvelopeSuccess `json:"success,required"`
JSON dnssecEditResponseEnvelopeJSON `json:"-"`
}
func (*DNSSECEditResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSECEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSECEditResponseEnvelopeErrors ¶
type DNSSECEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON dnssecEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DNSSECEditResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *DNSSECEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DNSSECEditResponseEnvelopeMessages ¶
type DNSSECEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON dnssecEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DNSSECEditResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *DNSSECEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DNSSECEditResponseEnvelopeSuccess ¶
type DNSSECEditResponseEnvelopeSuccess bool
Whether the API call was successful
const (
DNSSECEditResponseEnvelopeSuccessTrue DNSSECEditResponseEnvelopeSuccess = true
)
func (DNSSECEditResponseEnvelopeSuccess) IsKnown ¶
func (r DNSSECEditResponseEnvelopeSuccess) IsKnown() bool
type DNSSECGetParams ¶
type DNSSECGetResponseEnvelope ¶
type DNSSECGetResponseEnvelope struct {
Errors []DNSSECGetResponseEnvelopeErrors `json:"errors,required"`
Messages []DNSSECGetResponseEnvelopeMessages `json:"messages,required"`
Result DNSSECDNSSEC `json:"result,required"`
// Whether the API call was successful
Success DNSSECGetResponseEnvelopeSuccess `json:"success,required"`
JSON dnssecGetResponseEnvelopeJSON `json:"-"`
}
func (*DNSSECGetResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSECGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSECGetResponseEnvelopeErrors ¶
type DNSSECGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON dnssecGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*DNSSECGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *DNSSECGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type DNSSECGetResponseEnvelopeMessages ¶
type DNSSECGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
JSON dnssecGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*DNSSECGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *DNSSECGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type DNSSECGetResponseEnvelopeSuccess ¶
type DNSSECGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
DNSSECGetResponseEnvelopeSuccessTrue DNSSECGetResponseEnvelopeSuccess = true
)
func (DNSSECGetResponseEnvelopeSuccess) IsKnown ¶
func (r DNSSECGetResponseEnvelopeSuccess) IsKnown() bool
type DNSSECService ¶
type DNSSECService struct {
Options []option.RequestOption
}
DNSSECService contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDNSSECService method instead.
func NewDNSSECService ¶
func NewDNSSECService(opts ...option.RequestOption) (r *DNSSECService)
NewDNSSECService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*DNSSECService) Delete ¶
func (r *DNSSECService) Delete(ctx context.Context, body DNSSECDeleteParams, opts ...option.RequestOption) (res *DNSSECDeleteResponse, err error)
Delete DNSSEC.
func (*DNSSECService) Edit ¶
func (r *DNSSECService) Edit(ctx context.Context, params DNSSECEditParams, opts ...option.RequestOption) (res *DNSSECDNSSEC, err error)
Enable or disable DNSSEC.
func (*DNSSECService) Get ¶
func (r *DNSSECService) Get(ctx context.Context, query DNSSECGetParams, opts ...option.RequestOption) (res *DNSSECDNSSEC, err error)
Details about DNSSEC status and configuration.