# Shared
Types:
- ErrorData
# Accounts
Types:
- Account
- AccountUpdateResponse
- AccountListResponse
- AccountGetResponse
Methods:
- client.accounts.update({ ...params }) -> AccountUpdateResponse
- client.accounts.list({ ...params }) -> AccountListResponsesV4PagePaginationArray
- client.accounts.get({ ...params }) -> AccountGetResponse
## Members
Types:
- AccountMember
- AccountMemberWithID
- MemberListResponse
- MemberDeleteResponse
Methods:
- client.accounts.members.create({ ...params }) -> AccountMemberWithID
- client.accounts.members.update(memberId, { ...params }) -> AccountMember
- client.accounts.members.list({ ...params }) -> MemberListResponsesV4PagePaginationArray
- client.accounts.members.delete(memberId, { ...params }) -> MemberDeleteResponse | null
- client.accounts.members.get(memberId, { ...params }) -> AccountMember
## Roles
Types:
- Role
- RoleGetResponse
Methods:
- client.accounts.roles.list({ ...params }) -> RolesSinglePage
- client.accounts.roles.get(roleId, { ...params }) -> RoleGetResponse
# OriginCACertificates
Types:
- OriginCACertificate
- OriginCACertificateCreateResponse
- OriginCACertificateDeleteResponse
- OriginCACertificateGetResponse
Methods:
- client.originCACertificates.create({ ...params }) -> OriginCACertificateCreateResponse
- client.originCACertificates.list() -> OriginCACertificatesSinglePage
- client.originCACertificates.delete(certificateId) -> OriginCACertificateDeleteResponse
- client.originCACertificates.get(certificateId) -> OriginCACertificateGetResponse
# 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:
- User
- UserEditResponse
- UserGetResponse
Methods:
- client.user.edit({ ...params }) -> UserEditResponse
- client.user.get() -> UserGetResponse
## AuditLogs
Types:
- AuditLogListResponse
Methods:
- client.user.auditLogs.list({ ...params }) -> AuditLogListResponsesV4PagePaginationArray
## Billing
### History
Types:
- BillingHistory
- HistoryGetResponse
Methods:
- client.user.billing.history.get({ ...params }) -> HistoryGetResponse | null
### Profile
Types:
- ProfileGetResponse
Methods:
- client.user.billing.profile.get() -> ProfileGetResponse
## Firewall
### AccessRules
Types:
- FirewallRule
- AccessRuleDeleteResponse
Methods:
- client.user.firewall.accessRules.create({ ...params }) -> FirewallRule | null
- client.user.firewall.accessRules.list({ ...params }) -> FirewallRulesV4PagePaginationArray
- client.user.firewall.accessRules.delete(identifier) -> AccessRuleDeleteResponse | null
- client.user.firewall.accessRules.edit(identifier, { ...params }) -> FirewallRule | null
## Invites
Types:
- UserInvite
- InviteListResponse
- InviteEditResponse
- InviteGetResponse
Methods:
- client.user.invites.list() -> InviteListResponsesSinglePage
- client.user.invites.edit(inviteId, { ...params }) -> InviteEditResponse
- client.user.invites.get(inviteId) -> InviteGetResponse
## LoadBalancers
### Monitors
Types:
- LoadBalancingMonitor
- MonitorDeleteResponse
- MonitorPreviewResponse
- MonitorReferencesResponse
Methods:
- client.user.loadBalancers.monitors.create({ ...params }) -> LoadBalancingMonitor
- client.user.loadBalancers.monitors.update(monitorId, { ...params }) -> LoadBalancingMonitor
- client.user.loadBalancers.monitors.list() -> LoadBalancingMonitorsSinglePage
- client.user.loadBalancers.monitors.delete(monitorId) -> MonitorDeleteResponse
- client.user.loadBalancers.monitors.edit(monitorId, { ...params }) -> LoadBalancingMonitor
- client.user.loadBalancers.monitors.get(monitorId) -> LoadBalancingMonitor
- client.user.loadBalancers.monitors.preview(monitorId, { ...params }) -> MonitorPreviewResponse
- client.user.loadBalancers.monitors.references(monitorId) -> MonitorReferencesResponse | null
### Pools
Types:
- LoadBalancingPool
- PoolDeleteResponse
- PoolHealthResponse
- PoolPreviewResponse
- PoolReferencesResponse
Methods:
- client.user.loadBalancers.pools.create({ ...params }) -> LoadBalancingPool
- client.user.loadBalancers.pools.update(poolId, { ...params }) -> LoadBalancingPool
- client.user.loadBalancers.pools.list({ ...params }) -> LoadBalancingPoolsSinglePage
- client.user.loadBalancers.pools.delete(poolId) -> PoolDeleteResponse
- client.user.loadBalancers.pools.edit(poolId, { ...params }) -> LoadBalancingPool
- client.user.loadBalancers.pools.get(poolId) -> LoadBalancingPool
- client.user.loadBalancers.pools.health(poolId) -> PoolHealthResponse
- client.user.loadBalancers.pools.preview(poolId, { ...params }) -> PoolPreviewResponse
- client.user.loadBalancers.pools.references(poolId) -> PoolReferencesResponse | null
### Preview
Types:
- LoadBalancingPreview
Methods:
- client.user.loadBalancers.preview.get(previewId) -> LoadBalancingPreview
### Analytics
#### Events
Types:
- LoadBalancingAnalytics
Methods:
- client.user.loadBalancers.analytics.events.list({ ...params }) -> LoadBalancingAnalyticsSinglePage
## 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:
- Subscription
- SubscriptionUpdateResponse
- SubscriptionDeleteResponse
- SubscriptionEditResponse
- SubscriptionGetResponse
Methods:
- client.user.subscriptions.update(identifier, { ...params }) -> SubscriptionUpdateResponse
- client.user.subscriptions.delete(identifier) -> SubscriptionDeleteResponse
- client.user.subscriptions.edit(identifier, { ...params }) -> SubscriptionEditResponse
- client.user.subscriptions.get() -> SubscriptionGetResponse | null
## Tokens
Types:
- TokenCreateResponse
- TokenUpdateResponse
- TokenListResponse
- TokenDeleteResponse
- TokenGetResponse
- TokenVerifyResponse
Methods:
- client.user.tokens.create({ ...params }) -> TokenCreateResponse
- client.user.tokens.update(tokenId, { ...params }) -> TokenUpdateResponse
- client.user.tokens.list({ ...params }) -> TokenListResponsesV4PagePaginationArray
- client.user.tokens.delete(tokenId) -> TokenDeleteResponse | null
- client.user.tokens.get(tokenId) -> TokenGetResponse
- client.user.tokens.verify() -> TokenVerifyResponse
### PermissionGroups
Types:
- PermissionGroupListResponse
Methods:
- client.user.tokens.permissionGroups.list() -> PermissionGroupListResponsesSinglePage
### Value
Types:
- TokenValue
Methods:
- client.user.tokens.value.update(tokenId, { ...params }) -> TokenValue
# Zones
Types:
- 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
## DNSSettings
Types:
- DNSSettingEditResponse
- DNSSettingGetResponse
Methods:
- client.zones.dnsSettings.edit({ ...params }) -> DNSSettingEditResponse
- client.zones.dnsSettings.get({ ...params }) -> DNSSettingGetResponse
## Settings
Types:
- SettingEditResponse
- SettingGetResponse
Methods:
- client.zones.settings.edit({ ...params }) -> SettingEditResponse
- client.zones.settings.get({ ...params }) -> SettingGetResponse
### ZeroRTT
Types:
- ZoneSetting0rtt
Methods:
- client.zones.settings.zeroRTT.edit({ ...params }) -> ZoneSetting0rtt
- client.zones.settings.zeroRTT.get({ ...params }) -> ZoneSetting0rtt
### AdvancedDDoS
Types:
- ZoneSettingAdvancedDDoS
Methods:
- client.zones.settings.advancedDDoS.get({ ...params }) -> ZoneSettingAdvancedDDoS
### AlwaysOnline
Types:
- ZoneSettingAlwaysOnline
Methods:
- client.zones.settings.alwaysOnline.edit({ ...params }) -> ZoneSettingAlwaysOnline
- client.zones.settings.alwaysOnline.get({ ...params }) -> ZoneSettingAlwaysOnline
### AlwaysUseHTTPS
Types:
- ZoneSettingAlwaysUseHTTPS
Methods:
- client.zones.settings.alwaysUseHTTPS.edit({ ...params }) -> ZoneSettingAlwaysUseHTTPS
- client.zones.settings.alwaysUseHTTPS.get({ ...params }) -> ZoneSettingAlwaysUseHTTPS
### AutomaticHTTPSRewrites
Types:
- ZoneSettingAutomaticHTTPSRewrites
Methods:
- client.zones.settings.automaticHTTPSRewrites.edit({ ...params }) -> ZoneSettingAutomaticHTTPSRewrites
- client.zones.settings.automaticHTTPSRewrites.get({ ...params }) -> ZoneSettingAutomaticHTTPSRewrites
### AutomaticPlatformOptimization
Types:
- ZoneSettingAutomaticPlatformOptimization
Methods:
- client.zones.settings.automaticPlatformOptimization.edit({ ...params }) -> ZoneSettingAutomaticPlatformOptimization
- client.zones.settings.automaticPlatformOptimization.get({ ...params }) -> ZoneSettingAutomaticPlatformOptimization
### Brotli
Types:
- ZoneSettingBrotli
Methods:
- client.zones.settings.brotli.edit({ ...params }) -> ZoneSettingBrotli
- client.zones.settings.brotli.get({ ...params }) -> ZoneSettingBrotli
### BrowserCacheTTL
Types:
- ZoneSettingBrowserCacheTTL
Methods:
- client.zones.settings.browserCacheTTL.edit({ ...params }) -> ZoneSettingBrowserCacheTTL
- client.zones.settings.browserCacheTTL.get({ ...params }) -> ZoneSettingBrowserCacheTTL
### BrowserCheck
Types:
- ZoneSettingBrowserCheck
Methods:
- client.zones.settings.browserCheck.edit({ ...params }) -> ZoneSettingBrowserCheck
- client.zones.settings.browserCheck.get({ ...params }) -> ZoneSettingBrowserCheck
### CacheLevel
Types:
- ZoneSettingCacheLevel
Methods:
- client.zones.settings.cacheLevel.edit({ ...params }) -> ZoneSettingCacheLevel
- client.zones.settings.cacheLevel.get({ ...params }) -> ZoneSettingCacheLevel
### ChallengeTTL
Types:
- ZoneSettingChallengeTTL
Methods:
- client.zones.settings.challengeTTL.edit({ ...params }) -> ZoneSettingChallengeTTL
- client.zones.settings.challengeTTL.get({ ...params }) -> ZoneSettingChallengeTTL
### Ciphers
Types:
- ZoneSettingCiphers
Methods:
- client.zones.settings.ciphers.edit({ ...params }) -> ZoneSettingCiphers
- client.zones.settings.ciphers.get({ ...params }) -> ZoneSettingCiphers
### DevelopmentMode
Types:
- ZoneSettingDevelopmentMode
Methods:
- client.zones.settings.developmentMode.edit({ ...params }) -> ZoneSettingDevelopmentMode
- client.zones.settings.developmentMode.get({ ...params }) -> ZoneSettingDevelopmentMode
### EarlyHints
Types:
- ZoneSettingEarlyHints
Methods:
- client.zones.settings.earlyHints.edit({ ...params }) -> ZoneSettingEarlyHints
- client.zones.settings.earlyHints.get({ ...params }) -> ZoneSettingEarlyHints
### EmailObfuscation
Types:
- ZoneSettingEmailObfuscation
Methods:
- client.zones.settings.emailObfuscation.edit({ ...params }) -> ZoneSettingEmailObfuscation
- client.zones.settings.emailObfuscation.get({ ...params }) -> ZoneSettingEmailObfuscation
### H2Prioritization
Types:
- ZoneSettingH2Prioritization
Methods:
- client.zones.settings.h2Prioritization.edit({ ...params }) -> ZoneSettingH2Prioritization
- client.zones.settings.h2Prioritization.get({ ...params }) -> ZoneSettingH2Prioritization
### HotlinkProtection
Types:
- ZoneSettingHotlinkProtection
Methods:
- client.zones.settings.hotlinkProtection.edit({ ...params }) -> ZoneSettingHotlinkProtection
- client.zones.settings.hotlinkProtection.get({ ...params }) -> ZoneSettingHotlinkProtection
### HTTP2
Types:
- ZoneSettingHTTP2
Methods:
- client.zones.settings.http2.edit({ ...params }) -> ZoneSettingHTTP2
- client.zones.settings.http2.get({ ...params }) -> ZoneSettingHTTP2
### HTTP3
Types:
- ZoneSettingHTTP3
Methods:
- client.zones.settings.http3.edit({ ...params }) -> ZoneSettingHTTP3
- client.zones.settings.http3.get({ ...params }) -> ZoneSettingHTTP3
### ImageResizing
Types:
- ZoneSettingImageResizing
Methods:
- client.zones.settings.imageResizing.edit({ ...params }) -> ZoneSettingImageResizing
- client.zones.settings.imageResizing.get({ ...params }) -> ZoneSettingImageResizing
### IPGeolocation
Types:
- ZoneSettingIPGeolocation
Methods:
- client.zones.settings.ipGeolocation.edit({ ...params }) -> ZoneSettingIPGeolocation
- client.zones.settings.ipGeolocation.get({ ...params }) -> ZoneSettingIPGeolocation
### IPV6
Types:
- ZoneSettingIPV6
Methods:
- client.zones.settings.ipv6.edit({ ...params }) -> ZoneSettingIPV6
- client.zones.settings.ipv6.get({ ...params }) -> ZoneSettingIPV6
### MinTLSVersion
Types:
- ZoneSettingMinTLSVersion
Methods:
- client.zones.settings.minTLSVersion.edit({ ...params }) -> ZoneSettingMinTLSVersion
- client.zones.settings.minTLSVersion.get({ ...params }) -> ZoneSettingMinTLSVersion
### Minify
Types:
- ZoneSettingMinify
Methods:
- client.zones.settings.minify.edit({ ...params }) -> ZoneSettingMinify
- client.zones.settings.minify.get({ ...params }) -> ZoneSettingMinify
### Mirage
Types:
- ZoneSettingMirage
Methods:
- client.zones.settings.mirage.edit({ ...params }) -> ZoneSettingMirage
- client.zones.settings.mirage.get({ ...params }) -> ZoneSettingMirage
### MobileRedirect
Types:
- ZoneSettingMobileRedirect
Methods:
- client.zones.settings.mobileRedirect.edit({ ...params }) -> ZoneSettingMobileRedirect
- client.zones.settings.mobileRedirect.get({ ...params }) -> ZoneSettingMobileRedirect
### NEL
Types:
- ZoneSettingNEL
Methods:
- client.zones.settings.nel.edit({ ...params }) -> ZoneSettingNEL
- client.zones.settings.nel.get({ ...params }) -> ZoneSettingNEL
### OpportunisticEncryption
Types:
- ZoneSettingOpportunisticEncryption
Methods:
- client.zones.settings.opportunisticEncryption.edit({ ...params }) -> ZoneSettingOpportunisticEncryption
- client.zones.settings.opportunisticEncryption.get({ ...params }) -> ZoneSettingOpportunisticEncryption
### OpportunisticOnion
Types:
- ZoneSettingOpportunisticOnion
Methods:
- client.zones.settings.opportunisticOnion.edit({ ...params }) -> ZoneSettingOpportunisticOnion
- client.zones.settings.opportunisticOnion.get({ ...params }) -> ZoneSettingOpportunisticOnion
### OrangeToOrange
Types:
- ZoneSettingOrangeToOrange
Methods:
- client.zones.settings.orangeToOrange.edit({ ...params }) -> ZoneSettingOrangeToOrange
- client.zones.settings.orangeToOrange.get({ ...params }) -> ZoneSettingOrangeToOrange
### OriginErrorPagePassThru
Types:
- ZoneSettingOriginErrorPagePassThru
Methods:
- client.zones.settings.originErrorPagePassThru.edit({ ...params }) -> ZoneSettingOriginErrorPagePassThru
- client.zones.settings.originErrorPagePassThru.get({ ...params }) -> ZoneSettingOriginErrorPagePassThru
### OriginMaxHTTPVersion
Types:
- OriginMaxHTTPVersionEditResponse
- OriginMaxHTTPVersionGetResponse
Methods:
- client.zones.settings.originMaxHTTPVersion.edit({ ...params }) -> OriginMaxHTTPVersionEditResponse
- client.zones.settings.originMaxHTTPVersion.get({ ...params }) -> OriginMaxHTTPVersionGetResponse
### Polish
Types:
- ZoneSettingPolish
Methods:
- client.zones.settings.polish.edit({ ...params }) -> ZoneSettingPolish
- client.zones.settings.polish.get({ ...params }) -> ZoneSettingPolish
### PrefetchPreload
Types:
- ZoneSettingPrefetchPreload
Methods:
- client.zones.settings.prefetchPreload.edit({ ...params }) -> ZoneSettingPrefetchPreload
- client.zones.settings.prefetchPreload.get({ ...params }) -> ZoneSettingPrefetchPreload
### ProxyReadTimeout
Types:
- ZoneSettingProxyReadTimeout
Methods:
- client.zones.settings.proxyReadTimeout.edit({ ...params }) -> ZoneSettingProxyReadTimeout
- client.zones.settings.proxyReadTimeout.get({ ...params }) -> ZoneSettingProxyReadTimeout
### PseudoIPV4
Types:
- ZoneSettingPseudoIPV4
Methods:
- client.zones.settings.pseudoIPV4.edit({ ...params }) -> ZoneSettingPseudoIPV4
- client.zones.settings.pseudoIPV4.get({ ...params }) -> ZoneSettingPseudoIPV4
### ResponseBuffering
Types:
- ZoneSettingBuffering
Methods:
- client.zones.settings.responseBuffering.edit({ ...params }) -> ZoneSettingBuffering
- client.zones.settings.responseBuffering.get({ ...params }) -> ZoneSettingBuffering
### RocketLoader
Types:
- ZoneSettingRocketLoader
Methods:
- client.zones.settings.rocketLoader.edit({ ...params }) -> ZoneSettingRocketLoader
- client.zones.settings.rocketLoader.get({ ...params }) -> ZoneSettingRocketLoader
### SecurityHeaders
Types:
- ZoneSettingSecurityHeader
Methods:
- client.zones.settings.securityHeaders.edit({ ...params }) -> ZoneSettingSecurityHeader
- client.zones.settings.securityHeaders.get({ ...params }) -> ZoneSettingSecurityHeader
### SecurityLevel
Types:
- ZoneSettingSecurityLevel
Methods:
- client.zones.settings.securityLevel.edit({ ...params }) -> ZoneSettingSecurityLevel
- client.zones.settings.securityLevel.get({ ...params }) -> ZoneSettingSecurityLevel
### ServerSideExcludes
Types:
- ZoneSettingServerSideExclude
Methods:
- client.zones.settings.serverSideExcludes.edit({ ...params }) -> ZoneSettingServerSideExclude
- client.zones.settings.serverSideExcludes.get({ ...params }) -> ZoneSettingServerSideExclude
### SortQueryStringForCache
Types:
- ZoneSettingSortQueryStringForCache
Methods:
- client.zones.settings.sortQueryStringForCache.edit({ ...params }) -> ZoneSettingSortQueryStringForCache
- client.zones.settings.sortQueryStringForCache.get({ ...params }) -> ZoneSettingSortQueryStringForCache
### SSL
Types:
- ZoneSettingSSL
Methods:
- client.zones.settings.ssl.edit({ ...params }) -> ZoneSettingSSL
- client.zones.settings.ssl.get({ ...params }) -> ZoneSettingSSL
### SSLRecommender
Types:
- ZoneSettingSSLRecommender
Methods:
- client.zones.settings.sslRecommender.edit({ ...params }) -> ZoneSettingSSLRecommender
- client.zones.settings.sslRecommender.get({ ...params }) -> ZoneSettingSSLRecommender
### TLS1_3
Types:
- ZoneSettingTLS1_3
Methods:
- client.zones.settings.tls1_3.edit({ ...params }) -> ZoneSettingTLS1_3
- client.zones.settings.tls1_3.get({ ...params }) -> ZoneSettingTLS1_3
### TLSClientAuth
Types:
- ZoneSettingTLSClientAuth
Methods:
- client.zones.settings.tlsClientAuth.edit({ ...params }) -> ZoneSettingTLSClientAuth
- client.zones.settings.tlsClientAuth.get({ ...params }) -> ZoneSettingTLSClientAuth
### TrueClientIPHeader
Types:
- ZoneSettingTrueClientIPHeader
Methods:
- client.zones.settings.trueClientIPHeader.edit({ ...params }) -> ZoneSettingTrueClientIPHeader
- client.zones.settings.trueClientIPHeader.get({ ...params }) -> ZoneSettingTrueClientIPHeader
### WAF
Types:
- ZoneSettingWAF
Methods:
- client.zones.settings.waf.edit({ ...params }) -> ZoneSettingWAF
- client.zones.settings.waf.get({ ...params }) -> ZoneSettingWAF
### WebP
Types:
- ZoneSettingWebP
Methods:
- client.zones.settings.WebP.edit({ ...params }) -> ZoneSettingWebP
- client.zones.settings.WebP.get({ ...params }) -> ZoneSettingWebP
### Websocket
Types:
- ZoneSettingWebsockets
Methods:
- client.zones.settings.websocket.edit({ ...params }) -> ZoneSettingWebsockets
- client.zones.settings.websocket.get({ ...params }) -> ZoneSettingWebsockets
### FontSettings
Types:
- ZoneSettingFonts
Methods:
- client.zones.settings.fontSettings.edit({ ...params }) -> ZoneSettingFonts
- client.zones.settings.fontSettings.get({ ...params }) -> ZoneSettingFonts
## CustomNameservers
Types:
- CustomNameserverUpdateResponse
- CustomNameserverGetResponse
Methods:
- client.zones.customNameservers.update({ ...params }) -> CustomNameserverUpdateResponse | null
- client.zones.customNameservers.get({ ...params }) -> CustomNameserverGetResponse | null
## Holds
Types:
- HoldCreateResponse
- HoldDeleteResponse
- HoldGetResponse
Methods:
- client.zones.holds.create({ ...params }) -> HoldCreateResponse
- client.zones.holds.delete({ ...params }) -> HoldDeleteResponse
- client.zones.holds.get({ ...params }) -> HoldGetResponse
## Workers
### Script
Types:
- ScriptUpdateResponse
Methods:
- client.zones.workers.script.update({ ...params }) -> ScriptUpdateResponse
- client.zones.workers.script.delete({ ...params }) -> void
- client.zones.workers.script.get({ ...params }) -> Response
## Subscriptions
Types:
- SubscriptionCreateResponse
- SubscriptionListResponse
- SubscriptionGetResponse
Methods:
- client.zones.subscriptions.create(identifier, { ...params }) -> SubscriptionCreateResponse
- client.zones.subscriptions.list(accountIdentifier) -> SubscriptionListResponsesSinglePage
- client.zones.subscriptions.get(identifier) -> SubscriptionGetResponse
# LoadBalancers
Types:
- LoadBalancer
- 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:
- MonitorDeleteResponse
Methods:
- client.loadBalancers.monitors.create({ ...params }) -> LoadBalancingMonitor
- client.loadBalancers.monitors.update(monitorId, { ...params }) -> LoadBalancingMonitor
- client.loadBalancers.monitors.list({ ...params }) -> LoadBalancingMonitorsSinglePage
- client.loadBalancers.monitors.delete(monitorId, { ...params }) -> MonitorDeleteResponse
- client.loadBalancers.monitors.edit(monitorId, { ...params }) -> LoadBalancingMonitor
- client.loadBalancers.monitors.get(monitorId, { ...params }) -> LoadBalancingMonitor
### Previews
Types:
- PreviewCreateResponse
Methods:
- client.loadBalancers.monitors.previews.create(monitorId, { ...params }) -> PreviewCreateResponse
### References
Types:
- ReferenceGetResponse
Methods:
- client.loadBalancers.monitors.references.get(monitorId, { ...params }) -> ReferenceGetResponse | null
## Pools
Types:
- PoolDeleteResponse
Methods:
- client.loadBalancers.pools.create({ ...params }) -> LoadBalancingPool
- client.loadBalancers.pools.update(poolId, { ...params }) -> LoadBalancingPool
- client.loadBalancers.pools.list({ ...params }) -> LoadBalancingPoolsSinglePage
- client.loadBalancers.pools.delete(poolId, { ...params }) -> PoolDeleteResponse
- client.loadBalancers.pools.edit(poolId, { ...params }) -> LoadBalancingPool
- client.loadBalancers.pools.get(poolId, { ...params }) -> LoadBalancingPool
### 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 }) -> ReferenceGetResponse | null
## Previews
Methods:
- client.loadBalancers.previews.get(previewId, { ...params }) -> LoadBalancingPreview
## Regions
Types:
- RegionListResponse
- RegionGetResponse
Methods:
- client.loadBalancers.regions.list({ ...params }) -> RegionListResponse
- client.loadBalancers.regions.get(regionId, { ...params }) -> RegionGetResponse
## Searches
Types:
- SearchGetResponse
Methods:
- client.loadBalancers.searches.get({ ...params }) -> SearchGetResponse | null
# Cache
Types:
- CachePurgeResponse
Methods:
- client.cache.purge({ ...params }) -> CachePurgeResponse | null
## CacheReserve
Types:
- 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:
- CacheVariants
- VariantEditResponse
- VariantGetResponse
Methods:
- client.cache.variants.delete({ ...params }) -> CacheVariants
- client.cache.variants.edit({ ...params }) -> VariantEditResponse
- client.cache.variants.get({ ...params }) -> VariantGetResponse
## RegionalTieredCache
Types:
- 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:
- CertificatePackListResponse
- CertificatePackDeleteResponse
- CertificatePackEditResponse
- CertificatePackGetResponse
Methods:
- 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
### Order
Types:
- OrderCreateResponse
Methods:
- client.ssl.certificatePacks.order.create({ ...params }) -> OrderCreateResponse
### Quota
Types:
- QuotaGetResponse
Methods:
- client.ssl.certificatePacks.quota.get({ ...params }) -> QuotaGetResponse
## Recommendations
Types:
- RecommendationGetResponse
Methods:
- client.ssl.recommendations.get(zoneIdentifier) -> RecommendationGetResponse | null
## Universal
### Settings
Types:
- UniversalSSLSettings
Methods:
- client.ssl.universal.settings.edit({ ...params }) -> UniversalSSLSettings
- client.ssl.universal.settings.get({ ...params }) -> UniversalSSLSettings
## Verification
Types:
- TLSVerificationSetting
- VerificationEditResponse
- VerificationGetResponse
Methods:
- client.ssl.verification.edit(certificatePackId, { ...params }) -> VerificationEditResponse
- client.ssl.verification.get({ ...params }) -> VerificationGetResponse
# Subscriptions
Types:
- SubscriptionCreateResponse
- SubscriptionUpdateResponse
- SubscriptionListResponse
- SubscriptionDeleteResponse
- SubscriptionGetResponse
Methods:
- client.subscriptions.create(identifier, { ...params }) -> SubscriptionCreateResponse
- client.subscriptions.update(accountIdentifier, subscriptionIdentifier, { ...params }) -> SubscriptionUpdateResponse
- client.subscriptions.list(accountIdentifier) -> SubscriptionListResponsesSinglePage
- client.subscriptions.delete(accountIdentifier, subscriptionIdentifier) -> SubscriptionDeleteResponse
- client.subscriptions.get(identifier) -> SubscriptionGetResponse
# ACM
## TotalTLS
Types:
- 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
# Plans
Types:
- AvailableRatePlan
Methods:
- client.plans.list(zoneIdentifier) -> AvailableRatePlansSinglePage
- client.plans.get(zoneIdentifier, planIdentifier) -> AvailableRatePlan
# RatePlans
Types:
- RatePlan
- RatePlanGetResponse
Methods:
- client.ratePlans.get(zoneIdentifier) -> RatePlanGetResponse | null
# CertificateAuthorities
## HostnameAssociations
Types:
- TLSHostnameAssociation
Methods:
- client.certificateAuthorities.hostnameAssociations.update({ ...params }) -> TLSHostnameAssociation
- client.certificateAuthorities.hostnameAssociations.get({ ...params }) -> TLSHostnameAssociation
# 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
- CustomCertificateCreateResponse
- CustomCertificateDeleteResponse
- CustomCertificateEditResponse
- CustomCertificateGetResponse
Methods:
- client.customCertificates.create({ ...params }) -> CustomCertificateCreateResponse
- client.customCertificates.list({ ...params }) -> CustomCertificatesV4PagePaginationArray
- client.customCertificates.delete(customCertificateId, { ...params }) -> CustomCertificateDeleteResponse
- client.customCertificates.edit(customCertificateId, { ...params }) -> CustomCertificateEditResponse
- client.customCertificates.get(customCertificateId, { ...params }) -> CustomCertificateGetResponse
## Prioritize
Types:
- PrioritizeUpdateResponse
Methods:
- client.customCertificates.prioritize.update({ ...params }) -> PrioritizeUpdateResponse | null
# CustomHostnames
Types:
- CustomHostname
- 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
# CustomNameservers
Types:
- CustomNameserver
- CustomNameserverDeleteResponse
- CustomNameserverAvailabiltyResponse
- CustomNameserverGetResponse
- CustomNameserverVerifyResponse
Methods:
- client.customNameservers.create({ ...params }) -> CustomNameserver
- client.customNameservers.delete(customNSId, { ...params }) -> CustomNameserverDeleteResponse | null
- client.customNameservers.availabilty({ ...params }) -> CustomNameserverAvailabiltyResponse | null
- client.customNameservers.get({ ...params }) -> CustomNameserverGetResponse | null
- client.customNameservers.verify({ ...params }) -> CustomNameserverVerifyResponse | null
# DNS
## Records
Types:
- DNSRecord
- RecordDeleteResponse
- RecordExportResponse
- RecordImportResponse
- RecordScanResponse
Methods:
- client.dns.records.create({ ...params }) -> DNSRecord
- client.dns.records.update(dnsRecordId, { ...params }) -> DNSRecord
- client.dns.records.list({ ...params }) -> DNSRecordsV4PagePaginationArray
- client.dns.records.delete(dnsRecordId, { ...params }) -> RecordDeleteResponse
- client.dns.records.edit(dnsRecordId, { ...params }) -> DNSRecord
- client.dns.records.export({ ...params }) -> string
- client.dns.records.get(dnsRecordId, { ...params }) -> DNSRecord
- client.dns.records.import({ ...params }) -> RecordImportResponse
- client.dns.records.scan({ ...params }) -> RecordScanResponse
## Analytics
### Reports
Types:
- DNSAnalyticsReport
Methods:
- client.dns.analytics.reports.get({ ...params }) -> DNSAnalyticsReport
#### Bytimes
Types:
- DNSAnalyticsReportByTime
Methods:
- client.dns.analytics.reports.bytimes.get({ ...params }) -> DNSAnalyticsReportByTime
## Firewall
Types:
- DNSFirewall
- FirewallDeleteResponse
Methods:
- client.dns.firewall.create({ ...params }) -> DNSFirewall
- client.dns.firewall.list({ ...params }) -> DNSFirewallsV4PagePaginationArray
- client.dns.firewall.delete(dnsFirewallId, { ...params }) -> FirewallDeleteResponse
- client.dns.firewall.edit(dnsFirewallId, { ...params }) -> DNSFirewall
- client.dns.firewall.get(dnsFirewallId, { ...params }) -> DNSFirewall
### Analytics
#### Reports
Methods:
- client.dns.firewall.analytics.reports.get(dnsFirewallId, { ...params }) -> DNSAnalyticsReport
##### Bytimes
Methods:
- client.dns.firewall.analytics.reports.bytimes.get(dnsFirewallId, { ...params }) -> DNSAnalyticsReportByTime
# DNSSEC
Types:
- DNSSEC
- DNSSECDeleteResponse
Methods:
- client.dnssec.delete({ ...params }) -> DNSSECDeleteResponse
- client.dnssec.edit({ ...params }) -> DNSSEC
- client.dnssec.get({ ...params }) -> DNSSEC
# EmailRouting
Types:
- EmailSettings
- EmailRoutingDisableResponse
- EmailRoutingEnableResponse
- EmailRoutingGetResponse
Methods:
- client.emailRouting.disable(zoneIdentifier) -> EmailRoutingDisableResponse
- client.emailRouting.enable(zoneIdentifier) -> EmailRoutingEnableResponse
- client.emailRouting.get(zoneIdentifier) -> EmailRoutingGetResponse
## DNS
Types:
- EmailDNSRecord
- DNSGetResponse
Methods:
- client.emailRouting.dns.get(zoneIdentifier) -> DNSGetResponse | null
## Rules
Types:
- EmailRules
- RuleCreateResponse
- RuleUpdateResponse
- RuleListResponse
- RuleDeleteResponse
- RuleGetResponse
Methods:
- client.emailRouting.rules.create(zoneIdentifier, { ...params }) -> RuleCreateResponse
- client.emailRouting.rules.update(zoneIdentifier, ruleIdentifier, { ...params }) -> RuleUpdateResponse
- client.emailRouting.rules.list(zoneIdentifier, { ...params }) -> RuleListResponsesV4PagePaginationArray
- client.emailRouting.rules.delete(zoneIdentifier, ruleIdentifier) -> RuleDeleteResponse
- client.emailRouting.rules.get(zoneIdentifier, ruleIdentifier) -> RuleGetResponse
### CatchAlls
Types:
- EmailCatchAllRule
Methods:
- client.emailRouting.rules.catchAlls.update(zoneIdentifier, { ...params }) -> EmailCatchAllRule
- client.emailRouting.rules.catchAlls.get(zoneIdentifier) -> EmailCatchAllRule
## Addresses
Types:
- EmailAddresses
- AddressCreateResponse
- AddressListResponse
- AddressDeleteResponse
- AddressGetResponse
Methods:
- client.emailRouting.addresses.create(accountIdentifier, { ...params }) -> AddressCreateResponse
- client.emailRouting.addresses.list(accountIdentifier, { ...params }) -> AddressListResponsesV4PagePaginationArray
- client.emailRouting.addresses.delete(accountIdentifier, destinationAddressIdentifier) -> AddressDeleteResponse
- client.emailRouting.addresses.get(accountIdentifier, destinationAddressIdentifier) -> AddressGetResponse
# Filters
Types:
- FirewallFilter
- FilterCreateResponse
Methods:
- client.filters.create(zoneIdentifier, { ...params }) -> FilterCreateResponse | null
- client.filters.update(zoneIdentifier, id, { ...params }) -> FirewallFilter | null
- client.filters.list(zoneIdentifier, { ...params }) -> FirewallFiltersV4PagePaginationArray
- client.filters.delete(zoneIdentifier, id) -> FirewallFilter | null
- client.filters.get(zoneIdentifier, id) -> FirewallFilter | null
# Firewall
## Lockdowns
Types:
- FirewallZoneLockdown
- LockdownDeleteResponse
Methods:
- client.firewall.lockdowns.create(zoneIdentifier, { ...params }) -> FirewallZoneLockdown | null
- client.firewall.lockdowns.update(zoneIdentifier, id, { ...params }) -> FirewallZoneLockdown | null
- client.firewall.lockdowns.list(zoneIdentifier, { ...params }) -> FirewallZoneLockdownsV4PagePaginationArray
- client.firewall.lockdowns.delete(zoneIdentifier, id) -> LockdownDeleteResponse
- client.firewall.lockdowns.get(zoneIdentifier, id) -> FirewallZoneLockdown | null
## Rules
Types:
- FirewallFilterRule
- RuleCreateResponse
- RuleEditResponse
Methods:
- client.firewall.rules.create(zoneIdentifier, { ...params }) -> RuleCreateResponse | null
- client.firewall.rules.update(zoneIdentifier, id, { ...params }) -> FirewallFilterRule | null
- client.firewall.rules.list(zoneIdentifier, { ...params }) -> FirewallFilterRulesV4PagePaginationArray
- client.firewall.rules.delete(zoneIdentifier, id, { ...params }) -> FirewallFilterRule | null
- client.firewall.rules.edit(zoneIdentifier, id, { ...params }) -> RuleEditResponse | null
- client.firewall.rules.get(zoneIdentifier, id) -> FirewallFilterRule | null
## AccessRules
Types:
- AccessRuleCreateResponse
- AccessRuleListResponse
- AccessRuleDeleteResponse
- AccessRuleEditResponse
- AccessRuleGetResponse
Methods:
- client.firewall.accessRules.create({ ...params }) -> AccessRuleCreateResponse | null
- client.firewall.accessRules.list({ ...params }) -> AccessRuleListResponsesV4PagePaginationArray
- client.firewall.accessRules.delete(identifier, { ...params }) -> AccessRuleDeleteResponse | null
- client.firewall.accessRules.edit(identifier, { ...params }) -> AccessRuleEditResponse | null
- client.firewall.accessRules.get(identifier, { ...params }) -> AccessRuleGetResponse | null
## UARules
Types:
- FirewallUserAgentRule
- UARuleCreateResponse
- UARuleUpdateResponse
- UARuleListResponse
- UARuleDeleteResponse
- UARuleGetResponse
Methods:
- client.firewall.uaRules.create(zoneIdentifier, { ...params }) -> UARuleCreateResponse | null
- client.firewall.uaRules.update(zoneIdentifier, id, { ...params }) -> UARuleUpdateResponse | null
- client.firewall.uaRules.list(zoneIdentifier, { ...params }) -> UARuleListResponsesV4PagePaginationArray
- client.firewall.uaRules.delete(zoneIdentifier, id) -> UARuleDeleteResponse | null
- client.firewall.uaRules.get(zoneIdentifier, id) -> UARuleGetResponse | null
## WAF
### Overrides
Types:
- WAFOverride
- OverrideDeleteResponse
Methods:
- client.firewall.waf.overrides.create(zoneIdentifier, { ...params }) -> WAFOverride | null
- client.firewall.waf.overrides.update(zoneIdentifier, id, { ...params }) -> WAFOverride | null
- client.firewall.waf.overrides.list(zoneIdentifier, { ...params }) -> WAFOverridesV4PagePaginationArray
- client.firewall.waf.overrides.delete(zoneIdentifier, id) -> OverrideDeleteResponse
- client.firewall.waf.overrides.get(zoneIdentifier, id) -> WAFOverride | null
### Packages
Types:
- PackageListResponse
- PackageGetResponse
Methods:
- client.firewall.waf.packages.list(zoneIdentifier, { ...params }) -> PackageListResponsesV4PagePaginationArray
- client.firewall.waf.packages.get(zoneIdentifier, identifier) -> PackageGetResponse
#### Groups
Types:
- WAFManagedRulesGroup
- GroupEditResponse
- GroupGetResponse
Methods:
- client.firewall.waf.packages.groups.list(packageId, { ...params }) -> WAFManagedRulesGroupsV4PagePaginationArray
- client.firewall.waf.packages.groups.edit(packageId, groupId, { ...params }) -> GroupEditResponse
- client.firewall.waf.packages.groups.get(packageId, groupId, { ...params }) -> GroupGetResponse
#### Rules
Types:
- WAFManagedRulesRule
- RuleEditResponse
- RuleGetResponse
Methods:
- client.firewall.waf.packages.rules.list(packageId, { ...params }) -> WAFManagedRulesRulesV4PagePaginationArray
- client.firewall.waf.packages.rules.edit(packageId, ruleId, { ...params }) -> RuleEditResponse
- client.firewall.waf.packages.rules.get(packageId, ruleId, { ...params }) -> RuleGetResponse
# Healthchecks
Types:
- Healthcheck
- HealthcheckDeleteResponse
Methods:
- client.healthchecks.create({ ...params }) -> Healthcheck
- client.healthchecks.update(healthcheckId, { ...params }) -> Healthcheck
- client.healthchecks.list({ ...params }) -> HealthchecksSinglePage
- 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
- KeylessCertificateHostname
- KeylessCertificateDeleteResponse
Methods:
- client.keylessCertificates.create({ ...params }) -> KeylessCertificateHostname
- client.keylessCertificates.list({ ...params }) -> KeylessCertificateHostnamesSinglePage
- client.keylessCertificates.delete(keylessCertificateId, { ...params }) -> KeylessCertificateDeleteResponse
- client.keylessCertificates.edit(keylessCertificateId, { ...params }) -> KeylessCertificateHostname
- client.keylessCertificates.get(keylessCertificateId, { ...params }) -> KeylessCertificateHostname
# Logpush
## Datasets
### Fields
Types:
- FieldGetResponse
Methods:
- client.logpush.datasets.fields.get(datasetId, { ...params }) -> FieldGetResponse
### Jobs
Types:
- LogpushJob
- JobGetResponse
Methods:
- client.logpush.datasets.jobs.get(datasetId, { ...params }) -> JobGetResponse
## Edge
Types:
- InstantLogpushJob
- EdgeGetResponse
Methods:
- client.logpush.edge.create({ ...params }) -> InstantLogpushJob | null
- client.logpush.edge.get({ ...params }) -> EdgeGetResponse
## Jobs
Types:
- 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 | null
- client.logpush.jobs.get(jobId, { ...params }) -> LogpushJob | null
## Ownership
Types:
- OwnershipCreateResponse
- OwnershipValidateResponse
Methods:
- client.logpush.ownership.create({ ...params }) -> OwnershipCreateResponse | null
- client.logpush.ownership.validate({ ...params }) -> OwnershipValidateResponse | null
## Validate
Types:
- ValidateDestinationResponse
- ValidateOriginResponse
Methods:
- client.logpush.validate.destination({ ...params }) -> ValidateDestinationResponse | null
- client.logpush.validate.origin({ ...params }) -> ValidateOriginResponse | null
# Logs
## Control
### Retention
#### Flag
Types:
- FlagCreateResponse
- FlagGetResponse
Methods:
- client.logs.control.retention.flag.create(zoneIdentifier, { ...params }) -> FlagCreateResponse
- client.logs.control.retention.flag.get(zoneIdentifier) -> FlagGetResponse
### 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(zoneIdentifier, rayIdentifier, { ...params }) -> RayIDGetResponse
## Received
Types:
- ReceivedGetResponse
Methods:
- client.logs.received.get(zoneIdentifier, { ...params }) -> ReceivedGetResponse
### Fields
Types:
- FieldGetResponse
Methods:
- client.logs.received.fields.get(zoneIdentifier) -> FieldGetResponse
# OriginTLSClientAuth
Types:
- OriginTLSClientCertificateZoneAuthenticatedOriginPull
- 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:
- OriginTLSClientCertificateAuthenticatedOriginPull
- OriginTLSClientCertificateID
- HostnameUpdateResponse
Methods:
- client.originTLSClientAuth.hostnames.update({ ...params }) -> HostnameUpdateResponse | null
- client.originTLSClientAuth.hostnames.get(hostname, { ...params }) -> OriginTLSClientCertificateID
### Certificates
Types:
- OriginTLSClientCertificate
Methods:
- client.originTLSClientAuth.hostnames.certificates.create({ ...params }) -> OriginTLSClientCertificate
- client.originTLSClientAuth.hostnames.certificates.list({ ...params }) -> OriginTLSClientCertificateIDsSinglePage
- client.originTLSClientAuth.hostnames.certificates.delete(certificateId, { ...params }) -> OriginTLSClientCertificate
- client.originTLSClientAuth.hostnames.certificates.get(certificateId, { ...params }) -> OriginTLSClientCertificate
## Settings
Types:
- SettingUpdateResponse
- SettingGetResponse
Methods:
- client.originTLSClientAuth.settings.update({ ...params }) -> SettingUpdateResponse
- client.originTLSClientAuth.settings.get({ ...params }) -> SettingGetResponse
# Pagerules
Types:
- ZonesPagerule
- PageruleCreateResponse
- PageruleUpdateResponse
- PageruleListResponse
- PageruleDeleteResponse
- PageruleEditResponse
- PageruleGetResponse
Methods:
- client.pagerules.create({ ...params }) -> PageruleCreateResponse
- client.pagerules.update(pageruleId, { ...params }) -> PageruleUpdateResponse
- client.pagerules.list({ ...params }) -> PageruleListResponse
- client.pagerules.delete(pageruleId, { ...params }) -> PageruleDeleteResponse | null
- client.pagerules.edit(pageruleId, { ...params }) -> PageruleEditResponse
- client.pagerules.get(pageruleId, { ...params }) -> PageruleGetResponse
## Settings
Types:
- ZonePageruleSettings
Methods:
- client.pagerules.settings.list({ ...params }) -> ZonePageruleSettings
# RateLimits
Types:
- RateLimit
- RateLimitCreateResponse
- RateLimitListResponse
- RateLimitDeleteResponse
- RateLimitEditResponse
- RateLimitGetResponse
Methods:
- client.rateLimits.create(zoneIdentifier, { ...params }) -> RateLimitCreateResponse | null
- client.rateLimits.list(zoneIdentifier, { ...params }) -> RateLimitListResponsesV4PagePaginationArray
- client.rateLimits.delete(zoneIdentifier, id) -> RateLimitDeleteResponse | null
- client.rateLimits.edit(zoneIdentifier, id, { ...params }) -> RateLimitEditResponse | null
- client.rateLimits.get(zoneIdentifier, id) -> RateLimitGetResponse | null
# SecondaryDNS
## ForceAXFR
Types:
- SecondaryDNSForce
Methods:
- client.secondaryDNS.forceAXFR.create({ ...params }) -> SecondaryDNSForce
## Incoming
Types:
- IncomingCreateResponse
- IncomingUpdateResponse
- IncomingDeleteResponse
- IncomingGetResponse
Methods:
- client.secondaryDNS.incoming.create({ ...params }) -> IncomingCreateResponse
- client.secondaryDNS.incoming.update({ ...params }) -> IncomingUpdateResponse
- client.secondaryDNS.incoming.delete({ ...params }) -> IncomingDeleteResponse
- client.secondaryDNS.incoming.get({ ...params }) -> IncomingGetResponse
## Outgoing
Types:
- SecondaryDNSDisableTransfer
- SecondaryDNSEnableTransfer
- OutgoingCreateResponse
- OutgoingUpdateResponse
- OutgoingDeleteResponse
- OutgoingForceNotifyResponse
- OutgoingGetResponse
Methods:
- client.secondaryDNS.outgoing.create({ ...params }) -> OutgoingCreateResponse
- client.secondaryDNS.outgoing.update({ ...params }) -> OutgoingUpdateResponse
- client.secondaryDNS.outgoing.delete({ ...params }) -> OutgoingDeleteResponse
- client.secondaryDNS.outgoing.disable({ ...params }) -> SecondaryDNSDisableTransfer
- client.secondaryDNS.outgoing.enable({ ...params }) -> SecondaryDNSEnableTransfer
- client.secondaryDNS.outgoing.forceNotify({ ...params }) -> OutgoingForceNotifyResponse
- client.secondaryDNS.outgoing.get({ ...params }) -> OutgoingGetResponse
### Status
Methods:
- client.secondaryDNS.outgoing.status.get({ ...params }) -> SecondaryDNSEnableTransfer
## ACLs
Types:
- SecondaryDNSACL
- ACLDeleteResponse
Methods:
- client.secondaryDNS.acls.create({ ...params }) -> SecondaryDNSACL
- client.secondaryDNS.acls.update(aclId, { ...params }) -> SecondaryDNSACL
- client.secondaryDNS.acls.list({ ...params }) -> SecondaryDnsaclsSinglePage
- client.secondaryDNS.acls.delete(aclId, { ...params }) -> ACLDeleteResponse
- client.secondaryDNS.acls.get(aclId, { ...params }) -> SecondaryDNSACL
## Peers
Types:
- SecondaryDNSPeer
- PeerDeleteResponse
Methods:
- client.secondaryDNS.peers.create({ ...params }) -> SecondaryDNSPeer
- client.secondaryDNS.peers.update(peerId, { ...params }) -> SecondaryDNSPeer
- client.secondaryDNS.peers.list({ ...params }) -> SecondaryDNSPeersSinglePage
- client.secondaryDNS.peers.delete(peerId, { ...params }) -> PeerDeleteResponse
- client.secondaryDNS.peers.get(peerId, { ...params }) -> SecondaryDNSPeer
## TSIGs
Types:
- SecondaryDNSTSIG
- TSIGDeleteResponse
Methods:
- client.secondaryDNS.tsigs.create({ ...params }) -> SecondaryDNSTSIG
- client.secondaryDNS.tsigs.update(tsigId, { ...params }) -> SecondaryDNSTSIG
- client.secondaryDNS.tsigs.list({ ...params }) -> SecondaryDnstsigsSinglePage
- client.secondaryDNS.tsigs.delete(tsigId, { ...params }) -> TSIGDeleteResponse
- client.secondaryDNS.tsigs.get(tsigId, { ...params }) -> SecondaryDNSTSIG
# WaitingRooms
Types:
- WaitingRoom
- WaitingRoomDeleteResponse
Methods:
- client.waitingRooms.create(zoneIdentifier, { ...params }) -> WaitingRoom
- client.waitingRooms.update(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingRoom
- client.waitingRooms.list(zoneIdentifier) -> WaitingRoomsSinglePage
- client.waitingRooms.delete(zoneIdentifier, waitingRoomId) -> WaitingRoomDeleteResponse
- client.waitingRooms.edit(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingRoom
- client.waitingRooms.get(zoneIdentifier, waitingRoomId) -> WaitingRoom
## Page
Types:
- PagePreviewResponse
Methods:
- client.waitingRooms.page.preview(zoneIdentifier, { ...params }) -> PagePreviewResponse
## Events
Types:
- WaitingroomEvent
- EventDeleteResponse
Methods:
- client.waitingRooms.events.create(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingroomEvent
- client.waitingRooms.events.update(zoneIdentifier, waitingRoomId, eventId, { ...params }) -> WaitingroomEvent
- client.waitingRooms.events.list(zoneIdentifier, waitingRoomId) -> WaitingroomEventsSinglePage
- client.waitingRooms.events.delete(zoneIdentifier, waitingRoomId, eventId) -> EventDeleteResponse
- client.waitingRooms.events.edit(zoneIdentifier, waitingRoomId, eventId, { ...params }) -> WaitingroomEvent
- client.waitingRooms.events.get(zoneIdentifier, waitingRoomId, eventId) -> WaitingroomEvent
### Details
Types:
- WaitingroomEventDetails
Methods:
- client.waitingRooms.events.details.get(zoneIdentifier, waitingRoomId, eventId) -> WaitingroomEventDetails
## Rules
Types:
- WaitingroomRule
- RuleCreateResponse
- RuleUpdateResponse
- RuleDeleteResponse
- RuleEditResponse
Methods:
- client.waitingRooms.rules.create(zoneIdentifier, waitingRoomId, { ...params }) -> RuleCreateResponse | null
- client.waitingRooms.rules.update(zoneIdentifier, waitingRoomId, [ ...body ]) -> RuleUpdateResponse | null
- client.waitingRooms.rules.list(zoneIdentifier, waitingRoomId) -> WaitingroomRulesSinglePage
- client.waitingRooms.rules.delete(zoneIdentifier, waitingRoomId, ruleId) -> RuleDeleteResponse | null
- client.waitingRooms.rules.edit(zoneIdentifier, waitingRoomId, ruleId, { ...params }) -> RuleEditResponse | null
## Statuses
Types:
- StatusGetResponse
Methods:
- client.waitingRooms.statuses.get(zoneIdentifier, waitingRoomId) -> StatusGetResponse
## Settings
Types:
- SettingUpdateResponse
- SettingEditResponse
- SettingGetResponse
Methods:
- client.waitingRooms.settings.update(zoneIdentifier, { ...params }) -> SettingUpdateResponse
- client.waitingRooms.settings.edit(zoneIdentifier, { ...params }) -> SettingEditResponse
- client.waitingRooms.settings.get(zoneIdentifier) -> SettingGetResponse
# Web3
## Hostnames
Types:
- DistributedWebHostname
- HostnameDeleteResponse
Methods:
- client.web3.hostnames.create(zoneIdentifier, { ...params }) -> DistributedWebHostname
- client.web3.hostnames.list(zoneIdentifier) -> DistributedWebHostnamesSinglePage
- client.web3.hostnames.delete(zoneIdentifier, identifier) -> HostnameDeleteResponse | null
- client.web3.hostnames.edit(zoneIdentifier, identifier, { ...params }) -> DistributedWebHostname
- client.web3.hostnames.get(zoneIdentifier, identifier) -> DistributedWebHostname
### IPFSUniversalPaths
#### ContentLists
Types:
- DistributedWebConfigContentList
Methods:
- client.web3.hostnames.ipfsUniversalPaths.contentLists.update(zoneIdentifier, identifier, { ...params }) -> DistributedWebConfigContentList
- client.web3.hostnames.ipfsUniversalPaths.contentLists.get(zoneIdentifier, identifier) -> DistributedWebConfigContentList
##### Entries
Types:
- DistributedWebConfigContentListEntry
- EntryListResponse
- EntryDeleteResponse
Methods:
- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.create(zoneIdentifier, identifier, { ...params }) -> DistributedWebConfigContentListEntry
- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.update(zoneIdentifier, identifier, contentListEntryIdentifier, { ...params }) -> DistributedWebConfigContentListEntry
- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.list(zoneIdentifier, identifier) -> EntryListResponse | null
- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.delete(zoneIdentifier, identifier, contentListEntryIdentifier) -> EntryDeleteResponse | null
- client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.get(zoneIdentifier, identifier, contentListEntryIdentifier) -> DistributedWebConfigContentListEntry
# Workers
## AI
Types:
- AIRunResponse
Methods:
- client.workers.ai.run(modelName, { ...params }) -> AIRunResponse
## Scripts
Types:
- WorkersScript
Methods:
- client.workers.scripts.update(scriptName, { ...params }) -> WorkersScript
- client.workers.scripts.list({ ...params }) -> WorkersScriptsSinglePage
- client.workers.scripts.delete(scriptName, { ...params }) -> void
- client.workers.scripts.get(scriptName, { ...params }) -> Response
### Bindings
Types:
- WorkersBinding
- BindingGetResponse
Methods:
- client.workers.scripts.bindings.get({ ...params }) -> BindingGetResponse
### Schedules
Types:
- ScheduleUpdateResponse
- ScheduleGetResponse
Methods:
- client.workers.scripts.schedules.update(scriptName, { ...params }) -> ScheduleUpdateResponse
- client.workers.scripts.schedules.get(scriptName, { ...params }) -> ScheduleGetResponse
### Tail
Types:
- 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
### UsageModel
Types:
- UsageModelUpdateResponse
- UsageModelGetResponse
Methods:
- client.workers.scripts.usageModel.update(scriptName, { ...params }) -> UsageModelUpdateResponse
- client.workers.scripts.usageModel.get(scriptName, { ...params }) -> UsageModelGetResponse
### Content
Methods:
- client.workers.scripts.content.update(scriptName, { ...params }) -> WorkersScript
### ContentV2
Methods:
- client.workers.scripts.contentV2.get(scriptName, { ...params }) -> Response
### Settings
Types:
- SettingEditResponse
- SettingGetResponse
Methods:
- client.workers.scripts.settings.edit(scriptName, { ...params }) -> SettingEditResponse
- client.workers.scripts.settings.get(scriptName, { ...params }) -> SettingGetResponse
## Filters
Types:
- WorkersFilter
- FilterCreateResponse
- FilterDeleteResponse
Methods:
- client.workers.filters.create({ ...params }) -> FilterCreateResponse | null
- client.workers.filters.update(filterId, { ...params }) -> WorkersFilter
- client.workers.filters.list({ ...params }) -> WorkersFiltersSinglePage
- client.workers.filters.delete(filterId, { ...params }) -> FilterDeleteResponse | null
## Routes
Types:
- WorkersRoute
- RouteCreateResponse
- RouteDeleteResponse
Methods:
- client.workers.routes.create({ ...params }) -> RouteCreateResponse
- client.workers.routes.update(routeId, { ...params }) -> WorkersRoute
- client.workers.routes.list({ ...params }) -> WorkersRoutesSinglePage
- client.workers.routes.delete(routeId, { ...params }) -> RouteDeleteResponse
- client.workers.routes.get(routeId, { ...params }) -> WorkersRoute
## AccountSettings
Types:
- AccountSettingUpdateResponse
- AccountSettingGetResponse
Methods:
- client.workers.accountSettings.update({ ...params }) -> AccountSettingUpdateResponse
- client.workers.accountSettings.get({ ...params }) -> AccountSettingGetResponse
## Deployments
### ByScripts
Types:
- ByScriptGetResponse
Methods:
- client.workers.deployments.byScripts.get(scriptId, { ...params }) -> ByScriptGetResponse
#### Details
Types:
- DetailGetResponse
Methods:
- client.workers.deployments.byScripts.details.get(scriptId, deploymentId, { ...params }) -> DetailGetResponse
## Domains
Types:
- WorkersDomain
Methods:
- client.workers.domains.update({ ...params }) -> WorkersDomain
- client.workers.domains.list({ ...params }) -> WorkersDomainsSinglePage
- client.workers.domains.delete(domainId, { ...params }) -> void
- client.workers.domains.get(domainId, { ...params }) -> WorkersDomain
## Subdomains
Types:
- SubdomainUpdateResponse
- SubdomainGetResponse
Methods:
- client.workers.subdomains.update({ ...params }) -> SubdomainUpdateResponse
- client.workers.subdomains.get({ ...params }) -> SubdomainGetResponse
## Services
### Environments
#### Content
Methods:
- client.workers.services.environments.content.update(serviceName, environmentName, { ...params }) -> WorkersScript
- client.workers.services.environments.content.get(serviceName, environmentName, { ...params }) -> Response
#### Settings
Types:
- SettingEditResponse
- SettingGetResponse
Methods:
- client.workers.services.environments.settings.edit(serviceName, environmentName, { ...params }) -> SettingEditResponse
- client.workers.services.environments.settings.get(serviceName, environmentName, { ...params }) -> SettingGetResponse
# KV
## Namespaces
Types:
- WorkersKVNamespace
- NamespaceUpdateResponse
- NamespaceDeleteResponse
Methods:
- client.kv.namespaces.create({ ...params }) -> WorkersKVNamespace
- client.kv.namespaces.update(namespaceId, { ...params }) -> NamespaceUpdateResponse
- client.kv.namespaces.list({ ...params }) -> WorkersKVNamespacesV4PagePaginationArray
- client.kv.namespaces.delete(namespaceId, { ...params }) -> NamespaceDeleteResponse
### Bulk
Types:
- BulkUpdateResponse
- BulkDeleteResponse
Methods:
- client.kv.namespaces.bulk.update(namespaceId, [ ...body ]) -> BulkUpdateResponse
- client.kv.namespaces.bulk.delete(namespaceId, [ ...body ]) -> BulkDeleteResponse
### Keys
Types:
- WorkersKVKey
Methods:
- client.kv.namespaces.keys.list(namespaceId, { ...params }) -> WorkersKVKeysCursorLimitPagination
### Metadata
Types:
- MetadataGetResponse
Methods:
- client.kv.namespaces.metadata.get(namespaceId, keyName, { ...params }) -> MetadataGetResponse
### Values
Types:
- ValueUpdateResponse
- ValueDeleteResponse
- ValueGetResponse
Methods:
- client.kv.namespaces.values.update(namespaceId, keyName, { ...params }) -> ValueUpdateResponse
- client.kv.namespaces.values.delete(namespaceId, keyName, { ...params }) -> ValueDeleteResponse
- client.kv.namespaces.values.get(namespaceId, keyName, { ...params }) -> string
# DurableObjects
## Namespaces
Types:
- DurableObjectNamespace
Methods:
- client.durableObjects.namespaces.list({ ...params }) -> DurableObjectNamespacesSinglePage
### Objects
Types:
- DurableObject
Methods:
- client.durableObjects.namespaces.objects.list(id, { ...params }) -> DurableObjectsCursorLimitPagination
# Queues
Types:
- Queue
- QueueCreated
- QueueUpdated
- QueueCreateResponse
- QueueUpdateResponse
- QueueListResponse
- QueueDeleteResponse
- QueueGetResponse
Methods:
- client.queues.create({ ...params }) -> QueueCreateResponse | null
- client.queues.update(queueId, { ...params }) -> QueueUpdateResponse | null
- client.queues.list({ ...params }) -> QueueListResponsesSinglePage
- client.queues.delete(queueId, { ...params }) -> QueueDeleteResponse | null
- client.queues.get(queueId, { ...params }) -> QueueGetResponse | null
## Consumers
Types:
- ConsumerCreateResponse
- ConsumerUpdateResponse
- ConsumerDeleteResponse
- ConsumerGetResponse
Methods:
- client.queues.consumers.create(queueId, { ...params }) -> ConsumerCreateResponse | null
- client.queues.consumers.update(queueId, consumerId, { ...params }) -> ConsumerUpdateResponse | null
- client.queues.consumers.delete(queueId, consumerId, { ...params }) -> ConsumerDeleteResponse | null
- client.queues.consumers.get(queueId, { ...params }) -> ConsumerGetResponse | null
## Messages
Types:
- QueueConsumer
- QueueConsumerCreated
- QueueConsumerUpdated
- MessageAckResponse
- MessagePullResponse
Methods:
- client.queues.messages.ack(queueId, { ...params }) -> MessageAckResponse | null
- client.queues.messages.pull(queueId, { ...params }) -> MessagePullResponse | null
# ManagedHeaders
Types:
- ManagedHeaderListResponse
- ManagedHeaderEditResponse
Methods:
- client.managedHeaders.list({ ...params }) -> ManagedHeaderListResponse
- client.managedHeaders.edit({ ...params }) -> ManagedHeaderEditResponse
# PageShield
Types:
- PageShieldSetting
- PageShieldUpdateResponse
Methods:
- client.pageShield.update({ ...params }) -> PageShieldUpdateResponse
- client.pageShield.get({ ...params }) -> PageShieldSetting
## Policies
Types:
- PageShieldPolicy
Methods:
- client.pageShield.policies.create({ ...params }) -> PageShieldPolicy
- client.pageShield.policies.update(policyId, { ...params }) -> PageShieldPolicy
- client.pageShield.policies.list({ ...params }) -> PageShieldPoliciesSinglePage
- client.pageShield.policies.delete(policyId, { ...params }) -> void
- client.pageShield.policies.get(policyId, { ...params }) -> PageShieldPolicy
## Connections
Types:
- PageShieldConnection
Methods:
- client.pageShield.connections.list({ ...params }) -> PageShieldConnectionsSinglePage
- client.pageShield.connections.get(connectionId, { ...params }) -> PageShieldConnection
## Scripts
Types:
- PageShieldScript
- ScriptGetResponse
Methods:
- client.pageShield.scripts.list({ ...params }) -> PageShieldScriptsSinglePage
- client.pageShield.scripts.get(scriptId, { ...params }) -> ScriptGetResponse
# Rulesets
Types:
- Ruleset
- RulesetListResponse
Methods:
- client.rulesets.create({ ...params }) -> Ruleset
- client.rulesets.update(rulesetId, { ...params }) -> Ruleset
- client.rulesets.list({ ...params }) -> RulesetListResponsesSinglePage
- client.rulesets.delete(rulesetId, { ...params }) -> void
- client.rulesets.get(rulesetId, { ...params }) -> Ruleset
## Phases
Methods:
- client.rulesets.phases.update(rulesetPhase, { ...params }) -> Ruleset
- client.rulesets.phases.get(rulesetPhase, { ...params }) -> Ruleset
### Versions
Types:
- VersionListResponse
Methods:
- client.rulesets.phases.versions.list(rulesetPhase, { ...params }) -> VersionListResponsesSinglePage
- client.rulesets.phases.versions.get(rulesetPhase, rulesetVersion, { ...params }) -> Ruleset
## Rules
Methods:
- client.rulesets.rules.create(rulesetId, { ...params }) -> Ruleset
- client.rulesets.rules.delete(rulesetId, ruleId, { ...params }) -> Ruleset
- client.rulesets.rules.edit(rulesetId, ruleId, { ...params }) -> Ruleset
## Versions
Types:
- VersionListResponse
Methods:
- client.rulesets.versions.list(rulesetId, { ...params }) -> VersionListResponsesSinglePage
- client.rulesets.versions.delete(rulesetId, rulesetVersion, { ...params }) -> void
- client.rulesets.versions.get(rulesetId, rulesetVersion, { ...params }) -> Ruleset
### ByTag
Methods:
- client.rulesets.versions.byTag.get(rulesetId, rulesetVersion, ruleTag, { ...params }) -> Ruleset
# URLNormalization
Types:
- URLNormalizationUpdateResponse
- URLNormalizationGetResponse
Methods:
- client.urlNormalization.update({ ...params }) -> URLNormalizationUpdateResponse
- client.urlNormalization.get({ ...params }) -> URLNormalizationGetResponse
# Spectrum
## Analytics
### Aggregates
#### Currents
Types:
- CurrentGetResponse
Methods:
- client.spectrum.analytics.aggregates.currents.get(zone, { ...params }) -> CurrentGetResponse
### Events
#### Bytimes
Types:
- BytimeGetResponse
Methods:
- client.spectrum.analytics.events.bytimes.get(zone, { ...params }) -> BytimeGetResponse | null
#### Summaries
Types:
- SummaryGetResponse
Methods:
- client.spectrum.analytics.events.summaries.get(zone, { ...params }) -> SummaryGetResponse | null
## Apps
Types:
- AppCreateResponse
- AppUpdateResponse
- AppListResponse
- AppDeleteResponse
- AppGetResponse
Methods:
- client.spectrum.apps.create(zone, { ...params }) -> AppCreateResponse | null
- client.spectrum.apps.update(zone, appId, { ...params }) -> AppUpdateResponse | null
- client.spectrum.apps.list(zone, { ...params }) -> AppListResponsesV4PagePaginationArray
- client.spectrum.apps.delete(zone, appId) -> AppDeleteResponse | null
- client.spectrum.apps.get(zone, appId) -> AppGetResponse | null
# Addressing
## Services
Types:
- ServiceListResponse
Methods:
- client.addressing.services.list({ ...params }) -> ServiceListResponsesSinglePage
## AddressMaps
Types:
- AddressingAddressMaps
- AddressMapCreateResponse
- AddressMapDeleteResponse
- AddressMapGetResponse
Methods:
- client.addressing.addressMaps.create({ ...params }) -> AddressMapCreateResponse
- client.addressing.addressMaps.list({ ...params }) -> AddressingAddressMapsSinglePage
- client.addressing.addressMaps.delete(addressMapId, { ...params }) -> AddressMapDeleteResponse | null
- client.addressing.addressMaps.edit(addressMapId, { ...params }) -> AddressingAddressMaps
- client.addressing.addressMaps.get(addressMapId, { ...params }) -> AddressMapGetResponse
### Accounts
Types:
- AccountUpdateResponse
- AccountDeleteResponse
Methods:
- client.addressing.addressMaps.accounts.update(addressMapId, { ...params }) -> AccountUpdateResponse | null
- client.addressing.addressMaps.accounts.delete(addressMapId, { ...params }) -> AccountDeleteResponse | null
### IPs
Types:
- IPUpdateResponse
- IPDeleteResponse
Methods:
- client.addressing.addressMaps.ips.update(addressMapId, ipAddress, { ...params }) -> IPUpdateResponse | null
- client.addressing.addressMaps.ips.delete(addressMapId, ipAddress, { ...params }) -> IPDeleteResponse | null
### Zones
Types:
- ZoneUpdateResponse
- ZoneDeleteResponse
Methods:
- client.addressing.addressMaps.zones.update(addressMapId, { ...params }) -> ZoneUpdateResponse | null
- client.addressing.addressMaps.zones.delete(addressMapId, { ...params }) -> ZoneDeleteResponse | null
## LOADocuments
Types:
- LOADocumentCreateResponse
Methods:
- client.addressing.loaDocuments.create({ ...params }) -> LOADocumentCreateResponse
### Downloads
Types:
- DownloadGetResponse
Methods:
- client.addressing.loaDocuments.downloads.get(loaDocumentId, { ...params }) -> unknown
## Prefixes
Types:
- AddressingIpamPrefixes
- PrefixDeleteResponse
Methods:
- client.addressing.prefixes.create({ ...params }) -> AddressingIpamPrefixes
- client.addressing.prefixes.list({ ...params }) -> AddressingIpamPrefixesSinglePage
- client.addressing.prefixes.delete(prefixId, { ...params }) -> PrefixDeleteResponse | null
- client.addressing.prefixes.edit(prefixId, { ...params }) -> AddressingIpamPrefixes
- client.addressing.prefixes.get(prefixId, { ...params }) -> AddressingIpamPrefixes
### BGP
#### Bindings
Types:
- AddressingServiceBinding
- BindingDeleteResponse
Methods:
- client.addressing.prefixes.bgp.bindings.create(prefixId, { ...params }) -> AddressingServiceBinding
- client.addressing.prefixes.bgp.bindings.list(prefixId, { ...params }) -> AddressingServiceBindingsSinglePage
- client.addressing.prefixes.bgp.bindings.delete(prefixId, bindingId, { ...params }) -> BindingDeleteResponse
- client.addressing.prefixes.bgp.bindings.get(prefixId, bindingId, { ...params }) -> AddressingServiceBinding
#### Prefixes
Types:
- AddressingIpamBGPPrefixes
Methods:
- client.addressing.prefixes.bgp.prefixes.list(prefixId, { ...params }) -> AddressingIpamBGPPrefixesSinglePage
- client.addressing.prefixes.bgp.prefixes.edit(prefixId, bgpPrefixId, { ...params }) -> AddressingIpamBGPPrefixes
- client.addressing.prefixes.bgp.prefixes.get(prefixId, bgpPrefixId, { ...params }) -> AddressingIpamBGPPrefixes
#### Statuses
Types:
- StatusEditResponse
- StatusGetResponse
Methods:
- client.addressing.prefixes.bgp.statuses.edit(prefixId, { ...params }) -> StatusEditResponse
- client.addressing.prefixes.bgp.statuses.get(prefixId, { ...params }) -> StatusGetResponse
### Delegations
Types:
- AddressingIpamDelegations
- DelegationDeleteResponse
Methods:
- client.addressing.prefixes.delegations.create(prefixId, { ...params }) -> AddressingIpamDelegations
- client.addressing.prefixes.delegations.list(prefixId, { ...params }) -> AddressingIpamDelegationsSinglePage
- client.addressing.prefixes.delegations.delete(prefixId, delegationId, { ...params }) -> DelegationDeleteResponse
# AuditLogs
Types:
- AuditLogListResponse
Methods:
- client.auditLogs.list({ ...params }) -> AuditLogListResponsesV4PagePaginationArray
# Billing
## Profiles
Types:
- ProfileGetResponse
Methods:
- client.billing.profiles.get(accountIdentifier) -> ProfileGetResponse
# BrandProtection
Types:
- IntelPhishingURLInfo
- IntelPhishingURLSubmit
Methods:
- client.brandProtection.submit({ ...params }) -> IntelPhishingURLSubmit
- client.brandProtection.urlInfo({ ...params }) -> IntelPhishingURLInfo
# Diagnostics
## Traceroutes
Types:
- MagicTransitTargetResult
- TracerouteCreateResponse
Methods:
- client.diagnostics.traceroutes.create({ ...params }) -> TracerouteCreateResponse | null
# 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:
- ImagesImageKeys
Methods:
- client.images.v1.keys.update(signingKeyName, { ...params }) -> ImagesImageKeys
- client.images.v1.keys.list({ ...params }) -> ImagesImageKeys
- client.images.v1.keys.delete(signingKeyName, { ...params }) -> ImagesImageKeys
### Stats
Types:
- ImagesImagesStats
Methods:
- client.images.v1.stats.get({ ...params }) -> ImagesImagesStats
### Variants
Types:
- V1ImageVariant
- V1ImageVariants
- VariantDeleteResponse
Methods:
- client.images.v1.variants.create({ ...params }) -> V1ImageVariant
- client.images.v1.variants.list({ ...params }) -> V1ImageVariants
- client.images.v1.variants.delete(variantId, { ...params }) -> VariantDeleteResponse
- client.images.v1.variants.edit(variantId, { ...params }) -> V1ImageVariant
- client.images.v1.variants.get(variantId, { ...params }) -> V1ImageVariant
### 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
Types:
- IntelASN
Methods:
- client.intel.asn.get(asn, { ...params }) -> IntelASN
### Subnets
Types:
- SubnetGetResponse
Methods:
- client.intel.asn.subnets.get(asn, { ...params }) -> SubnetGetResponse
## DNS
Types:
- IntelPassiveDNSByIP
Methods:
- client.intel.dns.get({ ...params }) -> IntelPassiveDNSByIP
## Domains
Types:
- IntelDomain
Methods:
- client.intel.domains.get({ ...params }) -> IntelDomain
### Bulks
Types:
- BulkGetResponse
Methods:
- client.intel.domains.bulks.get({ ...params }) -> BulkGetResponse | null
## DomainHistory
Types:
- IntelDomainHistory
- DomainHistoryGetResponse
Methods:
- client.intel.domainHistory.get({ ...params }) -> DomainHistoryGetResponse | null
## IPs
Types:
- IntelSchemasIP
- IPGetResponse
Methods:
- client.intel.ips.get({ ...params }) -> IPGetResponse | null
## IPLists
Types:
- IntelIPList
- IPListGetResponse
Methods:
- client.intel.ipLists.get({ ...params }) -> IPListGetResponse | null
## Miscategorizations
Types:
- MiscategorizationCreateResponse
Methods:
- client.intel.miscategorizations.create({ ...params }) -> MiscategorizationCreateResponse
## Whois
Types:
- IntelWhois
Methods:
- client.intel.whois.get({ ...params }) -> IntelWhois
## 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
### 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
## Sinkholes
Types:
- IntelSinkholeItem
Methods:
- client.intel.sinkholes.list({ ...params }) -> IntelSinkholeItemsSinglePage
## AttackSurfaceReport
### IssueTypes
Types:
- IssueTypeGetResponse
Methods:
- client.intel.attackSurfaceReport.issueTypes.get({ ...params }) -> IssueTypeGetResponse
### Issues
Types:
- 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
## CfInterconnects
Types:
- CfInterconnectUpdateResponse
- CfInterconnectListResponse
- CfInterconnectGetResponse
Methods:
- client.magicTransit.cfInterconnects.update(tunnelIdentifier, { ...params }) -> CfInterconnectUpdateResponse
- client.magicTransit.cfInterconnects.list({ ...params }) -> CfInterconnectListResponse
- client.magicTransit.cfInterconnects.get(tunnelIdentifier, { ...params }) -> CfInterconnectGetResponse
## GRETunnels
Types:
- GRETunnelCreateResponse
- GRETunnelUpdateResponse
- GRETunnelListResponse
- GRETunnelDeleteResponse
- GRETunnelGetResponse
Methods:
- client.magicTransit.greTunnels.create({ ...params }) -> GRETunnelCreateResponse
- client.magicTransit.greTunnels.update(tunnelIdentifier, { ...params }) -> GRETunnelUpdateResponse
- client.magicTransit.greTunnels.list({ ...params }) -> GRETunnelListResponse
- client.magicTransit.greTunnels.delete(tunnelIdentifier, { ...params }) -> GRETunnelDeleteResponse
- client.magicTransit.greTunnels.get(tunnelIdentifier, { ...params }) -> GRETunnelGetResponse
## IPSECTunnels
Types:
- IPSECTunnelCreateResponse
- IPSECTunnelUpdateResponse
- IPSECTunnelListResponse
- IPSECTunnelDeleteResponse
- IPSECTunnelGetResponse
- IPSECTunnelPSKGenerateResponse
Methods:
- client.magicTransit.ipsecTunnels.create({ ...params }) -> IPSECTunnelCreateResponse
- client.magicTransit.ipsecTunnels.update(tunnelIdentifier, { ...params }) -> IPSECTunnelUpdateResponse
- client.magicTransit.ipsecTunnels.list({ ...params }) -> IPSECTunnelListResponse
- client.magicTransit.ipsecTunnels.delete(tunnelIdentifier, { ...params }) -> IPSECTunnelDeleteResponse
- client.magicTransit.ipsecTunnels.get(tunnelIdentifier, { ...params }) -> IPSECTunnelGetResponse
- client.magicTransit.ipsecTunnels.pskGenerate(tunnelIdentifier, { ...params }) -> IPSECTunnelPSKGenerateResponse
## Routes
Types:
- RouteCreateResponse
- RouteUpdateResponse
- RouteListResponse
- RouteDeleteResponse
- RouteEmptyResponse
- RouteGetResponse
Methods:
- client.magicTransit.routes.create({ ...params }) -> RouteCreateResponse
- client.magicTransit.routes.update(routeIdentifier, { ...params }) -> RouteUpdateResponse
- client.magicTransit.routes.list({ ...params }) -> RouteListResponse
- client.magicTransit.routes.delete(routeIdentifier, { ...params }) -> RouteDeleteResponse
- client.magicTransit.routes.empty({ ...params }) -> RouteEmptyResponse
- client.magicTransit.routes.get(routeIdentifier, { ...params }) -> RouteGetResponse
## Sites
Types:
- SiteCreateResponse
- SiteUpdateResponse
- SiteListResponse
- SiteDeleteResponse
- SiteGetResponse
Methods:
- client.magicTransit.sites.create({ ...params }) -> SiteCreateResponse
- client.magicTransit.sites.update(siteId, { ...params }) -> SiteUpdateResponse
- client.magicTransit.sites.list({ ...params }) -> SiteListResponse
- client.magicTransit.sites.delete(siteId, { ...params }) -> SiteDeleteResponse
- client.magicTransit.sites.get(siteId, { ...params }) -> SiteGetResponse
### ACLs
Types:
- ACLCreateResponse
- ACLUpdateResponse
- ACLListResponse
- ACLDeleteResponse
- ACLGetResponse
Methods:
- client.magicTransit.sites.acls.create(siteId, { ...params }) -> ACLCreateResponse
- client.magicTransit.sites.acls.update(siteId, aclIdentifier, { ...params }) -> ACLUpdateResponse
- client.magicTransit.sites.acls.list(siteId, { ...params }) -> ACLListResponse
- client.magicTransit.sites.acls.delete(siteId, aclIdentifier, { ...params }) -> ACLDeleteResponse
- client.magicTransit.sites.acls.get(siteId, aclIdentifier, { ...params }) -> ACLGetResponse
### LANs
Types:
- LANCreateResponse
- LANUpdateResponse
- LANListResponse
- LANDeleteResponse
- LANGetResponse
Methods:
- client.magicTransit.sites.lans.create(siteId, { ...params }) -> LANCreateResponse
- client.magicTransit.sites.lans.update(siteId, lanId, { ...params }) -> LANUpdateResponse
- client.magicTransit.sites.lans.list(siteId, { ...params }) -> LANListResponse
- client.magicTransit.sites.lans.delete(siteId, lanId, { ...params }) -> LANDeleteResponse
- client.magicTransit.sites.lans.get(siteId, lanId, { ...params }) -> LANGetResponse
### WANs
Types:
- WANCreateResponse
- WANUpdateResponse
- WANListResponse
- WANDeleteResponse
- WANGetResponse
Methods:
- client.magicTransit.sites.wans.create(siteId, { ...params }) -> WANCreateResponse
- client.magicTransit.sites.wans.update(siteId, wanId, { ...params }) -> WANUpdateResponse
- client.magicTransit.sites.wans.list(siteId, { ...params }) -> WANListResponse
- client.magicTransit.sites.wans.delete(siteId, wanId, { ...params }) -> WANDeleteResponse
- client.magicTransit.sites.wans.get(siteId, wanId, { ...params }) -> WANGetResponse
# MagicNetworkMonitoring
## Configs
Types:
- MagicNetworkMonitoringConfig
Methods:
- client.magicNetworkMonitoring.configs.create({ ...params }) -> MagicNetworkMonitoringConfig
- client.magicNetworkMonitoring.configs.update({ ...params }) -> MagicNetworkMonitoringConfig
- client.magicNetworkMonitoring.configs.delete({ ...params }) -> MagicNetworkMonitoringConfig
- client.magicNetworkMonitoring.configs.edit({ ...params }) -> MagicNetworkMonitoringConfig
- client.magicNetworkMonitoring.configs.get({ ...params }) -> MagicNetworkMonitoringConfig
### Full
Methods:
- client.magicNetworkMonitoring.configs.full.get({ ...params }) -> MagicNetworkMonitoringConfig
## 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:
- MagicNetworkMonitoringRuleAdvertisable
Methods:
- client.magicNetworkMonitoring.rules.advertisements.edit(ruleId, { ...params }) -> MagicNetworkMonitoringRuleAdvertisable | null
# MTLSCertificates
Types:
- MTLSCertificate
- MTLSCertificateUpdate
Methods:
- client.mtlsCertificates.create({ ...params }) -> MTLSCertificateUpdate
- client.mtlsCertificates.list({ ...params }) -> MTLSCertificatesSinglePage
- client.mtlsCertificates.delete(mtlsCertificateId, { ...params }) -> MTLSCertificate
- client.mtlsCertificates.get(mtlsCertificateId, { ...params }) -> MTLSCertificate
## Associations
Types:
- MTLSCertificateAsssociation
- AssociationGetResponse
Methods:
- client.mtlsCertificates.associations.get(mtlsCertificateId, { ...params }) -> AssociationGetResponse | null
# Pages
## Projects
Types:
- PagesDeployments
- PagesProjects
- ProjectCreateResponse
- ProjectDeleteResponse
- ProjectEditResponse
- ProjectPurgeBuildCacheResponse
Methods:
- client.pages.projects.create({ ...params }) -> ProjectCreateResponse
- client.pages.projects.list({ ...params }) -> PagesDeploymentsSinglePage
- client.pages.projects.delete(projectName, { ...params }) -> unknown
- client.pages.projects.edit(projectName, { ...params }) -> ProjectEditResponse
- client.pages.projects.get(projectName, { ...params }) -> PagesProjects
- client.pages.projects.purgeBuildCache(projectName, { ...params }) -> unknown
### Deployments
Types:
- DeploymentDeleteResponse
Methods:
- client.pages.projects.deployments.create(projectName, { ...params }) -> PagesDeployments
- client.pages.projects.deployments.list(projectName, { ...params }) -> PagesDeploymentsSinglePage
- client.pages.projects.deployments.delete(projectName, deploymentId, { ...params }) -> unknown
- client.pages.projects.deployments.get(projectName, deploymentId, { ...params }) -> PagesDeployments
- client.pages.projects.deployments.retry(projectName, deploymentId, { ...params }) -> PagesDeployments
- client.pages.projects.deployments.rollback(projectName, deploymentId, { ...params }) -> PagesDeployments
#### 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 }) -> unknown
- client.pages.projects.domains.edit(projectName, domainName, { ...params }) -> DomainEditResponse | null
- client.pages.projects.domains.get(projectName, domainName, { ...params }) -> DomainGetResponse | null
# PCAPs
Types:
- PCAPCreateResponse
- PCAPListResponse
- PCAPGetResponse
Methods:
- client.pcaps.create({ ...params }) -> PCAPCreateResponse
- client.pcaps.list({ ...params }) -> PCAPListResponsesSinglePage
- client.pcaps.get(pcapId, { ...params }) -> PCAPGetResponse
## Ownership
Types:
- MagicVisibilityPCAPsOwnership
- OwnershipGetResponse
Methods:
- client.pcaps.ownership.create({ ...params }) -> MagicVisibilityPCAPsOwnership
- client.pcaps.ownership.delete(ownershipId, { ...params }) -> void
- client.pcaps.ownership.get({ ...params }) -> OwnershipGetResponse | null
- client.pcaps.ownership.validate({ ...params }) -> MagicVisibilityPCAPsOwnership
## Download
Methods:
- client.pcaps.download.get(pcapId, { ...params }) -> Response
# Registrar
## Domains
Types:
- RegistrarDomains
- DomainUpdateResponse
- DomainListResponse
- DomainGetResponse
Methods:
- client.registrar.domains.update(domainName, { ...params }) -> DomainUpdateResponse | null
- client.registrar.domains.list({ ...params }) -> DomainListResponsesSinglePage
- client.registrar.domains.get(domainName, { ...params }) -> DomainGetResponse | null
# RequestTracers
## Traces
Types:
- Trace
- TraceItem
- TraceCreateResponse
Methods:
- client.requestTracers.traces.create(accountIdentifier, { ...params }) -> TraceCreateResponse
# Rules
## Lists
Types:
- ListsList
- ListDeleteResponse
Methods:
- client.rules.lists.create({ ...params }) -> ListsList | null
- client.rules.lists.update(listId, { ...params }) -> ListsList | null
- client.rules.lists.list({ ...params }) -> ListsListsSinglePage
- client.rules.lists.delete(listId, { ...params }) -> ListDeleteResponse | null
- client.rules.lists.get(listId, { ...params }) -> ListsList | null
### BulkOperations
Types:
- BulkOperationGetResponse
Methods:
- client.rules.lists.bulkOperations.get(accountIdentifier, operationId) -> BulkOperationGetResponse | null
### Items
Types:
- ItemCreateResponse
- ItemUpdateResponse
- ItemListResponse
- ItemDeleteResponse
- ItemGetResponse
Methods:
- client.rules.lists.items.create(listId, [ ...body ]) -> ItemCreateResponse | null
- client.rules.lists.items.update(listId, [ ...body ]) -> ItemUpdateResponse | null
- client.rules.lists.items.list(listId, { ...params }) -> ItemListResponsesCursorPagination
- client.rules.lists.items.delete(listId, { ...params }) -> ItemDeleteResponse | null
- client.rules.lists.items.get(accountIdentifier, listId, itemId) -> ItemGetResponse | null
# Storage
## Analytics
Types:
- WorkersKVComponentsSchemasResult
- WorkersKVSchemasResult
Methods:
- client.storage.analytics.list({ ...params }) -> WorkersKVSchemasResult
- client.storage.analytics.stored({ ...params }) -> WorkersKVComponentsSchemasResult
# Stream
Types:
- StreamVideos
Methods:
- client.stream.create({ ...params }) -> void
- client.stream.list({ ...params }) -> StreamVideosSinglePage
- client.stream.delete(identifier, { ...params }) -> void
- client.stream.get(identifier, { ...params }) -> StreamVideos
## AudioTracks
Types:
- StreamAudio
- AudioTrackDeleteResponse
- AudioTrackGetResponse
Methods:
- client.stream.audioTracks.delete(identifier, audioIdentifier, { ...params }) -> AudioTrackDeleteResponse
- client.stream.audioTracks.copy(identifier, { ...params }) -> StreamAudio
- client.stream.audioTracks.edit(identifier, audioIdentifier, { ...params }) -> StreamAudio
- client.stream.audioTracks.get(identifier, { ...params }) -> AudioTrackGetResponse
## Videos
Types:
- VideoStorageUsageResponse
Methods:
- client.stream.videos.storageUsage({ ...params }) -> VideoStorageUsageResponse
## Clip
Types:
- StreamClipping
Methods:
- client.stream.clip.create({ ...params }) -> StreamClipping
## Copy
Methods:
- client.stream.copy.create({ ...params }) -> StreamVideos
## DirectUpload
Types:
- DirectUploadCreateResponse
Methods:
- client.stream.directUpload.create({ ...params }) -> DirectUploadCreateResponse
## Keys
Types:
- StreamKeys
- KeyDeleteResponse
- KeyGetResponse
Methods:
- client.stream.keys.create({ ...params }) -> StreamKeys
- client.stream.keys.delete(identifier, { ...params }) -> KeyDeleteResponse
- client.stream.keys.get({ ...params }) -> KeyGetResponse
## LiveInputs
Types:
- StreamLiveInput
- LiveInputListResponse
Methods:
- client.stream.liveInputs.create({ ...params }) -> StreamLiveInput
- client.stream.liveInputs.update(liveInputIdentifier, { ...params }) -> StreamLiveInput
- client.stream.liveInputs.list({ ...params }) -> LiveInputListResponse
- client.stream.liveInputs.delete(liveInputIdentifier, { ...params }) -> void
- client.stream.liveInputs.get(liveInputIdentifier, { ...params }) -> StreamLiveInput
### Outputs
Types:
- StreamOutput
Methods:
- client.stream.liveInputs.outputs.create(liveInputIdentifier, { ...params }) -> StreamOutput
- client.stream.liveInputs.outputs.update(liveInputIdentifier, outputIdentifier, { ...params }) -> StreamOutput
- client.stream.liveInputs.outputs.list(liveInputIdentifier, { ...params }) -> StreamOutputsSinglePage
- client.stream.liveInputs.outputs.delete(liveInputIdentifier, outputIdentifier, { ...params }) -> void
## Watermarks
Types:
- StreamWatermarks
- WatermarkCreateResponse
- WatermarkDeleteResponse
- WatermarkGetResponse
Methods:
- client.stream.watermarks.create({ ...params }) -> WatermarkCreateResponse
- client.stream.watermarks.list({ ...params }) -> StreamWatermarksSinglePage
- client.stream.watermarks.delete(identifier, { ...params }) -> WatermarkDeleteResponse
- client.stream.watermarks.get(identifier, { ...params }) -> WatermarkGetResponse
## 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:
- StreamCaptions
- CaptionUpdateResponse
- CaptionDeleteResponse
- CaptionGetResponse
Methods:
- client.stream.captions.update(identifier, language, { ...params }) -> CaptionUpdateResponse
- client.stream.captions.delete(identifier, language, { ...params }) -> CaptionDeleteResponse
- client.stream.captions.get(identifier, { ...params }) -> CaptionGetResponse
## 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 | null
## Destinations
### Eligible
Types:
- EligibleGetResponse
Methods:
- client.alerting.destinations.eligible.get({ ...params }) -> EligibleGetResponse | null
### Pagerduty
Types:
- AlertingPagerduty
- PagerdutyCreateResponse
- PagerdutyDeleteResponse
- PagerdutyGetResponse
- PagerdutyLinkResponse
Methods:
- client.alerting.destinations.pagerduty.create({ ...params }) -> PagerdutyCreateResponse
- client.alerting.destinations.pagerduty.delete({ ...params }) -> PagerdutyDeleteResponse | null
- client.alerting.destinations.pagerduty.get({ ...params }) -> PagerdutyGetResponse | null
- client.alerting.destinations.pagerduty.link(tokenId, { ...params }) -> PagerdutyLinkResponse
### Webhooks
Types:
- AlertingWebhooks
- 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 }) -> AlertingWebhooksSinglePage
- client.alerting.destinations.webhooks.delete(webhookId, { ...params }) -> WebhookDeleteResponse | null
- client.alerting.destinations.webhooks.get(webhookId, { ...params }) -> AlertingWebhooks
## History
Types:
- AlertingHistory
Methods:
- client.alerting.history.list({ ...params }) -> AlertingHistoriesV4PagePaginationArray
## Policies
Types:
- AlertingPolicies
- PolicyCreateResponse
- PolicyUpdateResponse
- PolicyDeleteResponse
Methods:
- client.alerting.policies.create({ ...params }) -> PolicyCreateResponse
- client.alerting.policies.update(policyId, { ...params }) -> PolicyUpdateResponse
- client.alerting.policies.list({ ...params }) -> AlertingPoliciesSinglePage
- client.alerting.policies.delete(policyId, { ...params }) -> PolicyDeleteResponse | null
- client.alerting.policies.get(policyId, { ...params }) -> AlertingPolicies
# D1
## Database
Types:
- D1CreateDatabase
- D1DatabaseDetails
- D1QueryResult
- DatabaseDeleteResponse
- DatabaseQueryResponse
Methods:
- client.d1.database.create({ ...params }) -> D1CreateDatabase
- client.d1.database.list({ ...params }) -> D1CreateDatabasesV4PagePaginationArray
- client.d1.database.delete(accountIdentifier, databaseIdentifier) -> DatabaseDeleteResponse | null
- client.d1.database.get(accountIdentifier, databaseIdentifier) -> D1DatabaseDetails
- client.d1.database.query(accountIdentifier, databaseIdentifier, { ...params }) -> DatabaseQueryResponse
# R2
## Buckets
Types:
- R2Bucket
- BucketDeleteResponse
Methods:
- client.r2.buckets.create({ ...params }) -> R2Bucket
- client.r2.buckets.list({ ...params }) -> R2BucketsCursorPagination
- client.r2.buckets.delete(bucketName, { ...params }) -> BucketDeleteResponse
- client.r2.buckets.get(bucketName, { ...params }) -> R2Bucket
## Sippy
Types:
- R2Sippy
- SippyDeleteResponse
Methods:
- client.r2.sippy.update(bucketName, { ...params }) -> R2Sippy
- client.r2.sippy.delete(bucketName, { ...params }) -> SippyDeleteResponse
- client.r2.sippy.get(bucketName, { ...params }) -> R2Sippy
# WARPConnector
Types:
- WARPConnectorCreateResponse
- WARPConnectorListResponse
- WARPConnectorDeleteResponse
- WARPConnectorEditResponse
- WARPConnectorGetResponse
- WARPConnectorTokenResponse
Methods:
- client.warpConnector.create({ ...params }) -> WARPConnectorCreateResponse
- client.warpConnector.list({ ...params }) -> WARPConnectorListResponsesV4PagePaginationArray
- client.warpConnector.delete(tunnelId, { ...params }) -> WARPConnectorDeleteResponse
- client.warpConnector.edit(tunnelId, { ...params }) -> WARPConnectorEditResponse
- client.warpConnector.get(tunnelId, { ...params }) -> WARPConnectorGetResponse
- client.warpConnector.token(tunnelId, { ...params }) -> WARPConnectorTokenResponse
# 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:
- WorkersForPlatformsNamespaceScript
Methods:
- client.workersForPlatforms.dispatch.namespaces.scripts.update(dispatchNamespace, scriptName, { ...params }) -> WorkersScript
- client.workersForPlatforms.dispatch.namespaces.scripts.delete(dispatchNamespace, scriptName, { ...params }) -> void
- client.workersForPlatforms.dispatch.namespaces.scripts.get(dispatchNamespace, scriptName, { ...params }) -> WorkersForPlatformsNamespaceScript
##### Content
Methods:
- client.workersForPlatforms.dispatch.namespaces.scripts.content.update(dispatchNamespace, scriptName, { ...params }) -> WorkersScript
- 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 }) -> BindingGetResponse
# ZeroTrust
## Devices
Types:
- ZeroTrustDevices
- DeviceGetResponse
Methods:
- client.zeroTrust.devices.list({ ...params }) -> ZeroTrustDevicesSinglePage
- client.zeroTrust.devices.get(deviceId, { ...params }) -> DeviceGetResponse | null
### DEXTests
Types:
- DEXTestSchemasHTTP
- DEXTestDeleteResponse
Methods:
- client.zeroTrust.devices.dexTests.create({ ...params }) -> DEXTestSchemasHTTP | null
- client.zeroTrust.devices.dexTests.update(dexTestId, { ...params }) -> DEXTestSchemasHTTP | null
- client.zeroTrust.devices.dexTests.list({ ...params }) -> DEXTestSchemasHTTPSSinglePage
- client.zeroTrust.devices.dexTests.delete(dexTestId, { ...params }) -> DEXTestDeleteResponse | null
- client.zeroTrust.devices.dexTests.get(dexTestId, { ...params }) -> DEXTestSchemasHTTP | null
### Networks
Types:
- DeviceManagedNetworks
- NetworkDeleteResponse
Methods:
- client.zeroTrust.devices.networks.create({ ...params }) -> DeviceManagedNetworks | null
- client.zeroTrust.devices.networks.update(networkId, { ...params }) -> DeviceManagedNetworks | null
- client.zeroTrust.devices.networks.list({ ...params }) -> DeviceManagedNetworksSinglePage
- client.zeroTrust.devices.networks.delete(networkId, { ...params }) -> NetworkDeleteResponse | null
- client.zeroTrust.devices.networks.get(networkId, { ...params }) -> DeviceManagedNetworks | null
### Policies
Types:
- DevicesDeviceSettingsPolicy
- PolicyDeleteResponse
Methods:
- client.zeroTrust.devices.policies.create({ ...params }) -> DevicesDeviceSettingsPolicy | null
- client.zeroTrust.devices.policies.list({ ...params }) -> DevicesDeviceSettingsPoliciesSinglePage
- client.zeroTrust.devices.policies.delete(policyId, { ...params }) -> PolicyDeleteResponse | null
- client.zeroTrust.devices.policies.edit(policyId, { ...params }) -> DevicesDeviceSettingsPolicy | null
- client.zeroTrust.devices.policies.get(policyId, { ...params }) -> DevicesDeviceSettingsPolicy | null
#### DefaultPolicy
Types:
- DefaultPolicyGetResponse
Methods:
- client.zeroTrust.devices.policies.defaultPolicy.get({ ...params }) -> DefaultPolicyGetResponse | null
#### Excludes
Types:
- DevicesSplitTunnel
- ExcludeUpdateResponse
- ExcludeGetResponse
Methods:
- client.zeroTrust.devices.policies.excludes.update([ ...body ]) -> ExcludeUpdateResponse | null
- client.zeroTrust.devices.policies.excludes.list({ ...params }) -> DevicesSplitTunnelsSinglePage
- client.zeroTrust.devices.policies.excludes.get(policyId, { ...params }) -> ExcludeGetResponse | null
#### FallbackDomains
Types:
- DevicesFallbackDomain
- FallbackDomainUpdateResponse
- FallbackDomainGetResponse
Methods:
- client.zeroTrust.devices.policies.fallbackDomains.update(policyId, [ ...body ]) -> FallbackDomainUpdateResponse | null
- client.zeroTrust.devices.policies.fallbackDomains.list({ ...params }) -> DevicesFallbackDomainsSinglePage
- client.zeroTrust.devices.policies.fallbackDomains.get(policyId, { ...params }) -> FallbackDomainGetResponse | null
#### Includes
Types:
- DevicesSplitTunnelInclude
- IncludeUpdateResponse
- IncludeGetResponse
Methods:
- client.zeroTrust.devices.policies.includes.update([ ...body ]) -> IncludeUpdateResponse | null
- client.zeroTrust.devices.policies.includes.list({ ...params }) -> DevicesSplitTunnelIncludesSinglePage
- client.zeroTrust.devices.policies.includes.get(policyId, { ...params }) -> IncludeGetResponse | null
### Posture
Types:
- DevicePostureRules
- PostureDeleteResponse
Methods:
- client.zeroTrust.devices.posture.create({ ...params }) -> DevicePostureRules | null
- client.zeroTrust.devices.posture.update(ruleId, { ...params }) -> DevicePostureRules | null
- client.zeroTrust.devices.posture.list({ ...params }) -> DevicePostureRulesSinglePage
- client.zeroTrust.devices.posture.delete(ruleId, { ...params }) -> PostureDeleteResponse | null
- client.zeroTrust.devices.posture.get(ruleId, { ...params }) -> DevicePostureRules | null
#### Integrations
Types:
- DevicePostureIntegrations
- IntegrationDeleteResponse
Methods:
- client.zeroTrust.devices.posture.integrations.create({ ...params }) -> DevicePostureIntegrations | null
- client.zeroTrust.devices.posture.integrations.list({ ...params }) -> DevicePostureIntegrationsSinglePage
- client.zeroTrust.devices.posture.integrations.delete(integrationId, { ...params }) -> IntegrationDeleteResponse | null
- client.zeroTrust.devices.posture.integrations.edit(integrationId, { ...params }) -> DevicePostureIntegrations | null
- client.zeroTrust.devices.posture.integrations.get(integrationId, { ...params }) -> DevicePostureIntegrations | null
### Revoke
Types:
- RevokeCreateResponse
Methods:
- client.zeroTrust.devices.revoke.create([ ...body ]) -> RevokeCreateResponse | null
### Settings
Types:
- ZeroTrustAccountDeviceSettings
Methods:
- client.zeroTrust.devices.settings.update({ ...params }) -> ZeroTrustAccountDeviceSettings | null
- client.zeroTrust.devices.settings.list({ ...params }) -> ZeroTrustAccountDeviceSettings | null
### Unrevoke
Types:
- UnrevokeCreateResponse
Methods:
- client.zeroTrust.devices.unrevoke.create([ ...body ]) -> UnrevokeCreateResponse | null
### OverrideCodes
Types:
- OverrideCodeListResponse
Methods:
- client.zeroTrust.devices.overrideCodes.list(deviceId, { ...params }) -> OverrideCodeListResponse | null
## IdentityProviders
Types:
- ZeroTrustIdentityProviders
- IdentityProviderListResponse
- IdentityProviderDeleteResponse
Methods:
- client.zeroTrust.identityProviders.create({ ...params }) -> ZeroTrustIdentityProviders
- client.zeroTrust.identityProviders.update(uuid, { ...params }) -> ZeroTrustIdentityProviders
- client.zeroTrust.identityProviders.list({ ...params }) -> IdentityProviderListResponsesSinglePage
- client.zeroTrust.identityProviders.delete(uuid, { ...params }) -> IdentityProviderDeleteResponse
- client.zeroTrust.identityProviders.get(uuid, { ...params }) -> ZeroTrustIdentityProviders
## Organizations
Types:
- ZeroTrustOrganizations
- OrganizationRevokeUsersResponse
Methods:
- client.zeroTrust.organizations.create({ ...params }) -> ZeroTrustOrganizations
- client.zeroTrust.organizations.update({ ...params }) -> ZeroTrustOrganizations
- client.zeroTrust.organizations.list({ ...params }) -> ZeroTrustOrganizations
- client.zeroTrust.organizations.revokeUsers({ ...params }) -> OrganizationRevokeUsersResponse
## Seats
Types:
- ZeroTrustSeats
- SeatEditResponse
Methods:
- client.zeroTrust.seats.edit(identifier, [ ...body ]) -> SeatEditResponse | null
## Access
### Applications
Types:
- ZeroTrustApps
- ApplicationDeleteResponse
- ApplicationRevokeTokensResponse
Methods:
- client.zeroTrust.access.applications.create({ ...params }) -> ZeroTrustApps
- client.zeroTrust.access.applications.update(appId, { ...params }) -> ZeroTrustApps
- client.zeroTrust.access.applications.list({ ...params }) -> ZeroTrustAppsSinglePage
- client.zeroTrust.access.applications.delete(appId, { ...params }) -> ApplicationDeleteResponse
- client.zeroTrust.access.applications.get(appId, { ...params }) -> ZeroTrustApps
- client.zeroTrust.access.applications.revokeTokens(appId, { ...params }) -> ApplicationRevokeTokensResponse | null
#### CAs
Types:
- ZeroTrustCA
- CACreateResponse
- CADeleteResponse
- CAGetResponse
Methods:
- client.zeroTrust.access.applications.cas.create(uuid, { ...params }) -> CACreateResponse
- client.zeroTrust.access.applications.cas.list({ ...params }) -> ZeroTrustCAsSinglePage
- client.zeroTrust.access.applications.cas.delete(uuid, { ...params }) -> CADeleteResponse
- client.zeroTrust.access.applications.cas.get(uuid, { ...params }) -> CAGetResponse
#### UserPolicyChecks
Types:
- UserPolicyCheckListResponse
Methods:
- client.zeroTrust.access.applications.userPolicyChecks.list(appId, { ...params }) -> UserPolicyCheckListResponse
#### Policies
Types:
- ZeroTrustPolicies
- PolicyDeleteResponse
Methods:
- client.zeroTrust.access.applications.policies.create(uuid, { ...params }) -> ZeroTrustPolicies
- client.zeroTrust.access.applications.policies.update(uuid1, uuid, { ...params }) -> ZeroTrustPolicies
- client.zeroTrust.access.applications.policies.list(uuid, { ...params }) -> ZeroTrustPoliciesSinglePage
- client.zeroTrust.access.applications.policies.delete(uuid1, uuid, { ...params }) -> PolicyDeleteResponse
- client.zeroTrust.access.applications.policies.get(uuid1, uuid, { ...params }) -> ZeroTrustPolicies
### Certificates
Types:
- ZeroTrustCertificates
- CertificateDeleteResponse
Methods:
- client.zeroTrust.access.certificates.create({ ...params }) -> ZeroTrustCertificates
- client.zeroTrust.access.certificates.update(uuid, { ...params }) -> ZeroTrustCertificates
- client.zeroTrust.access.certificates.list({ ...params }) -> ZeroTrustCertificatesSinglePage
- client.zeroTrust.access.certificates.delete(uuid, { ...params }) -> CertificateDeleteResponse
- client.zeroTrust.access.certificates.get(uuid, { ...params }) -> ZeroTrustCertificates
#### Settings
Types:
- ZeroTrustSettings
- SettingUpdateResponse
- SettingGetResponse
Methods:
- client.zeroTrust.access.certificates.settings.update({ ...params }) -> SettingUpdateResponse | null
- client.zeroTrust.access.certificates.settings.get({ ...params }) -> SettingGetResponse | null
### Groups
Types:
- ZeroTrustGroups
- GroupDeleteResponse
Methods:
- client.zeroTrust.access.groups.create({ ...params }) -> ZeroTrustGroups
- client.zeroTrust.access.groups.update(uuid, { ...params }) -> ZeroTrustGroups
- client.zeroTrust.access.groups.list({ ...params }) -> ZeroTrustGroupsSinglePage
- client.zeroTrust.access.groups.delete(uuid, { ...params }) -> GroupDeleteResponse
- client.zeroTrust.access.groups.get(uuid, { ...params }) -> ZeroTrustGroups
### ServiceTokens
Types:
- ZeroTrustServiceTokens
- ServiceTokenCreateResponse
- ServiceTokenRotateResponse
Methods:
- client.zeroTrust.access.serviceTokens.create({ ...params }) -> ServiceTokenCreateResponse
- client.zeroTrust.access.serviceTokens.update(uuid, { ...params }) -> ZeroTrustServiceTokens
- client.zeroTrust.access.serviceTokens.list({ ...params }) -> ZeroTrustServiceTokensSinglePage
- client.zeroTrust.access.serviceTokens.delete(uuid, { ...params }) -> ZeroTrustServiceTokens
- client.zeroTrust.access.serviceTokens.refresh(identifier, uuid) -> ZeroTrustServiceTokens
- client.zeroTrust.access.serviceTokens.rotate(identifier, uuid) -> ServiceTokenRotateResponse
### Bookmarks
Types:
- ZeroTrustBookmarks
- BookmarkDeleteResponse
Methods:
- client.zeroTrust.access.bookmarks.create(identifier, uuid) -> ZeroTrustBookmarks
- client.zeroTrust.access.bookmarks.update(identifier, uuid) -> ZeroTrustBookmarks
- client.zeroTrust.access.bookmarks.list(identifier) -> ZeroTrustBookmarksSinglePage
- client.zeroTrust.access.bookmarks.delete(identifier, uuid) -> BookmarkDeleteResponse
- client.zeroTrust.access.bookmarks.get(identifier, uuid) -> ZeroTrustBookmarks
### Keys
Types:
- KeyUpdateResponse
- KeyGetResponse
- KeyRotateResponse
Methods:
- client.zeroTrust.access.keys.update(identifier, { ...params }) -> KeyUpdateResponse
- client.zeroTrust.access.keys.get(identifier) -> KeyGetResponse
- client.zeroTrust.access.keys.rotate(identifier) -> KeyRotateResponse
### Logs
#### AccessRequests
Types:
- ZeroTrustAccessRequests
- AccessRequestListResponse
Methods:
- client.zeroTrust.access.logs.accessRequests.list(identifier) -> AccessRequestListResponse | null
### Users
Types:
- ZeroTrustUsers
Methods:
- client.zeroTrust.access.users.list(identifier) -> ZeroTrustUsersSinglePage
#### ActiveSessions
Types:
- ActiveSessionListResponse
- ActiveSessionGetResponse
Methods:
- client.zeroTrust.access.users.activeSessions.list(identifier, id) -> ActiveSessionListResponsesSinglePage
- client.zeroTrust.access.users.activeSessions.get(identifier, id, nonce) -> ActiveSessionGetResponse
#### LastSeenIdentity
Types:
- ZeroTrustIdentity
Methods:
- client.zeroTrust.access.users.lastSeenIdentity.get(identifier, id) -> ZeroTrustIdentity
#### FailedLogins
Types:
- FailedLoginListResponse
Methods:
- client.zeroTrust.access.users.failedLogins.list(identifier, id) -> FailedLoginListResponsesSinglePage
### CustomPages
Types:
- ZeroTrustCustomPage
- ZeroTrustCustomPageWithoutHTML
- CustomPageDeleteResponse
Methods:
- client.zeroTrust.access.customPages.create(identifier, { ...params }) -> ZeroTrustCustomPageWithoutHTML
- client.zeroTrust.access.customPages.update(identifier, uuid, { ...params }) -> ZeroTrustCustomPageWithoutHTML
- client.zeroTrust.access.customPages.list(identifier) -> ZeroTrustCustomPageWithoutHTMLsSinglePage
- client.zeroTrust.access.customPages.delete(identifier, uuid) -> CustomPageDeleteResponse
- client.zeroTrust.access.customPages.get(identifier, uuid) -> ZeroTrustCustomPage
### Tags
Types:
- ZeroTrustTag
- TagDeleteResponse
Methods:
- client.zeroTrust.access.tags.create(identifier, { ...params }) -> ZeroTrustTag
- client.zeroTrust.access.tags.update(identifier, tagName, { ...params }) -> ZeroTrustTag
- client.zeroTrust.access.tags.list(identifier) -> ZeroTrustTagsSinglePage
- client.zeroTrust.access.tags.delete(identifier, name) -> TagDeleteResponse
- client.zeroTrust.access.tags.get(identifier, name) -> ZeroTrustTag
## DEX
### Colos
Types:
- ColoListResponse
Methods:
- client.zeroTrust.dex.colos.list({ ...params }) -> ColoListResponsesSinglePage
### FleetStatus
Types:
- FleetStatusLiveResponse
Methods:
- client.zeroTrust.dex.fleetStatus.live({ ...params }) -> FleetStatusLiveResponse
- client.zeroTrust.dex.fleetStatus.overTime({ ...params }) -> void
#### Devices
Types:
- DigitalExperienceMonitoringDevice
Methods:
- client.zeroTrust.dex.fleetStatus.devices.list({ ...params }) -> DigitalExperienceMonitoringDevicesV4PagePaginationArray
### HTTPTests
Types:
- DigitalExperienceMonitoringHTTPDetails
Methods:
- client.zeroTrust.dex.httpTests.get(testId, { ...params }) -> DigitalExperienceMonitoringHTTPDetails
#### Percentiles
Types:
- DigitalExperienceMonitoringHTTPDetailsPercentiles
Methods:
- client.zeroTrust.dex.httpTests.percentiles.get(testId, { ...params }) -> DigitalExperienceMonitoringHTTPDetailsPercentiles
### Tests
Types:
- DigitalExperienceMonitoringTests
- TestListResponse
Methods:
- client.zeroTrust.dex.tests.list({ ...params }) -> TestListResponsesV4PagePagination
#### UniqueDevices
Types:
- DigitalExperienceMonitoringUniqueDevices
Methods:
- client.zeroTrust.dex.tests.uniqueDevices.list({ ...params }) -> DigitalExperienceMonitoringUniqueDevices
### TracerouteTestResults
#### NetworkPath
Types:
- DigitalExperienceMonitoringTracerouteTestResultNetworkPath
Methods:
- client.zeroTrust.dex.tracerouteTestResults.networkPath.get(testResultId, { ...params }) -> DigitalExperienceMonitoringTracerouteTestResultNetworkPath
### TracerouteTests
Types:
- DigitalExperienceMonitoringTracerouteDetails
- DigitalExperienceMonitoringTracerouteDetailsPercentiles
- DigitalExperienceMonitoringTracerouteTestNetworkPath
Methods:
- client.zeroTrust.dex.tracerouteTests.get(testId, { ...params }) -> DigitalExperienceMonitoringTracerouteDetails
- client.zeroTrust.dex.tracerouteTests.networkPath(testId, { ...params }) -> DigitalExperienceMonitoringTracerouteTestNetworkPath
- client.zeroTrust.dex.tracerouteTests.percentiles(testId, { ...params }) -> DigitalExperienceMonitoringTracerouteDetailsPercentiles
## Tunnels
Types:
- TunnelArgoTunnel
- TunnelListResponse
- TunnelEditResponse
Methods:
- client.zeroTrust.tunnels.create({ ...params }) -> TunnelArgoTunnel
- client.zeroTrust.tunnels.list({ ...params }) -> TunnelListResponsesV4PagePaginationArray
- client.zeroTrust.tunnels.delete(tunnelId, { ...params }) -> TunnelArgoTunnel
- client.zeroTrust.tunnels.edit(tunnelId, { ...params }) -> TunnelEditResponse
- client.zeroTrust.tunnels.get(tunnelId, { ...params }) -> TunnelArgoTunnel
### Configurations
Types:
- ConfigurationUpdateResponse
- ConfigurationGetResponse
Methods:
- client.zeroTrust.tunnels.configurations.update(tunnelId, { ...params }) -> ConfigurationUpdateResponse
- client.zeroTrust.tunnels.configurations.get(tunnelId, { ...params }) -> ConfigurationGetResponse
### Connections
Types:
- TunnelTunnelClient
- ConnectionDeleteResponse
- ConnectionGetResponse
Methods:
- client.zeroTrust.tunnels.connections.delete(tunnelId, { ...params }) -> ConnectionDeleteResponse
- client.zeroTrust.tunnels.connections.get(tunnelId, { ...params }) -> ConnectionGetResponse | null
### Token
Types:
- TokenGetResponse
Methods:
- client.zeroTrust.tunnels.token.get(tunnelId, { ...params }) -> TokenGetResponse
### Connectors
Methods:
- client.zeroTrust.tunnels.connectors.get(tunnelId, connectorId, { ...params }) -> TunnelTunnelClient
### Management
Types:
- ManagementCreateResponse
Methods:
- client.zeroTrust.tunnels.management.create(tunnelId, { ...params }) -> ManagementCreateResponse
## ConnectivitySettings
Types:
- ConnectivitySettingEditResponse
- ConnectivitySettingGetResponse
Methods:
- client.zeroTrust.connectivitySettings.edit({ ...params }) -> ConnectivitySettingEditResponse
- client.zeroTrust.connectivitySettings.get({ ...params }) -> ConnectivitySettingGetResponse
## DLP
### Datasets
Types:
- DLPDataset
- DLPDatasetArray
- DLPDatasetCreation
Methods:
- client.zeroTrust.dlp.datasets.create({ ...params }) -> DLPDatasetCreation
- client.zeroTrust.dlp.datasets.update(datasetId, { ...params }) -> DLPDataset
- client.zeroTrust.dlp.datasets.list({ ...params }) -> DLPDatasetsSinglePage
- client.zeroTrust.dlp.datasets.delete(datasetId, { ...params }) -> void
- client.zeroTrust.dlp.datasets.get(datasetId, { ...params }) -> DLPDataset
#### Upload
Types:
- DLPDatasetNewVersion
Methods:
- client.zeroTrust.dlp.datasets.upload.create(datasetId, { ...params }) -> DLPDatasetNewVersion
- client.zeroTrust.dlp.datasets.upload.edit(datasetId, version, { ...params }) -> DLPDataset
### 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
### Profiles
Types:
- DLPProfiles
- ProfileGetResponse
Methods:
- client.zeroTrust.dlp.profiles.list({ ...params }) -> DLPProfilesSinglePage
- client.zeroTrust.dlp.profiles.get(profileId, { ...params }) -> ProfileGetResponse
#### Custom
Types:
- DLPCustomProfile
- CustomCreateResponse
- CustomDeleteResponse
Methods:
- client.zeroTrust.dlp.profiles.custom.create({ ...params }) -> CustomCreateResponse | null
- client.zeroTrust.dlp.profiles.custom.update(profileId, { ...params }) -> DLPCustomProfile
- client.zeroTrust.dlp.profiles.custom.delete(profileId, { ...params }) -> CustomDeleteResponse
- client.zeroTrust.dlp.profiles.custom.get(profileId, { ...params }) -> DLPCustomProfile
#### Predefined
Types:
- DLPPredefinedProfile
Methods:
- client.zeroTrust.dlp.profiles.predefined.update(profileId, { ...params }) -> DLPPredefinedProfile
- client.zeroTrust.dlp.profiles.predefined.get(profileId, { ...params }) -> DLPPredefinedProfile
## Gateway
Types:
- GatewayCreateResponse
- GatewayListResponse
Methods:
- client.zeroTrust.gateway.create({ ...params }) -> GatewayCreateResponse
- client.zeroTrust.gateway.list({ ...params }) -> GatewayListResponse
### AuditSSHSettings
Types:
- ZeroTrustGatewaySettings
Methods:
- client.zeroTrust.gateway.auditSSHSettings.update({ ...params }) -> ZeroTrustGatewaySettings
- client.zeroTrust.gateway.auditSSHSettings.get({ ...params }) -> ZeroTrustGatewaySettings
### Categories
Types:
- ZeroTrustGatewayCategories
Methods:
- client.zeroTrust.gateway.categories.list({ ...params }) -> ZeroTrustGatewayCategoriesSinglePage
### AppTypes
Types:
- ZeroTrustGatewayAppTypes
Methods:
- client.zeroTrust.gateway.appTypes.list({ ...params }) -> ZeroTrustGatewayAppTypesSinglePage
### Configurations
Types:
- 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
### Lists
Types:
- ZeroTrustGatewayLists
- ListCreateResponse
- ListDeleteResponse
Methods:
- client.zeroTrust.gateway.lists.create({ ...params }) -> ListCreateResponse
- client.zeroTrust.gateway.lists.update(listId, { ...params }) -> ZeroTrustGatewayLists
- client.zeroTrust.gateway.lists.list({ ...params }) -> ZeroTrustGatewayListsSinglePage
- client.zeroTrust.gateway.lists.delete(listId, { ...params }) -> ListDeleteResponse
- client.zeroTrust.gateway.lists.edit(listId, { ...params }) -> ZeroTrustGatewayLists
- client.zeroTrust.gateway.lists.get(listId, { ...params }) -> ZeroTrustGatewayLists
#### Items
Types:
- ItemListResponse
Methods:
- client.zeroTrust.gateway.lists.items.list(listId, { ...params }) -> ItemListResponsesSinglePage
### Locations
Types:
- ZeroTrustGatewayLocations
- LocationDeleteResponse
Methods:
- client.zeroTrust.gateway.locations.create({ ...params }) -> ZeroTrustGatewayLocations
- client.zeroTrust.gateway.locations.update(locationId, { ...params }) -> ZeroTrustGatewayLocations
- client.zeroTrust.gateway.locations.list({ ...params }) -> ZeroTrustGatewayLocationsSinglePage
- client.zeroTrust.gateway.locations.delete(locationId, { ...params }) -> LocationDeleteResponse
- client.zeroTrust.gateway.locations.get(locationId, { ...params }) -> ZeroTrustGatewayLocations
### Logging
Types:
- ZeroTrustGatewayGatewayAccountLoggingSettings
Methods:
- client.zeroTrust.gateway.logging.update({ ...params }) -> ZeroTrustGatewayGatewayAccountLoggingSettings
- client.zeroTrust.gateway.logging.get({ ...params }) -> ZeroTrustGatewayGatewayAccountLoggingSettings
### ProxyEndpoints
Types:
- ZeroTrustGatewayProxyEndpoints
- ProxyEndpointDeleteResponse
Methods:
- client.zeroTrust.gateway.proxyEndpoints.create({ ...params }) -> ZeroTrustGatewayProxyEndpoints
- client.zeroTrust.gateway.proxyEndpoints.list({ ...params }) -> ZeroTrustGatewayProxyEndpointsSinglePage
- client.zeroTrust.gateway.proxyEndpoints.delete(proxyEndpointId, { ...params }) -> ProxyEndpointDeleteResponse
- client.zeroTrust.gateway.proxyEndpoints.edit(proxyEndpointId, { ...params }) -> ZeroTrustGatewayProxyEndpoints
- client.zeroTrust.gateway.proxyEndpoints.get(proxyEndpointId, { ...params }) -> ZeroTrustGatewayProxyEndpoints
### Rules
Types:
- ZeroTrustGatewayRules
- RuleDeleteResponse
Methods:
- client.zeroTrust.gateway.rules.create({ ...params }) -> ZeroTrustGatewayRules
- client.zeroTrust.gateway.rules.update(ruleId, { ...params }) -> ZeroTrustGatewayRules
- client.zeroTrust.gateway.rules.list({ ...params }) -> ZeroTrustGatewayRulesSinglePage
- client.zeroTrust.gateway.rules.delete(ruleId, { ...params }) -> RuleDeleteResponse
- client.zeroTrust.gateway.rules.get(ruleId, { ...params }) -> ZeroTrustGatewayRules
## Networks
### Routes
Types:
- TunnelRoute
- TunnelTeamnet
Methods:
- client.zeroTrust.networks.routes.create({ ...params }) -> TunnelRoute
- client.zeroTrust.networks.routes.list({ ...params }) -> TunnelTeamnetsV4PagePaginationArray
- client.zeroTrust.networks.routes.delete(routeId, { ...params }) -> TunnelRoute
- client.zeroTrust.networks.routes.edit(routeId, { ...params }) -> TunnelRoute
#### IPs
Methods:
- client.zeroTrust.networks.routes.ips.get(ip, { ...params }) -> TunnelTeamnet
#### Networks
Methods:
- client.zeroTrust.networks.routes.networks.create(ipNetworkEncoded, { ...params }) -> TunnelRoute
- client.zeroTrust.networks.routes.networks.delete(ipNetworkEncoded, { ...params }) -> TunnelRoute
- client.zeroTrust.networks.routes.networks.edit(ipNetworkEncoded, { ...params }) -> TunnelRoute
### VirtualNetworks
Types:
- TunnelVirtualNetwork
- VirtualNetworkCreateResponse
- VirtualNetworkDeleteResponse
- VirtualNetworkEditResponse
Methods:
- client.zeroTrust.networks.virtualNetworks.create({ ...params }) -> VirtualNetworkCreateResponse
- client.zeroTrust.networks.virtualNetworks.list({ ...params }) -> TunnelVirtualNetworksSinglePage
- client.zeroTrust.networks.virtualNetworks.delete(virtualNetworkId, { ...params }) -> VirtualNetworkDeleteResponse
- client.zeroTrust.networks.virtualNetworks.edit(virtualNetworkId, { ...params }) -> VirtualNetworkEditResponse
# Challenges
## Widgets
Types:
- ChallengesWidget
- ChallengesWidgetList
Methods:
- client.challenges.widgets.create({ ...params }) -> ChallengesWidget
- client.challenges.widgets.update(sitekey, { ...params }) -> ChallengesWidget
- client.challenges.widgets.list({ ...params }) -> ChallengesWidgetListsV4PagePaginationArray
- client.challenges.widgets.delete(sitekey, { ...params }) -> ChallengesWidget
- client.challenges.widgets.get(sitekey, { ...params }) -> ChallengesWidget
- client.challenges.widgets.rotateSecret(sitekey, { ...params }) -> ChallengesWidget
# Hyperdrive
Types:
- Hyperdrive
## Configs
Types:
- ConfigCreateResponse
- ConfigUpdateResponse
- ConfigListResponse
- ConfigDeleteResponse
- ConfigEditResponse
- ConfigGetResponse
Methods:
- client.hyperdrive.configs.create({ ...params }) -> ConfigCreateResponse | null
- client.hyperdrive.configs.update(hyperdriveId, { ...params }) -> ConfigUpdateResponse | null
- client.hyperdrive.configs.list({ ...params }) -> ConfigListResponsesSinglePage
- client.hyperdrive.configs.delete(hyperdriveId, { ...params }) -> ConfigDeleteResponse | null
- client.hyperdrive.configs.edit(hyperdriveId, { ...params }) -> ConfigEditResponse | null
- client.hyperdrive.configs.get(hyperdriveId, { ...params }) -> ConfigGetResponse | null
# RUM
## SiteInfo
Types:
- RUMSite
- SiteInfoDeleteResponse
Methods:
- client.rum.siteInfo.create({ ...params }) -> RUMSite
- client.rum.siteInfo.update(siteId, { ...params }) -> RUMSite
- client.rum.siteInfo.list({ ...params }) -> RUMSitesV4PagePaginationArray
- client.rum.siteInfo.delete(siteId, { ...params }) -> SiteInfoDeleteResponse
- client.rum.siteInfo.get(siteId, { ...params }) -> RUMSite
## Rules
Types:
- RUMRule
- RuleListResponse
- RuleDeleteResponse
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
# Vectorize
## Indexes
Types:
- VectorizeCreateIndex
- VectorizeIndexDeleteVectorsByID
- VectorizeIndexInsert
- VectorizeIndexQuery
- VectorizeIndexUpsert
- IndexDeleteResponse
- IndexGetByIDsResponse
Methods:
- client.vectorize.indexes.create(accountIdentifier, { ...params }) -> VectorizeCreateIndex | null
- client.vectorize.indexes.update(accountIdentifier, indexName, { ...params }) -> VectorizeCreateIndex | null
- client.vectorize.indexes.list(accountIdentifier) -> VectorizeCreateIndicesSinglePage
- client.vectorize.indexes.delete(accountIdentifier, indexName) -> IndexDeleteResponse | null
- client.vectorize.indexes.deleteByIds(accountIdentifier, indexName, { ...params }) -> VectorizeIndexDeleteVectorsByID | null
- client.vectorize.indexes.get(accountIdentifier, indexName) -> VectorizeCreateIndex | null
- client.vectorize.indexes.getByIds(accountIdentifier, indexName, { ...params }) -> IndexGetByIDsResponse | null
- client.vectorize.indexes.insert(accountIdentifier, indexName) -> VectorizeIndexInsert | null
- client.vectorize.indexes.query(accountIdentifier, indexName, { ...params }) -> VectorizeIndexQuery | null
- client.vectorize.indexes.upsert(accountIdentifier, indexName) -> VectorizeIndexUpsert | null
# URLScanner
Types:
- URLScannerScanResponse
Methods:
- client.urlScanner.scan(accountId, { ...params }) -> URLScannerScanResponse
## Scans
Types:
- ScanCreateResponse
- ScanGetResponse
- ScanHarResponse
Methods:
- client.urlScanner.scans.create(accountId, { ...params }) -> ScanCreateResponse
- client.urlScanner.scans.get(accountId, scanId) -> ScanGetResponse
- client.urlScanner.scans.har(accountId, scanId) -> ScanHarResponse
- client.urlScanner.scans.screenshot(accountId, scanId, { ...params }) -> Response
# Radar
## Annotations
### 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
Types:
- LeakEventsResponse
Methods:
- client.radar.bgp.leaks.events({ ...params }) -> LeakEventsResponse
### 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
Types:
- HijackEventsResponse
Methods:
- client.radar.bgp.hijacks.events({ ...params }) -> HijackEventsResponse
### Routes
Types:
- RouteMoasResponse
- RoutePfx2asResponse
- RouteStatsResponse
- RouteTimeseriesResponse
Methods:
- client.radar.bgp.routes.moas({ ...params }) -> RouteMoasResponse
- client.radar.bgp.routes.pfx2as({ ...params }) -> RoutePfx2asResponse
- client.radar.bgp.routes.stats({ ...params }) -> RouteStatsResponse
- client.radar.bgp.routes.timeseries({ ...params }) -> RouteTimeseriesResponse
## Datasets
Types:
- DatasetListResponse
- DatasetDownloadResponse
- DatasetGetResponse
Methods:
- client.radar.datasets.list({ ...params }) -> DatasetListResponse
- client.radar.datasets.download({ ...params }) -> DatasetDownloadResponse
- client.radar.datasets.get(alias, { ...params }) -> string
## DNS
### Top
Types:
- TopAsesResponse
- TopLocationsResponse
Methods:
- client.radar.dns.top.ases({ ...params }) -> TopAsesResponse
- client.radar.dns.top.locations({ ...params }) -> TopLocationsResponse
## Netflows
Types:
- NetflowTimeseriesResponse
Methods:
- 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
## ConnectionTampering
Types:
- ConnectionTamperingSummaryResponse
- ConnectionTamperingTimeseriesGroupsResponse
Methods:
- client.radar.connectionTampering.summary({ ...params }) -> ConnectionTamperingSummaryResponse
- client.radar.connectionTampering.timeseriesGroups({ ...params }) -> ConnectionTamperingTimeseriesGroupsResponse
## Email
### 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
- SummaryGetResponse
- SummaryIPVersionResponse
- SummaryProtocolResponse
- SummaryVectorResponse
Methods:
- client.radar.attacks.layer3.summary.bitrate({ ...params }) -> SummaryBitrateResponse
- client.radar.attacks.layer3.summary.duration({ ...params }) -> SummaryDurationResponse
- client.radar.attacks.layer3.summary.get({ ...params }) -> SummaryGetResponse
- client.radar.attacks.layer3.summary.ipVersion({ ...params }) -> SummaryIPVersionResponse
- client.radar.attacks.layer3.summary.protocol({ ...params }) -> SummaryProtocolResponse
- client.radar.attacks.layer3.summary.vector({ ...params }) -> SummaryVectorResponse
#### TimeseriesGroups
Types:
- TimeseriesGroupBitrateResponse
- TimeseriesGroupDurationResponse
- TimeseriesGroupGetResponse
- 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.get({ ...params }) -> TimeseriesGroupGetResponse
- 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:
- SummaryGetResponse
- SummaryHTTPMethodResponse
- SummaryHTTPVersionResponse
- SummaryIPVersionResponse
- SummaryManagedRulesResponse
- SummaryMitigationProductResponse
Methods:
- client.radar.attacks.layer7.summary.get({ ...params }) -> SummaryGetResponse
- client.radar.attacks.layer7.summary.httpMethod({ ...params }) -> SummaryHTTPMethodResponse
- client.radar.attacks.layer7.summary.httpVersion({ ...params }) -> SummaryHTTPVersionResponse
- client.radar.attacks.layer7.summary.ipVersion({ ...params }) -> SummaryIPVersionResponse
- client.radar.attacks.layer7.summary.managedRules({ ...params }) -> SummaryManagedRulesResponse
- client.radar.attacks.layer7.summary.mitigationProduct({ ...params }) -> SummaryMitigationProductResponse
#### TimeseriesGroups
Types:
- TimeseriesGroupGetResponse
- TimeseriesGroupHTTPMethodResponse
- TimeseriesGroupHTTPVersionResponse
- TimeseriesGroupIndustryResponse
- TimeseriesGroupIPVersionResponse
- TimeseriesGroupManagedRulesResponse
- TimeseriesGroupMitigationProductResponse
- TimeseriesGroupVerticalResponse
Methods:
- client.radar.attacks.layer7.timeseriesGroups.get({ ...params }) -> TimeseriesGroupGetResponse
- 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
### Top
Types:
- TopBrowserFamiliesResponse
- TopBrowsersResponse
Methods:
- client.radar.http.top.browserFamilies({ ...params }) -> TopBrowserFamiliesResponse
- client.radar.http.top.browsers({ ...params }) -> TopBrowsersResponse
### 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
### 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
### Summary
Types:
- SummaryBotClassResponse
- SummaryDeviceTypeResponse
- SummaryHTTPProtocolResponse
- SummaryHTTPVersionResponse
- SummaryIPVersionResponse
- SummaryOSResponse
- 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.tlsVersion({ ...params }) -> SummaryTLSVersionResponse
### TimeseriesGroups
Types:
- TimeseriesGroupBotClassResponse
- TimeseriesGroupBrowserResponse
- TimeseriesGroupBrowserFamilyResponse
- TimeseriesGroupDeviceTypeResponse
- TimeseriesGroupHTTPProtocolResponse
- TimeseriesGroupHTTPVersionResponse
- TimeseriesGroupIPVersionResponse
- TimeseriesGroupOSResponse
- 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.tlsVersion({ ...params }) -> TimeseriesGroupTLSVersionResponse
## 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
## TrafficAnomalies
Types:
- TrafficAnomalyGetResponse
Methods:
- client.radar.trafficAnomalies.get({ ...params }) -> TrafficAnomalyGetResponse
### Locations
Types:
- LocationGetResponse
Methods:
- client.radar.trafficAnomalies.locations.get({ ...params }) -> LocationGetResponse
# BotManagement
Types:
- 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
# Speed
Types:
- ObservatorySchedule
- ObservatoryTrend
- SpeedDeleteResponse
Methods:
- client.speed.delete(url, { ...params }) -> SpeedDeleteResponse
- client.speed.scheduleGet(url, { ...params }) -> ObservatorySchedule
- client.speed.trendsList(url, { ...params }) -> ObservatoryTrend
## Tests
Types:
- ObservatoryPageTest
- TestListResponse
- TestDeleteResponse
Methods:
- client.speed.tests.create(url, { ...params }) -> ObservatoryPageTest
- client.speed.tests.list(url, { ...params }) -> TestListResponse
- client.speed.tests.delete(url, { ...params }) -> TestDeleteResponse
- client.speed.tests.get(url, testId, { ...params }) -> ObservatoryPageTest
## Schedule
Types:
- ScheduleCreateResponse
Methods:
- client.speed.schedule.create(url, { ...params }) -> ScheduleCreateResponse
## Availabilities
Types:
- ObservatoryAvailabilities
Methods:
- client.speed.availabilities.list({ ...params }) -> ObservatoryAvailabilities
## Pages
Types:
- PageListResponse
Methods:
- client.speed.pages.list({ ...params }) -> PageListResponsesSinglePage
# DCVDelegation
## UUID
Types:
- DCVDelegationUUID
Methods:
- client.dcvDelegation.uuid.get({ ...params }) -> DCVDelegationUUID
# Hostnames
## Settings
### TLS
Types:
- HostnameSettingDelete
- HostnameStting
- TLSGetResponse
Methods:
- client.hostnames.settings.tls.update(settingId, hostname, { ...params }) -> HostnameStting
- client.hostnames.settings.tls.delete(settingId, hostname, { ...params }) -> HostnameSettingDelete
- client.hostnames.settings.tls.get(settingId, { ...params }) -> TLSGetResponse | null
# Snippets
Types:
- Snippet
- SnippetDeleteResponse
Methods:
- client.snippets.update(zoneIdentifier, snippetName, { ...params }) -> Snippet
- client.snippets.list(zoneIdentifier) -> SnippetsSinglePage
- client.snippets.delete(zoneIdentifier, snippetName) -> SnippetDeleteResponse
- client.snippets.get(zoneIdentifier, snippetName) -> Snippet
## Content
Methods:
- client.snippets.content.get(zoneIdentifier, snippetName) -> Response
## Rules
Types:
- RuleUpdateResponse
- RuleListResponse
Methods:
- client.snippets.rules.update(zoneIdentifier, { ...params }) -> RuleUpdateResponse
- client.snippets.rules.list(zoneIdentifier) -> RuleListResponsesSinglePage
# Calls
Types:
- CallsApp
- CallsAppWithSecret
Methods:
- client.calls.create({ ...params }) -> CallsAppWithSecret
- client.calls.update(appId, { ...params }) -> CallsApp
- client.calls.list({ ...params }) -> CallsAppsSinglePage
- client.calls.delete(appId, { ...params }) -> CallsApp
- client.calls.get(appId, { ...params }) -> CallsApp
# CloudforceOne
## Requests
Types:
- CloudforceOneQuota
- CloudforceOneRequestConstants
- CloudforceOneRequestItem
- CloudforceOneRequestListItem
- CloudforceOneRequestTypes
- RequestDeleteResponse
Methods:
- client.cloudforceOne.requests.create(accountIdentifier, { ...params }) -> CloudforceOneRequestItem
- client.cloudforceOne.requests.update(accountIdentifier, requestIdentifier, { ...params }) -> CloudforceOneRequestItem
- client.cloudforceOne.requests.list(accountIdentifier, { ...params }) -> CloudforceOneRequestListItemsV4PagePaginationArray
- client.cloudforceOne.requests.delete(accountIdentifier, requestIdentifier) -> RequestDeleteResponse
- client.cloudforceOne.requests.constants(accountIdentifier) -> CloudforceOneRequestConstants
- client.cloudforceOne.requests.get(accountIdentifier, requestIdentifier) -> CloudforceOneRequestItem
- client.cloudforceOne.requests.quota(accountIdentifier) -> CloudforceOneQuota
- client.cloudforceOne.requests.types(accountIdentifier) -> CloudforceOneRequestTypes
### Message
Types:
- CloudforceOneRequestMessageItem
- MessageDeleteResponse
- MessageGetResponse
Methods:
- client.cloudforceOne.requests.message.create(accountIdentifier, requestIdentifier, { ...params }) -> CloudforceOneRequestMessageItem
- client.cloudforceOne.requests.message.update(accountIdentifier, requestIdentifier, messageIdentifer, { ...params }) -> CloudforceOneRequestMessageItem
- client.cloudforceOne.requests.message.delete(accountIdentifier, requestIdentifier, messageIdentifer) -> MessageDeleteResponse
- client.cloudforceOne.requests.message.get(accountIdentifier, requestIdentifier, { ...params }) -> MessageGetResponse
### Priority
Types:
- CloudforceOnePriorityItem
- PriorityDeleteResponse
Methods:
- client.cloudforceOne.requests.priority.create(accountIdentifier, { ...params }) -> CloudforceOnePriorityItem
- client.cloudforceOne.requests.priority.update(accountIdentifier, priorityIdentifer, { ...params }) -> CloudforceOneRequestItem
- client.cloudforceOne.requests.priority.delete(accountIdentifier, priorityIdentifer) -> PriorityDeleteResponse
- client.cloudforceOne.requests.priority.get(accountIdentifier, priorityIdentifer) -> CloudforceOneRequestItem
- client.cloudforceOne.requests.priority.quota(accountIdentifier) -> CloudforceOneQuota