api.md

Zones

Types:

• Type
• Zone
• ZoneDeleteResponse

Methods:

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

ActivationCheck

Types:

• ActivationCheckTriggerResponse

Methods:

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

Settings

Types:

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

Methods:

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

Environments

Types:

• EnvironmentCreateResponse
• EnvironmentUpdateResponse
• EnvironmentListResponse
• EnvironmentDeleteResponse
• EnvironmentEditResponse
• EnvironmentRollbackResponse

Methods:

• client.zones.environments.create({ ...params }) -> EnvironmentCreateResponse
• client.zones.environments.update({ ...params }) -> EnvironmentUpdateResponse
• client.zones.environments.list({ ...params }) -> EnvironmentListResponse
• client.zones.environments.delete(environmentId, { ...params }) -> EnvironmentDeleteResponse
• client.zones.environments.edit({ ...params }) -> EnvironmentEditResponse
• client.zones.environments.rollback(environmentId, { ...params }) -> EnvironmentRollbackResponse

CustomNameservers

Types:

• CustomNameserverUpdateResponse
• CustomNameserverGetResponse

Methods:

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

Holds

Types:

• ZoneHold

Methods:

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

Subscriptions

Types:

• SubscriptionCreateResponse
• SubscriptionUpdateResponse
• SubscriptionGetResponse

Methods:

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

Plans

Types:

• AvailableRatePlan

Methods:

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

RatePlans

Types:

• RatePlanGetResponse

Methods:

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