api.md

Shared

Types:

• ASN
• AuditLog
• CertificateCA
• CertificateRequestType
• CloudflareTunnel
• ErrorData
• Identifier
• LoadBalancerPreview
• Member
• PaginationInfo
• Permission
• PermissionGrant
• RatePlan
• ResponseInfo
• Result
• Role
• SortDirection
• Subscription
• SubscriptionComponent
• SubscriptionZone
• Token
• TokenConditionCIDRList
• TokenPolicy
• TokenValue

Accounts

Types:

• Account
• AccountDeleteResponse

Methods:

• client.accounts.create({ ...params }) -> Account
• client.accounts.update({ ...params }) -> Account
• client.accounts.list({ ...params }) -> AccountsV4PagePaginationArray
• client.accounts.delete({ ...params }) -> AccountDeleteResponse | null
• client.accounts.get({ ...params }) -> Account

Members

Types:

• Status
• MemberDeleteResponse

Methods:

• client.accounts.members.create({ ...params }) -> Member
• client.accounts.members.update(memberId, { ...params }) -> Member
• client.accounts.members.list({ ...params }) -> MembersV4PagePaginationArray
• client.accounts.members.delete(memberId, { ...params }) -> MemberDeleteResponse | null
• client.accounts.members.get(memberId, { ...params }) -> Member

Roles

Methods:

• client.accounts.roles.list({ ...params }) -> RolesV4PagePaginationArray
• client.accounts.roles.get(roleId, { ...params }) -> Role

Subscriptions

Types:

• SubscriptionCreateResponse
• SubscriptionUpdateResponse
• SubscriptionDeleteResponse

Methods:

• client.accounts.subscriptions.create({ ...params }) -> SubscriptionCreateResponse
• client.accounts.subscriptions.update(subscriptionIdentifier, { ...params }) -> SubscriptionUpdateResponse
• client.accounts.subscriptions.delete(subscriptionIdentifier, { ...params }) -> SubscriptionDeleteResponse
• client.accounts.subscriptions.get({ ...params }) -> SubscriptionsSinglePage

Tokens

Types:

• TokenCreateResponse
• TokenDeleteResponse
• TokenVerifyResponse

Methods:

• client.accounts.tokens.create({ ...params }) -> TokenCreateResponse
• client.accounts.tokens.update(tokenId, { ...params }) -> Token
• client.accounts.tokens.list({ ...params }) -> TokensV4PagePaginationArray
• client.accounts.tokens.delete(tokenId, { ...params }) -> TokenDeleteResponse | null
• client.accounts.tokens.get(tokenId, { ...params }) -> Token
• client.accounts.tokens.verify({ ...params }) -> TokenVerifyResponse

PermissionGroups

Types:

• PermissionGroupListResponse
• PermissionGroupGetResponse

Methods:

• client.accounts.tokens.permissionGroups.list({ ...params }) -> PermissionGroupListResponsesSinglePage
• client.accounts.tokens.permissionGroups.get({ ...params }) -> PermissionGroupGetResponsesSinglePage

Value

Methods:

• client.accounts.tokens.value.update(tokenId, { ...params }) -> TokenValue

Logs

Audit

Types:

• AuditListResponse

Methods:

• client.accounts.logs.audit.list({ ...params }) -> AuditListResponsesCursorLimitPagination

OriginCACertificates

Types:

• OriginCACertificate
• OriginCACertificateDeleteResponse

Methods:

• client.originCACertificates.create({ ...params }) -> OriginCACertificate
• client.originCACertificates.list({ ...params }) -> OriginCACertificatesV4PagePaginationArray
• client.originCACertificates.delete(certificateId) -> OriginCACertificateDeleteResponse
• client.originCACertificates.get(certificateId) -> OriginCACertificate

IPs

Types:

• IPs
• JDCloudIPs
• IPListResponse

Methods:

• client.ips.list({ ...params }) -> IPListResponse

Memberships

Types:

• Membership
• MembershipUpdateResponse
• MembershipDeleteResponse
• MembershipGetResponse

Methods:

• client.memberships.update(membershipId, { ...params }) -> MembershipUpdateResponse
• client.memberships.list({ ...params }) -> MembershipsV4PagePaginationArray
• client.memberships.delete(membershipId) -> MembershipDeleteResponse
• client.memberships.get(membershipId) -> MembershipGetResponse

User

Types:

• UserEditResponse
• UserGetResponse

Methods:

• client.user.edit({ ...params }) -> UserEditResponse
• client.user.get() -> UserGetResponse

AuditLogs

Methods:

• client.user.auditLogs.list({ ...params }) -> AuditLogsV4PagePaginationArray

Billing

History

Types:

• BillingHistory

Methods:

• client.user.billing.history.list({ ...params }) -> BillingHistoriesV4PagePaginationArray

Profile

Types:

• ProfileGetResponse

Methods:

• client.user.billing.profile.get() -> ProfileGetResponse

Invites

Types:

• Invite

Methods:

• client.user.invites.list() -> InvitesSinglePage
• client.user.invites.edit(inviteId, { ...params }) -> Invite
• client.user.invites.get(inviteId) -> Invite

Organizations

Types:

• Organization
• OrganizationDeleteResponse
• OrganizationGetResponse

Methods:

• client.user.organizations.list({ ...params }) -> OrganizationsV4PagePaginationArray
• client.user.organizations.delete(organizationId) -> OrganizationDeleteResponse
• client.user.organizations.get(organizationId) -> OrganizationGetResponse

Subscriptions

Types:

• SubscriptionUpdateResponse
• SubscriptionDeleteResponse

Methods:

• client.user.subscriptions.update(identifier, { ...params }) -> SubscriptionUpdateResponse
• client.user.subscriptions.delete(identifier) -> SubscriptionDeleteResponse
• client.user.subscriptions.get() -> SubscriptionsSinglePage

Tokens

Types:

• TokenCreateResponse
• TokenDeleteResponse
• TokenVerifyResponse

Methods:

• client.user.tokens.create({ ...params }) -> TokenCreateResponse
• client.user.tokens.update(tokenId, { ...params }) -> Token
• client.user.tokens.list({ ...params }) -> TokensV4PagePaginationArray
• client.user.tokens.delete(tokenId) -> TokenDeleteResponse | null
• client.user.tokens.get(tokenId) -> Token
• client.user.tokens.verify() -> TokenVerifyResponse

PermissionGroups

Types:

• PermissionGroupListResponse

Methods:

• client.user.tokens.permissionGroups.list() -> PermissionGroupListResponsesSinglePage

Value

Methods:

• client.user.tokens.value.update(tokenId, { ...params }) -> TokenValue

Zones

Types:

• Type
• Zone
• ZoneDeleteResponse

Methods:

• client.zones.create({ ...params }) -> Zone
• client.zones.list({ ...params }) -> ZonesV4PagePaginationArray
• client.zones.delete({ ...params }) -> ZoneDeleteResponse | null
• client.zones.edit({ ...params }) -> Zone
• client.zones.get({ ...params }) -> Zone

ActivationCheck

Types:

• ActivationCheckTriggerResponse

Methods:

• client.zones.activationCheck.trigger({ ...params }) -> ActivationCheckTriggerResponse

Settings

Types:

• AdvancedDDoS
• Aegis
• AlwaysOnline
• AlwaysUseHTTPS
• AutomaticHTTPSRewrites
• AutomaticPlatformOptimization
• Brotli
• BrowserCacheTTL
• BrowserCheck
• CacheLevel
• ChallengeTTL
• Ciphers
• DevelopmentMode
• EarlyHints
• EmailObfuscation
• FontSettings
• H2Prioritization
• HotlinkProtection
• HTTP2
• HTTP3
• ImageResizing
• IPGeolocation
• IPV6
• MinTLSVersion
• Mirage
• NEL
• OpportunisticEncryption
• OpportunisticOnion
• OrangeToOrange
• OriginErrorPagePassThru
• OriginMaxHTTPVersion
• Polish
• PrefetchPreload
• ProxyReadTimeout
• PseudoIPV4
• ResponseBuffering
• RocketLoader
• SecurityHeaders
• SecurityLevel
• ServerSideExcludes
• SortQueryStringForCache
• SSL
• SSLRecommender
• TLS1_3
• TLSClientAuth
• TrueClientIPHeader
• WAF
• WebP
• Websocket
• ZeroRTT
• SettingEditResponse
• SettingGetResponse

Methods:

• client.zones.settings.edit(settingId, { ...params }) -> SettingEditResponse
• client.zones.settings.get(settingId, { ...params }) -> SettingGetResponse

CustomNameservers

Types:

• CustomNameserverUpdateResponse
• CustomNameserverGetResponse

Methods:

• client.zones.customNameservers.update({ ...params }) -> CustomNameserverUpdateResponsesSinglePage
• client.zones.customNameservers.get({ ...params }) -> CustomNameserverGetResponse

Holds

Types:

• ZoneHold

Methods:

• client.zones.holds.create({ ...params }) -> ZoneHold
• client.zones.holds.delete({ ...params }) -> ZoneHold
• client.zones.holds.edit({ ...params }) -> ZoneHold
• client.zones.holds.get({ ...params }) -> ZoneHold

Subscriptions

Types:

• SubscriptionCreateResponse
• SubscriptionUpdateResponse
• SubscriptionGetResponse

Methods:

• client.zones.subscriptions.create(identifier, { ...params }) -> SubscriptionCreateResponse
• client.zones.subscriptions.update(identifier, { ...params }) -> SubscriptionUpdateResponse
• client.zones.subscriptions.get(identifier) -> SubscriptionGetResponse

Plans

Types:

• AvailableRatePlan

Methods:

• client.zones.plans.list({ ...params }) -> AvailableRatePlansSinglePage
• client.zones.plans.get(planIdentifier, { ...params }) -> AvailableRatePlan

RatePlans

Types:

• RatePlanGetResponse

Methods:

• client.zones.ratePlans.get({ ...params }) -> RatePlanGetResponsesSinglePage

LoadBalancers

Types:

• AdaptiveRouting
• CheckRegion
• DefaultPools
• FilterOptions
• Header
• Host
• LoadBalancer
• LoadShedding
• LocationStrategy
• NotificationFilter
• Origin
• OriginSteering
• RandomSteering
• Rules
• SessionAffinity
• SessionAffinityAttributes
• SteeringPolicy
• LoadBalancerDeleteResponse

Methods:

• client.loadBalancers.create({ ...params }) -> LoadBalancer
• client.loadBalancers.update(loadBalancerId, { ...params }) -> LoadBalancer
• client.loadBalancers.list({ ...params }) -> LoadBalancersSinglePage
• client.loadBalancers.delete(loadBalancerId, { ...params }) -> LoadBalancerDeleteResponse
• client.loadBalancers.edit(loadBalancerId, { ...params }) -> LoadBalancer
• client.loadBalancers.get(loadBalancerId, { ...params }) -> LoadBalancer

Monitors

Types:

• Monitor
• MonitorDeleteResponse

Methods:

• client.loadBalancers.monitors.create({ ...params }) -> Monitor
• client.loadBalancers.monitors.update(monitorId, { ...params }) -> Monitor
• client.loadBalancers.monitors.list({ ...params }) -> MonitorsSinglePage
• client.loadBalancers.monitors.delete(monitorId, { ...params }) -> MonitorDeleteResponse
• client.loadBalancers.monitors.edit(monitorId, { ...params }) -> Monitor
• client.loadBalancers.monitors.get(monitorId, { ...params }) -> Monitor

Previews

Types:

• PreviewCreateResponse

Methods:

• client.loadBalancers.monitors.previews.create(monitorId, { ...params }) -> PreviewCreateResponse

References

Types:

• ReferenceGetResponse

Methods:

• client.loadBalancers.monitors.references.get(monitorId, { ...params }) -> ReferenceGetResponsesSinglePage

Pools

Types:

• Pool
• PoolDeleteResponse

Methods:

• client.loadBalancers.pools.create({ ...params }) -> Pool
• client.loadBalancers.pools.update(poolId, { ...params }) -> Pool
• client.loadBalancers.pools.list({ ...params }) -> PoolsSinglePage
• client.loadBalancers.pools.delete(poolId, { ...params }) -> PoolDeleteResponse
• client.loadBalancers.pools.bulkEdit({ ...params }) -> PoolsSinglePage
• client.loadBalancers.pools.edit(poolId, { ...params }) -> Pool
• client.loadBalancers.pools.get(poolId, { ...params }) -> Pool

Health

Types:

• HealthCreateResponse
• HealthGetResponse

Methods:

• client.loadBalancers.pools.health.create(poolId, { ...params }) -> HealthCreateResponse
• client.loadBalancers.pools.health.get(poolId, { ...params }) -> HealthGetResponse

References

Types:

• ReferenceGetResponse

Methods:

• client.loadBalancers.pools.references.get(poolId, { ...params }) -> ReferenceGetResponsesSinglePage

Previews

Types:

• PreviewGetResponse

Methods:

• client.loadBalancers.previews.get(previewId, { ...params }) -> PreviewGetResponse

Regions

Types:

• RegionListResponse
• RegionGetResponse

Methods:

• client.loadBalancers.regions.list({ ...params }) -> RegionListResponse
• client.loadBalancers.regions.get(regionId, { ...params }) -> RegionGetResponse

Searches

Types:

• SearchListResponse

Methods:

• client.loadBalancers.searches.list({ ...params }) -> SearchListResponsesV4PagePagination

Cache

Types:

• CachePurgeResponse

Methods:

• client.cache.purge({ ...params }) -> CachePurgeResponse | null

CacheReserve

Types:

• CacheReserve
• CacheReserveClear
• State
• CacheReserveClearResponse
• CacheReserveEditResponse
• CacheReserveGetResponse
• CacheReserveStatusResponse

Methods:

• client.cache.cacheReserve.clear({ ...params }) -> CacheReserveClearResponse
• client.cache.cacheReserve.edit({ ...params }) -> CacheReserveEditResponse
• client.cache.cacheReserve.get({ ...params }) -> CacheReserveGetResponse
• client.cache.cacheReserve.status({ ...params }) -> CacheReserveStatusResponse

SmartTieredCache

Types:

• SmartTieredCacheDeleteResponse
• SmartTieredCacheEditResponse
• SmartTieredCacheGetResponse

Methods:

• client.cache.smartTieredCache.delete({ ...params }) -> SmartTieredCacheDeleteResponse
• client.cache.smartTieredCache.edit({ ...params }) -> SmartTieredCacheEditResponse
• client.cache.smartTieredCache.get({ ...params }) -> SmartTieredCacheGetResponse

Variants

Types:

• CacheVariant
• VariantDeleteResponse
• VariantEditResponse
• VariantGetResponse

Methods:

• client.cache.variants.delete({ ...params }) -> VariantDeleteResponse
• client.cache.variants.edit({ ...params }) -> VariantEditResponse
• client.cache.variants.get({ ...params }) -> VariantGetResponse

RegionalTieredCache

Types:

• RegionalTieredCache
• RegionalTieredCacheEditResponse
• RegionalTieredCacheGetResponse

Methods:

• client.cache.regionalTieredCache.edit({ ...params }) -> RegionalTieredCacheEditResponse
• client.cache.regionalTieredCache.get({ ...params }) -> RegionalTieredCacheGetResponse

SSL

Analyze

Types:

• AnalyzeCreateResponse

Methods:

• client.ssl.analyze.create({ ...params }) -> AnalyzeCreateResponse

CertificatePacks

Types:

• Host
• RequestValidity
• Status
• ValidationMethod
• CertificatePackCreateResponse
• CertificatePackListResponse
• CertificatePackDeleteResponse
• CertificatePackEditResponse
• CertificatePackGetResponse

Methods:

• client.ssl.certificatePacks.create({ ...params }) -> CertificatePackCreateResponse
• client.ssl.certificatePacks.list({ ...params }) -> CertificatePackListResponsesSinglePage
• client.ssl.certificatePacks.delete(certificatePackId, { ...params }) -> CertificatePackDeleteResponse
• client.ssl.certificatePacks.edit(certificatePackId, { ...params }) -> CertificatePackEditResponse
• client.ssl.certificatePacks.get(certificatePackId, { ...params }) -> CertificatePackGetResponse

Quota

Types:

• QuotaGetResponse

Methods:

• client.ssl.certificatePacks.quota.get({ ...params }) -> QuotaGetResponse

Recommendations

Types:

• RecommendationGetResponse

Methods:

• client.ssl.recommendations.get({ ...params }) -> RecommendationGetResponse

Universal

Settings

Types:

• UniversalSSLSettings

Methods:

• client.ssl.universal.settings.edit({ ...params }) -> UniversalSSLSettings
• client.ssl.universal.settings.get({ ...params }) -> UniversalSSLSettings

Verification

Types:

• Verification
• VerificationEditResponse
• VerificationGetResponse

Methods:

• client.ssl.verification.edit(certificatePackId, { ...params }) -> VerificationEditResponse
• client.ssl.verification.get({ ...params }) -> VerificationGetResponse

ACM

TotalTLS

Types:

• CertificateAuthority
• TotalTLSCreateResponse
• TotalTLSGetResponse

Methods:

• client.acm.totalTLS.create({ ...params }) -> TotalTLSCreateResponse
• client.acm.totalTLS.get({ ...params }) -> TotalTLSGetResponse

Argo

SmartRouting

Types:

• SmartRoutingEditResponse
• SmartRoutingGetResponse

Methods:

• client.argo.smartRouting.edit({ ...params }) -> SmartRoutingEditResponse
• client.argo.smartRouting.get({ ...params }) -> SmartRoutingGetResponse

TieredCaching

Types:

• TieredCachingEditResponse
• TieredCachingGetResponse

Methods:

• client.argo.tieredCaching.edit({ ...params }) -> TieredCachingEditResponse
• client.argo.tieredCaching.get({ ...params }) -> TieredCachingGetResponse

CertificateAuthorities

HostnameAssociations

Types:

• HostnameAssociation
• TLSHostnameAssociation
• HostnameAssociationUpdateResponse
• HostnameAssociationGetResponse

Methods:

• client.certificateAuthorities.hostnameAssociations.update({ ...params }) -> HostnameAssociationUpdateResponse
• client.certificateAuthorities.hostnameAssociations.get({ ...params }) -> HostnameAssociationGetResponse

ClientCertificates

Types:

• ClientCertificate

Methods:

• client.clientCertificates.create({ ...params }) -> ClientCertificate
• client.clientCertificates.list({ ...params }) -> ClientCertificatesV4PagePaginationArray
• client.clientCertificates.delete(clientCertificateId, { ...params }) -> ClientCertificate
• client.clientCertificates.edit(clientCertificateId, { ...params }) -> ClientCertificate
• client.clientCertificates.get(clientCertificateId, { ...params }) -> ClientCertificate

CustomCertificates

Types:

• CustomCertificate
• GeoRestrictions
• Status
• CustomCertificateDeleteResponse

Methods:

• client.customCertificates.create({ ...params }) -> CustomCertificate
• client.customCertificates.list({ ...params }) -> CustomCertificatesV4PagePaginationArray
• client.customCertificates.delete(customCertificateId, { ...params }) -> CustomCertificateDeleteResponse
• client.customCertificates.edit(customCertificateId, { ...params }) -> CustomCertificate
• client.customCertificates.get(customCertificateId, { ...params }) -> CustomCertificate

Prioritize

Methods:

• client.customCertificates.prioritize.update({ ...params }) -> CustomCertificatesSinglePage

CustomHostnames

Types:

• BundleMethod
• CustomHostname
• DCVMethod
• DomainValidationType
• CustomHostnameCreateResponse
• CustomHostnameListResponse
• CustomHostnameDeleteResponse
• CustomHostnameEditResponse
• CustomHostnameGetResponse

Methods:

• client.customHostnames.create({ ...params }) -> CustomHostnameCreateResponse
• client.customHostnames.list({ ...params }) -> CustomHostnameListResponsesV4PagePaginationArray
• client.customHostnames.delete(customHostnameId, { ...params }) -> CustomHostnameDeleteResponse
• client.customHostnames.edit(customHostnameId, { ...params }) -> CustomHostnameEditResponse
• client.customHostnames.get(customHostnameId, { ...params }) -> CustomHostnameGetResponse

FallbackOrigin

Types:

• FallbackOriginUpdateResponse
• FallbackOriginDeleteResponse
• FallbackOriginGetResponse

Methods:

• client.customHostnames.fallbackOrigin.update({ ...params }) -> FallbackOriginUpdateResponse
• client.customHostnames.fallbackOrigin.delete({ ...params }) -> FallbackOriginDeleteResponse
• client.customHostnames.fallbackOrigin.get({ ...params }) -> FallbackOriginGetResponse

CertificatePack

Certificates

Types:

• CertificateUpdateResponse
• CertificateDeleteResponse

Methods:

• client.customHostnames.certificatePack.certificates.update(customHostnameId, certificatePackId, certificateId, { ...params }) -> CertificateUpdateResponse
• client.customHostnames.certificatePack.certificates.delete(customHostnameId, certificatePackId, certificateId, { ...params }) -> CertificateDeleteResponse

CustomNameservers

Types:

• CustomNameserver
• CustomNameserverDeleteResponse

Methods:

• client.customNameservers.create({ ...params }) -> CustomNameserver
• client.customNameservers.delete(customNSId, { ...params }) -> CustomNameserverDeleteResponsesSinglePage
• client.customNameservers.get({ ...params }) -> CustomNameserversSinglePage

DNSFirewall

Types:

• AttackMitigation
• FirewallIPs
• UpstreamIPs
• DNSFirewallCreateResponse
• DNSFirewallListResponse
• DNSFirewallDeleteResponse
• DNSFirewallEditResponse
• DNSFirewallGetResponse

Methods:

• client.dnsFirewall.create({ ...params }) -> DNSFirewallCreateResponse
• client.dnsFirewall.list({ ...params }) -> DNSFirewallListResponsesV4PagePaginationArray
• client.dnsFirewall.delete(dnsFirewallId, { ...params }) -> DNSFirewallDeleteResponse
• client.dnsFirewall.edit(dnsFirewallId, { ...params }) -> DNSFirewallEditResponse
• client.dnsFirewall.get(dnsFirewallId, { ...params }) -> DNSFirewallGetResponse

Analytics

Reports

Methods:

• client.dnsFirewall.analytics.reports.get(dnsFirewallId, { ...params }) -> Report

Bytimes

Methods:

• client.dnsFirewall.analytics.reports.bytimes.get(dnsFirewallId, { ...params }) -> ByTime

ReverseDNS

Types:

• ReverseDNSEditResponse
• ReverseDNSGetResponse

Methods:

• client.dnsFirewall.reverseDNS.edit(dnsFirewallId, { ...params }) -> ReverseDNSEditResponse
• client.dnsFirewall.reverseDNS.get(dnsFirewallId, { ...params }) -> ReverseDNSGetResponse

DNS

Types:

• DNSAnalyticsNominalMetric
• DNSAnalyticsQuery

DNSSEC

Types:

• DNSSEC
• DNSSECDeleteResponse

Methods:

• client.dns.dnssec.delete({ ...params }) -> DNSSECDeleteResponse
• client.dns.dnssec.edit({ ...params }) -> DNSSEC
• client.dns.dnssec.get({ ...params }) -> DNSSEC

Records

Types:

• ARecord
• AAAARecord
• BatchPatch
• BatchPut
• CAARecord
• CERTRecord
• CNAMERecord
• DNSKEYRecord
• DSRecord
• HTTPSRecord
• LOCRecord
• MXRecord
• NAPTRRecord
• NSRecord
• PTRRecord
• Record
• RecordResponse
• RecordTags
• SMIMEARecord
• SRVRecord
• SSHFPRecord
• SVCBRecord
• TLSARecord
• TTL
• TXTRecord
• URIRecord
• RecordDeleteResponse
• RecordBatchResponse
• RecordExportResponse
• RecordImportResponse
• RecordScanResponse

Methods:

• client.dns.records.create({ ...params }) -> RecordResponse
• client.dns.records.update(dnsRecordId, { ...params }) -> RecordResponse
• client.dns.records.list({ ...params }) -> RecordResponsesV4PagePaginationArray
• client.dns.records.delete(dnsRecordId, { ...params }) -> RecordDeleteResponse
• client.dns.records.batch({ ...params }) -> RecordBatchResponse
• client.dns.records.edit(dnsRecordId, { ...params }) -> RecordResponse
• client.dns.records.export({ ...params }) -> string
• client.dns.records.get(dnsRecordId, { ...params }) -> RecordResponse
• client.dns.records.import({ ...params }) -> RecordImportResponse
• client.dns.records.scan({ ...params }) -> RecordScanResponse

Settings

Types:

• DNSSetting

Zone

Types:

• ZoneEditResponse
• ZoneGetResponse

Methods:

• client.dns.settings.zone.edit({ ...params }) -> ZoneEditResponse
• client.dns.settings.zone.get({ ...params }) -> ZoneGetResponse

Account

Types:

• AccountEditResponse
• AccountGetResponse

Methods:

• client.dns.settings.account.edit({ ...params }) -> AccountEditResponse
• client.dns.settings.account.get({ ...params }) -> AccountGetResponse

Views

Types:

• ViewCreateResponse
• ViewListResponse
• ViewDeleteResponse
• ViewEditResponse
• ViewGetResponse

Methods:

• client.dns.settings.account.views.create({ ...params }) -> ViewCreateResponse
• client.dns.settings.account.views.list({ ...params }) -> ViewListResponsesV4PagePaginationArray
• client.dns.settings.account.views.delete(viewId, { ...params }) -> ViewDeleteResponse
• client.dns.settings.account.views.edit(viewId, { ...params }) -> ViewEditResponse
• client.dns.settings.account.views.get(viewId, { ...params }) -> ViewGetResponse

Analytics

Reports

Types:

• Report

Methods:

• client.dns.analytics.reports.get({ ...params }) -> Report

Bytimes

Types:

• ByTime

Methods:

• client.dns.analytics.reports.bytimes.get({ ...params }) -> ByTime

ZoneTransfers

ForceAXFR

Types:

• ForceAXFR

Methods:

• client.dns.zoneTransfers.forceAXFR.create({ ...params }) -> ForceAXFR

Incoming

Types:

• Incoming
• IncomingCreateResponse
• IncomingUpdateResponse
• IncomingDeleteResponse
• IncomingGetResponse

Methods:

• client.dns.zoneTransfers.incoming.create({ ...params }) -> IncomingCreateResponse
• client.dns.zoneTransfers.incoming.update({ ...params }) -> IncomingUpdateResponse
• client.dns.zoneTransfers.incoming.delete({ ...params }) -> IncomingDeleteResponse
• client.dns.zoneTransfers.incoming.get({ ...params }) -> IncomingGetResponse

Outgoing

Types:

• DisableTransfer
• EnableTransfer
• Outgoing
• OutgoingStatus
• OutgoingCreateResponse
• OutgoingUpdateResponse
• OutgoingDeleteResponse
• OutgoingForceNotifyResponse
• OutgoingGetResponse

Methods:

• client.dns.zoneTransfers.outgoing.create({ ...params }) -> OutgoingCreateResponse
• client.dns.zoneTransfers.outgoing.update({ ...params }) -> OutgoingUpdateResponse
• client.dns.zoneTransfers.outgoing.delete({ ...params }) -> OutgoingDeleteResponse
• client.dns.zoneTransfers.outgoing.disable({ ...params }) -> DisableTransfer
• client.dns.zoneTransfers.outgoing.enable({ ...params }) -> EnableTransfer
• client.dns.zoneTransfers.outgoing.forceNotify({ ...params }) -> OutgoingForceNotifyResponse
• client.dns.zoneTransfers.outgoing.get({ ...params }) -> OutgoingGetResponse

Status

Methods:

• client.dns.zoneTransfers.outgoing.status.get({ ...params }) -> EnableTransfer

ACLs

Types:

• ACL
• ACLDeleteResponse

Methods:

• client.dns.zoneTransfers.acls.create({ ...params }) -> ACL
• client.dns.zoneTransfers.acls.update(aclId, { ...params }) -> ACL
• client.dns.zoneTransfers.acls.list({ ...params }) -> ACLsSinglePage
• client.dns.zoneTransfers.acls.delete(aclId, { ...params }) -> ACLDeleteResponse
• client.dns.zoneTransfers.acls.get(aclId, { ...params }) -> ACL

Peers

Types:

• Peer
• PeerDeleteResponse

Methods:

• client.dns.zoneTransfers.peers.create({ ...params }) -> Peer
• client.dns.zoneTransfers.peers.update(peerId, { ...params }) -> Peer
• client.dns.zoneTransfers.peers.list({ ...params }) -> PeersSinglePage
• client.dns.zoneTransfers.peers.delete(peerId, { ...params }) -> PeerDeleteResponse
• client.dns.zoneTransfers.peers.get(peerId, { ...params }) -> Peer

TSIGs

Types:

• TSIG
• TSIGDeleteResponse

Methods:

• client.dns.zoneTransfers.tsigs.create({ ...params }) -> TSIG
• client.dns.zoneTransfers.tsigs.update(tsigId, { ...params }) -> TSIG
• client.dns.zoneTransfers.tsigs.list({ ...params }) -> TSIGsSinglePage
• client.dns.zoneTransfers.tsigs.delete(tsigId, { ...params }) -> TSIGDeleteResponse
• client.dns.zoneTransfers.tsigs.get(tsigId, { ...params }) -> TSIG

EmailSecurity

Investigate

Types:

• InvestigateListResponse
• InvestigateGetResponse

Methods:

