Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AssociationGetParams
- type AssociationGetResponseEnvelope
- type AssociationGetResponseEnvelopeResultInfo
- type AssociationGetResponseEnvelopeSuccess
- type AssociationService
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateAsssociation
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type MTLSCertificate
- type MTLSCertificateDeleteParams
- type MTLSCertificateDeleteResponseEnvelope
- type MTLSCertificateDeleteResponseEnvelopeSuccess
- type MTLSCertificateGetParams
- type MTLSCertificateGetResponseEnvelope
- type MTLSCertificateGetResponseEnvelopeSuccess
- type MTLSCertificateListParams
- type MTLSCertificateNewParams
- type MTLSCertificateNewResponse
- type MTLSCertificateNewResponseEnvelope
- type MTLSCertificateNewResponseEnvelopeSuccess
- type MTLSCertificateService
- func (r *MTLSCertificateService) Delete(ctx context.Context, mtlsCertificateID string, ...) (res *MTLSCertificate, err error)
- func (r *MTLSCertificateService) Get(ctx context.Context, mtlsCertificateID string, query MTLSCertificateGetParams, ...) (res *MTLSCertificate, err error)
- func (r *MTLSCertificateService) List(ctx context.Context, query MTLSCertificateListParams, ...) (res *pagination.SinglePage[MTLSCertificate], err error)
- func (r *MTLSCertificateService) ListAutoPaging(ctx context.Context, query MTLSCertificateListParams, ...) *pagination.SinglePageAutoPager[MTLSCertificate]
- func (r *MTLSCertificateService) New(ctx context.Context, params MTLSCertificateNewParams, ...) (res *MTLSCertificateNewResponse, err error)
- type Member
- type MemberParam
- type MemberRole
- type MemberRoleParam
- type MemberRolesPermissions
- type MemberRolesPermissionsParam
- type MemberUser
- type MemberUserParam
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type ResponseInfo
- type Role
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 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 CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssociationGetParams ¶
type AssociationGetResponseEnvelope ¶
type AssociationGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result []CertificateAsssociation `json:"result,required,nullable"`
// Whether the API call was successful
Success AssociationGetResponseEnvelopeSuccess `json:"success,required"`
ResultInfo AssociationGetResponseEnvelopeResultInfo `json:"result_info"`
JSON associationGetResponseEnvelopeJSON `json:"-"`
}
func (*AssociationGetResponseEnvelope) UnmarshalJSON ¶
func (r *AssociationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AssociationGetResponseEnvelopeResultInfo ¶
type AssociationGetResponseEnvelopeResultInfo struct {
// Total number of results for the requested service
Count float64 `json:"count"`
// Current page within paginated list of results
Page float64 `json:"page"`
// Number of results per page of results
PerPage float64 `json:"per_page"`
// Total results available without any search parameters
TotalCount float64 `json:"total_count"`
JSON associationGetResponseEnvelopeResultInfoJSON `json:"-"`
}
func (*AssociationGetResponseEnvelopeResultInfo) UnmarshalJSON ¶
func (r *AssociationGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)
type AssociationGetResponseEnvelopeSuccess ¶
type AssociationGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
AssociationGetResponseEnvelopeSuccessTrue AssociationGetResponseEnvelopeSuccess = true
)
func (AssociationGetResponseEnvelopeSuccess) IsKnown ¶
func (r AssociationGetResponseEnvelopeSuccess) IsKnown() bool
type AssociationService ¶
type AssociationService struct {
Options []option.RequestOption
}
AssociationService 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 NewAssociationService method instead.
func NewAssociationService ¶
func NewAssociationService(opts ...option.RequestOption) (r *AssociationService)
NewAssociationService 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 (*AssociationService) Get ¶
func (r *AssociationService) Get(ctx context.Context, mtlsCertificateID string, query AssociationGetParams, opts ...option.RequestOption) (res *[]CertificateAsssociation, err error)
Lists all active associations between the certificate and Cloudflare services.
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 CertificateAsssociation ¶
type CertificateAsssociation struct {
// The service using the certificate.
Service string `json:"service"`
// Certificate deployment status for the given service.
Status string `json:"status"`
JSON certificateAsssociationJSON `json:"-"`
}
func (*CertificateAsssociation) UnmarshalJSON ¶
func (r *CertificateAsssociation) UnmarshalJSON(data []byte) (err error)
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 CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
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 MTLSCertificate ¶
type MTLSCertificate struct {
// Identifier
ID string `json:"id"`
// Indicates whether the certificate is a CA or leaf certificate.
CA bool `json:"ca"`
// The uploaded root CA certificate.
Certificates string `json:"certificates"`
// When the certificate expires.
ExpiresOn time.Time `json:"expires_on" format:"date-time"`
// The certificate authority that issued the certificate.
Issuer string `json:"issuer"`
// Optional unique name for the certificate. Only used for human readability.
Name string `json:"name"`
// The certificate serial number.
SerialNumber string `json:"serial_number"`
// The type of hash used for the certificate.
Signature string `json:"signature"`
// This is the time the certificate was uploaded.
UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
JSON mtlsCertificateJSON `json:"-"`
}
func (*MTLSCertificate) UnmarshalJSON ¶
func (r *MTLSCertificate) UnmarshalJSON(data []byte) (err error)
type MTLSCertificateDeleteParams ¶
type MTLSCertificateDeleteParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Body interface{} `json:"body,required"`
}
func (MTLSCertificateDeleteParams) MarshalJSON ¶
func (r MTLSCertificateDeleteParams) MarshalJSON() (data []byte, err error)
type MTLSCertificateDeleteResponseEnvelope ¶
type MTLSCertificateDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result MTLSCertificate `json:"result,required"`
// Whether the API call was successful
Success MTLSCertificateDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON mtlsCertificateDeleteResponseEnvelopeJSON `json:"-"`
}
func (*MTLSCertificateDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *MTLSCertificateDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type MTLSCertificateDeleteResponseEnvelopeSuccess ¶
type MTLSCertificateDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
MTLSCertificateDeleteResponseEnvelopeSuccessTrue MTLSCertificateDeleteResponseEnvelopeSuccess = true
)
func (MTLSCertificateDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r MTLSCertificateDeleteResponseEnvelopeSuccess) IsKnown() bool
type MTLSCertificateGetResponseEnvelope ¶
type MTLSCertificateGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result MTLSCertificate `json:"result,required"`
// Whether the API call was successful
Success MTLSCertificateGetResponseEnvelopeSuccess `json:"success,required"`
JSON mtlsCertificateGetResponseEnvelopeJSON `json:"-"`
}
func (*MTLSCertificateGetResponseEnvelope) UnmarshalJSON ¶
func (r *MTLSCertificateGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type MTLSCertificateGetResponseEnvelopeSuccess ¶
type MTLSCertificateGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
MTLSCertificateGetResponseEnvelopeSuccessTrue MTLSCertificateGetResponseEnvelopeSuccess = true
)
func (MTLSCertificateGetResponseEnvelopeSuccess) IsKnown ¶
func (r MTLSCertificateGetResponseEnvelopeSuccess) IsKnown() bool
type MTLSCertificateNewParams ¶
type MTLSCertificateNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// Indicates whether the certificate is a CA or leaf certificate.
CA param.Field[bool] `json:"ca,required"`
// The uploaded root CA certificate.
Certificates param.Field[string] `json:"certificates,required"`
// Optional unique name for the certificate. Only used for human readability.
Name param.Field[string] `json:"name"`
// The private key for the certificate
PrivateKey param.Field[string] `json:"private_key"`
}
func (MTLSCertificateNewParams) MarshalJSON ¶
func (r MTLSCertificateNewParams) MarshalJSON() (data []byte, err error)
type MTLSCertificateNewResponse ¶
type MTLSCertificateNewResponse struct {
// Identifier
ID string `json:"id"`
// Indicates whether the certificate is a CA or leaf certificate.
CA bool `json:"ca"`
// The uploaded root CA certificate.
Certificates string `json:"certificates"`
// When the certificate expires.
ExpiresOn time.Time `json:"expires_on" format:"date-time"`
// The certificate authority that issued the certificate.
Issuer string `json:"issuer"`
// Optional unique name for the certificate. Only used for human readability.
Name string `json:"name"`
// The certificate serial number.
SerialNumber string `json:"serial_number"`
// The type of hash used for the certificate.
Signature string `json:"signature"`
// This is the time the certificate was updated.
UpdatedAt time.Time `json:"updated_at" format:"date-time"`
// This is the time the certificate was uploaded.
UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
JSON mtlsCertificateNewResponseJSON `json:"-"`
}
func (*MTLSCertificateNewResponse) UnmarshalJSON ¶
func (r *MTLSCertificateNewResponse) UnmarshalJSON(data []byte) (err error)
type MTLSCertificateNewResponseEnvelope ¶
type MTLSCertificateNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result MTLSCertificateNewResponse `json:"result,required"`
// Whether the API call was successful
Success MTLSCertificateNewResponseEnvelopeSuccess `json:"success,required"`
JSON mtlsCertificateNewResponseEnvelopeJSON `json:"-"`
}
func (*MTLSCertificateNewResponseEnvelope) UnmarshalJSON ¶
func (r *MTLSCertificateNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type MTLSCertificateNewResponseEnvelopeSuccess ¶
type MTLSCertificateNewResponseEnvelopeSuccess bool
Whether the API call was successful
const (
MTLSCertificateNewResponseEnvelopeSuccessTrue MTLSCertificateNewResponseEnvelopeSuccess = true
)
func (MTLSCertificateNewResponseEnvelopeSuccess) IsKnown ¶
func (r MTLSCertificateNewResponseEnvelopeSuccess) IsKnown() bool
type MTLSCertificateService ¶
type MTLSCertificateService struct {
Options []option.RequestOption
Associations *AssociationService
}
MTLSCertificateService 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 NewMTLSCertificateService method instead.
func NewMTLSCertificateService ¶
func NewMTLSCertificateService(opts ...option.RequestOption) (r *MTLSCertificateService)
NewMTLSCertificateService 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 (*MTLSCertificateService) Delete ¶
func (r *MTLSCertificateService) Delete(ctx context.Context, mtlsCertificateID string, params MTLSCertificateDeleteParams, opts ...option.RequestOption) (res *MTLSCertificate, err error)
Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services.
func (*MTLSCertificateService) Get ¶
func (r *MTLSCertificateService) Get(ctx context.Context, mtlsCertificateID string, query MTLSCertificateGetParams, opts ...option.RequestOption) (res *MTLSCertificate, err error)
Fetches a single mTLS certificate.
func (*MTLSCertificateService) List ¶
func (r *MTLSCertificateService) List(ctx context.Context, query MTLSCertificateListParams, opts ...option.RequestOption) (res *pagination.SinglePage[MTLSCertificate], err error)
Lists all mTLS certificates.
func (*MTLSCertificateService) ListAutoPaging ¶
func (r *MTLSCertificateService) ListAutoPaging(ctx context.Context, query MTLSCertificateListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[MTLSCertificate]
Lists all mTLS certificates.
func (*MTLSCertificateService) New ¶
func (r *MTLSCertificateService) New(ctx context.Context, params MTLSCertificateNewParams, opts ...option.RequestOption) (res *MTLSCertificateNewResponse, err error)
Upload a certificate that you want to use with mTLS-enabled Cloudflare services.
type MemberParam ¶ added in v2.1.0
type MemberParam = shared.MemberParam
This is an alias to an internal type.
type MemberRole ¶ added in v2.1.0
type MemberRole = shared.MemberRole
This is an alias to an internal type.
type MemberRoleParam ¶ added in v2.1.0
type MemberRoleParam = shared.MemberRoleParam
This is an alias to an internal type.
type MemberRolesPermissions ¶ added in v2.1.0
type MemberRolesPermissions = shared.MemberRolesPermissions
This is an alias to an internal type.
type MemberRolesPermissionsParam ¶ added in v2.1.0
type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam
This is an alias to an internal type.
type MemberUser ¶ added in v2.1.0
type MemberUser = shared.MemberUser
This is an alias to an internal type.
type MemberUserParam ¶ added in v2.1.0
type MemberUserParam = shared.MemberUserParam
This is an alias to an internal type.
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.