Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type OriginCACertificate
- type OriginCACertificateDeleteResponse
- type OriginCACertificateDeleteResponseEnvelope
- type OriginCACertificateGetResponseEnvelope
- type OriginCACertificateGetResponseEnvelopeErrors
- type OriginCACertificateGetResponseEnvelopeErrorsSource
- type OriginCACertificateGetResponseEnvelopeMessages
- type OriginCACertificateGetResponseEnvelopeMessagesSource
- type OriginCACertificateGetResponseEnvelopeSuccess
- type OriginCACertificateListParams
- type OriginCACertificateNewParams
- type OriginCACertificateNewResponseEnvelope
- type OriginCACertificateNewResponseEnvelopeErrors
- type OriginCACertificateNewResponseEnvelopeErrorsSource
- type OriginCACertificateNewResponseEnvelopeMessages
- type OriginCACertificateNewResponseEnvelopeMessagesSource
- type OriginCACertificateNewResponseEnvelopeSuccess
- type OriginCACertificateService
- func (r *OriginCACertificateService) Delete(ctx context.Context, certificateID string, opts ...option.RequestOption) (res *OriginCACertificateDeleteResponse, err error)
- func (r *OriginCACertificateService) Get(ctx context.Context, certificateID string, opts ...option.RequestOption) (res *OriginCACertificate, err error)
- func (r *OriginCACertificateService) List(ctx context.Context, query OriginCACertificateListParams, ...) (res *pagination.V4PagePaginationArray[OriginCACertificate], err error)
- func (r *OriginCACertificateService) ListAutoPaging(ctx context.Context, query OriginCACertificateListParams, ...) *pagination.V4PagePaginationArrayAutoPager[OriginCACertificate]
- func (r *OriginCACertificateService) New(ctx context.Context, body OriginCACertificateNewParams, ...) (res *OriginCACertificate, err error)
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type CertificateCA ¶
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶
type CertificateRequestType = shared.CertificateRequestType
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
This is an alias to an internal type.
type CloudflareTunnel ¶
type CloudflareTunnel = shared.CloudflareTunnel
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
type CloudflareTunnelConfigSrc ¶
type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc
Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
This is an alias to an internal type.
type CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
This is an alias to an internal type.
type CloudflareTunnelStatus ¶
type CloudflareTunnelStatus = shared.CloudflareTunnelStatus
The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).
This is an alias to an internal type.
type CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
This is an alias to an internal type.
type ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
type MemberStatus ¶
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUser ¶
type MemberUser = shared.MemberUser
Details of the user associated to the membership.
This is an alias to an internal type.
type OriginCACertificate ¶
type OriginCACertificate struct {
// The Certificate Signing Request (CSR). Must be newline-encoded.
Csr string `json:"csr,required"`
// Array of hostnames or wildcard names (e.g., \*.example.com) bound to the
// certificate.
Hostnames []string `json:"hostnames,required"`
// Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa),
// or "keyless-certificate" (for Keyless SSL servers).
RequestType shared.CertificateRequestType `json:"request_type,required"`
// The number of days for which the certificate should be valid.
RequestedValidity ssl.RequestValidity `json:"requested_validity,required"`
// Identifier.
ID string `json:"id"`
// The Origin CA certificate. Will be newline-encoded.
Certificate string `json:"certificate"`
// When the certificate will expire.
ExpiresOn string `json:"expires_on"`
JSON originCACertificateJSON `json:"-"`
}
func (*OriginCACertificate) UnmarshalJSON ¶
func (r *OriginCACertificate) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateDeleteResponse ¶
type OriginCACertificateDeleteResponse struct {
// Identifier.
ID string `json:"id"`
// When the certificate was revoked.
RevokedAt time.Time `json:"revoked_at" format:"date-time"`
JSON originCACertificateDeleteResponseJSON `json:"-"`
}
func (*OriginCACertificateDeleteResponse) UnmarshalJSON ¶
func (r *OriginCACertificateDeleteResponse) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateDeleteResponseEnvelope ¶
type OriginCACertificateDeleteResponseEnvelope struct {
Result OriginCACertificateDeleteResponse `json:"result"`
JSON originCACertificateDeleteResponseEnvelopeJSON `json:"-"`
}
func (*OriginCACertificateDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *OriginCACertificateDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateGetResponseEnvelope ¶
type OriginCACertificateGetResponseEnvelope struct {
Errors []OriginCACertificateGetResponseEnvelopeErrors `json:"errors,required"`
Messages []OriginCACertificateGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success OriginCACertificateGetResponseEnvelopeSuccess `json:"success,required"`
Result OriginCACertificate `json:"result"`
JSON originCACertificateGetResponseEnvelopeJSON `json:"-"`
}
func (*OriginCACertificateGetResponseEnvelope) UnmarshalJSON ¶
func (r *OriginCACertificateGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateGetResponseEnvelopeErrors ¶
type OriginCACertificateGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginCACertificateGetResponseEnvelopeErrorsSource `json:"source"`
JSON originCACertificateGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*OriginCACertificateGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *OriginCACertificateGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateGetResponseEnvelopeErrorsSource ¶
type OriginCACertificateGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON originCACertificateGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*OriginCACertificateGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *OriginCACertificateGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateGetResponseEnvelopeMessages ¶
type OriginCACertificateGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginCACertificateGetResponseEnvelopeMessagesSource `json:"source"`
JSON originCACertificateGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*OriginCACertificateGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *OriginCACertificateGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateGetResponseEnvelopeMessagesSource ¶
type OriginCACertificateGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON originCACertificateGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*OriginCACertificateGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *OriginCACertificateGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateGetResponseEnvelopeSuccess ¶
type OriginCACertificateGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCACertificateGetResponseEnvelopeSuccessTrue OriginCACertificateGetResponseEnvelopeSuccess = true
)
func (OriginCACertificateGetResponseEnvelopeSuccess) IsKnown ¶
func (r OriginCACertificateGetResponseEnvelopeSuccess) IsKnown() bool
type OriginCACertificateListParams ¶
type OriginCACertificateListParams struct {
// Identifier.
ZoneID param.Field[string] `query:"zone_id,required"`
// Limit to the number of records returned.
Limit param.Field[int64] `query:"limit"`
// Offset the results
Offset param.Field[int64] `query:"offset"`
// Page number of paginated results.
Page param.Field[float64] `query:"page"`
// Number of records per page.
PerPage param.Field[float64] `query:"per_page"`
}
func (OriginCACertificateListParams) URLQuery ¶
func (r OriginCACertificateListParams) URLQuery() (v url.Values)
URLQuery serializes OriginCACertificateListParams's query parameters as `url.Values`.
type OriginCACertificateNewParams ¶
type OriginCACertificateNewParams struct {
// The Certificate Signing Request (CSR). Must be newline-encoded.
Csr param.Field[string] `json:"csr,required"`
// Array of hostnames or wildcard names (e.g., \*.example.com) bound to the
// certificate.
Hostnames param.Field[[]string] `json:"hostnames,required"`
// Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa),
// or "keyless-certificate" (for Keyless SSL servers).
RequestType param.Field[shared.CertificateRequestType] `json:"request_type,required"`
// The number of days for which the certificate should be valid.
RequestedValidity param.Field[ssl.RequestValidity] `json:"requested_validity"`
}
func (OriginCACertificateNewParams) MarshalJSON ¶
func (r OriginCACertificateNewParams) MarshalJSON() (data []byte, err error)
type OriginCACertificateNewResponseEnvelope ¶
type OriginCACertificateNewResponseEnvelope struct {
Errors []OriginCACertificateNewResponseEnvelopeErrors `json:"errors,required"`
Messages []OriginCACertificateNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success OriginCACertificateNewResponseEnvelopeSuccess `json:"success,required"`
Result OriginCACertificate `json:"result"`
JSON originCACertificateNewResponseEnvelopeJSON `json:"-"`
}
func (*OriginCACertificateNewResponseEnvelope) UnmarshalJSON ¶
func (r *OriginCACertificateNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateNewResponseEnvelopeErrors ¶
type OriginCACertificateNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginCACertificateNewResponseEnvelopeErrorsSource `json:"source"`
JSON originCACertificateNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*OriginCACertificateNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *OriginCACertificateNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateNewResponseEnvelopeErrorsSource ¶
type OriginCACertificateNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON originCACertificateNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*OriginCACertificateNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *OriginCACertificateNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateNewResponseEnvelopeMessages ¶
type OriginCACertificateNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source OriginCACertificateNewResponseEnvelopeMessagesSource `json:"source"`
JSON originCACertificateNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*OriginCACertificateNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *OriginCACertificateNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateNewResponseEnvelopeMessagesSource ¶
type OriginCACertificateNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON originCACertificateNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*OriginCACertificateNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
func (r *OriginCACertificateNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type OriginCACertificateNewResponseEnvelopeSuccess ¶
type OriginCACertificateNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCACertificateNewResponseEnvelopeSuccessTrue OriginCACertificateNewResponseEnvelopeSuccess = true
)
func (OriginCACertificateNewResponseEnvelopeSuccess) IsKnown ¶
func (r OriginCACertificateNewResponseEnvelopeSuccess) IsKnown() bool
type OriginCACertificateService ¶
type OriginCACertificateService struct {
Options []option.RequestOption
}
OriginCACertificateService 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 NewOriginCACertificateService method instead.
func NewOriginCACertificateService ¶
func NewOriginCACertificateService(opts ...option.RequestOption) (r *OriginCACertificateService)
NewOriginCACertificateService 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 (*OriginCACertificateService) Delete ¶
func (r *OriginCACertificateService) Delete(ctx context.Context, certificateID string, opts ...option.RequestOption) (res *OriginCACertificateDeleteResponse, err error)
Revoke an existing Origin CA certificate by its serial number. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint ([see above](#requests)).
func (*OriginCACertificateService) Get ¶
func (r *OriginCACertificateService) Get(ctx context.Context, certificateID string, opts ...option.RequestOption) (res *OriginCACertificate, err error)
Get an existing Origin CA certificate by its serial number. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint ([see above](#requests)).
func (*OriginCACertificateService) List ¶
func (r *OriginCACertificateService) List(ctx context.Context, query OriginCACertificateListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[OriginCACertificate], err error)
List all existing Origin CA certificates for a given zone. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint ([see above](#requests)).
func (*OriginCACertificateService) ListAutoPaging ¶
func (r *OriginCACertificateService) ListAutoPaging(ctx context.Context, query OriginCACertificateListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[OriginCACertificate]
List all existing Origin CA certificates for a given zone. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint ([see above](#requests)).
func (*OriginCACertificateService) New ¶
func (r *OriginCACertificateService) New(ctx context.Context, body OriginCACertificateNewParams, opts ...option.RequestOption) (res *OriginCACertificate, err error)
Create an Origin CA certificate. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint ([see above](#requests)).
type PermissionGrant ¶
type PermissionGrant = shared.PermissionGrant
This is an alias to an internal type.
type PermissionGrantParam ¶
type PermissionGrantParam = shared.PermissionGrantParam
This is an alias to an internal type.
type RatePlanID ¶
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.
type SubscriptionFrequency ¶
type SubscriptionFrequency = shared.SubscriptionFrequency
How often the subscription is renewed automatically.
This is an alias to an internal type.
type SubscriptionParam ¶
type SubscriptionParam = shared.SubscriptionParam
This is an alias to an internal type.
type SubscriptionState ¶
type SubscriptionState = shared.SubscriptionState
The state that the subscription is in.
This is an alias to an internal type.
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectString ¶
type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.