• client.emailSecurity.investigate.list({ ...params }) -> InvestigateListResponsesV4PagePaginationArray
• client.emailSecurity.investigate.get(postfixId, { ...params }) -> InvestigateGetResponse

Detections

Types:

• DetectionGetResponse

Methods:

• client.emailSecurity.investigate.detections.get(postfixId, { ...params }) -> DetectionGetResponse

Preview

Types:

• PreviewCreateResponse
• PreviewGetResponse

Methods:

• client.emailSecurity.investigate.preview.create({ ...params }) -> PreviewCreateResponse
• client.emailSecurity.investigate.preview.get(postfixId, { ...params }) -> PreviewGetResponse

Raw

Types:

• RawGetResponse

Methods:

• client.emailSecurity.investigate.raw.get(postfixId, { ...params }) -> RawGetResponse

Trace

Types:

• TraceGetResponse

Methods:

• client.emailSecurity.investigate.trace.get(postfixId, { ...params }) -> TraceGetResponse

Move

Types:

• MoveCreateResponse
• MoveBulkResponse

Methods:

• client.emailSecurity.investigate.move.create(postfixId, { ...params }) -> MoveCreateResponsesSinglePage
• client.emailSecurity.investigate.move.bulk({ ...params }) -> MoveBulkResponsesSinglePage

Reclassify

Types:

• ReclassifyCreateResponse

Methods:

• client.emailSecurity.investigate.reclassify.create(postfixId, { ...params }) -> ReclassifyCreateResponse

Release

Types:

• ReleaseBulkResponse

Methods:

• client.emailSecurity.investigate.release.bulk([ ...body ]) -> ReleaseBulkResponsesSinglePage

Settings

AllowPolicies

Types:

• AllowPolicyCreateResponse
• AllowPolicyListResponse
• AllowPolicyDeleteResponse
• AllowPolicyEditResponse
• AllowPolicyGetResponse

Methods:

• client.emailSecurity.settings.allowPolicies.create({ ...params }) -> AllowPolicyCreateResponse
• client.emailSecurity.settings.allowPolicies.list({ ...params }) -> AllowPolicyListResponsesV4PagePaginationArray
• client.emailSecurity.settings.allowPolicies.delete(policyId, { ...params }) -> AllowPolicyDeleteResponse
• client.emailSecurity.settings.allowPolicies.edit(policyId, { ...params }) -> AllowPolicyEditResponse
• client.emailSecurity.settings.allowPolicies.get(policyId, { ...params }) -> AllowPolicyGetResponse

BlockSenders

Types:

• BlockSenderCreateResponse
• BlockSenderListResponse
• BlockSenderDeleteResponse
• BlockSenderEditResponse
• BlockSenderGetResponse

Methods:

• client.emailSecurity.settings.blockSenders.create({ ...params }) -> BlockSenderCreateResponse
• client.emailSecurity.settings.blockSenders.list({ ...params }) -> BlockSenderListResponsesV4PagePaginationArray
• client.emailSecurity.settings.blockSenders.delete(patternId, { ...params }) -> BlockSenderDeleteResponse
• client.emailSecurity.settings.blockSenders.edit(patternId, { ...params }) -> BlockSenderEditResponse
• client.emailSecurity.settings.blockSenders.get(patternId, { ...params }) -> BlockSenderGetResponse

Domains

Types:

• DomainListResponse
• DomainDeleteResponse
• DomainBulkDeleteResponse
• DomainEditResponse
• DomainGetResponse

Methods:

• client.emailSecurity.settings.domains.list({ ...params }) -> DomainListResponsesV4PagePaginationArray
• client.emailSecurity.settings.domains.delete(domainId, { ...params }) -> DomainDeleteResponse
• client.emailSecurity.settings.domains.bulkDelete({ ...params }) -> DomainBulkDeleteResponsesSinglePage
• client.emailSecurity.settings.domains.edit(domainId, { ...params }) -> DomainEditResponse
• client.emailSecurity.settings.domains.get(domainId, { ...params }) -> DomainGetResponse

ImpersonationRegistry

Types:

• ImpersonationRegistryCreateResponse
• ImpersonationRegistryListResponse
• ImpersonationRegistryDeleteResponse
• ImpersonationRegistryEditResponse
• ImpersonationRegistryGetResponse

Methods:

• client.emailSecurity.settings.impersonationRegistry.create({ ...params }) -> ImpersonationRegistryCreateResponse
• client.emailSecurity.settings.impersonationRegistry.list({ ...params }) -> ImpersonationRegistryListResponsesV4PagePaginationArray
• client.emailSecurity.settings.impersonationRegistry.delete(displayNameId, { ...params }) -> ImpersonationRegistryDeleteResponse
• client.emailSecurity.settings.impersonationRegistry.edit(displayNameId, { ...params }) -> ImpersonationRegistryEditResponse
• client.emailSecurity.settings.impersonationRegistry.get(displayNameId, { ...params }) -> ImpersonationRegistryGetResponse

TrustedDomains

Types:

• TrustedDomainCreateResponse
• TrustedDomainListResponse
• TrustedDomainDeleteResponse
• TrustedDomainEditResponse
• TrustedDomainGetResponse

Methods:

• client.emailSecurity.settings.trustedDomains.create({ ...params }) -> TrustedDomainCreateResponse
• client.emailSecurity.settings.trustedDomains.list({ ...params }) -> TrustedDomainListResponsesV4PagePaginationArray
• client.emailSecurity.settings.trustedDomains.delete(trustedDomainId, { ...params }) -> TrustedDomainDeleteResponse
• client.emailSecurity.settings.trustedDomains.edit(trustedDomainId, { ...params }) -> TrustedDomainEditResponse
• client.emailSecurity.settings.trustedDomains.get(trustedDomainId, { ...params }) -> TrustedDomainGetResponse

Submissions

Types:

• SubmissionListResponse

Methods:

• client.emailSecurity.submissions.list({ ...params }) -> SubmissionListResponsesV4PagePaginationArray

EmailRouting

Types:

• Settings

Methods:

• client.emailRouting.disable({ ...params }) -> Settings
• client.emailRouting.enable({ ...params }) -> Settings
• client.emailRouting.get({ ...params }) -> Settings

DNS

Types:

• DNSRecord
• DNSGetResponse

Methods:

• client.emailRouting.dns.create({ ...params }) -> Settings
• client.emailRouting.dns.delete({ ...params }) -> DNSRecordsSinglePage
• client.emailRouting.dns.edit({ ...params }) -> Settings
• client.emailRouting.dns.get({ ...params }) -> DNSGetResponse

Rules

Types:

• Action
• EmailRoutingRule
• Matcher

Methods:

• client.emailRouting.rules.create({ ...params }) -> EmailRoutingRule
• client.emailRouting.rules.update(ruleIdentifier, { ...params }) -> EmailRoutingRule
• client.emailRouting.rules.list({ ...params }) -> EmailRoutingRulesV4PagePaginationArray
• client.emailRouting.rules.delete(ruleIdentifier, { ...params }) -> EmailRoutingRule
• client.emailRouting.rules.get(ruleIdentifier, { ...params }) -> EmailRoutingRule

CatchAlls

Types:

• CatchAllAction
• CatchAllMatcher
• CatchAllUpdateResponse
• CatchAllGetResponse

Methods:

• client.emailRouting.rules.catchAlls.update({ ...params }) -> CatchAllUpdateResponse
• client.emailRouting.rules.catchAlls.get({ ...params }) -> CatchAllGetResponse

Addresses

Types:

• Address

Methods:

• client.emailRouting.addresses.create({ ...params }) -> Address
• client.emailRouting.addresses.list({ ...params }) -> AddressesV4PagePaginationArray
• client.emailRouting.addresses.delete(destinationAddressIdentifier, { ...params }) -> Address
• client.emailRouting.addresses.get(destinationAddressIdentifier, { ...params }) -> Address

Filters

Types:

• FirewallFilter

Methods:

• client.filters.create({ ...params }) -> FirewallFiltersSinglePage
• client.filters.update(filterId, { ...params }) -> FirewallFilter
• client.filters.list({ ...params }) -> FirewallFiltersV4PagePaginationArray
• client.filters.delete(filterId, { ...params }) -> FirewallFilter
• client.filters.bulkDelete({ ...params }) -> FirewallFiltersSinglePage
• client.filters.bulkUpdate({ ...params }) -> FirewallFiltersSinglePage
• client.filters.get(filterId, { ...params }) -> FirewallFilter

Firewall

Lockdowns

Types:

• Configuration
• Lockdown
• LockdownCIDRConfiguration
• LockdownIPConfiguration
• LockdownURL
• LockdownDeleteResponse

Methods:

• client.firewall.lockdowns.create({ ...params }) -> Lockdown
• client.firewall.lockdowns.update(lockDownsId, { ...params }) -> Lockdown
• client.firewall.lockdowns.list({ ...params }) -> LockdownsV4PagePaginationArray
• client.firewall.lockdowns.delete(lockDownsId, { ...params }) -> LockdownDeleteResponse
• client.firewall.lockdowns.get(lockDownsId, { ...params }) -> Lockdown

Rules

Types:

• DeletedFilter
• FirewallRule
• Product

Methods:

• client.firewall.rules.create({ ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.update(ruleId, { ...params }) -> FirewallRule
• client.firewall.rules.list({ ...params }) -> FirewallRulesV4PagePaginationArray
• client.firewall.rules.delete(ruleId, { ...params }) -> FirewallRule
• client.firewall.rules.bulkDelete({ ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.bulkEdit({ ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.bulkUpdate({ ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.edit(ruleId, { ...params }) -> FirewallRulesSinglePage
• client.firewall.rules.get(ruleId, { ...params }) -> FirewallRule

AccessRules

Types:

• AccessRuleCIDRConfiguration
• AccessRuleIPConfiguration
• ASNConfiguration
• CountryConfiguration
• IPV6Configuration
• AccessRuleCreateResponse
• AccessRuleListResponse
• AccessRuleDeleteResponse
• AccessRuleEditResponse
• AccessRuleGetResponse

Methods:

• client.firewall.accessRules.create({ ...params }) -> AccessRuleCreateResponse
• client.firewall.accessRules.list({ ...params }) -> AccessRuleListResponsesV4PagePaginationArray
• client.firewall.accessRules.delete(ruleId, { ...params }) -> AccessRuleDeleteResponse | null
• client.firewall.accessRules.edit(ruleId, { ...params }) -> AccessRuleEditResponse
• client.firewall.accessRules.get(ruleId, { ...params }) -> AccessRuleGetResponse

UARules

Types:

• UARuleCreateResponse
• UARuleUpdateResponse
• UARuleListResponse
• UARuleDeleteResponse
• UARuleGetResponse

Methods:

• client.firewall.uaRules.create({ ...params }) -> UARuleCreateResponse
• client.firewall.uaRules.update(uaRuleId, { ...params }) -> UARuleUpdateResponse
• client.firewall.uaRules.list({ ...params }) -> UARuleListResponsesV4PagePaginationArray
• client.firewall.uaRules.delete(uaRuleId, { ...params }) -> UARuleDeleteResponse
• client.firewall.uaRules.get(uaRuleId, { ...params }) -> UARuleGetResponse

WAF

Overrides

Types:

• Override
• OverrideURL
• RewriteAction
• WAFRule
• OverrideDeleteResponse

Methods:

• client.firewall.waf.overrides.create({ ...params }) -> Override
• client.firewall.waf.overrides.update(overridesId, { ...params }) -> Override
• client.firewall.waf.overrides.list({ ...params }) -> OverridesV4PagePaginationArray
• client.firewall.waf.overrides.delete(overridesId, { ...params }) -> OverrideDeleteResponse
• client.firewall.waf.overrides.get(overridesId, { ...params }) -> Override

Packages

Types:

• PackageListResponse
• PackageGetResponse

Methods:

• client.firewall.waf.packages.list({ ...params }) -> PackageListResponsesV4PagePaginationArray
• client.firewall.waf.packages.get(packageId, { ...params }) -> PackageGetResponse

Groups

Types:

• Group
• GroupEditResponse
• GroupGetResponse

Methods:

• client.firewall.waf.packages.groups.list(packageId, { ...params }) -> GroupsV4PagePaginationArray
• client.firewall.waf.packages.groups.edit(packageId, groupId, { ...params }) -> GroupEditResponse
• client.firewall.waf.packages.groups.get(packageId, groupId, { ...params }) -> GroupGetResponse

Rules

Types:

• AllowedModesAnomaly
• WAFRuleGroup
• RuleListResponse
• RuleEditResponse
• RuleGetResponse

Methods:

• client.firewall.waf.packages.rules.list(packageId, { ...params }) -> RuleListResponsesV4PagePaginationArray
• client.firewall.waf.packages.rules.edit(packageId, ruleId, { ...params }) -> RuleEditResponse
• client.firewall.waf.packages.rules.get(packageId, ruleId, { ...params }) -> RuleGetResponse

Healthchecks

Types:

• CheckRegion
• Healthcheck
• HTTPConfiguration
• QueryHealthcheck
• TCPConfiguration
• HealthcheckDeleteResponse

Methods:

• client.healthchecks.create({ ...params }) -> Healthcheck
• client.healthchecks.update(healthcheckId, { ...params }) -> Healthcheck
• client.healthchecks.list({ ...params }) -> HealthchecksV4PagePaginationArray
• client.healthchecks.delete(healthcheckId, { ...params }) -> HealthcheckDeleteResponse
• client.healthchecks.edit(healthcheckId, { ...params }) -> Healthcheck
• client.healthchecks.get(healthcheckId, { ...params }) -> Healthcheck

Previews

Types:

• PreviewDeleteResponse

Methods:

• client.healthchecks.previews.create({ ...params }) -> Healthcheck
• client.healthchecks.previews.delete(healthcheckId, { ...params }) -> PreviewDeleteResponse
• client.healthchecks.previews.get(healthcheckId, { ...params }) -> Healthcheck

KeylessCertificates

Types:

• KeylessCertificate
• Tunnel
• KeylessCertificateDeleteResponse

Methods:

• client.keylessCertificates.create({ ...params }) -> KeylessCertificate
• client.keylessCertificates.list({ ...params }) -> KeylessCertificatesSinglePage
• client.keylessCertificates.delete(keylessCertificateId, { ...params }) -> KeylessCertificateDeleteResponse
• client.keylessCertificates.edit(keylessCertificateId, { ...params }) -> KeylessCertificate
• client.keylessCertificates.get(keylessCertificateId, { ...params }) -> KeylessCertificate

Logpush

Datasets

Fields

Types:

• FieldGetResponse

Methods:

• client.logpush.datasets.fields.get(datasetId, { ...params }) -> FieldGetResponse

Jobs

Methods:

• client.logpush.datasets.jobs.get(datasetId, { ...params }) -> LogpushJobsSinglePage

Edge

Types:

• InstantLogpushJob

Methods:

• client.logpush.edge.create({ ...params }) -> InstantLogpushJob | null
• client.logpush.edge.get({ ...params }) -> InstantLogpushJobsSinglePage

Jobs

Types:

• LogpushJob
• OutputOptions
• JobDeleteResponse

Methods:

• client.logpush.jobs.create({ ...params }) -> LogpushJob | null
• client.logpush.jobs.update(jobId, { ...params }) -> LogpushJob | null
• client.logpush.jobs.list({ ...params }) -> LogpushJobsSinglePage
• client.logpush.jobs.delete(jobId, { ...params }) -> JobDeleteResponse
• client.logpush.jobs.get(jobId, { ...params }) -> LogpushJob | null

Ownership

Types:

• OwnershipValidation
• OwnershipCreateResponse

Methods:

• client.logpush.ownership.create({ ...params }) -> OwnershipCreateResponse | null
• client.logpush.ownership.validate({ ...params }) -> OwnershipValidation | null

Validate

Types:

• ValidateDestinationResponse
• ValidateDestinationExistsResponse
• ValidateOriginResponse

Methods:

• client.logpush.validate.destination({ ...params }) -> ValidateDestinationResponse | null
• client.logpush.validate.destinationExists({ ...params }) -> ValidateDestinationExistsResponse | null
• client.logpush.validate.origin({ ...params }) -> ValidateOriginResponse | null

Logs

Control

Retention

Types:

• RetentionCreateResponse
• RetentionGetResponse

Methods:

• client.logs.control.retention.create({ ...params }) -> RetentionCreateResponse | null
• client.logs.control.retention.get({ ...params }) -> RetentionGetResponse | null

Cmb

Config

Types:

• CmbConfig
• ConfigDeleteResponse

Methods:

• client.logs.control.cmb.config.create({ ...params }) -> CmbConfig | null
• client.logs.control.cmb.config.delete({ ...params }) -> ConfigDeleteResponse | null
• client.logs.control.cmb.config.get({ ...params }) -> CmbConfig | null

RayID

Types:

• RayIDGetResponse

Methods:

• client.logs.RayID.get(RayID, { ...params }) -> RayIDGetResponse

Received

Types:

• ReceivedGetResponse

Methods:

• client.logs.received.get({ ...params }) -> ReceivedGetResponse

Fields

Types:

• FieldGetResponse

Methods:

• client.logs.received.fields.get({ ...params }) -> FieldGetResponse

OriginTLSClientAuth

Types:

• ZoneAuthenticatedOriginPull
• OriginTLSClientAuthCreateResponse
• OriginTLSClientAuthListResponse
• OriginTLSClientAuthDeleteResponse
• OriginTLSClientAuthGetResponse

Methods:

• client.originTLSClientAuth.create({ ...params }) -> OriginTLSClientAuthCreateResponse
• client.originTLSClientAuth.list({ ...params }) -> OriginTLSClientAuthListResponsesSinglePage
• client.originTLSClientAuth.delete(certificateId, { ...params }) -> OriginTLSClientAuthDeleteResponse
• client.originTLSClientAuth.get(certificateId, { ...params }) -> OriginTLSClientAuthGetResponse

Hostnames

Types:

• AuthenticatedOriginPull
• HostnameUpdateResponse

Methods:

• client.originTLSClientAuth.hostnames.update({ ...params }) -> HostnameUpdateResponsesSinglePage
• client.originTLSClientAuth.hostnames.get(hostname, { ...params }) -> AuthenticatedOriginPull

Certificates

Types:

• Certificate
• CertificateCreateResponse
• CertificateListResponse
• CertificateDeleteResponse
• CertificateGetResponse

Methods:

• client.originTLSClientAuth.hostnames.certificates.create({ ...params }) -> CertificateCreateResponse
• client.originTLSClientAuth.hostnames.certificates.list({ ...params }) -> CertificateListResponsesSinglePage
• client.originTLSClientAuth.hostnames.certificates.delete(certificateId, { ...params }) -> CertificateDeleteResponse
• client.originTLSClientAuth.hostnames.certificates.get(certificateId, { ...params }) -> CertificateGetResponse

Settings

Types:

• SettingUpdateResponse
• SettingGetResponse

Methods:

• client.originTLSClientAuth.settings.update({ ...params }) -> SettingUpdateResponse
• client.originTLSClientAuth.settings.get({ ...params }) -> SettingGetResponse

PageRules

Types:

• PageRule
• Target
• PageRuleListResponse
• PageRuleDeleteResponse

Methods:

• client.pageRules.create({ ...params }) -> PageRule
• client.pageRules.update(pageruleId, { ...params }) -> PageRule
• client.pageRules.list({ ...params }) -> PageRuleListResponse
• client.pageRules.delete(pageruleId, { ...params }) -> PageRuleDeleteResponse | null
• client.pageRules.edit(pageruleId, { ...params }) -> PageRule
• client.pageRules.get(pageruleId, { ...params }) -> PageRule

RateLimits

Types:

• Action
• RateLimit
• RateLimitDeleteResponse

Methods:

• client.rateLimits.create({ ...params }) -> RateLimit
• client.rateLimits.list({ ...params }) -> RateLimitsV4PagePaginationArray
• client.rateLimits.delete(rateLimitId, { ...params }) -> RateLimitDeleteResponse
• client.rateLimits.edit(rateLimitId, { ...params }) -> RateLimit
• client.rateLimits.get(rateLimitId, { ...params }) -> RateLimit

WaitingRooms

Types:

• AdditionalRoutes
• CookieAttributes
• Query
• WaitingRoom
• WaitingRoomDeleteResponse

Methods:

• client.waitingRooms.create({ ...params }) -> WaitingRoom
• client.waitingRooms.update(waitingRoomId, { ...params }) -> WaitingRoom
• client.waitingRooms.list({ ...params }) -> WaitingRoomsV4PagePaginationArray
• client.waitingRooms.delete(waitingRoomId, { ...params }) -> WaitingRoomDeleteResponse
• client.waitingRooms.edit(waitingRoomId, { ...params }) -> WaitingRoom
• client.waitingRooms.get(waitingRoomId, { ...params }) -> WaitingRoom

Page

Types:

• PagePreviewResponse

Methods:

• client.waitingRooms.page.preview({ ...params }) -> PagePreviewResponse

Events

Types:

• Event
• EventDeleteResponse

Methods:

• client.waitingRooms.events.create(waitingRoomId, { ...params }) -> Event
• client.waitingRooms.events.update(waitingRoomId, eventId, { ...params }) -> Event
• client.waitingRooms.events.list(waitingRoomId, { ...params }) -> EventsV4PagePaginationArray
• client.waitingRooms.events.delete(waitingRoomId, eventId, { ...params }) -> EventDeleteResponse
• client.waitingRooms.events.edit(waitingRoomId, eventId, { ...params }) -> Event
• client.waitingRooms.events.get(waitingRoomId, eventId, { ...params }) -> Event

Details

Types:

• EventQuery
• DetailGetResponse

Methods:

• client.waitingRooms.events.details.get(waitingRoomId, eventId, { ...params }) -> DetailGetResponse

Rules

Types:

• WaitingRoomRule

Methods:

• client.waitingRooms.rules.create(waitingRoomId, { ...params }) -> WaitingRoomRulesSinglePage
• client.waitingRooms.rules.update(waitingRoomId, [ ...rules ]) -> WaitingRoomRulesSinglePage
• client.waitingRooms.rules.delete(waitingRoomId, ruleId, { ...params }) -> WaitingRoomRulesSinglePage
• client.waitingRooms.rules.edit(waitingRoomId, ruleId, { ...params }) -> WaitingRoomRulesSinglePage
• client.waitingRooms.rules.get(waitingRoomId, { ...params }) -> WaitingRoomRulesSinglePage

Statuses

Types:

• StatusGetResponse

Methods:

• client.waitingRooms.statuses.get(waitingRoomId, { ...params }) -> StatusGetResponse

Settings

Types:

• Setting
• SettingUpdateResponse
• SettingEditResponse
• SettingGetResponse

Methods:

• client.waitingRooms.settings.update({ ...params }) -> SettingUpdateResponse
• client.waitingRooms.settings.edit({ ...params }) -> SettingEditResponse
• client.waitingRooms.settings.get({ ...params }) -> SettingGetResponse

Web3

Hostnames

Types:

• Hostname
• HostnameDeleteResponse

Methods:

• client.web3.hostnames.create({ ...params }) -> Hostname
• client.web3.hostnames.list({ ...params }) -> HostnamesSinglePage
• client.web3.hostnames.delete(identifier, { ...params }) -> HostnameDeleteResponse | null
• client.web3.hostnames.edit(identifier, { ...params }) -> Hostname
• client.web3.hostnames.get(identifier, { ...params }) -> Hostname

IPFSUniversalPaths

ContentLists

Types:

• ContentList

Methods:

• client.web3.hostnames.ipfsUniversalPaths.contentLists.update(identifier, { ...params }) -> ContentList
• client.web3.hostnames.ipfsUniversalPaths.contentLists.get(identifier, { ...params }) -> ContentList

Entries

Types:

• EntryCreateResponse
• EntryUpdateResponse
• EntryListResponse
• EntryDeleteResponse
• EntryGetResponse

Methods:

• client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.create(identifier, { ...params }) -> EntryCreateResponse
• client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.update(identifier, contentListEntryIdentifier, { ...params }) -> EntryUpdateResponse
• client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.list(identifier, { ...params }) -> EntryListResponse | null
• client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.delete(identifier, contentListEntryIdentifier, { ...params }) -> EntryDeleteResponse | null
• client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.get(identifier, contentListEntryIdentifier, { ...params }) -> EntryGetResponse

Workers

Types:

• MigrationStep
• SingleStepMigration
• WorkerMetadata

Routes

Types:

• RouteCreateResponse
• RouteUpdateResponse
• RouteListResponse
• RouteDeleteResponse
• RouteGetResponse

Methods:

• client.workers.routes.create({ ...params }) -> RouteCreateResponse
• client.workers.routes.update(routeId, { ...params }) -> RouteUpdateResponse
• client.workers.routes.list({ ...params }) -> RouteListResponsesSinglePage
• client.workers.routes.delete(routeId, { ...params }) -> RouteDeleteResponse
• client.workers.routes.get(routeId, { ...params }) -> RouteGetResponse

Assets

Upload

Types:

• UploadCreateResponse

Methods:

• client.workers.assets.upload.create({ ...params }) -> UploadCreateResponse

Scripts

Types:

• Script
• ScriptSetting
• ScriptUpdateResponse
• ScriptDeleteResponse
• ScriptGetResponse

Methods:

• client.workers.scripts.update(scriptName, { ...params }) -> ScriptUpdateResponse
• client.workers.scripts.list({ ...params }) -> ScriptsSinglePage
• client.workers.scripts.delete(scriptName, { ...params }) -> ScriptDeleteResponse | null
• client.workers.scripts.get(scriptName, { ...params }) -> string

Assets

Upload

Types:

• UploadCreateResponse

Methods:

• client.workers.scripts.assets.upload.create(scriptName, { ...params }) -> UploadCreateResponse

Subdomain

Types:

• SubdomainCreateResponse
• SubdomainDeleteResponse
• SubdomainGetResponse

Methods:

• client.workers.scripts.subdomain.create(scriptName, { ...params }) -> SubdomainCreateResponse
• client.workers.scripts.subdomain.delete(scriptName, { ...params }) -> SubdomainDeleteResponse
• client.workers.scripts.subdomain.get(scriptName, { ...params }) -> SubdomainGetResponse

Schedules

Types:

• ScheduleUpdateResponse
• ScheduleGetResponse

Methods:

• client.workers.scripts.schedules.update(scriptName, [ ...body ]) -> ScheduleUpdateResponse
• client.workers.scripts.schedules.get(scriptName, { ...params }) -> ScheduleGetResponse

Tail

Types:

• ConsumerScript
• TailCreateResponse
• TailDeleteResponse
• TailGetResponse

Methods:

• client.workers.scripts.tail.create(scriptName, { ...params }) -> TailCreateResponse
• client.workers.scripts.tail.delete(scriptName, id, { ...params }) -> TailDeleteResponse
• client.workers.scripts.tail.get(scriptName, { ...params }) -> TailGetResponse

Content

Methods:

• client.workers.scripts.content.update(scriptName, { ...params }) -> Script
• client.workers.scripts.content.get(scriptName, { ...params }) -> Response

Settings

Methods:

• client.workers.scripts.settings.edit(scriptName, { ...params }) -> ScriptSetting
• client.workers.scripts.settings.get(scriptName, { ...params }) -> ScriptSetting

Deployments

Types:

• Deployment
• DeploymentCreateResponse
• DeploymentGetResponse

Methods:

• client.workers.scripts.deployments.create(scriptName, { ...params }) -> DeploymentCreateResponse
• client.workers.scripts.deployments.get(scriptName, { ...params }) -> DeploymentGetResponse

Versions

Types:

• VersionCreateResponse
• VersionListResponse
• VersionGetResponse

Methods:

• client.workers.scripts.versions.create(scriptName, { ...params }) -> VersionCreateResponse
• client.workers.scripts.versions.list(scriptName, { ...params }) -> VersionListResponsesV4PagePagination
• client.workers.scripts.versions.get(scriptName, versionId, { ...params }) -> VersionGetResponse

Secrets

Types:

• SecretUpdateResponse
• SecretListResponse
• SecretDeleteResponse
• SecretGetResponse

Methods:

• client.workers.scripts.secrets.update(scriptName, { ...params }) -> SecretUpdateResponse
• client.workers.scripts.secrets.list(scriptName, { ...params }) -> SecretListResponsesSinglePage
• client.workers.scripts.secrets.delete(scriptName, secretName, { ...params }) -> SecretDeleteResponse | null
• client.workers.scripts.secrets.get(scriptName, secretName, { ...params }) -> SecretGetResponse

ScriptAndVersionSettings

Types:

• ScriptAndVersionSettingEditResponse
• ScriptAndVersionSettingGetResponse

Methods:

• client.workers.scripts.scriptAndVersionSettings.edit(scriptName, { ...params }) -> ScriptAndVersionSettingEditResponse
• client.workers.scripts.scriptAndVersionSettings.get(scriptName, { ...params }) -> ScriptAndVersionSettingGetResponse

AccountSettings

Types:

• AccountSettingUpdateResponse
• AccountSettingGetResponse

Methods:

• client.workers.accountSettings.update({ ...params }) -> AccountSettingUpdateResponse
• client.workers.accountSettings.get({ ...params }) -> AccountSettingGetResponse

Domains

Types:

• Domain

Methods:

• client.workers.domains.update({ ...params }) -> Domain
• client.workers.domains.list({ ...params }) -> DomainsSinglePage
• client.workers.domains.delete(domainId, { ...params }) -> void
• client.workers.domains.get(domainId, { ...params }) -> Domain

Subdomains

Types:

• SubdomainUpdateResponse
• SubdomainGetResponse

Methods:

• client.workers.subdomains.update({ ...params }) -> SubdomainUpdateResponse
• client.workers.subdomains.get({ ...params }) -> SubdomainGetResponse

Observability

Telemetry

Types:

• TelemetryKeysResponse
• TelemetryQueryResponse
• TelemetryValuesResponse

Methods:

• client.workers.observability.telemetry.keys({ ...params }) -> TelemetryKeysResponsesSinglePage
• client.workers.observability.telemetry.query({ ...params }) -> TelemetryQueryResponse
• client.workers.observability.telemetry.values({ ...params }) -> TelemetryValuesResponsesSinglePage

KV

Namespaces

Types:

• Namespace
• NamespaceDeleteResponse

Methods:

• client.kv.namespaces.create({ ...params }) -> Namespace
• client.kv.namespaces.update(namespaceId, { ...params }) -> Namespace
• client.kv.namespaces.list({ ...params }) -> NamespacesV4PagePaginationArray
• client.kv.namespaces.delete(namespaceId, { ...params }) -> NamespaceDeleteResponse | null
• client.kv.namespaces.get(namespaceId, { ...params }) -> Namespace

Keys

Types:

• Key
• KeyBulkDeleteResponse
• KeyBulkGetResponse
• KeyBulkUpdateResponse

Methods:

• client.kv.namespaces.keys.list(namespaceId, { ...params }) -> KeysCursorLimitPagination
• client.kv.namespaces.keys.bulkDelete(namespaceId, [ ...body ]) -> KeyBulkDeleteResponse | null
• client.kv.namespaces.keys.bulkGet(namespaceId, { ...params }) -> KeyBulkGetResponse | null
• client.kv.namespaces.keys.bulkUpdate(namespaceId, [ ...body ]) -> KeyBulkUpdateResponse | null

Metadata

Types:

• MetadataGetResponse

Methods:

• client.kv.namespaces.metadata.get(namespaceId, keyName, { ...params }) -> MetadataGetResponse

Values

Types:

• ValueUpdateResponse
• ValueDeleteResponse

Methods:

• client.kv.namespaces.values.update(namespaceId, keyName, { ...params }) -> ValueUpdateResponse | null
• client.kv.namespaces.values.delete(namespaceId, keyName, { ...params }) -> ValueDeleteResponse | null
• client.kv.namespaces.values.get(namespaceId, keyName, { ...params }) -> Response

DurableObjects

Namespaces

Types:

• Namespace

Methods:

• client.durableObjects.namespaces.list({ ...params }) -> NamespacesSinglePage

Objects

Types:

• DurableObject

Methods:

• client.durableObjects.namespaces.objects.list(id, { ...params }) -> DurableObjectsCursorLimitPagination

Queues

Types:

• Queue
• QueueDeleteResponse

Methods:

• client.queues.create({ ...params }) -> Queue
• client.queues.update(queueId, { ...params }) -> Queue
• client.queues.list({ ...params }) -> QueuesSinglePage
• client.queues.delete(queueId, { ...params }) -> QueueDeleteResponse
• client.queues.edit(queueId, { ...params }) -> Queue
• client.queues.get(queueId, { ...params }) -> Queue

Consumers

Types:

• Consumer
• ConsumerDeleteResponse

Methods:

• client.queues.consumers.create(queueId, { ...params }) -> Consumer
• client.queues.consumers.update(queueId, consumerId, { ...params }) -> Consumer
• client.queues.consumers.delete(queueId, consumerId, { ...params }) -> ConsumerDeleteResponse
• client.queues.consumers.get(queueId, { ...params }) -> ConsumersSinglePage

Messages

Types:

• MessageAckResponse
• MessageBulkPushResponse
• MessagePullResponse
• MessagePushResponse

Methods:

• client.queues.messages.ack(queueId, { ...params }) -> MessageAckResponse
• client.queues.messages.bulkPush(queueId, { ...params }) -> MessageBulkPushResponse
• client.queues.messages.pull(queueId, { ...params }) -> MessagePullResponsesSinglePage
• client.queues.messages.push(queueId, { ...params }) -> MessagePushResponse

Purge

Types:

• PurgeStatusResponse

Methods:

• client.queues.purge.start(queueId, { ...params }) -> Queue
• client.queues.purge.status(queueId, { ...params }) -> PurgeStatusResponse

APIGateway

Configurations

Types:

• Configuration
• ConfigurationUpdateResponse

Methods:

• client.apiGateway.configurations.update({ ...params }) -> ConfigurationUpdateResponse
• client.apiGateway.configurations.get({ ...params }) -> Configuration

Discovery

Types:

• DiscoveryOperation
• DiscoveryGetResponse

Methods:

• client.apiGateway.discovery.get({ ...params }) -> DiscoveryGetResponse

Operations

Types:

• OperationBulkEditResponse
• OperationEditResponse

Methods:

• client.apiGateway.discovery.operations.list({ ...params }) -> DiscoveryOperationsV4PagePaginationArray
• client.apiGateway.discovery.operations.bulkEdit({ ...params }) -> OperationBulkEditResponse
• client.apiGateway.discovery.operations.edit(operationId, { ...params }) -> OperationEditResponse

Operations

Types:

• APIShield
• OperationCreateResponse
• OperationListResponse
• OperationDeleteResponse
• OperationBulkCreateResponse
• OperationBulkDeleteResponse
• OperationGetResponse

Methods:

• client.apiGateway.operations.create({ ...params }) -> OperationCreateResponse
• client.apiGateway.operations.list({ ...params }) -> OperationListResponsesV4PagePaginationArray
• client.apiGateway.operations.delete(operationId, { ...params }) -> OperationDeleteResponse
• client.apiGateway.operations.bulkCreate([ ...body ]) -> OperationBulkCreateResponsesSinglePage
• client.apiGateway.operations.bulkDelete({ ...params }) -> OperationBulkDeleteResponse
• client.apiGateway.operations.get(operationId, { ...params }) -> OperationGetResponse

SchemaValidation

Types:

• SettingsMultipleRequest
• SchemaValidationUpdateResponse
• SchemaValidationGetResponse

Methods:

• client.apiGateway.operations.schemaValidation.update(operationId, { ...params }) -> SchemaValidationUpdateResponse
• client.apiGateway.operations.schemaValidation.edit({ ...params }) -> SettingsMultipleRequest
• client.apiGateway.operations.schemaValidation.get(operationId, { ...params }) -> SchemaValidationGetResponse

Schemas

Types:

• SchemaListResponse

Methods:

• client.apiGateway.schemas.list({ ...params }) -> SchemaListResponse

Settings

Types:

• Settings

SchemaValidation

Methods:

• client.apiGateway.settings.schemaValidation.update({ ...params }) -> Settings
• client.apiGateway.settings.schemaValidation.edit({ ...params }) -> Settings
• client.apiGateway.settings.schemaValidation.get({ ...params }) -> Settings

UserSchemas

Types:

• Message
• PublicSchema
• SchemaUpload
• UserSchemaDeleteResponse

Methods:

• client.apiGateway.userSchemas.create({ ...params }) -> SchemaUpload
• client.apiGateway.userSchemas.list({ ...params }) -> PublicSchemasV4PagePaginationArray
• client.apiGateway.userSchemas.delete(schemaId, { ...params }) -> UserSchemaDeleteResponse
• client.apiGateway.userSchemas.edit(schemaId, { ...params }) -> PublicSchema
• client.apiGateway.userSchemas.get(schemaId, { ...params }) -> PublicSchema

Operations

Types:

• OperationListResponse

Methods:

• client.apiGateway.userSchemas.operations.list(schemaId, { ...params }) -> OperationListResponsesV4PagePaginationArray

Hosts

Types:

• HostListResponse

Methods:

• client.apiGateway.userSchemas.hosts.list({ ...params }) -> HostListResponsesV4PagePaginationArray

ExpressionTemplate

Fallthrough

Types:

• FallthroughCreateResponse

Methods:

• client.apiGateway.expressionTemplate.fallthrough.create({ ...params }) -> FallthroughCreateResponse

ManagedTransforms

Types:

• ManagedTransformListResponse
• ManagedTransformEditResponse

Methods:

• client.managedTransforms.list({ ...params }) -> ManagedTransformListResponse
• client.managedTransforms.delete({ ...params }) -> void
• client.managedTransforms.edit({ ...params }) -> ManagedTransformEditResponse

PageShield

Types:

• Setting
• PageShieldUpdateResponse

Methods:

• client.pageShield.update({ ...params }) -> PageShieldUpdateResponse
• client.pageShield.get({ ...params }) -> Setting | null

Policies

Types:

• Policy
• PolicyCreateResponse
• PolicyUpdateResponse
• PolicyListResponse
• PolicyGetResponse

Methods:

• client.pageShield.policies.create({ ...params }) -> PolicyCreateResponse | null
• client.pageShield.policies.update(policyId, { ...params }) -> PolicyUpdateResponse | null
• client.pageShield.policies.list({ ...params }) -> PolicyListResponsesSinglePage
• client.pageShield.policies.delete(policyId, { ...params }) -> void
• client.pageShield.policies.get(policyId, { ...params }) -> PolicyGetResponse | null

Connections

Types:

• Connection

Methods:

• client.pageShield.connections.list({ ...params }) -> ConnectionsSinglePage
• client.pageShield.connections.get(connectionId, { ...params }) -> Connection | null

Scripts

Types:

• Script
• ScriptGetResponse

Methods:

• client.pageShield.scripts.list({ ...params }) -> ScriptsSinglePage
• client.pageShield.scripts.get(scriptId, { ...params }) -> ScriptGetResponse | null

Cookies

Types:

• CookieListResponse
• CookieGetResponse

Methods:

• client.pageShield.cookies.list({ ...params }) -> CookieListResponsesSinglePage
• client.pageShield.cookies.get(cookieId, { ...params }) -> CookieGetResponse | null

Rulesets

Types:

• Kind
• Phase
• Ruleset
• RulesetCreateResponse
• RulesetUpdateResponse
• RulesetListResponse
• RulesetGetResponse

Methods:

• client.rulesets.create({ ...params }) -> RulesetCreateResponse
• client.rulesets.update(rulesetId, { ...params }) -> RulesetUpdateResponse
• client.rulesets.list({ ...params }) -> RulesetListResponsesCursorPagination
• client.rulesets.delete(rulesetId, { ...params }) -> void
• client.rulesets.get(rulesetId, { ...params }) -> RulesetGetResponse

Phases

Types:

• PhaseUpdateResponse
• PhaseGetResponse

Methods:

• client.rulesets.phases.update(rulesetPhase, { ...params }) -> PhaseUpdateResponse
• client.rulesets.phases.get(rulesetPhase, { ...params }) -> PhaseGetResponse

Versions

Types:

• VersionListResponse
• VersionGetResponse

Methods:

• client.rulesets.phases.versions.list(rulesetPhase, { ...params }) -> VersionListResponsesSinglePage
• client.rulesets.phases.versions.get(rulesetPhase, rulesetVersion, { ...params }) -> VersionGetResponse

Rules

Types:

• BlockRule
• CompressResponseRule
• DDoSDynamicRule
• ExecuteRule
• ForceConnectionCloseRule
• LogCustomFieldRule
• LogRule
• Logging
• ManagedChallengeRule
• RedirectRule
• RewriteRule
• RewriteURIPart
• RouteRule
• RulesetRule
• ScoreRule
• ServeErrorRule
• SetCacheSettingsRule
• SetConfigRule
• SkipRule
• RuleCreateResponse
• RuleDeleteResponse
• RuleEditResponse

Methods:

• client.rulesets.rules.create(rulesetId, { ...params }) -> RuleCreateResponse
• client.rulesets.rules.delete(rulesetId, ruleId, { ...params }) -> RuleDeleteResponse
• client.rulesets.rules.edit(rulesetId, ruleId, { ...params }) -> RuleEditResponse

Versions

Types:

• VersionListResponse
• VersionGetResponse

Methods:

• client.rulesets.versions.list(rulesetId, { ...params }) -> VersionListResponsesSinglePage
• client.rulesets.versions.delete(rulesetId, rulesetVersion, { ...params }) -> void
• client.rulesets.versions.get(rulesetId, rulesetVersion, { ...params }) -> VersionGetResponse

URLNormalization

Types:

• URLNormalizationUpdateResponse
• URLNormalizationGetResponse

Methods:

• client.urlNormalization.update({ ...params }) -> URLNormalizationUpdateResponse
• client.urlNormalization.delete({ ...params }) -> void
• client.urlNormalization.get({ ...params }) -> URLNormalizationGetResponse

Spectrum

Types:

• DNS
• EdgeIPs
• OriginDNS
• OriginPort

Analytics

Aggregates

Currents

Types:

• CurrentGetResponse

Methods:

• client.spectrum.analytics.aggregates.currents.get({ ...params }) -> CurrentGetResponse

Events

Types:

• Dimension

Bytimes

Types:

• BytimeGetResponse

Methods:

• client.spectrum.analytics.events.bytimes.get({ ...params }) -> BytimeGetResponse

Summaries

Types:

• SummaryGetResponse

Methods:

• client.spectrum.analytics.events.summaries.get({ ...params }) -> SummaryGetResponse

Apps

Types:

• AppCreateResponse
• AppUpdateResponse
• AppListResponse
• AppDeleteResponse
• AppGetResponse

Methods:

• client.spectrum.apps.create({ ...params }) -> AppCreateResponse
• client.spectrum.apps.update(appId, { ...params }) -> AppUpdateResponse
• client.spectrum.apps.list({ ...params }) -> AppListResponsesV4PagePaginationArray
• client.spectrum.apps.delete(appId, { ...params }) -> AppDeleteResponse | null
• client.spectrum.apps.get(appId, { ...params }) -> AppGetResponse

Addressing

RegionalHostnames

Types:

• RegionalHostnameCreateResponse
• RegionalHostnameListResponse
• RegionalHostnameDeleteResponse
• RegionalHostnameEditResponse
• RegionalHostnameGetResponse

Methods:

• client.addressing.regionalHostnames.create({ ...params }) -> RegionalHostnameCreateResponse
• client.addressing.regionalHostnames.list({ ...params }) -> RegionalHostnameListResponsesSinglePage
• client.addressing.regionalHostnames.delete(hostname, { ...params }) -> RegionalHostnameDeleteResponse
• client.addressing.regionalHostnames.edit(hostname, { ...params }) -> RegionalHostnameEditResponse
• client.addressing.regionalHostnames.get(hostname, { ...params }) -> RegionalHostnameGetResponse

Regions

Types:

• RegionListResponse

Methods:

• client.addressing.regionalHostnames.regions.list({ ...params }) -> RegionListResponsesSinglePage

Services

Types:

• ServiceListResponse

Methods:

• client.addressing.services.list({ ...params }) -> ServiceListResponsesSinglePage

AddressMaps

Types:

• AddressMap
• Kind
• AddressMapCreateResponse
• AddressMapDeleteResponse
• AddressMapGetResponse

Methods:

• client.addressing.addressMaps.create({ ...params }) -> AddressMapCreateResponse
• client.addressing.addressMaps.list({ ...params }) -> AddressMapsSinglePage
• client.addressing.addressMaps.delete(addressMapId, { ...params }) -> AddressMapDeleteResponse
• client.addressing.addressMaps.edit(addressMapId, { ...params }) -> AddressMap
• client.addressing.addressMaps.get(addressMapId, { ...params }) -> AddressMapGetResponse

Accounts

Types:

• AccountUpdateResponse
• AccountDeleteResponse

Methods:

• client.addressing.addressMaps.accounts.update(addressMapId, { ...params }) -> AccountUpdateResponse
• client.addressing.addressMaps.accounts.delete(addressMapId, { ...params }) -> AccountDeleteResponse

IPs

Types:

• IPUpdateResponse
• IPDeleteResponse

Methods:

• client.addressing.addressMaps.ips.update(addressMapId, ipAddress, { ...params }) -> IPUpdateResponse
• client.addressing.addressMaps.ips.delete(addressMapId, ipAddress, { ...params }) -> IPDeleteResponse

Zones

Types:

• ZoneUpdateResponse
• ZoneDeleteResponse

Methods:

• client.addressing.addressMaps.zones.update(addressMapId, { ...params }) -> ZoneUpdateResponse
• client.addressing.addressMaps.zones.delete(addressMapId, { ...params }) -> ZoneDeleteResponse

LOADocuments

Types:

• LOADocumentCreateResponse

Methods:

• client.addressing.loaDocuments.create({ ...params }) -> LOADocumentCreateResponse
• client.addressing.loaDocuments.get(loaDocumentId, { ...params }) -> Response

Prefixes

Types:

• Prefix
• PrefixDeleteResponse

Methods:

• client.addressing.prefixes.create({ ...params }) -> Prefix
• client.addressing.prefixes.list({ ...params }) -> PrefixesSinglePage
• client.addressing.prefixes.delete(prefixId, { ...params }) -> PrefixDeleteResponse
• client.addressing.prefixes.edit(prefixId, { ...params }) -> Prefix
• client.addressing.prefixes.get(prefixId, { ...params }) -> Prefix

ServiceBindings

Types:

• ServiceBinding
• ServiceBindingDeleteResponse

Methods:

• client.addressing.prefixes.serviceBindings.create(prefixId, { ...params }) -> ServiceBinding
• client.addressing.prefixes.serviceBindings.list(prefixId, { ...params }) -> ServiceBindingsSinglePage
• client.addressing.prefixes.serviceBindings.delete(prefixId, bindingId, { ...params }) -> ServiceBindingDeleteResponse
• client.addressing.prefixes.serviceBindings.get(prefixId, bindingId, { ...params }) -> ServiceBinding

BGPPrefixes

Types:

• BGPPrefix

Methods:

• client.addressing.prefixes.bgpPrefixes.create(prefixId, { ...params }) -> BGPPrefix
• client.addressing.prefixes.bgpPrefixes.list(prefixId, { ...params }) -> BGPPrefixesSinglePage
• client.addressing.prefixes.bgpPrefixes.edit(prefixId, bgpPrefixId, { ...params }) -> BGPPrefix
• client.addressing.prefixes.bgpPrefixes.get(prefixId, bgpPrefixId, { ...params }) -> BGPPrefix

AdvertisementStatus

Types:

• AdvertisementStatusEditResponse
• AdvertisementStatusGetResponse

Methods:

• client.addressing.prefixes.advertisementStatus.edit(prefixId, { ...params }) -> AdvertisementStatusEditResponse
• client.addressing.prefixes.advertisementStatus.get(prefixId, { ...params }) -> AdvertisementStatusGetResponse

Delegations

Types:

• Delegations
• DelegationDeleteResponse

Methods:

• client.addressing.prefixes.delegations.create(prefixId, { ...params }) -> Delegations
• client.addressing.prefixes.delegations.list(prefixId, { ...params }) -> DelegationsSinglePage
• client.addressing.prefixes.delegations.delete(prefixId, delegationId, { ...params }) -> DelegationDeleteResponse

AuditLogs

Methods:

• client.auditLogs.list({ ...params }) -> AuditLogsV4PagePaginationArray

Billing

Profiles

Types:

• ProfileGetResponse

Methods:

• client.billing.profiles.get({ ...params }) -> ProfileGetResponse

BrandProtection

Types:

• Info
• RuleMatch
• ScanStatus
• Submit
• URLInfoModelResults

Methods:

• client.brandProtection.submit({ ...params }) -> Submit
• client.brandProtection.urlInfo({ ...params }) -> Info

Diagnostics

Traceroutes

Types:

• Traceroute

Methods:

• client.diagnostics.traceroutes.create({ ...params }) -> TraceroutesSinglePage

Images

V1

Types:

• Image
• V1ListResponse
• V1DeleteResponse

Methods:

• client.images.v1.create({ ...params }) -> Image
• client.images.v1.list({ ...params }) -> V1ListResponsesV4PagePagination
• client.images.v1.delete(imageId, { ...params }) -> V1DeleteResponse
• client.images.v1.edit(imageId, { ...params }) -> Image
• client.images.v1.get(imageId, { ...params }) -> Image

Keys

Types:

• Key
• KeyUpdateResponse
• KeyListResponse
• KeyDeleteResponse

Methods:

• client.images.v1.keys.update(signingKeyName, { ...params }) -> KeyUpdateResponse
• client.images.v1.keys.list({ ...params }) -> KeyListResponse
• client.images.v1.keys.delete(signingKeyName, { ...params }) -> KeyDeleteResponse

Stats

Types:

• Stat

Methods:

• client.images.v1.stats.get({ ...params }) -> Stat

Variants

Types:

• Variant
• VariantCreateResponse
• VariantDeleteResponse
• VariantEditResponse
• VariantGetResponse

Methods:

• client.images.v1.variants.create({ ...params }) -> VariantCreateResponse
• client.images.v1.variants.list({ ...params }) -> Variant
• client.images.v1.variants.delete(variantId, { ...params }) -> VariantDeleteResponse
• client.images.v1.variants.edit(variantId, { ...params }) -> VariantEditResponse
• client.images.v1.variants.get(variantId, { ...params }) -> VariantGetResponse

Blobs

Methods:

• client.images.v1.blobs.get(imageId, { ...params }) -> Response

V2

Types:

• V2ListResponse

Methods:

• client.images.v2.list({ ...params }) -> V2ListResponse

DirectUploads

Types:

• DirectUploadCreateResponse

Methods:

• client.images.v2.directUploads.create({ ...params }) -> DirectUploadCreateResponse

Intel

ASN

Methods:

• client.intel.asn.get(asn, { ...params }) -> ASN

Subnets

Types:

• SubnetGetResponse

Methods:

• client.intel.asn.subnets.get(asn, { ...params }) -> SubnetGetResponse

DNS

Types:

• DNS

Methods:

• client.intel.dns.list({ ...params }) -> DNSV4PagePagination

Domains

Types:

• Domain

Methods:

• client.intel.domains.get({ ...params }) -> Domain

Bulks

Types:

• BulkGetResponse

Methods:

• client.intel.domains.bulks.get({ ...params }) -> BulkGetResponse | null

DomainHistory

Types:

• DomainHistory
• DomainHistoryGetResponse

Methods:

• client.intel.domainHistory.get({ ...params }) -> DomainHistoryGetResponse | null

IPs

Types:

• IP
• IPGetResponse

Methods:

• client.intel.ips.get({ ...params }) -> IPGetResponse | null

IPLists

Types:

• IPList

Methods:

• client.intel.ipLists.get({ ...params }) -> IPListsSinglePage

Miscategorizations

Types:

• MiscategorizationCreateResponse

Methods:

• client.intel.miscategorizations.create({ ...params }) -> MiscategorizationCreateResponse

Whois

Types:

• Whois
• WhoisGetResponse

Methods:

• client.intel.whois.get({ ...params }) -> WhoisGetResponse

IndicatorFeeds

Types:

• IndicatorFeedCreateResponse
• IndicatorFeedUpdateResponse
• IndicatorFeedListResponse
• IndicatorFeedDataResponse
• IndicatorFeedGetResponse

Methods:

• client.intel.indicatorFeeds.create({ ...params }) -> IndicatorFeedCreateResponse
• client.intel.indicatorFeeds.update(feedId, { ...params }) -> IndicatorFeedUpdateResponse
• client.intel.indicatorFeeds.list({ ...params }) -> IndicatorFeedListResponsesSinglePage
• client.intel.indicatorFeeds.data(feedId, { ...params }) -> string
• client.intel.indicatorFeeds.get(feedId, { ...params }) -> IndicatorFeedGetResponse

Snapshots

Types:

• SnapshotUpdateResponse

Methods:

• client.intel.indicatorFeeds.snapshots.update(feedId, { ...params }) -> SnapshotUpdateResponse

Permissions

Types:

• PermissionCreateResponse
• PermissionListResponse
• PermissionDeleteResponse

Methods:

• client.intel.indicatorFeeds.permissions.create({ ...params }) -> PermissionCreateResponse
• client.intel.indicatorFeeds.permissions.list({ ...params }) -> PermissionListResponse
• client.intel.indicatorFeeds.permissions.delete({ ...params }) -> PermissionDeleteResponse

Downloads

Types:

• DownloadGetResponse

Methods:

• client.intel.indicatorFeeds.downloads.get(feedId, { ...params }) -> DownloadGetResponse

Sinkholes

Types:

• Sinkhole

Methods:

• client.intel.sinkholes.list({ ...params }) -> SinkholesSinglePage

AttackSurfaceReport

IssueTypes

Types:

• IssueTypeGetResponse

Methods:

• client.intel.attackSurfaceReport.issueTypes.get({ ...params }) -> IssueTypeGetResponsesSinglePage

Issues

Types:

• IssueType
• SeverityQueryParam
• IssueListResponse
• IssueClassResponse
• IssueDismissResponse
• IssueSeverityResponse
• IssueTypeResponse

Methods:

• client.intel.attackSurfaceReport.issues.list({ ...params }) -> IssueListResponsesV4PagePagination
• client.intel.attackSurfaceReport.issues.class({ ...params }) -> IssueClassResponse
• client.intel.attackSurfaceReport.issues.dismiss(issueId, { ...params }) -> IssueDismissResponse
• client.intel.attackSurfaceReport.issues.severity({ ...params }) -> IssueSeverityResponse
• client.intel.attackSurfaceReport.issues.type({ ...params }) -> IssueTypeResponse

MagicTransit

Types:

• HealthCheck
• HealthCheckRate
• HealthCheckType

Apps

Types:

• AppCreateResponse
• AppUpdateResponse
• AppListResponse
• AppDeleteResponse
• AppEditResponse

Methods:

• client.magicTransit.apps.create({ ...params }) -> AppCreateResponse | null
• client.magicTransit.apps.update(accountAppId, { ...params }) -> AppUpdateResponse | null
• client.magicTransit.apps.list({ ...params }) -> AppListResponsesSinglePage
• client.magicTransit.apps.delete(accountAppId, { ...params }) -> AppDeleteResponse | null
• client.magicTransit.apps.edit(accountAppId, { ...params }) -> AppEditResponse | null

CfInterconnects

Types:

• CfInterconnectUpdateResponse
• CfInterconnectListResponse
• CfInterconnectBulkUpdateResponse
• CfInterconnectGetResponse

Methods:

• client.magicTransit.cfInterconnects.update(cfInterconnectId, { ...params }) -> CfInterconnectUpdateResponse
• client.magicTransit.cfInterconnects.list({ ...params }) -> CfInterconnectListResponse
• client.magicTransit.cfInterconnects.bulkUpdate({ ...params }) -> CfInterconnectBulkUpdateResponse
• client.magicTransit.cfInterconnects.get(cfInterconnectId, { ...params }) -> CfInterconnectGetResponse

GRETunnels

Types:

• GRETunnelCreateResponse
• GRETunnelUpdateResponse
• GRETunnelListResponse
• GRETunnelDeleteResponse
• GRETunnelBulkUpdateResponse
• GRETunnelGetResponse

Methods:

• client.magicTransit.greTunnels.create({ ...params }) -> GRETunnelCreateResponse
• client.magicTransit.greTunnels.update(greTunnelId, { ...params }) -> GRETunnelUpdateResponse
• client.magicTransit.greTunnels.list({ ...params }) -> GRETunnelListResponse
• client.magicTransit.greTunnels.delete(greTunnelId, { ...params }) -> GRETunnelDeleteResponse
• client.magicTransit.greTunnels.bulkUpdate({ ...params }) -> GRETunnelBulkUpdateResponse
• client.magicTransit.greTunnels.get(greTunnelId, { ...params }) -> GRETunnelGetResponse

IPSECTunnels

Types:

• PSKMetadata
• IPSECTunnelCreateResponse
• IPSECTunnelUpdateResponse
• IPSECTunnelListResponse
• IPSECTunnelDeleteResponse
• IPSECTunnelBulkUpdateResponse
• IPSECTunnelGetResponse
• IPSECTunnelPSKGenerateResponse

Methods:

• client.magicTransit.ipsecTunnels.create({ ...params }) -> IPSECTunnelCreateResponse
• client.magicTransit.ipsecTunnels.update(ipsecTunnelId, { ...params }) -> IPSECTunnelUpdateResponse
• client.magicTransit.ipsecTunnels.list({ ...params }) -> IPSECTunnelListResponse
• client.magicTransit.ipsecTunnels.delete(ipsecTunnelId, { ...params }) -> IPSECTunnelDeleteResponse
• client.magicTransit.ipsecTunnels.bulkUpdate({ ...params }) -> IPSECTunnelBulkUpdateResponse
• client.magicTransit.ipsecTunnels.get(ipsecTunnelId, { ...params }) -> IPSECTunnelGetResponse
• client.magicTransit.ipsecTunnels.pskGenerate(ipsecTunnelId, { ...params }) -> IPSECTunnelPSKGenerateResponse

Routes

Types:

• Scope
• RouteCreateResponse
• RouteUpdateResponse
• RouteListResponse
• RouteDeleteResponse
• RouteBulkUpdateResponse
• RouteEmptyResponse
• RouteGetResponse

Methods:

• client.magicTransit.routes.create({ ...params }) -> RouteCreateResponse
• client.magicTransit.routes.update(routeId, { ...params }) -> RouteUpdateResponse
• client.magicTransit.routes.list({ ...params }) -> RouteListResponse
• client.magicTransit.routes.delete(routeId, { ...params }) -> RouteDeleteResponse
• client.magicTransit.routes.bulkUpdate({ ...params }) -> RouteBulkUpdateResponse
• client.magicTransit.routes.empty({ ...params }) -> RouteEmptyResponse
• client.magicTransit.routes.get(routeId, { ...params }) -> RouteGetResponse

Sites

Types:

• Site
• SiteLocation

Methods:

• client.magicTransit.sites.create({ ...params }) -> Site
• client.magicTransit.sites.update(siteId, { ...params }) -> Site
• client.magicTransit.sites.list({ ...params }) -> SitesSinglePage
• client.magicTransit.sites.delete(siteId, { ...params }) -> Site
• client.magicTransit.sites.edit(siteId, { ...params }) -> Site
• client.magicTransit.sites.get(siteId, { ...params }) -> Site

ACLs

Types:

• ACL
• ACLConfiguration
• AllowedProtocol
• Subnet

Methods:

• client.magicTransit.sites.acls.create(siteId, { ...params }) -> ACL
• client.magicTransit.sites.acls.update(siteId, aclId, { ...params }) -> ACL
• client.magicTransit.sites.acls.list(siteId, { ...params }) -> ACLsSinglePage
• client.magicTransit.sites.acls.delete(siteId, aclId, { ...params }) -> ACL
• client.magicTransit.sites.acls.edit(siteId, aclId, { ...params }) -> ACL
• client.magicTransit.sites.acls.get(siteId, aclId, { ...params }) -> ACL

LANs

Types:

• DHCPRelay
• DHCPServer
• LAN
• LANStaticAddressing
• Nat
• RoutedSubnet

Methods:

• client.magicTransit.sites.lans.create(siteId, { ...params }) -> LANsSinglePage
• client.magicTransit.sites.lans.update(siteId, lanId, { ...params }) -> LAN
• client.magicTransit.sites.lans.list(siteId, { ...params }) -> LANsSinglePage
• client.magicTransit.sites.lans.delete(siteId, lanId, { ...params }) -> LAN
• client.magicTransit.sites.lans.edit(siteId, lanId, { ...params }) -> LAN
• client.magicTransit.sites.lans.get(siteId, lanId, { ...params }) -> LAN

WANs

Types:

• WAN
• WANStaticAddressing

Methods:

• client.magicTransit.sites.wans.create(siteId, { ...params }) -> WANsSinglePage
• client.magicTransit.sites.wans.update(siteId, wanId, { ...params }) -> WAN
• client.magicTransit.sites.wans.list(siteId, { ...params }) -> WANsSinglePage
• client.magicTransit.sites.wans.delete(siteId, wanId, { ...params }) -> WAN
• client.magicTransit.sites.wans.edit(siteId, wanId, { ...params }) -> WAN
• client.magicTransit.sites.wans.get(siteId, wanId, { ...params }) -> WAN

Connectors

Types:

• ConnectorUpdateResponse
• ConnectorListResponse
• ConnectorEditResponse
• ConnectorGetResponse

Methods:

• client.magicTransit.connectors.update(connectorId, { ...params }) -> ConnectorUpdateResponse
• client.magicTransit.connectors.list({ ...params }) -> ConnectorListResponsesSinglePage
• client.magicTransit.connectors.edit(connectorId, { ...params }) -> ConnectorEditResponse
• client.magicTransit.connectors.get(connectorId, { ...params }) -> ConnectorGetResponse

Events

Types:

• EventListResponse
• EventGetResponse

Methods:

• client.magicTransit.connectors.events.list(connectorId, { ...params }) -> EventListResponse
• client.magicTransit.connectors.events.get(connectorId, eventT, eventN, { ...params }) -> EventGetResponse

Latest

Types:

• LatestListResponse

Methods:

• client.magicTransit.connectors.events.latest.list(connectorId, { ...params }) -> LatestListResponse

Snapshots

Types:

• SnapshotListResponse
• SnapshotGetResponse

Methods:

• client.magicTransit.connectors.snapshots.list(connectorId, { ...params }) -> SnapshotListResponse
• client.magicTransit.connectors.snapshots.get(connectorId, snapshotT, { ...params }) -> SnapshotGetResponse

Latest

Types:

• LatestListResponse

Methods:

• client.magicTransit.connectors.snapshots.latest.list(connectorId, { ...params }) -> LatestListResponse

PCAPs

Types:

• PCAP
• PCAPFilter
• PCAPCreateResponse
• PCAPListResponse
• PCAPGetResponse

Methods:

• client.magicTransit.pcaps.create({ ...params }) -> PCAPCreateResponse
• client.magicTransit.pcaps.list({ ...params }) -> PCAPListResponsesSinglePage
• client.magicTransit.pcaps.get(pcapId, { ...params }) -> PCAPGetResponse
• client.magicTransit.pcaps.stop(pcapId, { ...params }) -> void

Ownership

Types:

• Ownership

Methods:

• client.magicTransit.pcaps.ownership.create({ ...params }) -> Ownership
• client.magicTransit.pcaps.ownership.delete(ownershipId, { ...params }) -> void
• client.magicTransit.pcaps.ownership.get({ ...params }) -> OwnershipsSinglePage
• client.magicTransit.pcaps.ownership.validate({ ...params }) -> Ownership

Download

Methods:

• client.magicTransit.pcaps.download.get(pcapId, { ...params }) -> Response

MagicNetworkMonitoring

VPCFlows

Tokens

Types:

• TokenCreateResponse

Methods:

• client.magicNetworkMonitoring.vpcFlows.tokens.create({ ...params }) -> TokenCreateResponse

Configs

Types:

• Configuration

Methods:

• client.magicNetworkMonitoring.configs.create({ ...params }) -> Configuration
• client.magicNetworkMonitoring.configs.update({ ...params }) -> Configuration
• client.magicNetworkMonitoring.configs.delete({ ...params }) -> Configuration
• client.magicNetworkMonitoring.configs.edit({ ...params }) -> Configuration
• client.magicNetworkMonitoring.configs.get({ ...params }) -> Configuration

Full

Methods:

• client.magicNetworkMonitoring.configs.full.get({ ...params }) -> Configuration

Rules

Types:

• MagicNetworkMonitoringRule

Methods:

• client.magicNetworkMonitoring.rules.create({ ...params }) -> MagicNetworkMonitoringRule | null
• client.magicNetworkMonitoring.rules.update({ ...params }) -> MagicNetworkMonitoringRule | null
• client.magicNetworkMonitoring.rules.list({ ...params }) -> MagicNetworkMonitoringRulesSinglePage
• client.magicNetworkMonitoring.rules.delete(ruleId, { ...params }) -> MagicNetworkMonitoringRule | null
• client.magicNetworkMonitoring.rules.edit(ruleId, { ...params }) -> MagicNetworkMonitoringRule | null
• client.magicNetworkMonitoring.rules.get(ruleId, { ...params }) -> MagicNetworkMonitoringRule | null

Advertisements

Types:

• Advertisement

Methods:

• client.magicNetworkMonitoring.rules.advertisements.edit(ruleId, { ...params }) -> Advertisement | null

MagicCloudNetworking

CatalogSyncs

Types:

• CatalogSyncCreateResponse
• CatalogSyncUpdateResponse
• CatalogSyncListResponse
• CatalogSyncDeleteResponse
• CatalogSyncEditResponse
• CatalogSyncGetResponse
• CatalogSyncRefreshResponse

Methods:

• client.magicCloudNetworking.catalogSyncs.create({ ...params }) -> CatalogSyncCreateResponse
• client.magicCloudNetworking.catalogSyncs.update(syncId, { ...params }) -> CatalogSyncUpdateResponse
• client.magicCloudNetworking.catalogSyncs.list({ ...params }) -> CatalogSyncListResponsesSinglePage
• client.magicCloudNetworking.catalogSyncs.delete(syncId, { ...params }) -> CatalogSyncDeleteResponse
• client.magicCloudNetworking.catalogSyncs.edit(syncId, { ...params }) -> CatalogSyncEditResponse
• client.magicCloudNetworking.catalogSyncs.get(syncId, { ...params }) -> CatalogSyncGetResponse
• client.magicCloudNetworking.catalogSyncs.refresh(syncId, { ...params }) -> CatalogSyncRefreshResponse

PrebuiltPolicies

Types:

• PrebuiltPolicyListResponse

Methods:

• client.magicCloudNetworking.catalogSyncs.prebuiltPolicies.list({ ...params }) -> PrebuiltPolicyListResponsesSinglePage

OnRamps

Types:

• OnRampCreateResponse
• OnRampUpdateResponse
• OnRampListResponse
• OnRampDeleteResponse
• OnRampApplyResponse
• OnRampEditResponse
• OnRampGetResponse
• OnRampPlanResponse

Methods:

• client.magicCloudNetworking.onRamps.create({ ...params }) -> OnRampCreateResponse
• client.magicCloudNetworking.onRamps.update(onrampId, { ...params }) -> OnRampUpdateResponse
• client.magicCloudNetworking.onRamps.list({ ...params }) -> OnRampListResponsesSinglePage
• client.magicCloudNetworking.onRamps.delete(onrampId, { ...params }) -> OnRampDeleteResponse
• client.magicCloudNetworking.onRamps.apply(onrampId, { ...params }) -> OnRampApplyResponse
• client.magicCloudNetworking.onRamps.edit(onrampId, { ...params }) -> OnRampEditResponse
• client.magicCloudNetworking.onRamps.export(onrampId, { ...params }) -> Response
• client.magicCloudNetworking.onRamps.get(onrampId, { ...params }) -> OnRampGetResponse
• client.magicCloudNetworking.onRamps.plan(onrampId, { ...params }) -> OnRampPlanResponse

AddressSpaces

Types:

• AddressSpaceUpdateResponse
• AddressSpaceListResponse
• AddressSpaceEditResponse

Methods:

• client.magicCloudNetworking.onRamps.addressSpaces.update({ ...params }) -> AddressSpaceUpdateResponse
• client.magicCloudNetworking.onRamps.addressSpaces.list({ ...params }) -> AddressSpaceListResponse
• client.magicCloudNetworking.onRamps.addressSpaces.edit({ ...params }) -> AddressSpaceEditResponse

CloudIntegrations

Types:

• CloudIntegrationCreateResponse
• CloudIntegrationUpdateResponse
• CloudIntegrationListResponse
• CloudIntegrationDeleteResponse
• CloudIntegrationDiscoverResponse
• CloudIntegrationDiscoverAllResponse
• CloudIntegrationEditResponse
• CloudIntegrationGetResponse
• CloudIntegrationInitialSetupResponse

Methods:

• client.magicCloudNetworking.cloudIntegrations.create({ ...params }) -> CloudIntegrationCreateResponse
• client.magicCloudNetworking.cloudIntegrations.update(providerId, { ...params }) -> CloudIntegrationUpdateResponse
• client.magicCloudNetworking.cloudIntegrations.list({ ...params }) -> CloudIntegrationListResponsesSinglePage
• client.magicCloudNetworking.cloudIntegrations.delete(providerId, { ...params }) -> CloudIntegrationDeleteResponse
• client.magicCloudNetworking.cloudIntegrations.discover(providerId, { ...params }) -> CloudIntegrationDiscoverResponse
• client.magicCloudNetworking.cloudIntegrations.discoverAll({ ...params }) -> CloudIntegrationDiscoverAllResponse
• client.magicCloudNetworking.cloudIntegrations.edit(providerId, { ...params }) -> CloudIntegrationEditResponse
• client.magicCloudNetworking.cloudIntegrations.get(providerId, { ...params }) -> CloudIntegrationGetResponse
• client.magicCloudNetworking.cloudIntegrations.initialSetup(providerId, { ...params }) -> CloudIntegrationInitialSetupResponse

Resources

Types:

• ResourceListResponse
• ResourceGetResponse
• ResourcePolicyPreviewResponse

Methods:

• client.magicCloudNetworking.resources.list({ ...params }) -> ResourceListResponsesV4PagePaginationArray
• client.magicCloudNetworking.resources.export({ ...params }) -> Response
• client.magicCloudNetworking.resources.get(resourceId, { ...params }) -> ResourceGetResponse
• client.magicCloudNetworking.resources.policyPreview({ ...params }) -> ResourcePolicyPreviewResponse

NetworkInterconnects

CNIs

Types:

• CNICreateResponse
• CNIUpdateResponse
• CNIListResponse
• CNIGetResponse

Methods:

• client.networkInterconnects.cnis.create({ ...params }) -> CNICreateResponse
• client.networkInterconnects.cnis.update(cni, { ...params }) -> CNIUpdateResponse
• client.networkInterconnects.cnis.list({ ...params }) -> CNIListResponse
• client.networkInterconnects.cnis.delete(cni, { ...params }) -> void
• client.networkInterconnects.cnis.get(cni, { ...params }) -> CNIGetResponse

Interconnects

Types:

• InterconnectCreateResponse
• InterconnectListResponse
• InterconnectGetResponse
• InterconnectStatusResponse

Methods:

• client.networkInterconnects.interconnects.create({ ...params }) -> InterconnectCreateResponse
• client.networkInterconnects.interconnects.list({ ...params }) -> InterconnectListResponse
• client.networkInterconnects.interconnects.delete(icon, { ...params }) -> void
• client.networkInterconnects.interconnects.get(icon, { ...params }) -> InterconnectGetResponse
• client.networkInterconnects.interconnects.loa(icon, { ...params }) -> void
• client.networkInterconnects.interconnects.status(icon, { ...params }) -> InterconnectStatusResponse

Settings

Types:

• SettingUpdateResponse
• SettingGetResponse

Methods:

• client.networkInterconnects.settings.update({ ...params }) -> SettingUpdateResponse
• client.networkInterconnects.settings.get({ ...params }) -> SettingGetResponse

Slots

Types:

• SlotListResponse
• SlotGetResponse

Methods:

• client.networkInterconnects.slots.list({ ...params }) -> SlotListResponse
• client.networkInterconnects.slots.get(slot, { ...params }) -> SlotGetResponse

MTLSCertificates

Types:

• MTLSCertificate
• MTLSCertificateCreateResponse

Methods:

• client.mtlsCertificates.create({ ...params }) -> MTLSCertificateCreateResponse
• client.mtlsCertificates.list({ ...params }) -> MTLSCertificatesSinglePage
• client.mtlsCertificates.delete(mtlsCertificateId, { ...params }) -> MTLSCertificate
• client.mtlsCertificates.get(mtlsCertificateId, { ...params }) -> MTLSCertificate

Associations

Types:

• CertificateAsssociation

Methods:

• client.mtlsCertificates.associations.get(mtlsCertificateId, { ...params }) -> CertificateAsssociationsSinglePage

Pages

Projects

Types:

• Deployment
• Project
• Stage
• ProjectDeleteResponse
• ProjectPurgeBuildCacheResponse

Methods:

• client.pages.projects.create({ ...params }) -> Project
• client.pages.projects.list({ ...params }) -> DeploymentsSinglePage
• client.pages.projects.delete(projectName, { ...params }) -> ProjectDeleteResponse | null
• client.pages.projects.edit(projectName, { ...params }) -> Project
• client.pages.projects.get(projectName, { ...params }) -> Project
• client.pages.projects.purgeBuildCache(projectName, { ...params }) -> ProjectPurgeBuildCacheResponse | null

Deployments

Types:

• DeploymentDeleteResponse

Methods:

• client.pages.projects.deployments.create(projectName, { ...params }) -> Deployment
• client.pages.projects.deployments.list(projectName, { ...params }) -> DeploymentsSinglePage
• client.pages.projects.deployments.delete(projectName, deploymentId, { ...params }) -> DeploymentDeleteResponse | null
• client.pages.projects.deployments.get(projectName, deploymentId, { ...params }) -> Deployment
• client.pages.projects.deployments.retry(projectName, deploymentId, { ...params }) -> Deployment
• client.pages.projects.deployments.rollback(projectName, deploymentId, { ...params }) -> Deployment

History

Logs

Types:

• LogGetResponse

Methods:

• client.pages.projects.deployments.history.logs.get(projectName, deploymentId, { ...params }) -> LogGetResponse

Domains

Types:

• DomainCreateResponse
• DomainListResponse
• DomainDeleteResponse
• DomainEditResponse
• DomainGetResponse

Methods:

• client.pages.projects.domains.create(projectName, { ...params }) -> DomainCreateResponse | null
• client.pages.projects.domains.list(projectName, { ...params }) -> DomainListResponsesSinglePage
• client.pages.projects.domains.delete(projectName, domainName, { ...params }) -> DomainDeleteResponse | null
• client.pages.projects.domains.edit(projectName, domainName, { ...params }) -> DomainEditResponse | null
• client.pages.projects.domains.get(projectName, domainName, { ...params }) -> DomainGetResponse | null

Registrar

Domains

Types:

• Domain
• DomainUpdateResponse
• DomainGetResponse

Methods:

• client.registrar.domains.update(domainName, { ...params }) -> DomainUpdateResponse | null
• client.registrar.domains.list({ ...params }) -> DomainsSinglePage
• client.registrar.domains.get(domainName, { ...params }) -> DomainGetResponse | null

RequestTracers

Traces

Types:

• Trace
• TraceItem
• TraceCreateResponse

Methods:

• client.requestTracers.traces.create({ ...params }) -> TraceCreateResponse

Rules

Lists

Types:

• Hostname
• ListsList
• Redirect
• ListCreateResponse
• ListUpdateResponse
• ListListResponse
• ListDeleteResponse
• ListGetResponse

Methods:

• client.rules.lists.create({ ...params }) -> ListCreateResponse
• client.rules.lists.update(listId, { ...params }) -> ListUpdateResponse
• client.rules.lists.list({ ...params }) -> ListListResponse
• client.rules.lists.delete(listId, { ...params }) -> ListDeleteResponse
• client.rules.lists.get(listId, { ...params }) -> ListGetResponse

BulkOperations

Types:

• BulkOperationGetResponse

Methods:

• client.rules.lists.bulkOperations.get(operationId, { ...params }) -> BulkOperationGetResponse

Items

Types:

• ListCursor
• ListItem
• ItemCreateResponse
• ItemUpdateResponse
• ItemListResponse
• ItemDeleteResponse
• ItemGetResponse

Methods:

• client.rules.lists.items.create(listId, [ ...body ]) -> ItemCreateResponse
• client.rules.lists.items.update(listId, [ ...body ]) -> ItemUpdateResponse
• client.rules.lists.items.list(listId, { ...params }) -> ItemListResponse
• client.rules.lists.items.delete(listId, { ...params }) -> ItemDeleteResponse
• client.rules.lists.items.get(listId, itemId, { ...params }) -> ItemGetResponse

Stream

Types:

• AllowedOrigins
• Video

Methods:

• client.stream.create({ ...params }) -> void
• client.stream.list({ ...params }) -> VideosSinglePage
• client.stream.delete(identifier, { ...params }) -> void
• client.stream.edit(identifier, { ...params }) -> Video
• client.stream.get(identifier, { ...params }) -> Video

AudioTracks

Types:

• Audio
• AudioTrackDeleteResponse

Methods:

• client.stream.audioTracks.delete(identifier, audioIdentifier, { ...params }) -> AudioTrackDeleteResponse
• client.stream.audioTracks.copy(identifier, { ...params }) -> Audio
• client.stream.audioTracks.edit(identifier, audioIdentifier, { ...params }) -> Audio
• client.stream.audioTracks.get(identifier, { ...params }) -> AudioSinglePage

Videos

Types:

• VideoStorageUsageResponse

Methods:

• client.stream.videos.storageUsage({ ...params }) -> VideoStorageUsageResponse

Clip

Types:

• Clip

Methods:

• client.stream.clip.create({ ...params }) -> Clip

Copy

Methods:

• client.stream.copy.create({ ...params }) -> Video

DirectUpload

Types:

• DirectUploadCreateResponse

Methods:

• client.stream.directUpload.create({ ...params }) -> DirectUploadCreateResponse

Keys

Types:

• Keys
• KeyDeleteResponse
• KeyGetResponse

Methods:

• client.stream.keys.create({ ...params }) -> Keys
• client.stream.keys.delete(identifier, { ...params }) -> KeyDeleteResponse
• client.stream.keys.get({ ...params }) -> KeyGetResponsesSinglePage

LiveInputs

Types:

• LiveInput
• LiveInputListResponse

Methods:

• client.stream.liveInputs.create({ ...params }) -> LiveInput
• client.stream.liveInputs.update(liveInputIdentifier, { ...params }) -> LiveInput
• client.stream.liveInputs.list({ ...params }) -> LiveInputListResponse
• client.stream.liveInputs.delete(liveInputIdentifier, { ...params }) -> void
• client.stream.liveInputs.get(liveInputIdentifier, { ...params }) -> LiveInput

Outputs

Types:

• Output

Methods:

• client.stream.liveInputs.outputs.create(liveInputIdentifier, { ...params }) -> Output
• client.stream.liveInputs.outputs.update(liveInputIdentifier, outputIdentifier, { ...params }) -> Output
• client.stream.liveInputs.outputs.list(liveInputIdentifier, { ...params }) -> OutputsSinglePage
• client.stream.liveInputs.outputs.delete(liveInputIdentifier, outputIdentifier, { ...params }) -> void

Watermarks

Types:

• Watermark
• WatermarkDeleteResponse

Methods:

• client.stream.watermarks.create({ ...params }) -> Watermark
• client.stream.watermarks.list({ ...params }) -> WatermarksSinglePage
• client.stream.watermarks.delete(identifier, { ...params }) -> WatermarkDeleteResponse
• client.stream.watermarks.get(identifier, { ...params }) -> Watermark

Webhooks

Types:

• WebhookUpdateResponse
• WebhookDeleteResponse
• WebhookGetResponse

Methods:

• client.stream.webhooks.update({ ...params }) -> WebhookUpdateResponse
• client.stream.webhooks.delete({ ...params }) -> WebhookDeleteResponse
• client.stream.webhooks.get({ ...params }) -> WebhookGetResponse

Captions

Types:

• Caption

Methods:

• client.stream.captions.get(identifier, { ...params }) -> CaptionsSinglePage

Language

Types:

• LanguageDeleteResponse

Methods:

• client.stream.captions.language.create(identifier, language, { ...params }) -> Caption
• client.stream.captions.language.update(identifier, language, { ...params }) -> Caption
• client.stream.captions.language.delete(identifier, language, { ...params }) -> LanguageDeleteResponse
• client.stream.captions.language.get(identifier, language, { ...params }) -> Caption

Vtt

Types:

• VttGetResponse

Methods:

• client.stream.captions.language.vtt.get(identifier, language, { ...params }) -> string

Downloads

Types:

• DownloadCreateResponse
• DownloadDeleteResponse
• DownloadGetResponse

Methods:

• client.stream.downloads.create(identifier, { ...params }) -> DownloadCreateResponse
• client.stream.downloads.delete(identifier, { ...params }) -> DownloadDeleteResponse
• client.stream.downloads.get(identifier, { ...params }) -> DownloadGetResponse

Embed

Types:

• EmbedGetResponse

Methods:

• client.stream.embed.get(identifier, { ...params }) -> string

Token

Types:

• TokenCreateResponse

Methods:

• client.stream.token.create(identifier, { ...params }) -> TokenCreateResponse

Alerting

AvailableAlerts

Types:

• AvailableAlertListResponse

Methods:

• client.alerting.availableAlerts.list({ ...params }) -> AvailableAlertListResponse

Destinations

Eligible

Types:

• EligibleGetResponse

Methods:

• client.alerting.destinations.eligible.get({ ...params }) -> EligibleGetResponse

Pagerduty

Types:

• Pagerduty
• PagerdutyCreateResponse
• PagerdutyDeleteResponse
• PagerdutyLinkResponse

Methods:

• client.alerting.destinations.pagerduty.create({ ...params }) -> PagerdutyCreateResponse
• client.alerting.destinations.pagerduty.delete({ ...params }) -> PagerdutyDeleteResponse
• client.alerting.destinations.pagerduty.get({ ...params }) -> PagerdutiesSinglePage
• client.alerting.destinations.pagerduty.link(tokenId, { ...params }) -> PagerdutyLinkResponse

Webhooks

Types:

• Webhooks
• WebhookCreateResponse
• WebhookUpdateResponse
• WebhookDeleteResponse

Methods:

• client.alerting.destinations.webhooks.create({ ...params }) -> WebhookCreateResponse
• client.alerting.destinations.webhooks.update(webhookId, { ...params }) -> WebhookUpdateResponse
• client.alerting.destinations.webhooks.list({ ...params }) -> WebhooksSinglePage
• client.alerting.destinations.webhooks.delete(webhookId, { ...params }) -> WebhookDeleteResponse
• client.alerting.destinations.webhooks.get(webhookId, { ...params }) -> Webhooks

History

Types:

• History

Methods:

• client.alerting.history.list({ ...params }) -> HistoriesV4PagePaginationArray

Policies

Types:

• Mechanism
• Policy
• PolicyFilter
• PolicyCreateResponse
• PolicyUpdateResponse
• PolicyDeleteResponse

Methods:

• client.alerting.policies.create({ ...params }) -> PolicyCreateResponse
• client.alerting.policies.update(policyId, { ...params }) -> PolicyUpdateResponse
• client.alerting.policies.list({ ...params }) -> PoliciesSinglePage
• client.alerting.policies.delete(policyId, { ...params }) -> PolicyDeleteResponse
• client.alerting.policies.get(policyId, { ...params }) -> Policy

D1

Types:

• D1

Database

Types:

• QueryResult
• DatabaseListResponse
• DatabaseDeleteResponse
• DatabaseExportResponse
• DatabaseImportResponse
• DatabaseRawResponse

Methods:

• client.d1.database.create({ ...params }) -> D1
• client.d1.database.update(databaseId, { ...params }) -> D1
• client.d1.database.list({ ...params }) -> DatabaseListResponsesV4PagePaginationArray
• client.d1.database.delete(databaseId, { ...params }) -> DatabaseDeleteResponse | null
• client.d1.database.edit(databaseId, { ...params }) -> D1
• client.d1.database.export(databaseId, { ...params }) -> DatabaseExportResponse
• client.d1.database.get(databaseId, { ...params }) -> D1
• client.d1.database.import(databaseId, { ...params }) -> DatabaseImportResponse
• client.d1.database.query(databaseId, { ...params }) -> QueryResultsSinglePage
• client.d1.database.raw(databaseId, { ...params }) -> DatabaseRawResponsesSinglePage

R2

Buckets

Types:

• Bucket
• BucketListResponse
• BucketDeleteResponse

Methods:

• client.r2.buckets.create({ ...params }) -> Bucket
• client.r2.buckets.list({ ...params }) -> BucketListResponse
• client.r2.buckets.delete(bucketName, { ...params }) -> BucketDeleteResponse
• client.r2.buckets.edit(bucketName, { ...params }) -> Bucket
• client.r2.buckets.get(bucketName, { ...params }) -> Bucket

Lifecycle

Types:

• LifecycleUpdateResponse
• LifecycleGetResponse

Methods:

• client.r2.buckets.lifecycle.update(bucketName, { ...params }) -> LifecycleUpdateResponse
• client.r2.buckets.lifecycle.get(bucketName, { ...params }) -> LifecycleGetResponse

CORS

Types:

• CORSUpdateResponse
• CORSDeleteResponse
• CORSGetResponse

Methods:

• client.r2.buckets.cors.update(bucketName, { ...params }) -> CORSUpdateResponse
• client.r2.buckets.cors.delete(bucketName, { ...params }) -> CORSDeleteResponse
• client.r2.buckets.cors.get(bucketName, { ...params }) -> CORSGetResponse

Domains

Custom

Types:

• CustomCreateResponse
• CustomUpdateResponse
• CustomListResponse
• CustomDeleteResponse
• CustomGetResponse

Methods:

• client.r2.buckets.domains.custom.create(bucketName, { ...params }) -> CustomCreateResponse
• client.r2.buckets.domains.custom.update(bucketName, domain, { ...params }) -> CustomUpdateResponse
• client.r2.buckets.domains.custom.list(bucketName, { ...params }) -> CustomListResponse
• client.r2.buckets.domains.custom.delete(bucketName, domain, { ...params }) -> CustomDeleteResponse
• client.r2.buckets.domains.custom.get(bucketName, domain, { ...params }) -> CustomGetResponse

Managed

Types:

• ManagedUpdateResponse
• ManagedListResponse

Methods:

• client.r2.buckets.domains.managed.update(bucketName, { ...params }) -> ManagedUpdateResponse
• client.r2.buckets.domains.managed.list(bucketName, { ...params }) -> ManagedListResponse

EventNotifications

Types:

• EventNotificationUpdateResponse
• EventNotificationListResponse
• EventNotificationDeleteResponse
• EventNotificationGetResponse

Methods:

• client.r2.buckets.eventNotifications.update(bucketName, queueId, { ...params }) -> EventNotificationUpdateResponse
• client.r2.buckets.eventNotifications.list(bucketName, { ...params }) -> EventNotificationListResponse
• client.r2.buckets.eventNotifications.delete(bucketName, queueId, { ...params }) -> EventNotificationDeleteResponse
• client.r2.buckets.eventNotifications.get(bucketName, queueId, { ...params }) -> EventNotificationGetResponse

Locks

Types:

• LockUpdateResponse
• LockGetResponse

Methods:

• client.r2.buckets.locks.update(bucketName, { ...params }) -> LockUpdateResponse
• client.r2.buckets.locks.get(bucketName, { ...params }) -> LockGetResponse

Metrics

Types:

• MetricListResponse

Methods:

• client.r2.buckets.metrics.list({ ...params }) -> MetricListResponse

Sippy

Types:

• Provider
• Sippy
• SippyDeleteResponse

Methods:

• client.r2.buckets.sippy.update(bucketName, { ...params }) -> Sippy
• client.r2.buckets.sippy.delete(bucketName, { ...params }) -> SippyDeleteResponse
• client.r2.buckets.sippy.get(bucketName, { ...params }) -> Sippy

TemporaryCredentials

Types:

• TemporaryCredential
• TemporaryCredentialCreateResponse

Methods:

• client.r2.temporaryCredentials.create({ ...params }) -> TemporaryCredentialCreateResponse

SuperSlurper

Jobs

Types:

• JobCreateResponse
• JobListResponse
• JobAbortResponse
• JobAbortAllResponse
• JobGetResponse
• JobPauseResponse
• JobProgressResponse
• JobResumeResponse

Methods:

• client.r2.superSlurper.jobs.create({ ...params }) -> JobCreateResponse
• client.r2.superSlurper.jobs.list({ ...params }) -> JobListResponsesSinglePage
• client.r2.superSlurper.jobs.abort(jobId, { ...params }) -> JobAbortResponse
• client.r2.superSlurper.jobs.abortAll({ ...params }) -> JobAbortAllResponse
• client.r2.superSlurper.jobs.get(jobId, { ...params }) -> JobGetResponse
• client.r2.superSlurper.jobs.pause(jobId, { ...params }) -> JobPauseResponse
• client.r2.superSlurper.jobs.progress(jobId, { ...params }) -> JobProgressResponse
• client.r2.superSlurper.jobs.resume(jobId, { ...params }) -> JobResumeResponse

Logs

Types:

• LogListResponse

Methods:

• client.r2.superSlurper.jobs.logs.list(jobId, { ...params }) -> LogListResponsesSinglePage

ConnectivityPrecheck

Types:

• ConnectivityPrecheckSourceResponse
• ConnectivityPrecheckTargetResponse

Methods:

• client.r2.superSlurper.connectivityPrecheck.source({ ...params }) -> ConnectivityPrecheckSourceResponse
• client.r2.superSlurper.connectivityPrecheck.target({ ...params }) -> ConnectivityPrecheckTargetResponse

WorkersForPlatforms

Dispatch

Namespaces

Types:

• NamespaceCreateResponse
• NamespaceListResponse
• NamespaceDeleteResponse
• NamespaceGetResponse

Methods:

• client.workersForPlatforms.dispatch.namespaces.create({ ...params }) -> NamespaceCreateResponse
• client.workersForPlatforms.dispatch.namespaces.list({ ...params }) -> NamespaceListResponsesSinglePage
• client.workersForPlatforms.dispatch.namespaces.delete(dispatchNamespace, { ...params }) -> NamespaceDeleteResponse | null
• client.workersForPlatforms.dispatch.namespaces.get(dispatchNamespace, { ...params }) -> NamespaceGetResponse

Scripts

Types:

• Script
• ScriptUpdateResponse
• ScriptDeleteResponse

Methods:

• client.workersForPlatforms.dispatch.namespaces.scripts.update(dispatchNamespace, scriptName, { ...params }) -> ScriptUpdateResponse
• client.workersForPlatforms.dispatch.namespaces.scripts.delete(dispatchNamespace, scriptName, { ...params }) -> ScriptDeleteResponse | null
• client.workersForPlatforms.dispatch.namespaces.scripts.get(dispatchNamespace, scriptName, { ...params }) -> Script

AssetUpload

Types:

• AssetUploadCreateResponse

Methods:

• client.workersForPlatforms.dispatch.namespaces.scripts.assetUpload.create(dispatchNamespace, scriptName, { ...params }) -> AssetUploadCreateResponse

Content

Methods:

• client.workersForPlatforms.dispatch.namespaces.scripts.content.update(dispatchNamespace, scriptName, { ...params }) -> Script
• client.workersForPlatforms.dispatch.namespaces.scripts.content.get(dispatchNamespace, scriptName, { ...params }) -> Response

Settings

Types:

• SettingEditResponse
• SettingGetResponse

Methods:

• client.workersForPlatforms.dispatch.namespaces.scripts.settings.edit(dispatchNamespace, scriptName, { ...params }) -> SettingEditResponse
• client.workersForPlatforms.dispatch.namespaces.scripts.settings.get(dispatchNamespace, scriptName, { ...params }) -> SettingGetResponse

Bindings

Types:

• BindingGetResponse

Methods:

• client.workersForPlatforms.dispatch.namespaces.scripts.bindings.get(dispatchNamespace, scriptName, { ...params }) -> BindingGetResponsesSinglePage

Secrets

Types:

• SecretUpdateResponse
• SecretListResponse
• SecretDeleteResponse
• SecretGetResponse

Methods:

• client.workersForPlatforms.dispatch.namespaces.scripts.secrets.update(dispatchNamespace, scriptName, { ...params }) -> SecretUpdateResponse
• client.workersForPlatforms.dispatch.namespaces.scripts.secrets.list(dispatchNamespace, scriptName, { ...params }) -> SecretListResponsesSinglePage
• client.workersForPlatforms.dispatch.namespaces.scripts.secrets.delete(dispatchNamespace, scriptName, secretName, { ...params }) -> SecretDeleteResponse | null
• client.workersForPlatforms.dispatch.namespaces.scripts.secrets.get(dispatchNamespace, scriptName, secretName, { ...params }) -> SecretGetResponse

Tags

Types:

• TagUpdateResponse
• TagListResponse
• TagDeleteResponse

Methods:

• client.workersForPlatforms.dispatch.namespaces.scripts.tags.update(dispatchNamespace, scriptName, [ ...body ]) -> TagUpdateResponsesSinglePage
• client.workersForPlatforms.dispatch.namespaces.scripts.tags.list(dispatchNamespace, scriptName, { ...params }) -> TagListResponsesSinglePage
• client.workersForPlatforms.dispatch.namespaces.scripts.tags.delete(dispatchNamespace, scriptName, tag, { ...params }) -> TagDeleteResponse | null

ZeroTrust

Devices

Types:

• Device
• DeviceGetResponse

Methods:

• client.zeroTrust.devices.list({ ...params }) -> DevicesSinglePage
• client.zeroTrust.devices.get(deviceId, { ...params }) -> DeviceGetResponse | null

Devices

Types:

• DeviceListResponse
• DeviceDeleteResponse
• DeviceGetResponse
• DeviceRevokeResponse

Methods:

• client.zeroTrust.devices.devices.list({ ...params }) -> DeviceListResponsesCursorPagination
• client.zeroTrust.devices.devices.delete(deviceId, { ...params }) -> DeviceDeleteResponse | null
• client.zeroTrust.devices.devices.get(deviceId, { ...params }) -> DeviceGetResponse
• client.zeroTrust.devices.devices.revoke(deviceId, { ...params }) -> DeviceRevokeResponse | null

Resilience

GlobalWARPOverride

Types:

• GlobalWARPOverrideCreateResponse
• GlobalWARPOverrideGetResponse

Methods:

• client.zeroTrust.devices.resilience.globalWARPOverride.create({ ...params }) -> GlobalWARPOverrideCreateResponse | null
• client.zeroTrust.devices.resilience.globalWARPOverride.get({ ...params }) -> GlobalWARPOverrideGetResponse | null

Registrations

Types:

• RegistrationListResponse
• RegistrationDeleteResponse
• RegistrationBulkDeleteResponse
• RegistrationGetResponse
• RegistrationRevokeResponse
• RegistrationUnrevokeResponse

Methods:

• client.zeroTrust.devices.registrations.list({ ...params }) -> RegistrationListResponsesCursorPagination
• client.zeroTrust.devices.registrations.delete(registrationId, { ...params }) -> RegistrationDeleteResponse | null
• client.zeroTrust.devices.registrations.bulkDelete({ ...params }) -> RegistrationBulkDeleteResponse | null
• client.zeroTrust.devices.registrations.get(registrationId, { ...params }) -> RegistrationGetResponse
• client.zeroTrust.devices.registrations.revoke({ ...params }) -> RegistrationRevokeResponse | null
• client.zeroTrust.devices.registrations.unrevoke({ ...params }) -> RegistrationUnrevokeResponse | null

DEXTests

Types:

• SchemaData
• SchemaHTTP

Networks

Types:

• DeviceNetwork

Methods:

• client.zeroTrust.devices.networks.create({ ...params }) -> DeviceNetwork | null
• client.zeroTrust.devices.networks.update(networkId, { ...params }) -> DeviceNetwork | null
• client.zeroTrust.devices.networks.list({ ...params }) -> DeviceNetworksSinglePage
• client.zeroTrust.devices.networks.delete(networkId, { ...params }) -> DeviceNetworksSinglePage
• client.zeroTrust.devices.networks.get(networkId, { ...params }) -> DeviceNetwork | null

FleetStatus

Types:

• FleetStatusGetResponse

Methods:

• client.zeroTrust.devices.fleetStatus.get(deviceId, { ...params }) -> FleetStatusGetResponse

Policies

Types:

• DevicePolicyCertificates
• FallbackDomain
• FallbackDomainPolicy
• SettingsPolicy
• SplitTunnelExclude
• SplitTunnelInclude

Default

Types:

• DefaultEditResponse
• DefaultGetResponse

Methods:

• client.zeroTrust.devices.policies.default.edit({ ...params }) -> DefaultEditResponse | null
• client.zeroTrust.devices.policies.default.get({ ...params }) -> DefaultGetResponse | null

Excludes

Methods:

• client.zeroTrust.devices.policies.default.excludes.update([ ...body ]) -> SplitTunnelExcludesSinglePage
• client.zeroTrust.devices.policies.default.excludes.get({ ...params }) -> SplitTunnelExcludesSinglePage

Includes

Methods:

• client.zeroTrust.devices.policies.default.includes.update([ ...body ]) -> SplitTunnelIncludesSinglePage
• client.zeroTrust.devices.policies.default.includes.get({ ...params }) -> SplitTunnelIncludesSinglePage

FallbackDomains

Methods:

• client.zeroTrust.devices.policies.default.fallbackDomains.update([ ...domains ]) -> FallbackDomainsSinglePage
• client.zeroTrust.devices.policies.default.fallbackDomains.get({ ...params }) -> FallbackDomainsSinglePage

Certificates

Methods:

• client.zeroTrust.devices.policies.default.certificates.edit({ ...params }) -> DevicePolicyCertificates | null
• client.zeroTrust.devices.policies.default.certificates.get({ ...params }) -> DevicePolicyCertificates | null

Custom

Methods:

• client.zeroTrust.devices.policies.custom.create({ ...params }) -> SettingsPolicy | null
• client.zeroTrust.devices.policies.custom.list({ ...params }) -> SettingsPoliciesSinglePage
• client.zeroTrust.devices.policies.custom.delete(policyId, { ...params }) -> SettingsPoliciesSinglePage
• client.zeroTrust.devices.policies.custom.edit(policyId, { ...params }) -> SettingsPolicy | null
• client.zeroTrust.devices.policies.custom.get(policyId, { ...params }) -> SettingsPolicy | null

Excludes

Methods:

• client.zeroTrust.devices.policies.custom.excludes.update(policyId, [ ...body ]) -> SplitTunnelExcludesSinglePage
• client.zeroTrust.devices.policies.custom.excludes.get(policyId, { ...params }) -> SplitTunnelExcludesSinglePage

Includes

Methods:

• client.zeroTrust.devices.policies.custom.includes.update(policyId, [ ...body ]) -> SplitTunnelIncludesSinglePage
• client.zeroTrust.devices.policies.custom.includes.get(policyId, { ...params }) -> SplitTunnelIncludesSinglePage

FallbackDomains

Methods:

• client.zeroTrust.devices.policies.custom.fallbackDomains.update(policyId, [ ...domains ]) -> FallbackDomainsSinglePage
• client.zeroTrust.devices.policies.custom.fallbackDomains.get(policyId, { ...params }) -> FallbackDomainsSinglePage

Posture

Types:

• CarbonblackInput
• ClientCertificateInput
• CrowdstrikeInput
• DeviceInput
• DeviceMatch
• DevicePostureRule
• DiskEncryptionInput
• DomainJoinedInput
• FileInput
• FirewallInput
• IntuneInput
• KolideInput
• OSVersionInput
• SentineloneInput
• SentineloneS2sInput
• TaniumInput
• UniqueClientIDInput
• WorkspaceOneInput
• PostureDeleteResponse

Methods:

• client.zeroTrust.devices.posture.create({ ...params }) -> DevicePostureRule | null
• client.zeroTrust.devices.posture.update(ruleId, { ...params }) -> DevicePostureRule | null
• client.zeroTrust.devices.posture.list({ ...params }) -> DevicePostureRulesSinglePage
• client.zeroTrust.devices.posture.delete(ruleId, { ...params }) -> PostureDeleteResponse | null
• client.zeroTrust.devices.posture.get(ruleId, { ...params }) -> DevicePostureRule | null

Integrations

Types:

• Integration
• IntegrationDeleteResponse

Methods:

• client.zeroTrust.devices.posture.integrations.create({ ...params }) -> Integration | null
• client.zeroTrust.devices.posture.integrations.list({ ...params }) -> IntegrationsSinglePage
• client.zeroTrust.devices.posture.integrations.delete(integrationId, { ...params }) -> IntegrationDeleteResponse | null
• client.zeroTrust.devices.posture.integrations.edit(integrationId, { ...params }) -> Integration | null
• client.zeroTrust.devices.posture.integrations.get(integrationId, { ...params }) -> Integration | null

Revoke

Types:

• RevokeCreateResponse

Methods:

• client.zeroTrust.devices.revoke.create([ ...body ]) -> RevokeCreateResponse | null

Settings

Types:

• DeviceSettings

Methods:

• client.zeroTrust.devices.settings.update({ ...params }) -> DeviceSettings | null
• client.zeroTrust.devices.settings.edit({ ...params }) -> DeviceSettings | null
• client.zeroTrust.devices.settings.get({ ...params }) -> DeviceSettings | null

Unrevoke

Types:

• UnrevokeCreateResponse

Methods:

• client.zeroTrust.devices.unrevoke.create([ ...body ]) -> UnrevokeCreateResponse | null

OverrideCodes

Types:

• OverrideCodeListResponse
• OverrideCodeGetResponse

Methods:

• client.zeroTrust.devices.overrideCodes.list(deviceId, { ...params }) -> OverrideCodeListResponsesSinglePage
• client.zeroTrust.devices.overrideCodes.get(registrationId, { ...params }) -> OverrideCodeGetResponse

IdentityProviders

Types:

• AzureAD
• GenericOAuthConfig
• IdentityProvider
• IdentityProviderSCIMConfig
• IdentityProviderType
• IdentityProviderListResponse
• IdentityProviderDeleteResponse

Methods:

• client.zeroTrust.identityProviders.create({ ...params }) -> IdentityProvider
• client.zeroTrust.identityProviders.update(identityProviderId, { ...params }) -> IdentityProvider
• client.zeroTrust.identityProviders.list({ ...params }) -> IdentityProviderListResponsesSinglePage
• client.zeroTrust.identityProviders.delete(identityProviderId, { ...params }) -> IdentityProviderDeleteResponse
• client.zeroTrust.identityProviders.get(identityProviderId, { ...params }) -> IdentityProvider

SCIM

Groups

Methods:

• client.zeroTrust.identityProviders.scim.groups.list(identityProviderId, { ...params }) -> ZeroTrustGroupsSinglePage

Users

Methods:

• client.zeroTrust.identityProviders.scim.users.list(identityProviderId, { ...params }) -> AccessUsersSinglePage

Organizations

Types:

• LoginDesign
• Organization
• OrganizationRevokeUsersResponse

Methods:

• client.zeroTrust.organizations.create({ ...params }) -> Organization
• client.zeroTrust.organizations.update({ ...params }) -> Organization
• client.zeroTrust.organizations.list({ ...params }) -> Organization
• client.zeroTrust.organizations.revokeUsers({ ...params }) -> OrganizationRevokeUsersResponse

DOH

Types:

• DOHUpdateResponse
• DOHGetResponse

Methods:

• client.zeroTrust.organizations.doh.update({ ...params }) -> DOHUpdateResponse
• client.zeroTrust.organizations.doh.get({ ...params }) -> DOHGetResponse

Seats

Types:

• Seat

Methods:

• client.zeroTrust.seats.edit([ ...body ]) -> SeatsSinglePage

Access

GatewayCA

Types:

• GatewayCACreateResponse
• GatewayCAListResponse
• GatewayCADeleteResponse

Methods:

• client.zeroTrust.access.gatewayCA.create({ ...params }) -> GatewayCACreateResponse
• client.zeroTrust.access.gatewayCA.list({ ...params }) -> GatewayCAListResponsesSinglePage
• client.zeroTrust.access.gatewayCA.delete(certificateId, { ...params }) -> GatewayCADeleteResponse

Infrastructure

Targets

Types:

• TargetCreateResponse
• TargetUpdateResponse
• TargetListResponse
• TargetBulkUpdateResponse
• TargetGetResponse

Methods:

• client.zeroTrust.access.infrastructure.targets.create({ ...params }) -> TargetCreateResponse
• client.zeroTrust.access.infrastructure.targets.update(targetId, { ...params }) -> TargetUpdateResponse
• client.zeroTrust.access.infrastructure.targets.list({ ...params }) -> TargetListResponsesV4PagePaginationArray
• client.zeroTrust.access.infrastructure.targets.delete(targetId, { ...params }) -> void
• client.zeroTrust.access.infrastructure.targets.bulkDelete({ ...params }) -> void
• client.zeroTrust.access.infrastructure.targets.bulkUpdate([ ...body ]) -> TargetBulkUpdateResponsesSinglePage
• client.zeroTrust.access.infrastructure.targets.get(targetId, { ...params }) -> TargetGetResponse

Applications

Types:

• AllowedHeaders
• AllowedIdPs
• AllowedMethods
• AllowedOrigins
• AppID
• Application
• ApplicationPolicy
• ApplicationSCIMConfig
• ApplicationType
• CORSHeaders
• Decision
• OIDCSaaSApp
• SaaSAppNameIDFormat
• SAMLSaaSApp
• SCIMConfigAuthenticationHTTPBasic
• SCIMConfigAuthenticationOAuthBearerToken
• SCIMConfigAuthenticationOauth2
• SCIMConfigMapping
• SelfHostedDomains
• ApplicationCreateResponse
• ApplicationUpdateResponse
• ApplicationListResponse
• ApplicationDeleteResponse
• ApplicationGetResponse
• ApplicationRevokeTokensResponse

Methods:

• client.zeroTrust.access.applications.create({ ...params }) -> ApplicationCreateResponse
• client.zeroTrust.access.applications.update(appId, { ...params }) -> ApplicationUpdateResponse
• client.zeroTrust.access.applications.list({ ...params }) -> ApplicationListResponsesSinglePage
• client.zeroTrust.access.applications.delete(appId, { ...params }) -> ApplicationDeleteResponse
• client.zeroTrust.access.applications.get(appId, { ...params }) -> ApplicationGetResponse
• client.zeroTrust.access.applications.revokeTokens(appId, { ...params }) -> ApplicationRevokeTokensResponse | null

CAs

Types:

• CA
• CADeleteResponse

Methods:

• client.zeroTrust.access.applications.cas.create(appId, { ...params }) -> CA
• client.zeroTrust.access.applications.cas.list({ ...params }) -> CAsSinglePage
• client.zeroTrust.access.applications.cas.delete(appId, { ...params }) -> CADeleteResponse
• client.zeroTrust.access.applications.cas.get(appId, { ...params }) -> CA

UserPolicyChecks

Types:

• UserPolicyCheckGeo
• UserPolicyCheckListResponse

Methods:

• client.zeroTrust.access.applications.userPolicyChecks.list(appId, { ...params }) -> UserPolicyCheckListResponse

Policies

Types:

• AccessDevicePostureRule
• AccessRule
• AnyValidServiceTokenRule
• AuthenticationMethodRule
• AzureGroupRule
• CertificateRule
• CountryRule
• DomainRule
• EmailListRule
• EmailRule
• EveryoneRule
• ExternalEvaluationRule
• GitHubOrganizationRule
• GroupRule
• GSuiteGroupRule
• IPListRule
• IPRule
• OktaGroupRule
• SAMLGroupRule
• ServiceTokenRule
• PolicyCreateResponse
• PolicyUpdateResponse
• PolicyListResponse
• PolicyDeleteResponse
• PolicyGetResponse

Methods:

• client.zeroTrust.access.applications.policies.create(appId, { ...params }) -> PolicyCreateResponse
• client.zeroTrust.access.applications.policies.update(appId, policyId, { ...params }) -> PolicyUpdateResponse
• client.zeroTrust.access.applications.policies.list(appId, { ...params }) -> PolicyListResponsesSinglePage
• client.zeroTrust.access.applications.policies.delete(appId, policyId, { ...params }) -> PolicyDeleteResponse
• client.zeroTrust.access.applications.policies.get(appId, policyId, { ...params }) -> PolicyGetResponse

PolicyTests

Types:

• PolicyTestCreateResponse
• PolicyTestGetResponse

Methods:

• client.zeroTrust.access.applications.policyTests.create({ ...params }) -> PolicyTestCreateResponse
• client.zeroTrust.access.applications.policyTests.get(policyTestId, { ...params }) -> PolicyTestGetResponse

Users

Types:

• UserListResponse

Methods:

• client.zeroTrust.access.applications.policyTests.users.list(policyTestId, { ...params }) -> UserListResponsesV4PagePaginationArray

Settings

Types:

• SettingUpdateResponse
• SettingEditResponse

Methods:

• client.zeroTrust.access.applications.settings.update(appId, { ...params }) -> SettingUpdateResponse
• client.zeroTrust.access.applications.settings.edit(appId, { ...params }) -> SettingEditResponse

Certificates

Types:

• AssociatedHostnames
• Certificate
• CertificateDeleteResponse

Methods:

• client.zeroTrust.access.certificates.create({ ...params }) -> Certificate
• client.zeroTrust.access.certificates.update(certificateId, { ...params }) -> Certificate
• client.zeroTrust.access.certificates.list({ ...params }) -> CertificatesSinglePage
• client.zeroTrust.access.certificates.delete(certificateId, { ...params }) -> CertificateDeleteResponse
• client.zeroTrust.access.certificates.get(certificateId, { ...params }) -> Certificate

Settings

Types:

• CertificateSettings

Methods:

• client.zeroTrust.access.certificates.settings.update({ ...params }) -> CertificateSettingsSinglePage
• client.zeroTrust.access.certificates.settings.get({ ...params }) -> CertificateSettingsSinglePage

Groups

Types:

• ZeroTrustGroup
• GroupCreateResponse
• GroupUpdateResponse
• GroupListResponse
• GroupDeleteResponse
• GroupGetResponse

Methods:

• client.zeroTrust.access.groups.create({ ...params }) -> GroupCreateResponse
• client.zeroTrust.access.groups.update(groupId, { ...params }) -> GroupUpdateResponse
• client.zeroTrust.access.groups.list({ ...params }) -> GroupListResponsesSinglePage
• client.zeroTrust.access.groups.delete(groupId, { ...params }) -> GroupDeleteResponse
• client.zeroTrust.access.groups.get(groupId, { ...params }) -> GroupGetResponse

ServiceTokens

Types:

• ServiceToken
• ServiceTokenCreateResponse
• ServiceTokenRotateResponse

Methods:

• client.zeroTrust.access.serviceTokens.create({ ...params }) -> ServiceTokenCreateResponse
• client.zeroTrust.access.serviceTokens.update(serviceTokenId, { ...params }) -> ServiceToken
• client.zeroTrust.access.serviceTokens.list({ ...params }) -> ServiceTokensSinglePage
• client.zeroTrust.access.serviceTokens.delete(serviceTokenId, { ...params }) -> ServiceToken
• client.zeroTrust.access.serviceTokens.get(serviceTokenId, { ...params }) -> ServiceToken
• client.zeroTrust.access.serviceTokens.refresh(serviceTokenId, { ...params }) -> ServiceToken
• client.zeroTrust.access.serviceTokens.rotate(serviceTokenId, { ...params }) -> ServiceTokenRotateResponse

Bookmarks

Types:

• Bookmark
• BookmarkDeleteResponse

Methods:

• client.zeroTrust.access.bookmarks.create(bookmarkId, { ...params }) -> Bookmark
• client.zeroTrust.access.bookmarks.update(bookmarkId, { ...params }) -> Bookmark
• client.zeroTrust.access.bookmarks.list({ ...params }) -> BookmarksSinglePage
• client.zeroTrust.access.bookmarks.delete(bookmarkId, { ...params }) -> BookmarkDeleteResponse
• client.zeroTrust.access.bookmarks.get(bookmarkId, { ...params }) -> Bookmark

Keys

Types:

• KeyUpdateResponse
• KeyGetResponse
• KeyRotateResponse

Methods:

• client.zeroTrust.access.keys.update({ ...params }) -> KeyUpdateResponse
• client.zeroTrust.access.keys.get({ ...params }) -> KeyGetResponse
• client.zeroTrust.access.keys.rotate({ ...params }) -> KeyRotateResponse

Logs

AccessRequests

Types:

• AccessRequestListResponse

Methods:

• client.zeroTrust.access.logs.accessRequests.list({ ...params }) -> AccessRequestListResponse

SCIM

Types:

• AccessRequest

Updates

Types:

• UpdateListResponse

Methods:

• client.zeroTrust.access.logs.scim.updates.list({ ...params }) -> UpdateListResponsesSinglePage

Users

Types:

• AccessUser
• UserListResponse

Methods:

• client.zeroTrust.access.users.list({ ...params }) -> UserListResponsesSinglePage

ActiveSessions

Types:

• ActiveSessionListResponse
• ActiveSessionGetResponse

Methods:

• client.zeroTrust.access.users.activeSessions.list(userId, { ...params }) -> ActiveSessionListResponsesSinglePage
• client.zeroTrust.access.users.activeSessions.get(userId, nonce, { ...params }) -> ActiveSessionGetResponse

LastSeenIdentity

Types:

• Identity

Methods:

• client.zeroTrust.access.users.lastSeenIdentity.get(userId, { ...params }) -> Identity

FailedLogins

Types:

• FailedLoginListResponse

Methods:

• client.zeroTrust.access.users.failedLogins.list(userId, { ...params }) -> FailedLoginListResponsesSinglePage

CustomPages

Types:

• CustomPage
• CustomPageWithoutHTML
• CustomPageDeleteResponse

Methods:

• client.zeroTrust.access.customPages.create({ ...params }) -> CustomPageWithoutHTML
• client.zeroTrust.access.customPages.update(customPageId, { ...params }) -> CustomPageWithoutHTML
• client.zeroTrust.access.customPages.list({ ...params }) -> CustomPageWithoutHTMLsSinglePage
• client.zeroTrust.access.customPages.delete(customPageId, { ...params }) -> CustomPageDeleteResponse
• client.zeroTrust.access.customPages.get(customPageId, { ...params }) -> CustomPage

Tags

Types:

• Tag
• TagDeleteResponse

Methods:

• client.zeroTrust.access.tags.create({ ...params }) -> Tag
• client.zeroTrust.access.tags.update(tagName, { ...params }) -> Tag
• client.zeroTrust.access.tags.list({ ...params }) -> TagsSinglePage
• client.zeroTrust.access.tags.delete(tagName, { ...params }) -> TagDeleteResponse
• client.zeroTrust.access.tags.get(tagName, { ...params }) -> Tag

Policies

Types:

• ApprovalGroup
• Policy
• PolicyCreateResponse
• PolicyUpdateResponse
• PolicyListResponse
• PolicyDeleteResponse
• PolicyGetResponse

Methods:

• client.zeroTrust.access.policies.create({ ...params }) -> PolicyCreateResponse
• client.zeroTrust.access.policies.update(policyId, { ...params }) -> PolicyUpdateResponse
• client.zeroTrust.access.policies.list({ ...params }) -> PolicyListResponsesSinglePage
• client.zeroTrust.access.policies.delete(policyId, { ...params }) -> PolicyDeleteResponse
• client.zeroTrust.access.policies.get(policyId, { ...params }) -> PolicyGetResponse

DEX

Types:

• DigitalExperienceMonitor
• NetworkPath
• NetworkPathResponse
• Percentiles

Commands

Types:

• CommandCreateResponse
• CommandListResponse

Methods:

• client.zeroTrust.dex.commands.create({ ...params }) -> CommandCreateResponse
• client.zeroTrust.dex.commands.list({ ...params }) -> CommandListResponsesV4PagePagination

Devices

Types:

• DeviceListResponse

Methods:

• client.zeroTrust.dex.commands.devices.list({ ...params }) -> DeviceListResponsesV4PagePagination

Downloads

Methods:

• client.zeroTrust.dex.commands.downloads.get(commandId, filename, { ...params }) -> Response

Quota

Types:

• QuotaGetResponse

Methods:

• client.zeroTrust.dex.commands.quota.get({ ...params }) -> QuotaGetResponse

Colos

Types:

• ColoListResponse

Methods:

• client.zeroTrust.dex.colos.list({ ...params }) -> ColoListResponsesSinglePage

FleetStatus

Types:

• LiveStat
• FleetStatusLiveResponse

Methods:

• client.zeroTrust.dex.fleetStatus.live({ ...params }) -> FleetStatusLiveResponse
• client.zeroTrust.dex.fleetStatus.overTime({ ...params }) -> void

Devices

Types:

• DeviceListResponse

Methods:

• client.zeroTrust.dex.fleetStatus.devices.list({ ...params }) -> DeviceListResponsesV4PagePaginationArray

HTTPTests

Types:

• HTTPDetails

Methods:

• client.zeroTrust.dex.httpTests.get(testId, { ...params }) -> HTTPDetails

Percentiles

Types:

• HTTPDetailsPercentiles
• TestStatOverTime

Methods:

• client.zeroTrust.dex.httpTests.percentiles.get(testId, { ...params }) -> HTTPDetailsPercentiles

Tests

Types:

• AggregateTimePeriod
• Tests

Methods:

• client.zeroTrust.dex.tests.list({ ...params }) -> TestsV4PagePagination

UniqueDevices

Types:

• UniqueDevices

Methods:

• client.zeroTrust.dex.tests.uniqueDevices.list({ ...params }) -> UniqueDevices

TracerouteTestResults

NetworkPath

Types:

• NetworkPathGetResponse

Methods:

• client.zeroTrust.dex.tracerouteTestResults.networkPath.get(testResultId, { ...params }) -> NetworkPathGetResponse

TracerouteTests

Types:

• Traceroute
• TracerouteTestPercentilesResponse

Methods:

• client.zeroTrust.dex.tracerouteTests.get(testId, { ...params }) -> Traceroute
• client.zeroTrust.dex.tracerouteTests.networkPath(testId, { ...params }) -> NetworkPathResponse
• client.zeroTrust.dex.tracerouteTests.percentiles(testId, { ...params }) -> TracerouteTestPercentilesResponse

Tunnels

Types:

• Connection
• TunnelListResponse

Methods:

• client.zeroTrust.tunnels.list({ ...params }) -> TunnelListResponsesV4PagePaginationArray

Cloudflared

Types:

• CloudflaredCreateResponse
• CloudflaredListResponse
• CloudflaredDeleteResponse
• CloudflaredEditResponse
• CloudflaredGetResponse

Methods:

• client.zeroTrust.tunnels.cloudflared.create({ ...params }) -> CloudflaredCreateResponse
• client.zeroTrust.tunnels.cloudflared.list({ ...params }) -> CloudflaredListResponsesV4PagePaginationArray
• client.zeroTrust.tunnels.cloudflared.delete(tunnelId, { ...params }) -> CloudflaredDeleteResponse
• client.zeroTrust.tunnels.cloudflared.edit(tunnelId, { ...params }) -> CloudflaredEditResponse
• client.zeroTrust.tunnels.cloudflared.get(tunnelId, { ...params }) -> CloudflaredGetResponse

Configurations

Types:

• ConfigurationUpdateResponse
• ConfigurationGetResponse

Methods:

• client.zeroTrust.tunnels.cloudflared.configurations.update(tunnelId, { ...params }) -> ConfigurationUpdateResponse
• client.zeroTrust.tunnels.cloudflared.configurations.get(tunnelId, { ...params }) -> ConfigurationGetResponse

Connections

Types:

• Client
• ConnectionDeleteResponse

Methods:

• client.zeroTrust.tunnels.cloudflared.connections.delete(tunnelId, { ...params }) -> ConnectionDeleteResponse | null
• client.zeroTrust.tunnels.cloudflared.connections.get(tunnelId, { ...params }) -> ClientsSinglePage

Token

Types:

• TokenGetResponse

Methods:

• client.zeroTrust.tunnels.cloudflared.token.get(tunnelId, { ...params }) -> TokenGetResponse

Connectors

Methods:

• client.zeroTrust.tunnels.cloudflared.connectors.get(tunnelId, connectorId, { ...params }) -> Client

Management

Types:

• ManagementCreateResponse

Methods:

• client.zeroTrust.tunnels.cloudflared.management.create(tunnelId, { ...params }) -> ManagementCreateResponse

WARPConnector

Types:

• WARPConnectorCreateResponse
• WARPConnectorListResponse
• WARPConnectorDeleteResponse
• WARPConnectorEditResponse
• WARPConnectorGetResponse

Methods:

• client.zeroTrust.tunnels.warpConnector.create({ ...params }) -> WARPConnectorCreateResponse
• client.zeroTrust.tunnels.warpConnector.list({ ...params }) -> WARPConnectorListResponsesV4PagePaginationArray
• client.zeroTrust.tunnels.warpConnector.delete(tunnelId, { ...params }) -> WARPConnectorDeleteResponse
• client.zeroTrust.tunnels.warpConnector.edit(tunnelId, { ...params }) -> WARPConnectorEditResponse
• client.zeroTrust.tunnels.warpConnector.get(tunnelId, { ...params }) -> WARPConnectorGetResponse

Token

Types:

• TokenGetResponse

Methods:

• client.zeroTrust.tunnels.warpConnector.token.get(tunnelId, { ...params }) -> TokenGetResponse

ConnectivitySettings

Types:

• ConnectivitySettingEditResponse
• ConnectivitySettingGetResponse

Methods:

• client.zeroTrust.connectivitySettings.edit({ ...params }) -> ConnectivitySettingEditResponse
• client.zeroTrust.connectivitySettings.get({ ...params }) -> ConnectivitySettingGetResponse

DLP

Datasets

Types:

• Dataset
• DatasetArray
• DatasetCreation

Methods:

• client.zeroTrust.dlp.datasets.create({ ...params }) -> DatasetCreation
• client.zeroTrust.dlp.datasets.update(datasetId, { ...params }) -> Dataset
• client.zeroTrust.dlp.datasets.list({ ...params }) -> DatasetsSinglePage
• client.zeroTrust.dlp.datasets.delete(datasetId, { ...params }) -> void
• client.zeroTrust.dlp.datasets.get(datasetId, { ...params }) -> Dataset

Upload

Types:

• NewVersion

Methods:

• client.zeroTrust.dlp.datasets.upload.create(datasetId, { ...params }) -> NewVersion
• client.zeroTrust.dlp.datasets.upload.edit(datasetId, version, { ...params }) -> Dataset

Versions

Types:

• VersionCreateResponse

Methods:

• client.zeroTrust.dlp.datasets.versions.create(datasetId, version, [ ...body ]) -> VersionCreateResponsesSinglePage

Entries

Types:

• EntryCreateResponse

Methods:

• client.zeroTrust.dlp.datasets.versions.entries.create(datasetId, version, entryId, { ...params }) -> EntryCreateResponse

Patterns

Types:

• PatternValidateResponse

Methods:

• client.zeroTrust.dlp.patterns.validate({ ...params }) -> PatternValidateResponse

PayloadLogs

Types:

• PayloadLogUpdateResponse
• PayloadLogGetResponse

Methods:

• client.zeroTrust.dlp.payloadLogs.update({ ...params }) -> PayloadLogUpdateResponse
• client.zeroTrust.dlp.payloadLogs.get({ ...params }) -> PayloadLogGetResponse

Email

AccountMapping

Types:

• AccountMappingCreateResponse
• AccountMappingGetResponse

Methods:

• client.zeroTrust.dlp.email.accountMapping.create({ ...params }) -> AccountMappingCreateResponse
• client.zeroTrust.dlp.email.accountMapping.get({ ...params }) -> AccountMappingGetResponse

Rules

Types:

• RuleCreateResponse
• RuleUpdateResponse
• RuleListResponse
• RuleDeleteResponse
• RuleBulkEditResponse
• RuleGetResponse

Methods:

• client.zeroTrust.dlp.email.rules.create({ ...params }) -> RuleCreateResponse
• client.zeroTrust.dlp.email.rules.update(ruleId, { ...params }) -> RuleUpdateResponse
• client.zeroTrust.dlp.email.rules.list({ ...params }) -> RuleListResponsesSinglePage
• client.zeroTrust.dlp.email.rules.delete(ruleId, { ...params }) -> RuleDeleteResponse
• client.zeroTrust.dlp.email.rules.bulkEdit({ ...params }) -> RuleBulkEditResponse
• client.zeroTrust.dlp.email.rules.get(ruleId, { ...params }) -> RuleGetResponse

Profiles

Types:

• ContextAwareness
• Profile
• SkipConfiguration

Methods:

• client.zeroTrust.dlp.profiles.list({ ...params }) -> ProfilesSinglePage
• client.zeroTrust.dlp.profiles.get(profileId, { ...params }) -> Profile

Custom

Types:

• CustomProfile
• Pattern
• CustomCreateResponse
• CustomDeleteResponse

Methods:

• client.zeroTrust.dlp.profiles.custom.create({ ...params }) -> CustomCreateResponse
• client.zeroTrust.dlp.profiles.custom.update(profileId, { ...params }) -> Profile
• client.zeroTrust.dlp.profiles.custom.delete(profileId, { ...params }) -> CustomDeleteResponse | null
• client.zeroTrust.dlp.profiles.custom.get(profileId, { ...params }) -> Profile

Predefined

Types:

• PredefinedProfile

Methods:

• client.zeroTrust.dlp.profiles.predefined.update(profileId, { ...params }) -> Profile
• client.zeroTrust.dlp.profiles.predefined.get(profileId, { ...params }) -> Profile

Limits

Types:

• LimitListResponse

Methods:

• client.zeroTrust.dlp.limits.list({ ...params }) -> LimitListResponse

Entries

Types:

• EntryCreateResponse
• EntryUpdateResponse
• EntryListResponse
• EntryDeleteResponse
• EntryGetResponse

Methods:

• client.zeroTrust.dlp.entries.create({ ...params }) -> EntryCreateResponse
• client.zeroTrust.dlp.entries.update(entryId, { ...params }) -> EntryUpdateResponse
• client.zeroTrust.dlp.entries.list({ ...params }) -> EntryListResponsesSinglePage
• client.zeroTrust.dlp.entries.delete(entryId, { ...params }) -> EntryDeleteResponse | null
• client.zeroTrust.dlp.entries.get(entryId, { ...params }) -> EntryGetResponse

Gateway

Types:

• GatewayCreateResponse
• GatewayListResponse

Methods:

• client.zeroTrust.gateway.create({ ...params }) -> GatewayCreateResponse
• client.zeroTrust.gateway.list({ ...params }) -> GatewayListResponse

AuditSSHSettings

Types:

• GatewaySettings

Methods:

• client.zeroTrust.gateway.auditSSHSettings.update({ ...params }) -> GatewaySettings
• client.zeroTrust.gateway.auditSSHSettings.get({ ...params }) -> GatewaySettings
• client.zeroTrust.gateway.auditSSHSettings.rotateSeed({ ...params }) -> GatewaySettings

Categories

Types:

• Category

Methods:

• client.zeroTrust.gateway.categories.list({ ...params }) -> CategoriesSinglePage

AppTypes

Types:

• AppType

Methods:

• client.zeroTrust.gateway.appTypes.list({ ...params }) -> AppTypesSinglePage

Configurations

Types:

• ActivityLogSettings
• AntiVirusSettings
• BlockPageSettings
• BodyScanningSettings
• BrowserIsolationSettings
• CustomCertificateSettings
• ExtendedEmailMatching
• FipsSettings
• GatewayConfigurationSettings
• NotificationSettings
• ProtocolDetection
• TLSSettings
• ConfigurationUpdateResponse
• ConfigurationEditResponse
• ConfigurationGetResponse

Methods:

• client.zeroTrust.gateway.configurations.update({ ...params }) -> ConfigurationUpdateResponse
• client.zeroTrust.gateway.configurations.edit({ ...params }) -> ConfigurationEditResponse
• client.zeroTrust.gateway.configurations.get({ ...params }) -> ConfigurationGetResponse

CustomCertificate

Methods:

• client.zeroTrust.gateway.configurations.customCertificate.get({ ...params }) -> CustomCertificateSettings | null

Lists

Types:

• GatewayItem
• GatewayList
• ListCreateResponse
• ListDeleteResponse

Methods:

• client.zeroTrust.gateway.lists.create({ ...params }) -> ListCreateResponse
• client.zeroTrust.gateway.lists.update(listId, { ...params }) -> GatewayList
• client.zeroTrust.gateway.lists.list({ ...params }) -> GatewayListsSinglePage
• client.zeroTrust.gateway.lists.delete(listId, { ...params }) -> ListDeleteResponse
• client.zeroTrust.gateway.lists.edit(listId, { ...params }) -> GatewayList
• client.zeroTrust.gateway.lists.get(listId, { ...params }) -> GatewayList

Items

Types:

• ItemListResponse

Methods:

• client.zeroTrust.gateway.lists.items.list(listId, { ...params }) -> ItemListResponsesSinglePage

Locations

Types:

• DOHEndpoint
• DOTEndpoint
• Endpoint
• IPNetwork
• IPV4Endpoint
• IPV6Endpoint
• IPV6Network
• Location
• LocationDeleteResponse

Methods:

• client.zeroTrust.gateway.locations.create({ ...params }) -> Location
• client.zeroTrust.gateway.locations.update(locationId, { ...params }) -> Location
• client.zeroTrust.gateway.locations.list({ ...params }) -> LocationsSinglePage
• client.zeroTrust.gateway.locations.delete(locationId, { ...params }) -> LocationDeleteResponse
• client.zeroTrust.gateway.locations.get(locationId, { ...params }) -> Location

Logging

Types:

• LoggingSetting

Methods:

• client.zeroTrust.gateway.logging.update({ ...params }) -> LoggingSetting
• client.zeroTrust.gateway.logging.get({ ...params }) -> LoggingSetting

ProxyEndpoints

Types:

• GatewayIPs
• ProxyEndpoint
• ProxyEndpointDeleteResponse

Methods:

• client.zeroTrust.gateway.proxyEndpoints.create({ ...params }) -> ProxyEndpoint
• client.zeroTrust.gateway.proxyEndpoints.list({ ...params }) -> ProxyEndpoint
• client.zeroTrust.gateway.proxyEndpoints.delete(proxyEndpointId, { ...params }) -> ProxyEndpointDeleteResponse
• client.zeroTrust.gateway.proxyEndpoints.edit(proxyEndpointId, { ...params }) -> ProxyEndpoint
• client.zeroTrust.gateway.proxyEndpoints.get(proxyEndpointId, { ...params }) -> ProxyEndpointsSinglePage

Rules

Types:

• DNSResolverSettingsV4
• DNSResolverSettingsV6
• GatewayFilter
• GatewayRule
• RuleSetting
• Schedule
• RuleDeleteResponse

Methods:

• client.zeroTrust.gateway.rules.create({ ...params }) -> GatewayRule
• client.zeroTrust.gateway.rules.update(ruleId, { ...params }) -> GatewayRule
• client.zeroTrust.gateway.rules.list({ ...params }) -> GatewayRulesSinglePage
• client.zeroTrust.gateway.rules.delete(ruleId, { ...params }) -> RuleDeleteResponse
• client.zeroTrust.gateway.rules.get(ruleId, { ...params }) -> GatewayRule
• client.zeroTrust.gateway.rules.resetExpiration(ruleId, { ...params }) -> GatewayRule

Certificates

Types:

• CertificateCreateResponse
• CertificateListResponse
• CertificateDeleteResponse
• CertificateActivateResponse
• CertificateDeactivateResponse
• CertificateGetResponse

Methods:

• client.zeroTrust.gateway.certificates.create({ ...params }) -> CertificateCreateResponse
• client.zeroTrust.gateway.certificates.list({ ...params }) -> CertificateListResponsesSinglePage
• client.zeroTrust.gateway.certificates.delete(certificateId, { ...params }) -> CertificateDeleteResponse
• client.zeroTrust.gateway.certificates.activate(certificateId, { ...params }) -> CertificateActivateResponse
• client.zeroTrust.gateway.certificates.deactivate(certificateId, { ...params }) -> CertificateDeactivateResponse
• client.zeroTrust.gateway.certificates.get(certificateId, { ...params }) -> CertificateGetResponse

Networks

Routes

Types:

• NetworkRoute
• Route
• Teamnet

Methods:

• client.zeroTrust.networks.routes.create({ ...params }) -> Route
• client.zeroTrust.networks.routes.list({ ...params }) -> TeamnetsV4PagePaginationArray
• client.zeroTrust.networks.routes.delete(routeId, { ...params }) -> Route
• client.zeroTrust.networks.routes.edit(routeId, { ...params }) -> Route
• client.zeroTrust.networks.routes.get(routeId, { ...params }) -> Route

IPs

Methods:

• client.zeroTrust.networks.routes.ips.get(ip, { ...params }) -> Teamnet

Networks

Methods:

• client.zeroTrust.networks.routes.networks.create(ipNetworkEncoded, { ...params }) -> Route
• client.zeroTrust.networks.routes.networks.delete(ipNetworkEncoded, { ...params }) -> Route
• client.zeroTrust.networks.routes.networks.edit(ipNetworkEncoded, { ...params }) -> Route

VirtualNetworks

Types:

• VirtualNetwork

Methods:

• client.zeroTrust.networks.virtualNetworks.create({ ...params }) -> VirtualNetwork
• client.zeroTrust.networks.virtualNetworks.list({ ...params }) -> VirtualNetworksSinglePage
• client.zeroTrust.networks.virtualNetworks.delete(virtualNetworkId, { ...params }) -> VirtualNetwork
• client.zeroTrust.networks.virtualNetworks.edit(virtualNetworkId, { ...params }) -> VirtualNetwork
• client.zeroTrust.networks.virtualNetworks.get(virtualNetworkId, { ...params }) -> VirtualNetwork

Subnets

Types:

• SubnetListResponse

Methods:

• client.zeroTrust.networks.subnets.list({ ...params }) -> SubnetListResponsesV4PagePaginationArray

CloudflareSource

Types:

• CloudflareSourceUpdateResponse

Methods:

• client.zeroTrust.networks.subnets.cloudflareSource.update(addressFamily, { ...params }) -> CloudflareSourceUpdateResponse

RiskScoring

Types:

• RiskScoringGetResponse
• RiskScoringResetResponse

Methods:

• client.zeroTrust.riskScoring.get(userId, { ...params }) -> RiskScoringGetResponse
• client.zeroTrust.riskScoring.reset(userId, { ...params }) -> RiskScoringResetResponse | null

Behaviours

Types:

• BehaviourUpdateResponse
• BehaviourGetResponse

Methods:

• client.zeroTrust.riskScoring.behaviours.update({ ...params }) -> BehaviourUpdateResponse
• client.zeroTrust.riskScoring.behaviours.get({ ...params }) -> BehaviourGetResponse

Summary

Types:

• SummaryGetResponse

Methods:

• client.zeroTrust.riskScoring.summary.get({ ...params }) -> SummaryGetResponse

Integrations

Types:

• IntegrationCreateResponse
• IntegrationUpdateResponse
• IntegrationListResponse
• IntegrationDeleteResponse
• IntegrationGetResponse

Methods:

• client.zeroTrust.riskScoring.integrations.create({ ...params }) -> IntegrationCreateResponse
• client.zeroTrust.riskScoring.integrations.update(integrationId, { ...params }) -> IntegrationUpdateResponse
• client.zeroTrust.riskScoring.integrations.list({ ...params }) -> IntegrationListResponsesSinglePage
• client.zeroTrust.riskScoring.integrations.delete(integrationId, { ...params }) -> IntegrationDeleteResponse | null
• client.zeroTrust.riskScoring.integrations.get(integrationId, { ...params }) -> IntegrationGetResponse

References

Types:

• ReferenceGetResponse

Methods:

• client.zeroTrust.riskScoring.integrations.references.get(referenceId, { ...params }) -> ReferenceGetResponse

Turnstile

Widgets

Types:

• Widget
• WidgetDomain
• WidgetListResponse

Methods:

• client.turnstile.widgets.create({ ...params }) -> Widget
• client.turnstile.widgets.update(sitekey, { ...params }) -> Widget
• client.turnstile.widgets.list({ ...params }) -> WidgetListResponsesV4PagePaginationArray
• client.turnstile.widgets.delete(sitekey, { ...params }) -> Widget
• client.turnstile.widgets.get(sitekey, { ...params }) -> Widget
• client.turnstile.widgets.rotateSecret(sitekey, { ...params }) -> Widget

Hyperdrive

Types:

• Configuration
• Hyperdrive

Configs

Types:

• ConfigDeleteResponse

Methods:

• client.hyperdrive.configs.create({ ...params }) -> Hyperdrive
• client.hyperdrive.configs.update(hyperdriveId, { ...params }) -> Hyperdrive
• client.hyperdrive.configs.list({ ...params }) -> HyperdrivesSinglePage
• client.hyperdrive.configs.delete(hyperdriveId, { ...params }) -> ConfigDeleteResponse | null
• client.hyperdrive.configs.edit(hyperdriveId, { ...params }) -> Hyperdrive
• client.hyperdrive.configs.get(hyperdriveId, { ...params }) -> Hyperdrive

RUM

SiteInfo

Types:

• Site
• SiteInfoDeleteResponse

Methods:

• client.rum.siteInfo.create({ ...params }) -> Site
• client.rum.siteInfo.update(siteId, { ...params }) -> Site
• client.rum.siteInfo.list({ ...params }) -> SitesV4PagePaginationArray
• client.rum.siteInfo.delete(siteId, { ...params }) -> SiteInfoDeleteResponse
• client.rum.siteInfo.get(siteId, { ...params }) -> Site

Rules

Types:

• RUMRule
• RuleListResponse
• RuleDeleteResponse
• RuleBulkCreateResponse

Methods:

• client.rum.rules.create(rulesetId, { ...params }) -> RUMRule
• client.rum.rules.update(rulesetId, ruleId, { ...params }) -> RUMRule
• client.rum.rules.list(rulesetId, { ...params }) -> RuleListResponse
• client.rum.rules.delete(rulesetId, ruleId, { ...params }) -> RuleDeleteResponse
• client.rum.rules.bulkCreate(rulesetId, { ...params }) -> RuleBulkCreateResponse

Vectorize

Indexes

Types:

• CreateIndex
• IndexDeleteVectorsByID
• IndexDimensionConfiguration
• IndexInsert
• IndexQuery
• IndexUpsert
• IndexDeleteResponse
• IndexDeleteByIDsResponse
• IndexGetByIDsResponse
• IndexInfoResponse
• IndexInsertResponse
• IndexQueryResponse
• IndexUpsertResponse

Methods:

• client.vectorize.indexes.create({ ...params }) -> CreateIndex | null
• client.vectorize.indexes.list({ ...params }) -> CreateIndicesSinglePage
• client.vectorize.indexes.delete(indexName, { ...params }) -> IndexDeleteResponse | null
• client.vectorize.indexes.deleteByIds(indexName, { ...params }) -> IndexDeleteByIDsResponse | null
• client.vectorize.indexes.get(indexName, { ...params }) -> CreateIndex | null
• client.vectorize.indexes.getByIds(indexName, { ...params }) -> IndexGetByIDsResponse | null
• client.vectorize.indexes.info(indexName, { ...params }) -> IndexInfoResponse | null
• client.vectorize.indexes.insert(indexName, { ...params }) -> IndexInsertResponse | null
• client.vectorize.indexes.query(indexName, { ...params }) -> IndexQueryResponse | null
• client.vectorize.indexes.upsert(indexName, { ...params }) -> IndexUpsertResponse | null

MetadataIndex

Types:

• MetadataIndexCreateResponse
• MetadataIndexListResponse
• MetadataIndexDeleteResponse

Methods:

• client.vectorize.indexes.metadataIndex.create(indexName, { ...params }) -> MetadataIndexCreateResponse | null
• client.vectorize.indexes.metadataIndex.list(indexName, { ...params }) -> MetadataIndexListResponse | null
• client.vectorize.indexes.metadataIndex.delete(indexName, { ...params }) -> MetadataIndexDeleteResponse | null

URLScanner

Types:

• URLScannerDomain
• URLScannerTask

Responses

Types:

• ResponseGetResponse

Methods:

• client.urlScanner.responses.get(responseId, { ...params }) -> string

Scans

Types:

• ScanCreateResponse
• ScanListResponse
• ScanBulkCreateResponse
• ScanDOMResponse
• ScanGetResponse
• ScanHARResponse

Methods:

• client.urlScanner.scans.create({ ...params }) -> ScanCreateResponse
• client.urlScanner.scans.list({ ...params }) -> ScanListResponse
• client.urlScanner.scans.bulkCreate([ ...body ]) -> ScanBulkCreateResponse
• client.urlScanner.scans.dom(scanId, { ...params }) -> string
• client.urlScanner.scans.get(scanId, { ...params }) -> ScanGetResponse
• client.urlScanner.scans.har(scanId, { ...params }) -> ScanHARResponse
• client.urlScanner.scans.screenshot(scanId, { ...params }) -> Response

Radar

AI

ToMarkdown

Types:

• ToMarkdownCreateResponse

Methods:

• client.radar.ai.toMarkdown.create({ ...params }) -> ToMarkdownCreateResponsesSinglePage

Inference

Summary

Types:

• SummaryModelResponse
• SummaryTaskResponse

Methods:

• client.radar.ai.inference.summary.model({ ...params }) -> SummaryModelResponse
• client.radar.ai.inference.summary.task({ ...params }) -> SummaryTaskResponse

TimeseriesGroups

Summary

Types:

• SummaryModelResponse
• SummaryTaskResponse

Methods:

• client.radar.ai.inference.timeseriesGroups.summary.model({ ...params }) -> SummaryModelResponse
• client.radar.ai.inference.timeseriesGroups.summary.task({ ...params }) -> SummaryTaskResponse

Bots

Summary

Types:

• SummaryUserAgentResponse

Methods:

• client.radar.ai.bots.summary.userAgent({ ...params }) -> SummaryUserAgentResponse

TimeseriesGroups

Types:

• TimeseriesGroupUserAgentResponse

Methods:

• client.radar.ai.timeseriesGroups.userAgent({ ...params }) -> TimeseriesGroupUserAgentResponse

Annotations

Types:

• AnnotationListResponse

Methods:

• client.radar.annotations.list({ ...params }) -> AnnotationListResponse

Outages

Types:

• OutageGetResponse
• OutageLocationsResponse

Methods:

• client.radar.annotations.outages.get({ ...params }) -> OutageGetResponse
• client.radar.annotations.outages.locations({ ...params }) -> OutageLocationsResponse

BGP

Types:

• BGPTimeseriesResponse

Methods:

• client.radar.bgp.timeseries({ ...params }) -> BGPTimeseriesResponse

Leaks

Events

Types:

• EventListResponse

Methods:

• client.radar.bgp.leaks.events.list({ ...params }) -> EventListResponsesV4PagePagination

Top

Types:

• TopPrefixesResponse

Methods:

• client.radar.bgp.top.prefixes({ ...params }) -> TopPrefixesResponse

Ases

Types:

• AseGetResponse
• AsePrefixesResponse

Methods:

• client.radar.bgp.top.ases.get({ ...params }) -> AseGetResponse
• client.radar.bgp.top.ases.prefixes({ ...params }) -> AsePrefixesResponse

Hijacks

Events

Types:

• EventListResponse

Methods:

• client.radar.bgp.hijacks.events.list({ ...params }) -> EventListResponsesV4PagePagination

Routes

Types:

• RouteAsesResponse
• RouteMoasResponse
• RoutePfx2asResponse
• RouteRealtimeResponse
• RouteStatsResponse

Methods:

• client.radar.bgp.routes.ases({ ...params }) -> RouteAsesResponse
• client.radar.bgp.routes.moas({ ...params }) -> RouteMoasResponse
• client.radar.bgp.routes.pfx2as({ ...params }) -> RoutePfx2asResponse
• client.radar.bgp.routes.realtime({ ...params }) -> RouteRealtimeResponse
• client.radar.bgp.routes.stats({ ...params }) -> RouteStatsResponse

IPs

Types:

• IPTimeseriesResponse

Methods:

• client.radar.bgp.ips.timeseries({ ...params }) -> IPTimeseriesResponse

Datasets

Types:

• DatasetListResponse
• DatasetDownloadResponse
• DatasetGetResponse

Methods:

• client.radar.datasets.list({ ...params }) -> DatasetListResponse
• client.radar.datasets.download({ ...params }) -> DatasetDownloadResponse
• client.radar.datasets.get(alias) -> string

DNS

Types:

• DNSTimeseriesResponse

Methods:

• client.radar.dns.timeseries({ ...params }) -> DNSTimeseriesResponse

Top

Types:

• TopAsesResponse
• TopLocationsResponse

Methods:

• client.radar.dns.top.ases({ ...params }) -> TopAsesResponse
• client.radar.dns.top.locations({ ...params }) -> TopLocationsResponse

Summary

Types:

• SummaryCacheHitResponse
• SummaryDNSSECResponse
• SummaryDNSSECAwareResponse
• SummaryDNSSECE2EResponse
• SummaryIPVersionResponse
• SummaryMatchingAnswerResponse
• SummaryProtocolResponse
• SummaryQueryTypeResponse
• SummaryResponseCodeResponse
• SummaryResponseTTLResponse

Methods:

• client.radar.dns.summary.cacheHit({ ...params }) -> SummaryCacheHitResponse
• client.radar.dns.summary.dnssec({ ...params }) -> SummaryDNSSECResponse
• client.radar.dns.summary.dnssecAware({ ...params }) -> SummaryDNSSECAwareResponse
• client.radar.dns.summary.dnssecE2E({ ...params }) -> SummaryDNSSECE2EResponse
• client.radar.dns.summary.ipVersion({ ...params }) -> SummaryIPVersionResponse
• client.radar.dns.summary.matchingAnswer({ ...params }) -> SummaryMatchingAnswerResponse
• client.radar.dns.summary.protocol({ ...params }) -> SummaryProtocolResponse
• client.radar.dns.summary.queryType({ ...params }) -> SummaryQueryTypeResponse
• client.radar.dns.summary.responseCode({ ...params }) -> SummaryResponseCodeResponse
• client.radar.dns.summary.responseTTL({ ...params }) -> SummaryResponseTTLResponse

TimeseriesGroups

Types:

• TimeseriesGroupCacheHitResponse
• TimeseriesGroupDNSSECResponse
• TimeseriesGroupDNSSECAwareResponse
• TimeseriesGroupDNSSECE2EResponse
• TimeseriesGroupIPVersionResponse
• TimeseriesGroupMatchingAnswerResponse
• TimeseriesGroupProtocolResponse
• TimeseriesGroupQueryTypeResponse
• TimeseriesGroupResponseCodeResponse
• TimeseriesGroupResponseTTLResponse

Methods:

• client.radar.dns.timeseriesGroups.cacheHit({ ...params }) -> TimeseriesGroupCacheHitResponse
• client.radar.dns.timeseriesGroups.dnssec({ ...params }) -> TimeseriesGroupDNSSECResponse
• client.radar.dns.timeseriesGroups.dnssecAware({ ...params }) -> TimeseriesGroupDNSSECAwareResponse
• client.radar.dns.timeseriesGroups.dnssecE2E({ ...params }) -> TimeseriesGroupDNSSECE2EResponse
• client.radar.dns.timeseriesGroups.ipVersion({ ...params }) -> TimeseriesGroupIPVersionResponse
• client.radar.dns.timeseriesGroups.matchingAnswer({ ...params }) -> TimeseriesGroupMatchingAnswerResponse
• client.radar.dns.timeseriesGroups.protocol({ ...params }) -> TimeseriesGroupProtocolResponse
• client.radar.dns.timeseriesGroups.queryType({ ...params }) -> TimeseriesGroupQueryTypeResponse
• client.radar.dns.timeseriesGroups.responseCode({ ...params }) -> TimeseriesGroupResponseCodeResponse
• client.radar.dns.timeseriesGroups.responseTTL({ ...params }) -> TimeseriesGroupResponseTTLResponse

Netflows

Types:

• NetflowSummaryResponse
• NetflowTimeseriesResponse

Methods:

• client.radar.netflows.summary({ ...params }) -> NetflowSummaryResponse
• client.radar.netflows.timeseries({ ...params }) -> NetflowTimeseriesResponse

Top

Types:

• TopAsesResponse
• TopLocationsResponse

Methods:

• client.radar.netflows.top.ases({ ...params }) -> TopAsesResponse
• client.radar.netflows.top.locations({ ...params }) -> TopLocationsResponse

Search

Types:

• SearchGlobalResponse

Methods:

• client.radar.search.global({ ...params }) -> SearchGlobalResponse

VerifiedBots

Top

Types:

• TopBotsResponse
• TopCategoriesResponse

Methods:

• client.radar.verifiedBots.top.bots({ ...params }) -> TopBotsResponse
• client.radar.verifiedBots.top.categories({ ...params }) -> TopCategoriesResponse

AS112

Types:

• AS112TimeseriesResponse

Methods:

• client.radar.as112.timeseries({ ...params }) -> AS112TimeseriesResponse

Summary

Types:

• SummaryDNSSECResponse
• SummaryEdnsResponse
• SummaryIPVersionResponse
• SummaryProtocolResponse
• SummaryQueryTypeResponse
• SummaryResponseCodesResponse

Methods:

• client.radar.as112.summary.dnssec({ ...params }) -> SummaryDNSSECResponse
• client.radar.as112.summary.edns({ ...params }) -> SummaryEdnsResponse
• client.radar.as112.summary.ipVersion({ ...params }) -> SummaryIPVersionResponse
• client.radar.as112.summary.protocol({ ...params }) -> SummaryProtocolResponse
• client.radar.as112.summary.queryType({ ...params }) -> SummaryQueryTypeResponse
• client.radar.as112.summary.responseCodes({ ...params }) -> SummaryResponseCodesResponse

TimeseriesGroups

Types:

• TimeseriesGroupDNSSECResponse
• TimeseriesGroupEdnsResponse
• TimeseriesGroupIPVersionResponse
• TimeseriesGroupProtocolResponse
• TimeseriesGroupQueryTypeResponse
• TimeseriesGroupResponseCodesResponse

Methods:

• client.radar.as112.timeseriesGroups.dnssec({ ...params }) -> TimeseriesGroupDNSSECResponse
• client.radar.as112.timeseriesGroups.edns({ ...params }) -> TimeseriesGroupEdnsResponse
• client.radar.as112.timeseriesGroups.ipVersion({ ...params }) -> TimeseriesGroupIPVersionResponse
• client.radar.as112.timeseriesGroups.protocol({ ...params }) -> TimeseriesGroupProtocolResponse
• client.radar.as112.timeseriesGroups.queryType({ ...params }) -> TimeseriesGroupQueryTypeResponse
• client.radar.as112.timeseriesGroups.responseCodes({ ...params }) -> TimeseriesGroupResponseCodesResponse

Top

Types:

• TopDNSSECResponse
• TopEdnsResponse
• TopIPVersionResponse
• TopLocationsResponse

Methods:

• client.radar.as112.top.dnssec(dnssec, { ...params }) -> TopDNSSECResponse
• client.radar.as112.top.edns(edns, { ...params }) -> TopEdnsResponse
• client.radar.as112.top.ipVersion(ipVersion, { ...params }) -> TopIPVersionResponse
• client.radar.as112.top.locations({ ...params }) -> TopLocationsResponse

Email

Types:

• RadarEmailSeries
• RadarEmailSummary

Routing

Summary

Types:

• SummaryARCResponse
• SummaryDKIMResponse
• SummaryDMARCResponse
• SummaryEncryptedResponse
• SummaryIPVersionResponse
• SummarySPFResponse

Methods:

• client.radar.email.routing.summary.arc({ ...params }) -> SummaryARCResponse
• client.radar.email.routing.summary.dkim({ ...params }) -> SummaryDKIMResponse
• client.radar.email.routing.summary.dmarc({ ...params }) -> SummaryDMARCResponse
• client.radar.email.routing.summary.encrypted({ ...params }) -> SummaryEncryptedResponse
• client.radar.email.routing.summary.ipVersion({ ...params }) -> SummaryIPVersionResponse
• client.radar.email.routing.summary.spf({ ...params }) -> SummarySPFResponse

TimeseriesGroups

Types:

• TimeseriesGroupARCResponse
• TimeseriesGroupDKIMResponse
• TimeseriesGroupDMARCResponse
• TimeseriesGroupEncryptedResponse
• TimeseriesGroupIPVersionResponse
• TimeseriesGroupSPFResponse

Methods:

• client.radar.email.routing.timeseriesGroups.arc({ ...params }) -> TimeseriesGroupARCResponse
• client.radar.email.routing.timeseriesGroups.dkim({ ...params }) -> TimeseriesGroupDKIMResponse
• client.radar.email.routing.timeseriesGroups.dmarc({ ...params }) -> TimeseriesGroupDMARCResponse
• client.radar.email.routing.timeseriesGroups.encrypted({ ...params }) -> TimeseriesGroupEncryptedResponse
• client.radar.email.routing.timeseriesGroups.ipVersion({ ...params }) -> TimeseriesGroupIPVersionResponse
• client.radar.email.routing.timeseriesGroups.spf({ ...params }) -> TimeseriesGroupSPFResponse

Security

Top

Tlds

Types:

• TldGetResponse

Methods:

• client.radar.email.security.top.tlds.get({ ...params }) -> TldGetResponse

Malicious

Types:

• MaliciousGetResponse

Methods:

• client.radar.email.security.top.tlds.malicious.get(malicious, { ...params }) -> MaliciousGetResponse

Spam

Types:

• SpamGetResponse

Methods:

• client.radar.email.security.top.tlds.spam.get(spam, { ...params }) -> SpamGetResponse

Spoof

Types:

• SpoofGetResponse

Methods:

• client.radar.email.security.top.tlds.spoof.get(spoof, { ...params }) -> SpoofGetResponse

Summary

Types:

• SummaryARCResponse
• SummaryDKIMResponse
• SummaryDMARCResponse
• SummaryMaliciousResponse
• SummarySpamResponse
• SummarySPFResponse
• SummarySpoofResponse
• SummaryThreatCategoryResponse
• SummaryTLSVersionResponse

Methods:

• client.radar.email.security.summary.arc({ ...params }) -> SummaryARCResponse
• client.radar.email.security.summary.dkim({ ...params }) -> SummaryDKIMResponse
• client.radar.email.security.summary.dmarc({ ...params }) -> SummaryDMARCResponse
• client.radar.email.security.summary.malicious({ ...params }) -> SummaryMaliciousResponse
• client.radar.email.security.summary.spam({ ...params }) -> SummarySpamResponse
• client.radar.email.security.summary.spf({ ...params }) -> SummarySPFResponse
• client.radar.email.security.summary.spoof({ ...params }) -> SummarySpoofResponse
• client.radar.email.security.summary.threatCategory({ ...params }) -> SummaryThreatCategoryResponse
• client.radar.email.security.summary.tlsVersion({ ...params }) -> SummaryTLSVersionResponse

TimeseriesGroups

Types:

• TimeseriesGroupARCResponse
• TimeseriesGroupDKIMResponse
• TimeseriesGroupDMARCResponse
• TimeseriesGroupMaliciousResponse
• TimeseriesGroupSpamResponse
• TimeseriesGroupSPFResponse
• TimeseriesGroupSpoofResponse
• TimeseriesGroupThreatCategoryResponse
• TimeseriesGroupTLSVersionResponse

Methods:

• client.radar.email.security.timeseriesGroups.arc({ ...params }) -> TimeseriesGroupARCResponse
• client.radar.email.security.timeseriesGroups.dkim({ ...params }) -> TimeseriesGroupDKIMResponse
• client.radar.email.security.timeseriesGroups.dmarc({ ...params }) -> TimeseriesGroupDMARCResponse
• client.radar.email.security.timeseriesGroups.malicious({ ...params }) -> TimeseriesGroupMaliciousResponse
• client.radar.email.security.timeseriesGroups.spam({ ...params }) -> TimeseriesGroupSpamResponse
• client.radar.email.security.timeseriesGroups.spf({ ...params }) -> TimeseriesGroupSPFResponse
• client.radar.email.security.timeseriesGroups.spoof({ ...params }) -> TimeseriesGroupSpoofResponse
• client.radar.email.security.timeseriesGroups.threatCategory({ ...params }) -> TimeseriesGroupThreatCategoryResponse
• client.radar.email.security.timeseriesGroups.tlsVersion({ ...params }) -> TimeseriesGroupTLSVersionResponse

Attacks

Layer3

Types:

• Layer3TimeseriesResponse

Methods:

• client.radar.attacks.layer3.timeseries({ ...params }) -> Layer3TimeseriesResponse

Summary

Types:

• SummaryBitrateResponse
• SummaryDurationResponse
• SummaryIndustryResponse
• SummaryIPVersionResponse
• SummaryProtocolResponse
• SummaryVectorResponse
• SummaryVerticalResponse

Methods:

• client.radar.attacks.layer3.summary.bitrate({ ...params }) -> SummaryBitrateResponse
• client.radar.attacks.layer3.summary.duration({ ...params }) -> SummaryDurationResponse
• client.radar.attacks.layer3.summary.industry({ ...params }) -> SummaryIndustryResponse
• client.radar.attacks.layer3.summary.ipVersion({ ...params }) -> SummaryIPVersionResponse
• client.radar.attacks.layer3.summary.protocol({ ...params }) -> SummaryProtocolResponse
• client.radar.attacks.layer3.summary.vector({ ...params }) -> SummaryVectorResponse
• client.radar.attacks.layer3.summary.vertical({ ...params }) -> SummaryVerticalResponse

TimeseriesGroups

Types:

• TimeseriesGroupBitrateResponse
• TimeseriesGroupDurationResponse
• TimeseriesGroupIndustryResponse
• TimeseriesGroupIPVersionResponse
• TimeseriesGroupProtocolResponse
• TimeseriesGroupVectorResponse
• TimeseriesGroupVerticalResponse

Methods:

• client.radar.attacks.layer3.timeseriesGroups.bitrate({ ...params }) -> TimeseriesGroupBitrateResponse
• client.radar.attacks.layer3.timeseriesGroups.duration({ ...params }) -> TimeseriesGroupDurationResponse
• client.radar.attacks.layer3.timeseriesGroups.industry({ ...params }) -> TimeseriesGroupIndustryResponse
• client.radar.attacks.layer3.timeseriesGroups.ipVersion({ ...params }) -> TimeseriesGroupIPVersionResponse
• client.radar.attacks.layer3.timeseriesGroups.protocol({ ...params }) -> TimeseriesGroupProtocolResponse
• client.radar.attacks.layer3.timeseriesGroups.vector({ ...params }) -> TimeseriesGroupVectorResponse
• client.radar.attacks.layer3.timeseriesGroups.vertical({ ...params }) -> TimeseriesGroupVerticalResponse

Top

Types:

• TopAttacksResponse
• TopIndustryResponse
• TopVerticalResponse

Methods:

• client.radar.attacks.layer3.top.attacks({ ...params }) -> TopAttacksResponse
• client.radar.attacks.layer3.top.industry({ ...params }) -> TopIndustryResponse
• client.radar.attacks.layer3.top.vertical({ ...params }) -> TopVerticalResponse

Locations

Types:

• LocationOriginResponse
• LocationTargetResponse

Methods:

• client.radar.attacks.layer3.top.locations.origin({ ...params }) -> LocationOriginResponse
• client.radar.attacks.layer3.top.locations.target({ ...params }) -> LocationTargetResponse

Layer7

Types:

• Layer7TimeseriesResponse

Methods:

• client.radar.attacks.layer7.timeseries({ ...params }) -> Layer7TimeseriesResponse

Summary

Types:

• SummaryHTTPMethodResponse
• SummaryHTTPVersionResponse
• SummaryIndustryResponse
• SummaryIPVersionResponse
• SummaryManagedRulesResponse
• SummaryMitigationProductResponse
• SummaryVerticalResponse

Methods:

• client.radar.attacks.layer7.summary.httpMethod({ ...params }) -> SummaryHTTPMethodResponse
• client.radar.attacks.layer7.summary.httpVersion({ ...params }) -> SummaryHTTPVersionResponse
• client.radar.attacks.layer7.summary.industry({ ...params }) -> SummaryIndustryResponse
• client.radar.attacks.layer7.summary.ipVersion({ ...params }) -> SummaryIPVersionResponse
• client.radar.attacks.layer7.summary.managedRules({ ...params }) -> SummaryManagedRulesResponse
• client.radar.attacks.layer7.summary.mitigationProduct({ ...params }) -> SummaryMitigationProductResponse
• client.radar.attacks.layer7.summary.vertical({ ...params }) -> SummaryVerticalResponse

TimeseriesGroups

Types:

• TimeseriesGroupHTTPMethodResponse
• TimeseriesGroupHTTPVersionResponse
• TimeseriesGroupIndustryResponse
• TimeseriesGroupIPVersionResponse
• TimeseriesGroupManagedRulesResponse
• TimeseriesGroupMitigationProductResponse
• TimeseriesGroupVerticalResponse

Methods:

• client.radar.attacks.layer7.timeseriesGroups.httpMethod({ ...params }) -> TimeseriesGroupHTTPMethodResponse
• client.radar.attacks.layer7.timeseriesGroups.httpVersion({ ...params }) -> TimeseriesGroupHTTPVersionResponse
• client.radar.attacks.layer7.timeseriesGroups.industry({ ...params }) -> TimeseriesGroupIndustryResponse
• client.radar.attacks.layer7.timeseriesGroups.ipVersion({ ...params }) -> TimeseriesGroupIPVersionResponse
• client.radar.attacks.layer7.timeseriesGroups.managedRules({ ...params }) -> TimeseriesGroupManagedRulesResponse
• client.radar.attacks.layer7.timeseriesGroups.mitigationProduct({ ...params }) -> TimeseriesGroupMitigationProductResponse
• client.radar.attacks.layer7.timeseriesGroups.vertical({ ...params }) -> TimeseriesGroupVerticalResponse

Top

Types:

• TopAttacksResponse
• TopIndustryResponse
• TopVerticalResponse

Methods:

• client.radar.attacks.layer7.top.attacks({ ...params }) -> TopAttacksResponse
• client.radar.attacks.layer7.top.industry({ ...params }) -> TopIndustryResponse
• client.radar.attacks.layer7.top.vertical({ ...params }) -> TopVerticalResponse

Locations

Types:

• LocationOriginResponse
• LocationTargetResponse

Methods:

• client.radar.attacks.layer7.top.locations.origin({ ...params }) -> LocationOriginResponse
• client.radar.attacks.layer7.top.locations.target({ ...params }) -> LocationTargetResponse

Ases

Types:

• AseOriginResponse

Methods:

• client.radar.attacks.layer7.top.ases.origin({ ...params }) -> AseOriginResponse

Entities

Types:

• EntityGetResponse

Methods:

• client.radar.entities.get({ ...params }) -> EntityGetResponse

ASNs

Types:

• ASNListResponse
• ASNGetResponse
• ASNIPResponse
• ASNRelResponse

Methods:

• client.radar.entities.asns.list({ ...params }) -> ASNListResponse
• client.radar.entities.asns.get(asn, { ...params }) -> ASNGetResponse
• client.radar.entities.asns.ip({ ...params }) -> ASNIPResponse
• client.radar.entities.asns.rel(asn, { ...params }) -> ASNRelResponse

Locations

Types:

• LocationListResponse
• LocationGetResponse

Methods:

• client.radar.entities.locations.list({ ...params }) -> LocationListResponse
• client.radar.entities.locations.get(location, { ...params }) -> LocationGetResponse

HTTP

Types:

• HTTPTimeseriesResponse

Methods:

• client.radar.http.timeseries({ ...params }) -> HTTPTimeseriesResponse

Locations

Types:

• LocationGetResponse

Methods:

• client.radar.http.locations.get({ ...params }) -> LocationGetResponse

BotClass

Types:

• BotClassGetResponse

Methods:

• client.radar.http.locations.botClass.get(botClass, { ...params }) -> BotClassGetResponse

DeviceType

Types:

• DeviceTypeGetResponse

Methods:

• client.radar.http.locations.deviceType.get(deviceType, { ...params }) -> DeviceTypeGetResponse

HTTPProtocol

Types:

• HTTPProtocolGetResponse

Methods:

• client.radar.http.locations.httpProtocol.get(httpProtocol, { ...params }) -> HTTPProtocolGetResponse

HTTPMethod

Types:

• HTTPMethodGetResponse

Methods:

• client.radar.http.locations.httpMethod.get(httpVersion, { ...params }) -> HTTPMethodGetResponse

IPVersion

Types:

• IPVersionGetResponse

Methods:

• client.radar.http.locations.ipVersion.get(ipVersion, { ...params }) -> IPVersionGetResponse

OS

Types:

• OSGetResponse

Methods:

• client.radar.http.locations.os.get(os, { ...params }) -> OSGetResponse

TLSVersion

Types:

• TLSVersionGetResponse

Methods:

• client.radar.http.locations.tlsVersion.get(tlsVersion, { ...params }) -> TLSVersionGetResponse

BrowserFamily

Types:

• BrowserFamilyGetResponse

Methods:

• client.radar.http.locations.browserFamily.get(browserFamily, { ...params }) -> BrowserFamilyGetResponse

Ases

Types:

• AseGetResponse

Methods:

• client.radar.http.ases.get({ ...params }) -> AseGetResponse

BotClass

Types:

• BotClassGetResponse

Methods:

• client.radar.http.ases.botClass.get(botClass, { ...params }) -> BotClassGetResponse

DeviceType

Types:

• DeviceTypeGetResponse

Methods:

• client.radar.http.ases.deviceType.get(deviceType, { ...params }) -> DeviceTypeGetResponse

HTTPProtocol

Types:

• HTTPProtocolGetResponse

Methods:

• client.radar.http.ases.httpProtocol.get(httpProtocol, { ...params }) -> HTTPProtocolGetResponse

HTTPMethod

Types:

• HTTPMethodGetResponse

Methods:

• client.radar.http.ases.httpMethod.get(httpVersion, { ...params }) -> HTTPMethodGetResponse

IPVersion

Types:

• IPVersionGetResponse

Methods:

• client.radar.http.ases.ipVersion.get(ipVersion, { ...params }) -> IPVersionGetResponse

OS

Types:

• OSGetResponse

Methods:

• client.radar.http.ases.os.get(os, { ...params }) -> OSGetResponse

TLSVersion

Types:

• TLSVersionGetResponse

Methods:

• client.radar.http.ases.tlsVersion.get(tlsVersion, { ...params }) -> TLSVersionGetResponse

BrowserFamily

Types:

• BrowserFamilyGetResponse

Methods:

• client.radar.http.ases.browserFamily.get(browserFamily, { ...params }) -> BrowserFamilyGetResponse

Summary

Types:

• SummaryBotClassResponse
• SummaryDeviceTypeResponse
• SummaryHTTPProtocolResponse
• SummaryHTTPVersionResponse
• SummaryIPVersionResponse
• SummaryOSResponse
• SummaryPostQuantumResponse
• SummaryTLSVersionResponse

Methods:

• client.radar.http.summary.botClass({ ...params }) -> SummaryBotClassResponse
• client.radar.http.summary.deviceType({ ...params }) -> SummaryDeviceTypeResponse
• client.radar.http.summary.httpProtocol({ ...params }) -> SummaryHTTPProtocolResponse
• client.radar.http.summary.httpVersion({ ...params }) -> SummaryHTTPVersionResponse
• client.radar.http.summary.ipVersion({ ...params }) -> SummaryIPVersionResponse
• client.radar.http.summary.os({ ...params }) -> SummaryOSResponse
• client.radar.http.summary.postQuantum({ ...params }) -> SummaryPostQuantumResponse
• client.radar.http.summary.tlsVersion({ ...params }) -> SummaryTLSVersionResponse

TimeseriesGroups

Types:

• TimeseriesGroupBotClassResponse
• TimeseriesGroupBrowserResponse
• TimeseriesGroupBrowserFamilyResponse
• TimeseriesGroupDeviceTypeResponse
• TimeseriesGroupHTTPProtocolResponse
• TimeseriesGroupHTTPVersionResponse
• TimeseriesGroupIPVersionResponse
• TimeseriesGroupOSResponse
• TimeseriesGroupPostQuantumResponse
• TimeseriesGroupTLSVersionResponse

Methods:

• client.radar.http.timeseriesGroups.botClass({ ...params }) -> TimeseriesGroupBotClassResponse
• client.radar.http.timeseriesGroups.browser({ ...params }) -> TimeseriesGroupBrowserResponse
• client.radar.http.timeseriesGroups.browserFamily({ ...params }) -> TimeseriesGroupBrowserFamilyResponse
• client.radar.http.timeseriesGroups.deviceType({ ...params }) -> TimeseriesGroupDeviceTypeResponse
• client.radar.http.timeseriesGroups.httpProtocol({ ...params }) -> TimeseriesGroupHTTPProtocolResponse
• client.radar.http.timeseriesGroups.httpVersion({ ...params }) -> TimeseriesGroupHTTPVersionResponse
• client.radar.http.timeseriesGroups.ipVersion({ ...params }) -> TimeseriesGroupIPVersionResponse
• client.radar.http.timeseriesGroups.os({ ...params }) -> TimeseriesGroupOSResponse
• client.radar.http.timeseriesGroups.postQuantum({ ...params }) -> TimeseriesGroupPostQuantumResponse
• client.radar.http.timeseriesGroups.tlsVersion({ ...params }) -> TimeseriesGroupTLSVersionResponse

Top

Types:

• TopBrowserResponse
• TopBrowserFamilyResponse

Methods:

• client.radar.http.top.browser({ ...params }) -> TopBrowserResponse
• client.radar.http.top.browserFamily({ ...params }) -> TopBrowserFamilyResponse

Quality

IQI

Types:

• IQISummaryResponse
• IQITimeseriesGroupsResponse

Methods:

• client.radar.quality.iqi.summary({ ...params }) -> IQISummaryResponse
• client.radar.quality.iqi.timeseriesGroups({ ...params }) -> IQITimeseriesGroupsResponse

Speed

Types:

• SpeedHistogramResponse
• SpeedSummaryResponse

Methods:

• client.radar.quality.speed.histogram({ ...params }) -> SpeedHistogramResponse
• client.radar.quality.speed.summary({ ...params }) -> SpeedSummaryResponse

Top

Types:

• TopAsesResponse
• TopLocationsResponse

Methods:

• client.radar.quality.speed.top.ases({ ...params }) -> TopAsesResponse
• client.radar.quality.speed.top.locations({ ...params }) -> TopLocationsResponse

Ranking

Types:

• RankingTimeseriesGroupsResponse
• RankingTopResponse

Methods:

• client.radar.ranking.timeseriesGroups({ ...params }) -> RankingTimeseriesGroupsResponse
• client.radar.ranking.top({ ...params }) -> RankingTopResponse

Domain

Types:

• DomainGetResponse

Methods:

• client.radar.ranking.domain.get(domain, { ...params }) -> DomainGetResponse

InternetServices

Types:

• InternetServiceCategoriesResponse
• InternetServiceTimeseriesGroupsResponse
• InternetServiceTopResponse

Methods:

• client.radar.ranking.internetServices.categories({ ...params }) -> InternetServiceCategoriesResponse
• client.radar.ranking.internetServices.timeseriesGroups({ ...params }) -> InternetServiceTimeseriesGroupsResponse
• client.radar.ranking.internetServices.top({ ...params }) -> InternetServiceTopResponse

TrafficAnomalies

Types:

• TrafficAnomalyGetResponse

Methods:

• client.radar.trafficAnomalies.get({ ...params }) -> TrafficAnomalyGetResponse

Locations

Types:

• LocationGetResponse

Methods:

• client.radar.trafficAnomalies.locations.get({ ...params }) -> LocationGetResponse

TCPResetsTimeouts

Types:

• TCPResetsTimeoutSummaryResponse
• TCPResetsTimeoutTimeseriesGroupsResponse

Methods:

• client.radar.tcpResetsTimeouts.summary({ ...params }) -> TCPResetsTimeoutSummaryResponse
• client.radar.tcpResetsTimeouts.timeseriesGroups({ ...params }) -> TCPResetsTimeoutTimeseriesGroupsResponse

RobotsTXT

Top

Types:

• TopDomainCategoriesResponse

Methods:

• client.radar.robotsTXT.top.domainCategories({ ...params }) -> TopDomainCategoriesResponse

UserAgents

Types:

• UserAgentDirectiveResponse

Methods:

• client.radar.robotsTXT.top.userAgents.directive({ ...params }) -> UserAgentDirectiveResponse

LeakedCredentials

Summary

Types:

• SummaryBotClassResponse
• SummaryCompromisedResponse

Methods:

• client.radar.leakedCredentials.summary.botClass({ ...params }) -> SummaryBotClassResponse
• client.radar.leakedCredentials.summary.compromised({ ...params }) -> SummaryCompromisedResponse

TimeseriesGroups

Types:

• TimeseriesGroupBotClassResponse
• TimeseriesGroupCompromisedResponse

Methods:

• client.radar.leakedCredentials.timeseriesGroups.botClass({ ...params }) -> TimeseriesGroupBotClassResponse
• client.radar.leakedCredentials.timeseriesGroups.compromised({ ...params }) -> TimeseriesGroupCompromisedResponse

BotManagement

Types:

• BotFightModeConfiguration
• SubscriptionConfiguration
• SuperBotFightModeDefinitelyConfiguration
• SuperBotFightModeLikelyConfiguration
• BotManagementUpdateResponse
• BotManagementGetResponse

Methods:

• client.botManagement.update({ ...params }) -> BotManagementUpdateResponse
• client.botManagement.get({ ...params }) -> BotManagementGetResponse

OriginPostQuantumEncryption

Types:

• OriginPostQuantumEncryptionUpdateResponse
• OriginPostQuantumEncryptionGetResponse

Methods:

• client.originPostQuantumEncryption.update({ ...params }) -> OriginPostQuantumEncryptionUpdateResponse
• client.originPostQuantumEncryption.get({ ...params }) -> OriginPostQuantumEncryptionGetResponse

Zaraz

Types:

• ButtonTextTranslation
• NeoEvent

Methods:

• client.zaraz.update({ ...params }) -> Workflow

Config

Types:

• Configuration

Methods:

• client.zaraz.config.update({ ...params }) -> Configuration
• client.zaraz.config.get({ ...params }) -> Configuration

Default

Methods:

• client.zaraz.default.get({ ...params }) -> Configuration

Export

Methods:

• client.zaraz.export.get({ ...params }) -> Configuration

History

Types:

• HistoryListResponse

Methods:

• client.zaraz.history.update({ ...params }) -> Configuration
• client.zaraz.history.list({ ...params }) -> HistoryListResponsesSinglePage

Configs

Types:

• ConfigGetResponse

Methods:

• client.zaraz.history.configs.get({ ...params }) -> ConfigGetResponse

Publish

Types:

• PublishCreateResponse

Methods:

• client.zaraz.publish.create({ ...params }) -> PublishCreateResponse

Workflow

Types:

• Workflow

Methods:

• client.zaraz.workflow.get({ ...params }) -> Workflow

Speed

Types:

• LabeledRegion
• LighthouseReport
• Trend

Schedule

Types:

• Schedule
• ScheduleCreateResponse
• ScheduleDeleteResponse

Methods:

• client.speed.schedule.create(url, { ...params }) -> ScheduleCreateResponse
• client.speed.schedule.delete(url, { ...params }) -> ScheduleDeleteResponse
• client.speed.schedule.get(url, { ...params }) -> Schedule

Availabilities

Types:

• Availability

Methods:

• client.speed.availabilities.list({ ...params }) -> Availability

Pages

Types:

• PageListResponse

Methods:

• client.speed.pages.list({ ...params }) -> PageListResponsesSinglePage
• client.speed.pages.trend(url, { ...params }) -> Trend

Tests

Types:

• Test
• TestDeleteResponse

Methods:

• client.speed.pages.tests.create(url, { ...params }) -> Test
• client.speed.pages.tests.list(url, { ...params }) -> TestsV4PagePaginationArray
• client.speed.pages.tests.delete(url, { ...params }) -> TestDeleteResponse
• client.speed.pages.tests.get(url, testId, { ...params }) -> Test

DCVDelegation

Types:

• DCVDelegationUUID

Methods:

• client.dcvDelegation.get({ ...params }) -> DCVDelegationUUID

Hostnames

Settings

TLS

Types:

• Setting
• SettingValue
• TLSDeleteResponse
• TLSGetResponse

Methods:

• client.hostnames.settings.tls.update(settingId, hostname, { ...params }) -> Setting
• client.hostnames.settings.tls.delete(settingId, hostname, { ...params }) -> TLSDeleteResponse
• client.hostnames.settings.tls.get(settingId, { ...params }) -> TLSGetResponsesSinglePage

Snippets

Types:

• Snippet
• SnippetDeleteResponse

Methods:

• client.snippets.update(snippetName, { ...params }) -> Snippet
• client.snippets.list({ ...params }) -> SnippetsSinglePage
• client.snippets.delete(snippetName, { ...params }) -> SnippetDeleteResponse
• client.snippets.get(snippetName, { ...params }) -> Snippet

Content

Methods:

• client.snippets.content.get(snippetName, { ...params }) -> Response

Rules

Types:

• RuleUpdateResponse
• RuleListResponse
• RuleDeleteResponse

Methods:

• client.snippets.rules.update({ ...params }) -> RuleUpdateResponsesSinglePage
• client.snippets.rules.list({ ...params }) -> RuleListResponsesSinglePage
• client.snippets.rules.delete({ ...params }) -> RuleDeleteResponse

Calls

SFU

Types:

• SFUCreateResponse
• SFUUpdateResponse
• SFUListResponse
• SFUDeleteResponse
• SFUGetResponse

Methods:

• client.calls.sfu.create({ ...params }) -> SFUCreateResponse
• client.calls.sfu.update(appId, { ...params }) -> SFUUpdateResponse
• client.calls.sfu.list({ ...params }) -> SFUListResponsesSinglePage
• client.calls.sfu.delete(appId, { ...params }) -> SFUDeleteResponse
• client.calls.sfu.get(appId, { ...params }) -> SFUGetResponse

TURN

Types:

• TURNCreateResponse
• TURNUpdateResponse
• TURNListResponse
• TURNDeleteResponse
• TURNGetResponse

Methods:

• client.calls.turn.create({ ...params }) -> TURNCreateResponse
• client.calls.turn.update(keyId, { ...params }) -> TURNUpdateResponse
• client.calls.turn.list({ ...params }) -> TURNListResponsesSinglePage
• client.calls.turn.delete(keyId, { ...params }) -> TURNDeleteResponse
• client.calls.turn.get(keyId, { ...params }) -> TURNGetResponse

CloudforceOne

Scans

Results

Types:

• ScanResult
• ResultGetResponse

Methods:

• client.cloudforceOne.scans.results.get(configId, { ...params }) -> ResultGetResponse

Config

Types:

• ConfigCreateResponse
• ConfigListResponse
• ConfigDeleteResponse
• ConfigEditResponse

Methods:

• client.cloudforceOne.scans.config.create({ ...params }) -> ConfigCreateResponse
• client.cloudforceOne.scans.config.list({ ...params }) -> ConfigListResponsesSinglePage
• client.cloudforceOne.scans.config.delete(configId, { ...params }) -> ConfigDeleteResponse
• client.cloudforceOne.scans.config.edit(configId, { ...params }) -> ConfigEditResponse

Requests

Types:

• Item
• ListItem
• Quota
• RequestConstants
• RequestTypes
• RequestDeleteResponse
• RequestTypesResponse

Methods:

• client.cloudforceOne.requests.create({ ...params }) -> Item
• client.cloudforceOne.requests.update(requestId, { ...params }) -> Item
• client.cloudforceOne.requests.list({ ...params }) -> ListItemsSinglePage
• client.cloudforceOne.requests.delete(requestId, { ...params }) -> RequestDeleteResponse
• client.cloudforceOne.requests.constants({ ...params }) -> RequestConstants
• client.cloudforceOne.requests.get(requestId, { ...params }) -> Item
• client.cloudforceOne.requests.quota({ ...params }) -> Quota
• client.cloudforceOne.requests.types({ ...params }) -> RequestTypesResponsesSinglePage

Message

Types:

• Message
• MessageDeleteResponse

Methods:

• client.cloudforceOne.requests.message.create(requestId, { ...params }) -> Message
• client.cloudforceOne.requests.message.update(requestId, messageId, { ...params }) -> Message
• client.cloudforceOne.requests.message.delete(requestId, messageId, { ...params }) -> MessageDeleteResponse
• client.cloudforceOne.requests.message.get(requestId, { ...params }) -> MessagesSinglePage

Priority

Types:

• Label
• Priority
• PriorityEdit
• PriorityDeleteResponse

Methods:

• client.cloudforceOne.requests.priority.create({ ...params }) -> Priority
• client.cloudforceOne.requests.priority.update(priorityId, { ...params }) -> Item
• client.cloudforceOne.requests.priority.delete(priorityId, { ...params }) -> PriorityDeleteResponse
• client.cloudforceOne.requests.priority.get(priorityId, { ...params }) -> Item
• client.cloudforceOne.requests.priority.quota({ ...params }) -> Quota

Assets

Types:

• AssetCreateResponse
• AssetUpdateResponse
• AssetDeleteResponse
• AssetGetResponse

Methods:

• client.cloudforceOne.requests.assets.create(requestId, { ...params }) -> AssetCreateResponsesSinglePage
• client.cloudforceOne.requests.assets.update(requestId, assetId, { ...params }) -> AssetUpdateResponse
• client.cloudforceOne.requests.assets.delete(requestId, assetId, { ...params }) -> AssetDeleteResponse
• client.cloudforceOne.requests.assets.get(requestId, assetId, { ...params }) -> AssetGetResponsesSinglePage

ThreatEvents

Types:

• ThreatEventCreateResponse
• ThreatEventListResponse
• ThreatEventDeleteResponse
• ThreatEventBulkCreateResponse
• ThreatEventEditResponse
• ThreatEventGetResponse

Methods:

• client.cloudforceOne.threatEvents.create({ ...params }) -> ThreatEventCreateResponse
• client.cloudforceOne.threatEvents.list({ ...params }) -> ThreatEventListResponse
• client.cloudforceOne.threatEvents.delete(eventId, { ...params }) -> ThreatEventDeleteResponse
• client.cloudforceOne.threatEvents.bulkCreate({ ...params }) -> ThreatEventBulkCreateResponse
• client.cloudforceOne.threatEvents.edit(eventId, { ...params }) -> ThreatEventEditResponse
• client.cloudforceOne.threatEvents.get(eventId, { ...params }) -> ThreatEventGetResponse

Attackers

Types:

• AttackerListResponse

Methods:

• client.cloudforceOne.threatEvents.attackers.list({ ...params }) -> AttackerListResponse

Categories

Types:

• CategoryCreateResponse
• CategoryListResponse
• CategoryDeleteResponse
• CategoryEditResponse
• CategoryGetResponse

Methods:

• client.cloudforceOne.threatEvents.categories.create({ ...params }) -> CategoryCreateResponse
• client.cloudforceOne.threatEvents.categories.list({ ...params }) -> CategoryListResponse
• client.cloudforceOne.threatEvents.categories.delete(categoryId, { ...params }) -> CategoryDeleteResponse
• client.cloudforceOne.threatEvents.categories.edit(categoryId, { ...params }) -> CategoryEditResponse
• client.cloudforceOne.threatEvents.categories.get(categoryId, { ...params }) -> CategoryGetResponse

Countries

Types:

• CountryListResponse

Methods:

• client.cloudforceOne.threatEvents.countries.list({ ...params }) -> CountryListResponse

Crons

Types:

• CronListResponse
• CronEditResponse

Methods:

• client.cloudforceOne.threatEvents.crons.list({ ...params }) -> CronListResponse
• client.cloudforceOne.threatEvents.crons.edit({ ...params }) -> CronEditResponse

Datasets

Types:

• DatasetCreateResponse
• DatasetListResponse
• DatasetEditResponse
• DatasetGetResponse
• DatasetRawResponse

Methods:

• client.cloudforceOne.threatEvents.datasets.create({ ...params }) -> DatasetCreateResponse
• client.cloudforceOne.threatEvents.datasets.list({ ...params }) -> DatasetListResponse
• client.cloudforceOne.threatEvents.datasets.edit(datasetId, { ...params }) -> DatasetEditResponse
• client.cloudforceOne.threatEvents.datasets.get(datasetId, { ...params }) -> DatasetGetResponse
• client.cloudforceOne.threatEvents.datasets.raw(datasetId, eventId, { ...params }) -> DatasetRawResponse

IndicatorTypes

Types:

• IndicatorTypeListResponse

Methods:

• client.cloudforceOne.threatEvents.indicatorTypes.list({ ...params }) -> IndicatorTypeListResponse

Raw

Types:

• RawEditResponse
• RawGetResponse

Methods:

• client.cloudforceOne.threatEvents.raw.edit(eventId, rawId, { ...params }) -> RawEditResponse
• client.cloudforceOne.threatEvents.raw.get(eventId, rawId, { ...params }) -> RawGetResponse

Relate

Types:

• RelateDeleteResponse

Methods:

• client.cloudforceOne.threatEvents.relate.delete(eventId, { ...params }) -> RelateDeleteResponse

Tags

Types:

• TagCreateResponse

Methods:

• client.cloudforceOne.threatEvents.tags.create({ ...params }) -> TagCreateResponse

EventTags

Types:

• EventTagCreateResponse
• EventTagDeleteResponse

Methods:

• client.cloudforceOne.threatEvents.eventTags.create(eventId, { ...params }) -> EventTagCreateResponse
• client.cloudforceOne.threatEvents.eventTags.delete(eventId, { ...params }) -> EventTagDeleteResponse

TargetIndustries

Types:

• TargetIndustryListResponse

Methods:

• client.cloudforceOne.threatEvents.targetIndustries.list({ ...params }) -> TargetIndustryListResponse

Insights

Types:

• InsightCreateResponse
• InsightDeleteResponse
• InsightEditResponse
• InsightGetResponse

Methods:

• client.cloudforceOne.threatEvents.insights.create(eventId, { ...params }) -> InsightCreateResponse
• client.cloudforceOne.threatEvents.insights.delete(eventId, insightId, { ...params }) -> InsightDeleteResponse
• client.cloudforceOne.threatEvents.insights.edit(eventId, insightId, { ...params }) -> InsightEditResponse
• client.cloudforceOne.threatEvents.insights.get(eventId, insightId, { ...params }) -> InsightGetResponse

AIGateway

Types:

• AIGatewayCreateResponse
• AIGatewayUpdateResponse
• AIGatewayListResponse
• AIGatewayDeleteResponse
• AIGatewayGetResponse

Methods:

• client.aiGateway.create({ ...params }) -> AIGatewayCreateResponse
• client.aiGateway.update(id, { ...params }) -> AIGatewayUpdateResponse
• client.aiGateway.list({ ...params }) -> AIGatewayListResponsesV4PagePaginationArray
• client.aiGateway.delete(id, { ...params }) -> AIGatewayDeleteResponse
• client.aiGateway.get(id, { ...params }) -> AIGatewayGetResponse

EvaluationTypes

Types:

• EvaluationTypeListResponse

Methods:

• client.aiGateway.evaluationTypes.list({ ...params }) -> EvaluationTypeListResponsesV4PagePaginationArray

Logs

Types:

• LogListResponse
• LogDeleteResponse
• LogEditResponse
• LogGetResponse
• LogRequestResponse
• LogResponseResponse

Methods:

• client.aiGateway.logs.list(gatewayId, { ...params }) -> LogListResponsesV4PagePaginationArray
• client.aiGateway.logs.delete(gatewayId, { ...params }) -> LogDeleteResponse
• client.aiGateway.logs.edit(gatewayId, id, { ...params }) -> LogEditResponse
• client.aiGateway.logs.get(gatewayId, id, { ...params }) -> LogGetResponse
• client.aiGateway.logs.request(gatewayId, id, { ...params }) -> unknown
• client.aiGateway.logs.response(gatewayId, id, { ...params }) -> unknown

Datasets

Types:

• DatasetCreateResponse
• DatasetUpdateResponse
• DatasetListResponse
• DatasetDeleteResponse
• DatasetGetResponse

Methods:

• client.aiGateway.datasets.create(gatewayId, { ...params }) -> DatasetCreateResponse
• client.aiGateway.datasets.update(gatewayId, id, { ...params }) -> DatasetUpdateResponse
• client.aiGateway.datasets.list(gatewayId, { ...params }) -> DatasetListResponsesV4PagePaginationArray
• client.aiGateway.datasets.delete(gatewayId, id, { ...params }) -> DatasetDeleteResponse
• client.aiGateway.datasets.get(gatewayId, id, { ...params }) -> DatasetGetResponse

Evaluations

Types:

• EvaluationCreateResponse
• EvaluationListResponse
• EvaluationDeleteResponse
• EvaluationGetResponse

Methods:

• client.aiGateway.evaluations.create(gatewayId, { ...params }) -> EvaluationCreateResponse
• client.aiGateway.evaluations.list(gatewayId, { ...params }) -> EvaluationListResponsesV4PagePaginationArray
• client.aiGateway.evaluations.delete(gatewayId, id, { ...params }) -> EvaluationDeleteResponse
• client.aiGateway.evaluations.get(gatewayId, id, { ...params }) -> EvaluationGetResponse

URLs

Types:

• URLGetResponse

Methods:

• client.aiGateway.urls.get(gatewayId, provider, { ...params }) -> URLGetResponse

IAM

PermissionGroups

Types:

• PermissionGroupListResponse
• PermissionGroupGetResponse

Methods:

• client.iam.permissionGroups.list({ ...params }) -> PermissionGroupListResponsesV4PagePaginationArray
• client.iam.permissionGroups.get(permissionGroupId, { ...params }) -> PermissionGroupGetResponse

ResourceGroups

Types:

• ResourceGroupCreateResponse
• ResourceGroupUpdateResponse
• ResourceGroupListResponse
• ResourceGroupDeleteResponse
• ResourceGroupGetResponse

Methods:

• client.iam.resourceGroups.create({ ...params }) -> ResourceGroupCreateResponse
• client.iam.resourceGroups.update(resourceGroupId, { ...params }) -> ResourceGroupUpdateResponse
• client.iam.resourceGroups.list({ ...params }) -> ResourceGroupListResponsesV4PagePaginationArray
• client.iam.resourceGroups.delete(resourceGroupId, { ...params }) -> ResourceGroupDeleteResponse | null
• client.iam.resourceGroups.get(resourceGroupId, { ...params }) -> ResourceGroupGetResponse

CloudConnector

Rules

Types:

• RuleUpdateResponse
• RuleListResponse

Methods:

• client.cloudConnector.rules.update([ ...rules ]) -> RuleUpdateResponsesSinglePage
• client.cloudConnector.rules.list({ ...params }) -> RuleListResponsesSinglePage

BotnetFeed

ASN

Types:

• ASNDayReportResponse
• ASNFullReportResponse

Methods:

• client.botnetFeed.asn.dayReport(asnId, { ...params }) -> ASNDayReportResponse
• client.botnetFeed.asn.fullReport(asnId, { ...params }) -> ASNFullReportResponse

Configs

ASN

Types:

• ASNDeleteResponse
• ASNGetResponse

Methods:

• client.botnetFeed.configs.asn.delete(asnId, { ...params }) -> ASNDeleteResponse
• client.botnetFeed.configs.asn.get({ ...params }) -> ASNGetResponse

SecurityTXT

Types:

• SecurityTXTUpdateResponse
• SecurityTXTDeleteResponse
• SecurityTXTGetResponse

Methods:

• client.securityTXT.update({ ...params }) -> SecurityTXTUpdateResponse
• client.securityTXT.delete({ ...params }) -> SecurityTXTDeleteResponse
• client.securityTXT.get({ ...params }) -> SecurityTXTGetResponse

Workflows

Types:

• WorkflowUpdateResponse
• WorkflowListResponse
• WorkflowDeleteResponse
• WorkflowGetResponse

Methods:

• client.workflows.update(workflowName, { ...params }) -> WorkflowUpdateResponse
• client.workflows.list({ ...params }) -> WorkflowListResponsesV4PagePaginationArray
• client.workflows.delete(workflowName, { ...params }) -> WorkflowDeleteResponse
• client.workflows.get(workflowName, { ...params }) -> WorkflowGetResponse

Instances

Types:

• InstanceCreateResponse
• InstanceListResponse
• InstanceBulkResponse
• InstanceGetResponse

Methods:

• client.workflows.instances.create(workflowName, { ...params }) -> InstanceCreateResponse
• client.workflows.instances.list(workflowName, { ...params }) -> InstanceListResponsesV4PagePaginationArray
• client.workflows.instances.bulk(workflowName, [ ...body ]) -> InstanceBulkResponsesSinglePage
• client.workflows.instances.get(workflowName, instanceId, { ...params }) -> InstanceGetResponse

Status

Types:

• StatusEditResponse

Methods:

• client.workflows.instances.status.edit(workflowName, instanceId, { ...params }) -> StatusEditResponse

Events

Types:

• EventCreateResponse

Methods:

• client.workflows.instances.events.create(workflowName, instanceId, eventType, { ...params }) -> EventCreateResponse

Versions

Types:

• VersionListResponse
• VersionGetResponse

Methods:

• client.workflows.versions.list(workflowName, { ...params }) -> VersionListResponsesV4PagePaginationArray
• client.workflows.versions.get(workflowName, versionId, { ...params }) -> VersionGetResponse

ResourceSharing

Types:

• ResourceSharingCreateResponse
• ResourceSharingUpdateResponse
• ResourceSharingListResponse
• ResourceSharingDeleteResponse
• ResourceSharingGetResponse

Methods:

• client.resourceSharing.create({ ...params }) -> ResourceSharingCreateResponse
• client.resourceSharing.update(shareId, { ...params }) -> ResourceSharingUpdateResponse
• client.resourceSharing.list({ ...params }) -> ResourceSharingListResponsesV4PagePaginationArray
• client.resourceSharing.delete(shareId, { ...params }) -> ResourceSharingDeleteResponse
• client.resourceSharing.get(shareId, { ...params }) -> ResourceSharingGetResponse

Recipients

Types:

• RecipientCreateResponse
• RecipientListResponse
• RecipientDeleteResponse
• RecipientGetResponse

Methods:

• client.resourceSharing.recipients.create(shareId, { ...params }) -> RecipientCreateResponse
• client.resourceSharing.recipients.list(shareId, { ...params }) -> RecipientListResponsesV4PagePaginationArray
• client.resourceSharing.recipients.delete(shareId, recipientId, { ...params }) -> RecipientDeleteResponse
• client.resourceSharing.recipients.get(shareId, recipientId, { ...params }) -> RecipientGetResponse

Resources

Types:

• ResourceCreateResponse
• ResourceUpdateResponse
• ResourceListResponse
• ResourceDeleteResponse
• ResourceGetResponse

Methods:

• client.resourceSharing.resources.create(shareId, { ...params }) -> ResourceCreateResponse
• client.resourceSharing.resources.update(shareId, resourceId, { ...params }) -> ResourceUpdateResponse
• client.resourceSharing.resources.list(shareId, { ...params }) -> ResourceListResponsesV4PagePaginationArray
• client.resourceSharing.resources.delete(shareId, resourceId, { ...params }) -> ResourceDeleteResponse
• client.resourceSharing.resources.get(shareId, resourceId, { ...params }) -> ResourceGetResponse

LeakedCredentialChecks

Types:

• LeakedCredentialCheckCreateResponse
• LeakedCredentialCheckGetResponse

Methods:

• client.leakedCredentialChecks.create({ ...params }) -> LeakedCredentialCheckCreateResponse
• client.leakedCredentialChecks.get({ ...params }) -> LeakedCredentialCheckGetResponse

Detections

Types:

• DetectionCreateResponse
• DetectionUpdateResponse
• DetectionListResponse
• DetectionDeleteResponse

Methods:

• client.leakedCredentialChecks.detections.create({ ...params }) -> DetectionCreateResponse
• client.leakedCredentialChecks.detections.update(detectionId, { ...params }) -> DetectionUpdateResponse
• client.leakedCredentialChecks.detections.list({ ...params }) -> DetectionListResponsesSinglePage
• client.leakedCredentialChecks.detections.delete(detectionId, { ...params }) -> DetectionDeleteResponse

ContentScanning

Types:

• ContentScanningDisableResponse
• ContentScanningEnableResponse

Methods:

• client.contentScanning.disable({ ...params }) -> ContentScanningDisableResponse
• client.contentScanning.enable({ ...params }) -> ContentScanningEnableResponse

Payloads

Types:

• PayloadCreateResponse
• PayloadListResponse
• PayloadDeleteResponse

Methods:

• client.contentScanning.payloads.create([ ...body ]) -> PayloadCreateResponsesSinglePage
• client.contentScanning.payloads.list({ ...params }) -> PayloadListResponsesSinglePage
• client.contentScanning.payloads.delete(expressionId, { ...params }) -> PayloadDeleteResponsesSinglePage

Settings

Types:

• SettingGetResponse

Methods:

• client.contentScanning.settings.get({ ...params }) -> SettingGetResponse

AbuseReports

Types:

• AbuseReportCreateResponse

Methods:

• client.abuseReports.create(reportType, { ...params }) -> AbuseReportCreateResponse

AI

Types:

• AIRunResponse

Methods:

• client.ai.run(modelName, { ...params }) -> AIRunResponse

Finetunes

Types:

• FinetuneCreateResponse
• FinetuneListResponse

Methods:

• client.ai.finetunes.create({ ...params }) -> FinetuneCreateResponse
• client.ai.finetunes.list({ ...params }) -> FinetuneListResponse

Assets

Types:

• AssetCreateResponse

Methods:

• client.ai.finetunes.assets.create(finetuneId, { ...params }) -> AssetCreateResponse

Public

Types:

• PublicListResponse

Methods:

• client.ai.finetunes.public.list({ ...params }) -> PublicListResponsesSinglePage

Authors

Types:

• AuthorListResponse

Methods:

• client.ai.authors.list({ ...params }) -> AuthorListResponsesSinglePage

Tasks

Types:

• TaskListResponse

Methods:

• client.ai.tasks.list({ ...params }) -> TaskListResponsesSinglePage

Models

Types:

• ModelListResponse

Methods:

• client.ai.models.list({ ...params }) -> ModelListResponsesV4PagePaginationArray

Schema

Types:

• SchemaGetResponse

Methods:

• client.ai.models.schema.get({ ...params }) -> SchemaGetResponse

SecurityCenter

Insights

Types:

• InsightListResponse
• InsightDismissResponse

Methods:

• client.securityCenter.insights.list({ ...params }) -> InsightListResponsesV4PagePagination
• client.securityCenter.insights.dismiss(issueId, { ...params }) -> InsightDismissResponse

Class

Types:

• ClassGetResponse

Methods:

• client.securityCenter.insights.class.get({ ...params }) -> ClassGetResponse

Severity

Types:

• SeverityGetResponse

Methods:

• client.securityCenter.insights.severity.get({ ...params }) -> SeverityGetResponse

Type

Types:

• TypeGetResponse

Methods:

• client.securityCenter.insights.type.get({ ...params }) -> TypeGetResponse

BrowserRendering

Content

Types:

• ContentCreateResponse

Methods:

• client.browserRendering.content.create({ ...params }) -> ContentCreateResponse

PDF

Methods:

• client.browserRendering.pdf.create({ ...params }) -> Response

Scrape

Types:

• ScrapeCreateResponse

Methods:

• client.browserRendering.scrape.create({ ...params }) -> ScrapeCreateResponse

Screenshot

Types:

• ScreenshotCreateResponse

Methods:

• client.browserRendering.screenshot.create({ ...params }) -> ScreenshotCreateResponse

Snapshot

Types:

• SnapshotCreateResponse

Methods:

• client.browserRendering.snapshot.create({ ...params }) -> SnapshotCreateResponse

Json

Types:

• JsonCreateResponse

Methods:

• client.browserRendering.json.create({ ...params }) -> JsonCreateResponse

Links

Types:

• LinkCreateResponse

Methods:

• client.browserRendering.links.create({ ...params }) -> LinkCreateResponse

Markdown

Types:

• MarkdownCreateResponse

Methods:

• client.browserRendering.markdown.create({ ...params }) -> MarkdownCreateResponse

CustomPages

Types:

• CustomPageUpdateResponse
• CustomPageListResponse
• CustomPageGetResponse

Methods:

• client.customPages.update(identifier, { ...params }) -> CustomPageUpdateResponse | null
• client.customPages.list({ ...params }) -> CustomPageListResponsesSinglePage
• client.customPages.get(identifier, { ...params }) -> CustomPageGetResponse | null

SecretsStore

Stores

Types:

• StoreCreateResponse
• StoreListResponse
• StoreDeleteResponse

Methods:

• client.secretsStore.stores.create([ ...body ]) -> StoreCreateResponsesSinglePage
• client.secretsStore.stores.list({ ...params }) -> StoreListResponsesV4PagePaginationArray
• client.secretsStore.stores.delete(storeId, { ...params }) -> StoreDeleteResponse

Secrets

Types:

• SecretCreateResponse
• SecretListResponse
• SecretDeleteResponse
• SecretBulkDeleteResponse
• SecretDuplicateResponse
• SecretEditResponse
• SecretGetResponse

Methods:

• client.secretsStore.stores.secrets.create(storeId, [ ...body ]) -> SecretCreateResponsesSinglePage
• client.secretsStore.stores.secrets.list(storeId, { ...params }) -> SecretListResponsesV4PagePaginationArray
• client.secretsStore.stores.secrets.delete(storeId, secretId, { ...params }) -> SecretDeleteResponse
• client.secretsStore.stores.secrets.bulkDelete(storeId, { ...params }) -> SecretBulkDeleteResponsesSinglePage
• client.secretsStore.stores.secrets.duplicate(storeId, secretId, { ...params }) -> SecretDuplicateResponse
• client.secretsStore.stores.secrets.edit(storeId, secretId, { ...params }) -> SecretEditResponse
• client.secretsStore.stores.secrets.get(storeId, secretId, { ...params }) -> SecretGetResponse

Quota

Types:

• QuotaGetResponse

Methods:

• client.secretsStore.quota.get({ ...params }) -> QuotaGetResponse

Pipelines

Types:

• PipelineCreateResponse
• PipelineUpdateResponse
• PipelineListResponse
• PipelineGetResponse

Methods:

• client.pipelines.create({ ...params }) -> PipelineCreateResponse
• client.pipelines.update(pipelineName, { ...params }) -> PipelineUpdateResponse
• client.pipelines.list({ ...params }) -> PipelineListResponse
• client.pipelines.delete(pipelineName, { ...params }) -> void
• client.pipelines.get(pipelineName, { ...params }) -> PipelineGetResponse

SchemaValidation

Schemas

Types:

• SchemaCreateResponse
• SchemaListResponse
• SchemaDeleteResponse
• SchemaEditResponse
• SchemaGetResponse

Methods:

• client.schemaValidation.schemas.create({ ...params }) -> SchemaCreateResponse
• client.schemaValidation.schemas.list({ ...params }) -> SchemaListResponsesV4PagePaginationArray
• client.schemaValidation.schemas.delete(schemaId, { ...params }) -> SchemaDeleteResponse
• client.schemaValidation.schemas.edit(schemaId, { ...params }) -> SchemaEditResponse
• client.schemaValidation.schemas.get(schemaId, { ...params }) -> SchemaGetResponse

Settings

Types:

• SettingUpdateResponse
• SettingEditResponse
• SettingGetResponse

Methods:

• client.schemaValidation.settings.update({ ...params }) -> SettingUpdateResponse
• client.schemaValidation.settings.edit({ ...params }) -> SettingEditResponse
• client.schemaValidation.settings.get({ ...params }) -> SettingGetResponse

Operations

Types:

• OperationUpdateResponse
• OperationListResponse
• OperationDeleteResponse
• OperationBulkEditResponse
• OperationGetResponse

Methods:

• client.schemaValidation.settings.operations.update(operationId, { ...params }) -> OperationUpdateResponse
• client.schemaValidation.settings.operations.list({ ...params }) -> OperationListResponsesV4PagePaginationArray
• client.schemaValidation.settings.operations.delete(operationId, { ...params }) -> OperationDeleteResponse
• client.schemaValidation.settings.operations.bulkEdit({ ...params }) -> OperationBulkEditResponse
• client.schemaValidation.settings.operations.get(operationId, { ...params }) -> OperationGetResponse