cloudflare/cloudflare-typescript
Publicmirrored from https://github.com/cloudflare/cloudflare-typescriptAvailable
api.md
6840lines · modecode
| 1 | # Shared |
| 2 | |
| 3 | Types: |
| 4 | |
| 5 | - <code><a href="./src/resources/shared.ts">ASN</a></code> |
| 6 | - <code><a href="./src/resources/shared.ts">AuditLog</a></code> |
| 7 | - <code><a href="./src/resources/shared.ts">CertificateCA</a></code> |
| 8 | - <code><a href="./src/resources/shared.ts">CertificateRequestType</a></code> |
| 9 | - <code><a href="./src/resources/shared.ts">CloudflareTunnel</a></code> |
| 10 | - <code><a href="./src/resources/shared.ts">ErrorData</a></code> |
| 11 | - <code><a href="./src/resources/shared.ts">Identifier</a></code> |
| 12 | - <code><a href="./src/resources/shared.ts">LoadBalancerPreview</a></code> |
| 13 | - <code><a href="./src/resources/shared.ts">Member</a></code> |
| 14 | - <code><a href="./src/resources/shared.ts">PaginationInfo</a></code> |
| 15 | - <code><a href="./src/resources/shared.ts">Permission</a></code> |
| 16 | - <code><a href="./src/resources/shared.ts">PermissionGrant</a></code> |
| 17 | - <code><a href="./src/resources/shared.ts">ResponseInfo</a></code> |
| 18 | - <code><a href="./src/resources/shared.ts">Result</a></code> |
| 19 | - <code><a href="./src/resources/shared.ts">Role</a></code> |
| 20 | - <code><a href="./src/resources/shared.ts">SortDirection</a></code> |
| 21 | |
| 22 | # Accounts |
| 23 | |
| 24 | Types: |
| 25 | |
| 26 | - <code><a href="./src/resources/accounts/accounts.ts">Account</a></code> |
| 27 | - <code><a href="./src/resources/accounts/accounts.ts">AccountUpdateResponse</a></code> |
| 28 | - <code><a href="./src/resources/accounts/accounts.ts">AccountListResponse</a></code> |
| 29 | - <code><a href="./src/resources/accounts/accounts.ts">AccountGetResponse</a></code> |
| 30 | |
| 31 | Methods: |
| 32 | |
| 33 | - <code title="put /accounts/{account_id}">client.accounts.<a href="./src/resources/accounts/accounts.ts">update</a>({ ...params }) -> AccountUpdateResponse</code> |
| 34 | - <code title="get /accounts">client.accounts.<a href="./src/resources/accounts/accounts.ts">list</a>({ ...params }) -> AccountListResponsesV4PagePaginationArray</code> |
| 35 | - <code title="get /accounts/{account_id}">client.accounts.<a href="./src/resources/accounts/accounts.ts">get</a>({ ...params }) -> AccountGetResponse</code> |
| 36 | |
| 37 | ## Members |
| 38 | |
| 39 | Types: |
| 40 | |
| 41 | - <code><a href="./src/resources/accounts/members.ts">Status</a></code> |
| 42 | - <code><a href="./src/resources/accounts/members.ts">UserWithInviteCode</a></code> |
| 43 | - <code><a href="./src/resources/accounts/members.ts">MemberCreateResponse</a></code> |
| 44 | - <code><a href="./src/resources/accounts/members.ts">MemberUpdateResponse</a></code> |
| 45 | - <code><a href="./src/resources/accounts/members.ts">MemberListResponse</a></code> |
| 46 | - <code><a href="./src/resources/accounts/members.ts">MemberDeleteResponse</a></code> |
| 47 | - <code><a href="./src/resources/accounts/members.ts">MemberGetResponse</a></code> |
| 48 | |
| 49 | Methods: |
| 50 | |
| 51 | - <code title="post /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">create</a>({ ...params }) -> MemberCreateResponse</code> |
| 52 | - <code title="put /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">update</a>(memberId, { ...params }) -> MemberUpdateResponse</code> |
| 53 | - <code title="get /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">list</a>({ ...params }) -> MemberListResponsesV4PagePaginationArray</code> |
| 54 | - <code title="delete /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">delete</a>(memberId, { ...params }) -> MemberDeleteResponse | null</code> |
| 55 | - <code title="get /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">get</a>(memberId, { ...params }) -> MemberGetResponse</code> |
| 56 | |
| 57 | ## Roles |
| 58 | |
| 59 | Types: |
| 60 | |
| 61 | - <code><a href="./src/resources/accounts/roles.ts">RoleGetResponse</a></code> |
| 62 | |
| 63 | Methods: |
| 64 | |
| 65 | - <code title="get /accounts/{account_id}/roles">client.accounts.roles.<a href="./src/resources/accounts/roles.ts">list</a>({ ...params }) -> RolesSinglePage</code> |
| 66 | - <code title="get /accounts/{account_id}/roles/{role_id}">client.accounts.roles.<a href="./src/resources/accounts/roles.ts">get</a>(roleId, { ...params }) -> RoleGetResponse</code> |
| 67 | |
| 68 | # OriginCACertificates |
| 69 | |
| 70 | Types: |
| 71 | |
| 72 | - <code><a href="./src/resources/origin-ca-certificates.ts">OriginCACertificate</a></code> |
| 73 | - <code><a href="./src/resources/origin-ca-certificates.ts">OriginCACertificateCreateResponse</a></code> |
| 74 | - <code><a href="./src/resources/origin-ca-certificates.ts">OriginCACertificateDeleteResponse</a></code> |
| 75 | - <code><a href="./src/resources/origin-ca-certificates.ts">OriginCACertificateGetResponse</a></code> |
| 76 | |
| 77 | Methods: |
| 78 | |
| 79 | - <code title="post /certificates">client.originCACertificates.<a href="./src/resources/origin-ca-certificates.ts">create</a>({ ...params }) -> OriginCACertificateCreateResponse</code> |
| 80 | - <code title="get /certificates">client.originCACertificates.<a href="./src/resources/origin-ca-certificates.ts">list</a>({ ...params }) -> OriginCACertificatesSinglePage</code> |
| 81 | - <code title="delete /certificates/{certificate_id}">client.originCACertificates.<a href="./src/resources/origin-ca-certificates.ts">delete</a>(certificateId) -> OriginCACertificateDeleteResponse</code> |
| 82 | - <code title="get /certificates/{certificate_id}">client.originCACertificates.<a href="./src/resources/origin-ca-certificates.ts">get</a>(certificateId) -> OriginCACertificateGetResponse</code> |
| 83 | |
| 84 | # IPs |
| 85 | |
| 86 | Types: |
| 87 | |
| 88 | - <code><a href="./src/resources/ips.ts">IPs</a></code> |
| 89 | - <code><a href="./src/resources/ips.ts">JDCloudIPs</a></code> |
| 90 | - <code><a href="./src/resources/ips.ts">IPListResponse</a></code> |
| 91 | |
| 92 | Methods: |
| 93 | |
| 94 | - <code title="get /ips">client.ips.<a href="./src/resources/ips.ts">list</a>({ ...params }) -> IPListResponse</code> |
| 95 | |
| 96 | # Memberships |
| 97 | |
| 98 | Types: |
| 99 | |
| 100 | - <code><a href="./src/resources/memberships.ts">Membership</a></code> |
| 101 | - <code><a href="./src/resources/memberships.ts">MembershipUpdateResponse</a></code> |
| 102 | - <code><a href="./src/resources/memberships.ts">MembershipDeleteResponse</a></code> |
| 103 | - <code><a href="./src/resources/memberships.ts">MembershipGetResponse</a></code> |
| 104 | |
| 105 | Methods: |
| 106 | |
| 107 | - <code title="put /memberships/{membership_id}">client.memberships.<a href="./src/resources/memberships.ts">update</a>(membershipId, { ...params }) -> MembershipUpdateResponse</code> |
| 108 | - <code title="get /memberships">client.memberships.<a href="./src/resources/memberships.ts">list</a>({ ...params }) -> MembershipsV4PagePaginationArray</code> |
| 109 | - <code title="delete /memberships/{membership_id}">client.memberships.<a href="./src/resources/memberships.ts">delete</a>(membershipId) -> MembershipDeleteResponse</code> |
| 110 | - <code title="get /memberships/{membership_id}">client.memberships.<a href="./src/resources/memberships.ts">get</a>(membershipId) -> MembershipGetResponse</code> |
| 111 | |
| 112 | # User |
| 113 | |
| 114 | Types: |
| 115 | |
| 116 | - <code><a href="./src/resources/user/user.ts">UserEditResponse</a></code> |
| 117 | - <code><a href="./src/resources/user/user.ts">UserGetResponse</a></code> |
| 118 | |
| 119 | Methods: |
| 120 | |
| 121 | - <code title="patch /user">client.user.<a href="./src/resources/user/user.ts">edit</a>({ ...params }) -> UserEditResponse</code> |
| 122 | - <code title="get /user">client.user.<a href="./src/resources/user/user.ts">get</a>() -> UserGetResponse</code> |
| 123 | |
| 124 | ## AuditLogs |
| 125 | |
| 126 | Methods: |
| 127 | |
| 128 | - <code title="get /user/audit_logs">client.user.auditLogs.<a href="./src/resources/user/audit-logs.ts">list</a>({ ...params }) -> AuditLogsV4PagePaginationArray</code> |
| 129 | |
| 130 | ## Billing |
| 131 | |
| 132 | ### History |
| 133 | |
| 134 | Types: |
| 135 | |
| 136 | - <code><a href="./src/resources/user/billing/history.ts">BillingHistory</a></code> |
| 137 | |
| 138 | Methods: |
| 139 | |
| 140 | - <code title="get /user/billing/history">client.user.billing.history.<a href="./src/resources/user/billing/history.ts">list</a>({ ...params }) -> BillingHistoriesV4PagePaginationArray</code> |
| 141 | |
| 142 | ### Profile |
| 143 | |
| 144 | Types: |
| 145 | |
| 146 | - <code><a href="./src/resources/user/billing/profile.ts">ProfileGetResponse</a></code> |
| 147 | |
| 148 | Methods: |
| 149 | |
| 150 | - <code title="get /user/billing/profile">client.user.billing.profile.<a href="./src/resources/user/billing/profile.ts">get</a>() -> ProfileGetResponse</code> |
| 151 | |
| 152 | ## Invites |
| 153 | |
| 154 | Types: |
| 155 | |
| 156 | - <code><a href="./src/resources/user/invites.ts">Invite</a></code> |
| 157 | - <code><a href="./src/resources/user/invites.ts">InviteEditResponse</a></code> |
| 158 | - <code><a href="./src/resources/user/invites.ts">InviteGetResponse</a></code> |
| 159 | |
| 160 | Methods: |
| 161 | |
| 162 | - <code title="get /user/invites">client.user.invites.<a href="./src/resources/user/invites.ts">list</a>() -> InvitesSinglePage</code> |
| 163 | - <code title="patch /user/invites/{invite_id}">client.user.invites.<a href="./src/resources/user/invites.ts">edit</a>(inviteId, { ...params }) -> InviteEditResponse</code> |
| 164 | - <code title="get /user/invites/{invite_id}">client.user.invites.<a href="./src/resources/user/invites.ts">get</a>(inviteId) -> InviteGetResponse</code> |
| 165 | |
| 166 | ## Organizations |
| 167 | |
| 168 | Types: |
| 169 | |
| 170 | - <code><a href="./src/resources/user/organizations.ts">Organization</a></code> |
| 171 | - <code><a href="./src/resources/user/organizations.ts">OrganizationDeleteResponse</a></code> |
| 172 | - <code><a href="./src/resources/user/organizations.ts">OrganizationGetResponse</a></code> |
| 173 | |
| 174 | Methods: |
| 175 | |
| 176 | - <code title="get /user/organizations">client.user.organizations.<a href="./src/resources/user/organizations.ts">list</a>({ ...params }) -> OrganizationsV4PagePaginationArray</code> |
| 177 | - <code title="delete /user/organizations/{organization_id}">client.user.organizations.<a href="./src/resources/user/organizations.ts">delete</a>(organizationId) -> OrganizationDeleteResponse</code> |
| 178 | - <code title="get /user/organizations/{organization_id}">client.user.organizations.<a href="./src/resources/user/organizations.ts">get</a>(organizationId) -> OrganizationGetResponse</code> |
| 179 | |
| 180 | ## Subscriptions |
| 181 | |
| 182 | Types: |
| 183 | |
| 184 | - <code><a href="./src/resources/user/subscriptions.ts">RatePlan</a></code> |
| 185 | - <code><a href="./src/resources/user/subscriptions.ts">Subscription</a></code> |
| 186 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionComponent</a></code> |
| 187 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionZone</a></code> |
| 188 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionUpdateResponse</a></code> |
| 189 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionDeleteResponse</a></code> |
| 190 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionEditResponse</a></code> |
| 191 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionGetResponse</a></code> |
| 192 | |
| 193 | Methods: |
| 194 | |
| 195 | - <code title="put /user/subscriptions/{identifier}">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">update</a>(identifier, { ...params }) -> SubscriptionUpdateResponse</code> |
| 196 | - <code title="delete /user/subscriptions/{identifier}">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">delete</a>(identifier) -> SubscriptionDeleteResponse</code> |
| 197 | - <code title="put /zones/{identifier}/subscription">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">edit</a>(identifier, { ...params }) -> SubscriptionEditResponse</code> |
| 198 | - <code title="get /user/subscriptions">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">get</a>() -> SubscriptionGetResponse | null</code> |
| 199 | |
| 200 | ## Tokens |
| 201 | |
| 202 | Types: |
| 203 | |
| 204 | - <code><a href="./src/resources/user/tokens/tokens.ts">CIDRList</a></code> |
| 205 | - <code><a href="./src/resources/user/tokens/tokens.ts">Policy</a></code> |
| 206 | - <code><a href="./src/resources/user/tokens/tokens.ts">Token</a></code> |
| 207 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenCreateResponse</a></code> |
| 208 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenUpdateResponse</a></code> |
| 209 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenListResponse</a></code> |
| 210 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenDeleteResponse</a></code> |
| 211 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenGetResponse</a></code> |
| 212 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenVerifyResponse</a></code> |
| 213 | |
| 214 | Methods: |
| 215 | |
| 216 | - <code title="post /user/tokens">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">create</a>({ ...params }) -> TokenCreateResponse</code> |
| 217 | - <code title="put /user/tokens/{token_id}">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">update</a>(tokenId, { ...params }) -> TokenUpdateResponse</code> |
| 218 | - <code title="get /user/tokens">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">list</a>({ ...params }) -> TokenListResponsesV4PagePaginationArray</code> |
| 219 | - <code title="delete /user/tokens/{token_id}">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">delete</a>(tokenId) -> TokenDeleteResponse | null</code> |
| 220 | - <code title="get /user/tokens/{token_id}">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">get</a>(tokenId) -> TokenGetResponse</code> |
| 221 | - <code title="get /user/tokens/verify">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">verify</a>() -> TokenVerifyResponse</code> |
| 222 | |
| 223 | ### PermissionGroups |
| 224 | |
| 225 | Types: |
| 226 | |
| 227 | - <code><a href="./src/resources/user/tokens/permission-groups.ts">PermissionGroupListResponse</a></code> |
| 228 | |
| 229 | Methods: |
| 230 | |
| 231 | - <code title="get /user/tokens/permission_groups">client.user.tokens.permissionGroups.<a href="./src/resources/user/tokens/permission-groups.ts">list</a>() -> PermissionGroupListResponsesSinglePage</code> |
| 232 | |
| 233 | ### Value |
| 234 | |
| 235 | Types: |
| 236 | |
| 237 | - <code><a href="./src/resources/user/tokens/value.ts">Value</a></code> |
| 238 | |
| 239 | Methods: |
| 240 | |
| 241 | - <code title="put /user/tokens/{token_id}/value">client.user.tokens.value.<a href="./src/resources/user/tokens/value.ts">update</a>(tokenId, { ...params }) -> Value</code> |
| 242 | |
| 243 | # Zones |
| 244 | |
| 245 | Types: |
| 246 | |
| 247 | - <code><a href="./src/resources/zones/zones.ts">Type</a></code> |
| 248 | - <code><a href="./src/resources/zones/zones.ts">Zone</a></code> |
| 249 | - <code><a href="./src/resources/zones/zones.ts">ZoneDeleteResponse</a></code> |
| 250 | |
| 251 | Methods: |
| 252 | |
| 253 | - <code title="post /zones">client.zones.<a href="./src/resources/zones/zones.ts">create</a>({ ...params }) -> Zone</code> |
| 254 | - <code title="get /zones">client.zones.<a href="./src/resources/zones/zones.ts">list</a>({ ...params }) -> ZonesV4PagePaginationArray</code> |
| 255 | - <code title="delete /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">delete</a>({ ...params }) -> ZoneDeleteResponse | null</code> |
| 256 | - <code title="patch /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">edit</a>({ ...params }) -> Zone</code> |
| 257 | - <code title="get /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">get</a>({ ...params }) -> Zone</code> |
| 258 | |
| 259 | ## ActivationCheck |
| 260 | |
| 261 | Types: |
| 262 | |
| 263 | - <code><a href="./src/resources/zones/activation-check.ts">ActivationCheckTriggerResponse</a></code> |
| 264 | |
| 265 | Methods: |
| 266 | |
| 267 | - <code title="put /zones/{zone_id}/activation_check">client.zones.activationCheck.<a href="./src/resources/zones/activation-check.ts">trigger</a>({ ...params }) -> ActivationCheckTriggerResponse</code> |
| 268 | |
| 269 | ## Settings |
| 270 | |
| 271 | ### ZeroRTT |
| 272 | |
| 273 | Types: |
| 274 | |
| 275 | - <code><a href="./src/resources/zones/settings/zero-rtt.ts">ZeroRTT</a></code> |
| 276 | |
| 277 | Methods: |
| 278 | |
| 279 | - <code title="patch /zones/{zone_id}/settings/0rtt">client.zones.settings.zeroRTT.<a href="./src/resources/zones/settings/zero-rtt.ts">edit</a>({ ...params }) -> ZeroRTT</code> |
| 280 | - <code title="get /zones/{zone_id}/settings/0rtt">client.zones.settings.zeroRTT.<a href="./src/resources/zones/settings/zero-rtt.ts">get</a>({ ...params }) -> ZeroRTT</code> |
| 281 | |
| 282 | ### AdvancedDDoS |
| 283 | |
| 284 | Types: |
| 285 | |
| 286 | - <code><a href="./src/resources/zones/settings/advanced-ddos.ts">AdvancedDDoS</a></code> |
| 287 | |
| 288 | Methods: |
| 289 | |
| 290 | - <code title="get /zones/{zone_id}/settings/advanced_ddos">client.zones.settings.advancedDDoS.<a href="./src/resources/zones/settings/advanced-ddos.ts">get</a>({ ...params }) -> AdvancedDDoS</code> |
| 291 | |
| 292 | ### AlwaysOnline |
| 293 | |
| 294 | Types: |
| 295 | |
| 296 | - <code><a href="./src/resources/zones/settings/always-online.ts">AlwaysOnline</a></code> |
| 297 | |
| 298 | Methods: |
| 299 | |
| 300 | - <code title="patch /zones/{zone_id}/settings/always_online">client.zones.settings.alwaysOnline.<a href="./src/resources/zones/settings/always-online.ts">edit</a>({ ...params }) -> AlwaysOnline</code> |
| 301 | - <code title="get /zones/{zone_id}/settings/always_online">client.zones.settings.alwaysOnline.<a href="./src/resources/zones/settings/always-online.ts">get</a>({ ...params }) -> AlwaysOnline</code> |
| 302 | |
| 303 | ### AlwaysUseHTTPS |
| 304 | |
| 305 | Types: |
| 306 | |
| 307 | - <code><a href="./src/resources/zones/settings/always-use-https.ts">AlwaysUseHTTPS</a></code> |
| 308 | |
| 309 | Methods: |
| 310 | |
| 311 | - <code title="patch /zones/{zone_id}/settings/always_use_https">client.zones.settings.alwaysUseHTTPS.<a href="./src/resources/zones/settings/always-use-https.ts">edit</a>({ ...params }) -> AlwaysUseHTTPS</code> |
| 312 | - <code title="get /zones/{zone_id}/settings/always_use_https">client.zones.settings.alwaysUseHTTPS.<a href="./src/resources/zones/settings/always-use-https.ts">get</a>({ ...params }) -> AlwaysUseHTTPS</code> |
| 313 | |
| 314 | ### AutomaticHTTPSRewrites |
| 315 | |
| 316 | Types: |
| 317 | |
| 318 | - <code><a href="./src/resources/zones/settings/automatic-https-rewrites.ts">AutomaticHTTPSRewrites</a></code> |
| 319 | |
| 320 | Methods: |
| 321 | |
| 322 | - <code title="patch /zones/{zone_id}/settings/automatic_https_rewrites">client.zones.settings.automaticHTTPSRewrites.<a href="./src/resources/zones/settings/automatic-https-rewrites.ts">edit</a>({ ...params }) -> AutomaticHTTPSRewrites</code> |
| 323 | - <code title="get /zones/{zone_id}/settings/automatic_https_rewrites">client.zones.settings.automaticHTTPSRewrites.<a href="./src/resources/zones/settings/automatic-https-rewrites.ts">get</a>({ ...params }) -> AutomaticHTTPSRewrites</code> |
| 324 | |
| 325 | ### AutomaticPlatformOptimization |
| 326 | |
| 327 | Types: |
| 328 | |
| 329 | - <code><a href="./src/resources/zones/settings/automatic-platform-optimization.ts">AutomaticPlatformOptimization</a></code> |
| 330 | |
| 331 | Methods: |
| 332 | |
| 333 | - <code title="patch /zones/{zone_id}/settings/automatic_platform_optimization">client.zones.settings.automaticPlatformOptimization.<a href="./src/resources/zones/settings/automatic-platform-optimization.ts">edit</a>({ ...params }) -> AutomaticPlatformOptimization</code> |
| 334 | - <code title="get /zones/{zone_id}/settings/automatic_platform_optimization">client.zones.settings.automaticPlatformOptimization.<a href="./src/resources/zones/settings/automatic-platform-optimization.ts">get</a>({ ...params }) -> AutomaticPlatformOptimization</code> |
| 335 | |
| 336 | ### Brotli |
| 337 | |
| 338 | Types: |
| 339 | |
| 340 | - <code><a href="./src/resources/zones/settings/brotli.ts">Brotli</a></code> |
| 341 | |
| 342 | Methods: |
| 343 | |
| 344 | - <code title="patch /zones/{zone_id}/settings/brotli">client.zones.settings.brotli.<a href="./src/resources/zones/settings/brotli.ts">edit</a>({ ...params }) -> Brotli</code> |
| 345 | - <code title="get /zones/{zone_id}/settings/brotli">client.zones.settings.brotli.<a href="./src/resources/zones/settings/brotli.ts">get</a>({ ...params }) -> Brotli</code> |
| 346 | |
| 347 | ### BrowserCacheTTL |
| 348 | |
| 349 | Types: |
| 350 | |
| 351 | - <code><a href="./src/resources/zones/settings/browser-cache-ttl.ts">BrowserCacheTTL</a></code> |
| 352 | |
| 353 | Methods: |
| 354 | |
| 355 | - <code title="patch /zones/{zone_id}/settings/browser_cache_ttl">client.zones.settings.browserCacheTTL.<a href="./src/resources/zones/settings/browser-cache-ttl.ts">edit</a>({ ...params }) -> BrowserCacheTTL</code> |
| 356 | - <code title="get /zones/{zone_id}/settings/browser_cache_ttl">client.zones.settings.browserCacheTTL.<a href="./src/resources/zones/settings/browser-cache-ttl.ts">get</a>({ ...params }) -> BrowserCacheTTL</code> |
| 357 | |
| 358 | ### BrowserCheck |
| 359 | |
| 360 | Types: |
| 361 | |
| 362 | - <code><a href="./src/resources/zones/settings/browser-check.ts">BrowserCheck</a></code> |
| 363 | |
| 364 | Methods: |
| 365 | |
| 366 | - <code title="patch /zones/{zone_id}/settings/browser_check">client.zones.settings.browserCheck.<a href="./src/resources/zones/settings/browser-check.ts">edit</a>({ ...params }) -> BrowserCheck</code> |
| 367 | - <code title="get /zones/{zone_id}/settings/browser_check">client.zones.settings.browserCheck.<a href="./src/resources/zones/settings/browser-check.ts">get</a>({ ...params }) -> BrowserCheck</code> |
| 368 | |
| 369 | ### CacheLevel |
| 370 | |
| 371 | Types: |
| 372 | |
| 373 | - <code><a href="./src/resources/zones/settings/cache-level.ts">CacheLevel</a></code> |
| 374 | |
| 375 | Methods: |
| 376 | |
| 377 | - <code title="patch /zones/{zone_id}/settings/cache_level">client.zones.settings.cacheLevel.<a href="./src/resources/zones/settings/cache-level.ts">edit</a>({ ...params }) -> CacheLevel</code> |
| 378 | - <code title="get /zones/{zone_id}/settings/cache_level">client.zones.settings.cacheLevel.<a href="./src/resources/zones/settings/cache-level.ts">get</a>({ ...params }) -> CacheLevel</code> |
| 379 | |
| 380 | ### ChallengeTTL |
| 381 | |
| 382 | Types: |
| 383 | |
| 384 | - <code><a href="./src/resources/zones/settings/challenge-ttl.ts">ChallengeTTL</a></code> |
| 385 | |
| 386 | Methods: |
| 387 | |
| 388 | - <code title="patch /zones/{zone_id}/settings/challenge_ttl">client.zones.settings.challengeTTL.<a href="./src/resources/zones/settings/challenge-ttl.ts">edit</a>({ ...params }) -> ChallengeTTL</code> |
| 389 | - <code title="get /zones/{zone_id}/settings/challenge_ttl">client.zones.settings.challengeTTL.<a href="./src/resources/zones/settings/challenge-ttl.ts">get</a>({ ...params }) -> ChallengeTTL</code> |
| 390 | |
| 391 | ### Ciphers |
| 392 | |
| 393 | Types: |
| 394 | |
| 395 | - <code><a href="./src/resources/zones/settings/ciphers.ts">Ciphers</a></code> |
| 396 | |
| 397 | Methods: |
| 398 | |
| 399 | - <code title="patch /zones/{zone_id}/settings/ciphers">client.zones.settings.ciphers.<a href="./src/resources/zones/settings/ciphers.ts">edit</a>({ ...params }) -> Ciphers</code> |
| 400 | - <code title="get /zones/{zone_id}/settings/ciphers">client.zones.settings.ciphers.<a href="./src/resources/zones/settings/ciphers.ts">get</a>({ ...params }) -> Ciphers</code> |
| 401 | |
| 402 | ### DevelopmentMode |
| 403 | |
| 404 | Types: |
| 405 | |
| 406 | - <code><a href="./src/resources/zones/settings/development-mode.ts">DevelopmentMode</a></code> |
| 407 | |
| 408 | Methods: |
| 409 | |
| 410 | - <code title="patch /zones/{zone_id}/settings/development_mode">client.zones.settings.developmentMode.<a href="./src/resources/zones/settings/development-mode.ts">edit</a>({ ...params }) -> DevelopmentMode</code> |
| 411 | - <code title="get /zones/{zone_id}/settings/development_mode">client.zones.settings.developmentMode.<a href="./src/resources/zones/settings/development-mode.ts">get</a>({ ...params }) -> DevelopmentMode</code> |
| 412 | |
| 413 | ### EarlyHints |
| 414 | |
| 415 | Types: |
| 416 | |
| 417 | - <code><a href="./src/resources/zones/settings/early-hints.ts">EarlyHints</a></code> |
| 418 | |
| 419 | Methods: |
| 420 | |
| 421 | - <code title="patch /zones/{zone_id}/settings/early_hints">client.zones.settings.earlyHints.<a href="./src/resources/zones/settings/early-hints.ts">edit</a>({ ...params }) -> EarlyHints</code> |
| 422 | - <code title="get /zones/{zone_id}/settings/early_hints">client.zones.settings.earlyHints.<a href="./src/resources/zones/settings/early-hints.ts">get</a>({ ...params }) -> EarlyHints</code> |
| 423 | |
| 424 | ### EmailObfuscation |
| 425 | |
| 426 | Types: |
| 427 | |
| 428 | - <code><a href="./src/resources/zones/settings/email-obfuscation.ts">EmailObfuscation</a></code> |
| 429 | |
| 430 | Methods: |
| 431 | |
| 432 | - <code title="patch /zones/{zone_id}/settings/email_obfuscation">client.zones.settings.emailObfuscation.<a href="./src/resources/zones/settings/email-obfuscation.ts">edit</a>({ ...params }) -> EmailObfuscation</code> |
| 433 | - <code title="get /zones/{zone_id}/settings/email_obfuscation">client.zones.settings.emailObfuscation.<a href="./src/resources/zones/settings/email-obfuscation.ts">get</a>({ ...params }) -> EmailObfuscation</code> |
| 434 | |
| 435 | ### H2Prioritization |
| 436 | |
| 437 | Types: |
| 438 | |
| 439 | - <code><a href="./src/resources/zones/settings/h2-prioritization.ts">H2Prioritization</a></code> |
| 440 | |
| 441 | Methods: |
| 442 | |
| 443 | - <code title="patch /zones/{zone_id}/settings/h2_prioritization">client.zones.settings.h2Prioritization.<a href="./src/resources/zones/settings/h2-prioritization.ts">edit</a>({ ...params }) -> H2Prioritization</code> |
| 444 | - <code title="get /zones/{zone_id}/settings/h2_prioritization">client.zones.settings.h2Prioritization.<a href="./src/resources/zones/settings/h2-prioritization.ts">get</a>({ ...params }) -> H2Prioritization</code> |
| 445 | |
| 446 | ### HotlinkProtection |
| 447 | |
| 448 | Types: |
| 449 | |
| 450 | - <code><a href="./src/resources/zones/settings/hotlink-protection.ts">HotlinkProtection</a></code> |
| 451 | |
| 452 | Methods: |
| 453 | |
| 454 | - <code title="patch /zones/{zone_id}/settings/hotlink_protection">client.zones.settings.hotlinkProtection.<a href="./src/resources/zones/settings/hotlink-protection.ts">edit</a>({ ...params }) -> HotlinkProtection</code> |
| 455 | - <code title="get /zones/{zone_id}/settings/hotlink_protection">client.zones.settings.hotlinkProtection.<a href="./src/resources/zones/settings/hotlink-protection.ts">get</a>({ ...params }) -> HotlinkProtection</code> |
| 456 | |
| 457 | ### HTTP2 |
| 458 | |
| 459 | Types: |
| 460 | |
| 461 | - <code><a href="./src/resources/zones/settings/http2.ts">HTTP2</a></code> |
| 462 | |
| 463 | Methods: |
| 464 | |
| 465 | - <code title="patch /zones/{zone_id}/settings/http2">client.zones.settings.http2.<a href="./src/resources/zones/settings/http2.ts">edit</a>({ ...params }) -> HTTP2</code> |
| 466 | - <code title="get /zones/{zone_id}/settings/http2">client.zones.settings.http2.<a href="./src/resources/zones/settings/http2.ts">get</a>({ ...params }) -> HTTP2</code> |
| 467 | |
| 468 | ### HTTP3 |
| 469 | |
| 470 | Types: |
| 471 | |
| 472 | - <code><a href="./src/resources/zones/settings/http3.ts">HTTP3</a></code> |
| 473 | |
| 474 | Methods: |
| 475 | |
| 476 | - <code title="patch /zones/{zone_id}/settings/http3">client.zones.settings.http3.<a href="./src/resources/zones/settings/http3.ts">edit</a>({ ...params }) -> HTTP3</code> |
| 477 | - <code title="get /zones/{zone_id}/settings/http3">client.zones.settings.http3.<a href="./src/resources/zones/settings/http3.ts">get</a>({ ...params }) -> HTTP3</code> |
| 478 | |
| 479 | ### ImageResizing |
| 480 | |
| 481 | Types: |
| 482 | |
| 483 | - <code><a href="./src/resources/zones/settings/image-resizing.ts">ImageResizing</a></code> |
| 484 | |
| 485 | Methods: |
| 486 | |
| 487 | - <code title="patch /zones/{zone_id}/settings/image_resizing">client.zones.settings.imageResizing.<a href="./src/resources/zones/settings/image-resizing.ts">edit</a>({ ...params }) -> ImageResizing</code> |
| 488 | - <code title="get /zones/{zone_id}/settings/image_resizing">client.zones.settings.imageResizing.<a href="./src/resources/zones/settings/image-resizing.ts">get</a>({ ...params }) -> ImageResizing</code> |
| 489 | |
| 490 | ### IPGeolocation |
| 491 | |
| 492 | Types: |
| 493 | |
| 494 | - <code><a href="./src/resources/zones/settings/ip-geolocation.ts">IPGeolocation</a></code> |
| 495 | |
| 496 | Methods: |
| 497 | |
| 498 | - <code title="patch /zones/{zone_id}/settings/ip_geolocation">client.zones.settings.ipGeolocation.<a href="./src/resources/zones/settings/ip-geolocation.ts">edit</a>({ ...params }) -> IPGeolocation</code> |
| 499 | - <code title="get /zones/{zone_id}/settings/ip_geolocation">client.zones.settings.ipGeolocation.<a href="./src/resources/zones/settings/ip-geolocation.ts">get</a>({ ...params }) -> IPGeolocation</code> |
| 500 | |
| 501 | ### IPV6 |
| 502 | |
| 503 | Types: |
| 504 | |
| 505 | - <code><a href="./src/resources/zones/settings/ipv6.ts">IPV6</a></code> |
| 506 | |
| 507 | Methods: |
| 508 | |
| 509 | - <code title="patch /zones/{zone_id}/settings/ipv6">client.zones.settings.ipv6.<a href="./src/resources/zones/settings/ipv6.ts">edit</a>({ ...params }) -> IPV6</code> |
| 510 | - <code title="get /zones/{zone_id}/settings/ipv6">client.zones.settings.ipv6.<a href="./src/resources/zones/settings/ipv6.ts">get</a>({ ...params }) -> IPV6</code> |
| 511 | |
| 512 | ### MinTLSVersion |
| 513 | |
| 514 | Types: |
| 515 | |
| 516 | - <code><a href="./src/resources/zones/settings/min-tls-version.ts">MinTLSVersion</a></code> |
| 517 | |
| 518 | Methods: |
| 519 | |
| 520 | - <code title="patch /zones/{zone_id}/settings/min_tls_version">client.zones.settings.minTLSVersion.<a href="./src/resources/zones/settings/min-tls-version.ts">edit</a>({ ...params }) -> MinTLSVersion</code> |
| 521 | - <code title="get /zones/{zone_id}/settings/min_tls_version">client.zones.settings.minTLSVersion.<a href="./src/resources/zones/settings/min-tls-version.ts">get</a>({ ...params }) -> MinTLSVersion</code> |
| 522 | |
| 523 | ### Minify |
| 524 | |
| 525 | Types: |
| 526 | |
| 527 | - <code><a href="./src/resources/zones/settings/minify.ts">Minify</a></code> |
| 528 | |
| 529 | Methods: |
| 530 | |
| 531 | - <code title="patch /zones/{zone_id}/settings/minify">client.zones.settings.minify.<a href="./src/resources/zones/settings/minify.ts">edit</a>({ ...params }) -> Minify</code> |
| 532 | - <code title="get /zones/{zone_id}/settings/minify">client.zones.settings.minify.<a href="./src/resources/zones/settings/minify.ts">get</a>({ ...params }) -> Minify</code> |
| 533 | |
| 534 | ### Mirage |
| 535 | |
| 536 | Types: |
| 537 | |
| 538 | - <code><a href="./src/resources/zones/settings/mirage.ts">Mirage</a></code> |
| 539 | |
| 540 | Methods: |
| 541 | |
| 542 | - <code title="patch /zones/{zone_id}/settings/mirage">client.zones.settings.mirage.<a href="./src/resources/zones/settings/mirage.ts">edit</a>({ ...params }) -> Mirage</code> |
| 543 | - <code title="get /zones/{zone_id}/settings/mirage">client.zones.settings.mirage.<a href="./src/resources/zones/settings/mirage.ts">get</a>({ ...params }) -> Mirage</code> |
| 544 | |
| 545 | ### MobileRedirect |
| 546 | |
| 547 | Types: |
| 548 | |
| 549 | - <code><a href="./src/resources/zones/settings/mobile-redirect.ts">MobileRedirect</a></code> |
| 550 | |
| 551 | Methods: |
| 552 | |
| 553 | - <code title="patch /zones/{zone_id}/settings/mobile_redirect">client.zones.settings.mobileRedirect.<a href="./src/resources/zones/settings/mobile-redirect.ts">edit</a>({ ...params }) -> MobileRedirect</code> |
| 554 | - <code title="get /zones/{zone_id}/settings/mobile_redirect">client.zones.settings.mobileRedirect.<a href="./src/resources/zones/settings/mobile-redirect.ts">get</a>({ ...params }) -> MobileRedirect</code> |
| 555 | |
| 556 | ### NEL |
| 557 | |
| 558 | Types: |
| 559 | |
| 560 | - <code><a href="./src/resources/zones/settings/nel.ts">NEL</a></code> |
| 561 | |
| 562 | Methods: |
| 563 | |
| 564 | - <code title="patch /zones/{zone_id}/settings/nel">client.zones.settings.nel.<a href="./src/resources/zones/settings/nel.ts">edit</a>({ ...params }) -> NEL</code> |
| 565 | - <code title="get /zones/{zone_id}/settings/nel">client.zones.settings.nel.<a href="./src/resources/zones/settings/nel.ts">get</a>({ ...params }) -> NEL</code> |
| 566 | |
| 567 | ### OpportunisticEncryption |
| 568 | |
| 569 | Types: |
| 570 | |
| 571 | - <code><a href="./src/resources/zones/settings/opportunistic-encryption.ts">OpportunisticEncryption</a></code> |
| 572 | |
| 573 | Methods: |
| 574 | |
| 575 | - <code title="patch /zones/{zone_id}/settings/opportunistic_encryption">client.zones.settings.opportunisticEncryption.<a href="./src/resources/zones/settings/opportunistic-encryption.ts">edit</a>({ ...params }) -> OpportunisticEncryption</code> |
| 576 | - <code title="get /zones/{zone_id}/settings/opportunistic_encryption">client.zones.settings.opportunisticEncryption.<a href="./src/resources/zones/settings/opportunistic-encryption.ts">get</a>({ ...params }) -> OpportunisticEncryption</code> |
| 577 | |
| 578 | ### OpportunisticOnion |
| 579 | |
| 580 | Types: |
| 581 | |
| 582 | - <code><a href="./src/resources/zones/settings/opportunistic-onion.ts">OpportunisticOnion</a></code> |
| 583 | |
| 584 | Methods: |
| 585 | |
| 586 | - <code title="patch /zones/{zone_id}/settings/opportunistic_onion">client.zones.settings.opportunisticOnion.<a href="./src/resources/zones/settings/opportunistic-onion.ts">edit</a>({ ...params }) -> OpportunisticOnion</code> |
| 587 | - <code title="get /zones/{zone_id}/settings/opportunistic_onion">client.zones.settings.opportunisticOnion.<a href="./src/resources/zones/settings/opportunistic-onion.ts">get</a>({ ...params }) -> OpportunisticOnion</code> |
| 588 | |
| 589 | ### OrangeToOrange |
| 590 | |
| 591 | Types: |
| 592 | |
| 593 | - <code><a href="./src/resources/zones/settings/orange-to-orange.ts">OrangeToOrange</a></code> |
| 594 | |
| 595 | Methods: |
| 596 | |
| 597 | - <code title="patch /zones/{zone_id}/settings/orange_to_orange">client.zones.settings.orangeToOrange.<a href="./src/resources/zones/settings/orange-to-orange.ts">edit</a>({ ...params }) -> OrangeToOrange</code> |
| 598 | - <code title="get /zones/{zone_id}/settings/orange_to_orange">client.zones.settings.orangeToOrange.<a href="./src/resources/zones/settings/orange-to-orange.ts">get</a>({ ...params }) -> OrangeToOrange</code> |
| 599 | |
| 600 | ### OriginErrorPagePassThru |
| 601 | |
| 602 | Types: |
| 603 | |
| 604 | - <code><a href="./src/resources/zones/settings/origin-error-page-pass-thru.ts">OriginErrorPagePassThru</a></code> |
| 605 | |
| 606 | Methods: |
| 607 | |
| 608 | - <code title="patch /zones/{zone_id}/settings/origin_error_page_pass_thru">client.zones.settings.originErrorPagePassThru.<a href="./src/resources/zones/settings/origin-error-page-pass-thru.ts">edit</a>({ ...params }) -> OriginErrorPagePassThru</code> |
| 609 | - <code title="get /zones/{zone_id}/settings/origin_error_page_pass_thru">client.zones.settings.originErrorPagePassThru.<a href="./src/resources/zones/settings/origin-error-page-pass-thru.ts">get</a>({ ...params }) -> OriginErrorPagePassThru</code> |
| 610 | |
| 611 | ### OriginMaxHTTPVersion |
| 612 | |
| 613 | Types: |
| 614 | |
| 615 | - <code><a href="./src/resources/zones/settings/origin-max-http-version.ts">OriginMaxHTTPVersion</a></code> |
| 616 | - <code><a href="./src/resources/zones/settings/origin-max-http-version.ts">OriginMaxHTTPVersionEditResponse</a></code> |
| 617 | - <code><a href="./src/resources/zones/settings/origin-max-http-version.ts">OriginMaxHTTPVersionGetResponse</a></code> |
| 618 | |
| 619 | Methods: |
| 620 | |
| 621 | - <code title="patch /zones/{zone_id}/settings/origin_max_http_version">client.zones.settings.originMaxHTTPVersion.<a href="./src/resources/zones/settings/origin-max-http-version.ts">edit</a>({ ...params }) -> OriginMaxHTTPVersionEditResponse</code> |
| 622 | - <code title="get /zones/{zone_id}/settings/origin_max_http_version">client.zones.settings.originMaxHTTPVersion.<a href="./src/resources/zones/settings/origin-max-http-version.ts">get</a>({ ...params }) -> OriginMaxHTTPVersionGetResponse</code> |
| 623 | |
| 624 | ### Polish |
| 625 | |
| 626 | Types: |
| 627 | |
| 628 | - <code><a href="./src/resources/zones/settings/polish.ts">Polish</a></code> |
| 629 | |
| 630 | Methods: |
| 631 | |
| 632 | - <code title="patch /zones/{zone_id}/settings/polish">client.zones.settings.polish.<a href="./src/resources/zones/settings/polish.ts">edit</a>({ ...params }) -> Polish</code> |
| 633 | - <code title="get /zones/{zone_id}/settings/polish">client.zones.settings.polish.<a href="./src/resources/zones/settings/polish.ts">get</a>({ ...params }) -> Polish</code> |
| 634 | |
| 635 | ### PrefetchPreload |
| 636 | |
| 637 | Types: |
| 638 | |
| 639 | - <code><a href="./src/resources/zones/settings/prefetch-preload.ts">PrefetchPreload</a></code> |
| 640 | |
| 641 | Methods: |
| 642 | |
| 643 | - <code title="patch /zones/{zone_id}/settings/prefetch_preload">client.zones.settings.prefetchPreload.<a href="./src/resources/zones/settings/prefetch-preload.ts">edit</a>({ ...params }) -> PrefetchPreload</code> |
| 644 | - <code title="get /zones/{zone_id}/settings/prefetch_preload">client.zones.settings.prefetchPreload.<a href="./src/resources/zones/settings/prefetch-preload.ts">get</a>({ ...params }) -> PrefetchPreload</code> |
| 645 | |
| 646 | ### ProxyReadTimeout |
| 647 | |
| 648 | Types: |
| 649 | |
| 650 | - <code><a href="./src/resources/zones/settings/proxy-read-timeout.ts">ProxyReadTimeout</a></code> |
| 651 | |
| 652 | Methods: |
| 653 | |
| 654 | - <code title="patch /zones/{zone_id}/settings/proxy_read_timeout">client.zones.settings.proxyReadTimeout.<a href="./src/resources/zones/settings/proxy-read-timeout.ts">edit</a>({ ...params }) -> ProxyReadTimeout</code> |
| 655 | - <code title="get /zones/{zone_id}/settings/proxy_read_timeout">client.zones.settings.proxyReadTimeout.<a href="./src/resources/zones/settings/proxy-read-timeout.ts">get</a>({ ...params }) -> ProxyReadTimeout</code> |
| 656 | |
| 657 | ### PseudoIPV4 |
| 658 | |
| 659 | Types: |
| 660 | |
| 661 | - <code><a href="./src/resources/zones/settings/pseudo-ipv4.ts">PseudoIPV4</a></code> |
| 662 | |
| 663 | Methods: |
| 664 | |
| 665 | - <code title="patch /zones/{zone_id}/settings/pseudo_ipv4">client.zones.settings.pseudoIPV4.<a href="./src/resources/zones/settings/pseudo-ipv4.ts">edit</a>({ ...params }) -> PseudoIPV4</code> |
| 666 | - <code title="get /zones/{zone_id}/settings/pseudo_ipv4">client.zones.settings.pseudoIPV4.<a href="./src/resources/zones/settings/pseudo-ipv4.ts">get</a>({ ...params }) -> PseudoIPV4</code> |
| 667 | |
| 668 | ### ResponseBuffering |
| 669 | |
| 670 | Types: |
| 671 | |
| 672 | - <code><a href="./src/resources/zones/settings/response-buffering.ts">ResponseBuffering</a></code> |
| 673 | |
| 674 | Methods: |
| 675 | |
| 676 | - <code title="patch /zones/{zone_id}/settings/response_buffering">client.zones.settings.responseBuffering.<a href="./src/resources/zones/settings/response-buffering.ts">edit</a>({ ...params }) -> ResponseBuffering</code> |
| 677 | - <code title="get /zones/{zone_id}/settings/response_buffering">client.zones.settings.responseBuffering.<a href="./src/resources/zones/settings/response-buffering.ts">get</a>({ ...params }) -> ResponseBuffering</code> |
| 678 | |
| 679 | ### RocketLoader |
| 680 | |
| 681 | Types: |
| 682 | |
| 683 | - <code><a href="./src/resources/zones/settings/rocket-loader.ts">RocketLoader</a></code> |
| 684 | |
| 685 | Methods: |
| 686 | |
| 687 | - <code title="patch /zones/{zone_id}/settings/rocket_loader">client.zones.settings.rocketLoader.<a href="./src/resources/zones/settings/rocket-loader.ts">edit</a>({ ...params }) -> RocketLoader</code> |
| 688 | - <code title="get /zones/{zone_id}/settings/rocket_loader">client.zones.settings.rocketLoader.<a href="./src/resources/zones/settings/rocket-loader.ts">get</a>({ ...params }) -> RocketLoader</code> |
| 689 | |
| 690 | ### SecurityHeaders |
| 691 | |
| 692 | Types: |
| 693 | |
| 694 | - <code><a href="./src/resources/zones/settings/security-headers.ts">SecurityHeaders</a></code> |
| 695 | |
| 696 | Methods: |
| 697 | |
| 698 | - <code title="patch /zones/{zone_id}/settings/security_header">client.zones.settings.securityHeaders.<a href="./src/resources/zones/settings/security-headers.ts">edit</a>({ ...params }) -> SecurityHeaders</code> |
| 699 | - <code title="get /zones/{zone_id}/settings/security_header">client.zones.settings.securityHeaders.<a href="./src/resources/zones/settings/security-headers.ts">get</a>({ ...params }) -> SecurityHeaders</code> |
| 700 | |
| 701 | ### SecurityLevel |
| 702 | |
| 703 | Types: |
| 704 | |
| 705 | - <code><a href="./src/resources/zones/settings/security-level.ts">SecurityLevel</a></code> |
| 706 | |
| 707 | Methods: |
| 708 | |
| 709 | - <code title="patch /zones/{zone_id}/settings/security_level">client.zones.settings.securityLevel.<a href="./src/resources/zones/settings/security-level.ts">edit</a>({ ...params }) -> SecurityLevel</code> |
| 710 | - <code title="get /zones/{zone_id}/settings/security_level">client.zones.settings.securityLevel.<a href="./src/resources/zones/settings/security-level.ts">get</a>({ ...params }) -> SecurityLevel</code> |
| 711 | |
| 712 | ### ServerSideExcludes |
| 713 | |
| 714 | Types: |
| 715 | |
| 716 | - <code><a href="./src/resources/zones/settings/server-side-excludes.ts">ServerSideExcludes</a></code> |
| 717 | |
| 718 | Methods: |
| 719 | |
| 720 | - <code title="patch /zones/{zone_id}/settings/server_side_exclude">client.zones.settings.serverSideExcludes.<a href="./src/resources/zones/settings/server-side-excludes.ts">edit</a>({ ...params }) -> ServerSideExcludes</code> |
| 721 | - <code title="get /zones/{zone_id}/settings/server_side_exclude">client.zones.settings.serverSideExcludes.<a href="./src/resources/zones/settings/server-side-excludes.ts">get</a>({ ...params }) -> ServerSideExcludes</code> |
| 722 | |
| 723 | ### SortQueryStringForCache |
| 724 | |
| 725 | Types: |
| 726 | |
| 727 | - <code><a href="./src/resources/zones/settings/sort-query-string-for-cache.ts">SortQueryStringForCache</a></code> |
| 728 | |
| 729 | Methods: |
| 730 | |
| 731 | - <code title="patch /zones/{zone_id}/settings/sort_query_string_for_cache">client.zones.settings.sortQueryStringForCache.<a href="./src/resources/zones/settings/sort-query-string-for-cache.ts">edit</a>({ ...params }) -> SortQueryStringForCache</code> |
| 732 | - <code title="get /zones/{zone_id}/settings/sort_query_string_for_cache">client.zones.settings.sortQueryStringForCache.<a href="./src/resources/zones/settings/sort-query-string-for-cache.ts">get</a>({ ...params }) -> SortQueryStringForCache</code> |
| 733 | |
| 734 | ### SSL |
| 735 | |
| 736 | Types: |
| 737 | |
| 738 | - <code><a href="./src/resources/zones/settings/ssl.ts">SSL</a></code> |
| 739 | |
| 740 | Methods: |
| 741 | |
| 742 | - <code title="patch /zones/{zone_id}/settings/ssl">client.zones.settings.ssl.<a href="./src/resources/zones/settings/ssl.ts">edit</a>({ ...params }) -> SSL</code> |
| 743 | - <code title="get /zones/{zone_id}/settings/ssl">client.zones.settings.ssl.<a href="./src/resources/zones/settings/ssl.ts">get</a>({ ...params }) -> SSL</code> |
| 744 | |
| 745 | ### SSLRecommender |
| 746 | |
| 747 | Types: |
| 748 | |
| 749 | - <code><a href="./src/resources/zones/settings/ssl-recommender.ts">SSLRecommender</a></code> |
| 750 | |
| 751 | Methods: |
| 752 | |
| 753 | - <code title="patch /zones/{zone_id}/settings/ssl_recommender">client.zones.settings.sslRecommender.<a href="./src/resources/zones/settings/ssl-recommender.ts">edit</a>({ ...params }) -> SSLRecommender</code> |
| 754 | - <code title="get /zones/{zone_id}/settings/ssl_recommender">client.zones.settings.sslRecommender.<a href="./src/resources/zones/settings/ssl-recommender.ts">get</a>({ ...params }) -> SSLRecommender</code> |
| 755 | |
| 756 | ### TLS1_3 |
| 757 | |
| 758 | Types: |
| 759 | |
| 760 | - <code><a href="./src/resources/zones/settings/tls-1-3.ts">TLS1_3</a></code> |
| 761 | |
| 762 | Methods: |
| 763 | |
| 764 | - <code title="patch /zones/{zone_id}/settings/tls_1_3">client.zones.settings.tls1_3.<a href="./src/resources/zones/settings/tls-1-3.ts">edit</a>({ ...params }) -> TLS1_3</code> |
| 765 | - <code title="get /zones/{zone_id}/settings/tls_1_3">client.zones.settings.tls1_3.<a href="./src/resources/zones/settings/tls-1-3.ts">get</a>({ ...params }) -> TLS1_3</code> |
| 766 | |
| 767 | ### TLSClientAuth |
| 768 | |
| 769 | Types: |
| 770 | |
| 771 | - <code><a href="./src/resources/zones/settings/tls-client-auth.ts">TLSClientAuth</a></code> |
| 772 | |
| 773 | Methods: |
| 774 | |
| 775 | - <code title="patch /zones/{zone_id}/settings/tls_client_auth">client.zones.settings.tlsClientAuth.<a href="./src/resources/zones/settings/tls-client-auth.ts">edit</a>({ ...params }) -> TLSClientAuth</code> |
| 776 | - <code title="get /zones/{zone_id}/settings/tls_client_auth">client.zones.settings.tlsClientAuth.<a href="./src/resources/zones/settings/tls-client-auth.ts">get</a>({ ...params }) -> TLSClientAuth</code> |
| 777 | |
| 778 | ### TrueClientIPHeader |
| 779 | |
| 780 | Types: |
| 781 | |
| 782 | - <code><a href="./src/resources/zones/settings/true-client-ip-header.ts">TrueClientIPHeader</a></code> |
| 783 | |
| 784 | Methods: |
| 785 | |
| 786 | - <code title="patch /zones/{zone_id}/settings/true_client_ip_header">client.zones.settings.trueClientIPHeader.<a href="./src/resources/zones/settings/true-client-ip-header.ts">edit</a>({ ...params }) -> TrueClientIPHeader</code> |
| 787 | - <code title="get /zones/{zone_id}/settings/true_client_ip_header">client.zones.settings.trueClientIPHeader.<a href="./src/resources/zones/settings/true-client-ip-header.ts">get</a>({ ...params }) -> TrueClientIPHeader</code> |
| 788 | |
| 789 | ### WAF |
| 790 | |
| 791 | Types: |
| 792 | |
| 793 | - <code><a href="./src/resources/zones/settings/waf.ts">WAF</a></code> |
| 794 | |
| 795 | Methods: |
| 796 | |
| 797 | - <code title="patch /zones/{zone_id}/settings/waf">client.zones.settings.waf.<a href="./src/resources/zones/settings/waf.ts">edit</a>({ ...params }) -> WAF</code> |
| 798 | - <code title="get /zones/{zone_id}/settings/waf">client.zones.settings.waf.<a href="./src/resources/zones/settings/waf.ts">get</a>({ ...params }) -> WAF</code> |
| 799 | |
| 800 | ### WebP |
| 801 | |
| 802 | Types: |
| 803 | |
| 804 | - <code><a href="./src/resources/zones/settings/webp.ts">WebP</a></code> |
| 805 | |
| 806 | Methods: |
| 807 | |
| 808 | - <code title="patch /zones/{zone_id}/settings/webp">client.zones.settings.WebP.<a href="./src/resources/zones/settings/webp.ts">edit</a>({ ...params }) -> WebP</code> |
| 809 | - <code title="get /zones/{zone_id}/settings/webp">client.zones.settings.WebP.<a href="./src/resources/zones/settings/webp.ts">get</a>({ ...params }) -> WebP</code> |
| 810 | |
| 811 | ### Websocket |
| 812 | |
| 813 | Types: |
| 814 | |
| 815 | - <code><a href="./src/resources/zones/settings/websocket.ts">Websocket</a></code> |
| 816 | |
| 817 | Methods: |
| 818 | |
| 819 | - <code title="patch /zones/{zone_id}/settings/websockets">client.zones.settings.websocket.<a href="./src/resources/zones/settings/websocket.ts">edit</a>({ ...params }) -> Websocket</code> |
| 820 | - <code title="get /zones/{zone_id}/settings/websockets">client.zones.settings.websocket.<a href="./src/resources/zones/settings/websocket.ts">get</a>({ ...params }) -> Websocket</code> |
| 821 | |
| 822 | ### FontSettings |
| 823 | |
| 824 | Types: |
| 825 | |
| 826 | - <code><a href="./src/resources/zones/settings/font-settings.ts">FontSettings</a></code> |
| 827 | |
| 828 | Methods: |
| 829 | |
| 830 | - <code title="patch /zones/{zone_id}/settings/fonts">client.zones.settings.fontSettings.<a href="./src/resources/zones/settings/font-settings.ts">edit</a>({ ...params }) -> FontSettings</code> |
| 831 | - <code title="get /zones/{zone_id}/settings/fonts">client.zones.settings.fontSettings.<a href="./src/resources/zones/settings/font-settings.ts">get</a>({ ...params }) -> FontSettings</code> |
| 832 | |
| 833 | ## CustomNameservers |
| 834 | |
| 835 | Types: |
| 836 | |
| 837 | - <code><a href="./src/resources/zones/custom-nameservers.ts">CustomNameserverUpdateResponse</a></code> |
| 838 | - <code><a href="./src/resources/zones/custom-nameservers.ts">CustomNameserverGetResponse</a></code> |
| 839 | |
| 840 | Methods: |
| 841 | |
| 842 | - <code title="put /zones/{zone_id}/custom_ns">client.zones.customNameservers.<a href="./src/resources/zones/custom-nameservers.ts">update</a>({ ...params }) -> CustomNameserverUpdateResponse | null</code> |
| 843 | - <code title="get /zones/{zone_id}/custom_ns">client.zones.customNameservers.<a href="./src/resources/zones/custom-nameservers.ts">get</a>({ ...params }) -> CustomNameserverGetResponse | null</code> |
| 844 | |
| 845 | ## Holds |
| 846 | |
| 847 | Types: |
| 848 | |
| 849 | - <code><a href="./src/resources/zones/holds.ts">ZoneHold</a></code> |
| 850 | |
| 851 | Methods: |
| 852 | |
| 853 | - <code title="post /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">create</a>({ ...params }) -> ZoneHold</code> |
| 854 | - <code title="delete /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">delete</a>({ ...params }) -> ZoneHold</code> |
| 855 | - <code title="get /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">get</a>({ ...params }) -> ZoneHold</code> |
| 856 | |
| 857 | ## Subscriptions |
| 858 | |
| 859 | Types: |
| 860 | |
| 861 | - <code><a href="./src/resources/zones/subscriptions.ts">SubscriptionCreateResponse</a></code> |
| 862 | - <code><a href="./src/resources/zones/subscriptions.ts">SubscriptionGetResponse</a></code> |
| 863 | |
| 864 | Methods: |
| 865 | |
| 866 | - <code title="post /zones/{identifier}/subscription">client.zones.subscriptions.<a href="./src/resources/zones/subscriptions.ts">create</a>(identifier, { ...params }) -> SubscriptionCreateResponse</code> |
| 867 | - <code title="get /accounts/{account_identifier}/subscriptions">client.zones.subscriptions.<a href="./src/resources/zones/subscriptions.ts">list</a>(accountIdentifier) -> SubscriptionsSinglePage</code> |
| 868 | - <code title="get /zones/{identifier}/subscription">client.zones.subscriptions.<a href="./src/resources/zones/subscriptions.ts">get</a>(identifier) -> SubscriptionGetResponse</code> |
| 869 | |
| 870 | # LoadBalancers |
| 871 | |
| 872 | Types: |
| 873 | |
| 874 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">AdaptiveRouting</a></code> |
| 875 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">CheckRegion</a></code> |
| 876 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">DefaultPools</a></code> |
| 877 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">FilterOptions</a></code> |
| 878 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">Header</a></code> |
| 879 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">Host</a></code> |
| 880 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">LoadBalancer</a></code> |
| 881 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">LoadShedding</a></code> |
| 882 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">LocationStrategy</a></code> |
| 883 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">NotificationFilter</a></code> |
| 884 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">Origin</a></code> |
| 885 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">OriginSteering</a></code> |
| 886 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">RandomSteering</a></code> |
| 887 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">Rules</a></code> |
| 888 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">SessionAffinity</a></code> |
| 889 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">SessionAffinityAttributes</a></code> |
| 890 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">SteeringPolicy</a></code> |
| 891 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">LoadBalancerDeleteResponse</a></code> |
| 892 | |
| 893 | Methods: |
| 894 | |
| 895 | - <code title="post /zones/{zone_id}/load_balancers">client.loadBalancers.<a href="./src/resources/load-balancers/load-balancers.ts">create</a>({ ...params }) -> LoadBalancer</code> |
| 896 | - <code title="put /zones/{zone_id}/load_balancers/{load_balancer_id}">client.loadBalancers.<a href="./src/resources/load-balancers/load-balancers.ts">update</a>(loadBalancerId, { ...params }) -> LoadBalancer</code> |
| 897 | - <code title="get /zones/{zone_id}/load_balancers">client.loadBalancers.<a href="./src/resources/load-balancers/load-balancers.ts">list</a>({ ...params }) -> LoadBalancersSinglePage</code> |
| 898 | - <code title="delete /zones/{zone_id}/load_balancers/{load_balancer_id}">client.loadBalancers.<a href="./src/resources/load-balancers/load-balancers.ts">delete</a>(loadBalancerId, { ...params }) -> LoadBalancerDeleteResponse</code> |
| 899 | - <code title="patch /zones/{zone_id}/load_balancers/{load_balancer_id}">client.loadBalancers.<a href="./src/resources/load-balancers/load-balancers.ts">edit</a>(loadBalancerId, { ...params }) -> LoadBalancer</code> |
| 900 | - <code title="get /zones/{zone_id}/load_balancers/{load_balancer_id}">client.loadBalancers.<a href="./src/resources/load-balancers/load-balancers.ts">get</a>(loadBalancerId, { ...params }) -> LoadBalancer</code> |
| 901 | |
| 902 | ## Monitors |
| 903 | |
| 904 | Types: |
| 905 | |
| 906 | - <code><a href="./src/resources/load-balancers/monitors/monitors.ts">Monitor</a></code> |
| 907 | - <code><a href="./src/resources/load-balancers/monitors/monitors.ts">MonitorDeleteResponse</a></code> |
| 908 | |
| 909 | Methods: |
| 910 | |
| 911 | - <code title="post /accounts/{account_id}/load_balancers/monitors">client.loadBalancers.monitors.<a href="./src/resources/load-balancers/monitors/monitors.ts">create</a>({ ...params }) -> Monitor</code> |
| 912 | - <code title="put /accounts/{account_id}/load_balancers/monitors/{monitor_id}">client.loadBalancers.monitors.<a href="./src/resources/load-balancers/monitors/monitors.ts">update</a>(monitorId, { ...params }) -> Monitor</code> |
| 913 | - <code title="get /accounts/{account_id}/load_balancers/monitors">client.loadBalancers.monitors.<a href="./src/resources/load-balancers/monitors/monitors.ts">list</a>({ ...params }) -> MonitorsSinglePage</code> |
| 914 | - <code title="delete /accounts/{account_id}/load_balancers/monitors/{monitor_id}">client.loadBalancers.monitors.<a href="./src/resources/load-balancers/monitors/monitors.ts">delete</a>(monitorId, { ...params }) -> MonitorDeleteResponse</code> |
| 915 | - <code title="patch /accounts/{account_id}/load_balancers/monitors/{monitor_id}">client.loadBalancers.monitors.<a href="./src/resources/load-balancers/monitors/monitors.ts">edit</a>(monitorId, { ...params }) -> Monitor</code> |
| 916 | - <code title="get /accounts/{account_id}/load_balancers/monitors/{monitor_id}">client.loadBalancers.monitors.<a href="./src/resources/load-balancers/monitors/monitors.ts">get</a>(monitorId, { ...params }) -> Monitor</code> |
| 917 | |
| 918 | ### Previews |
| 919 | |
| 920 | Types: |
| 921 | |
| 922 | - <code><a href="./src/resources/load-balancers/monitors/previews.ts">PreviewCreateResponse</a></code> |
| 923 | |
| 924 | Methods: |
| 925 | |
| 926 | - <code title="post /accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview">client.loadBalancers.monitors.previews.<a href="./src/resources/load-balancers/monitors/previews.ts">create</a>(monitorId, { ...params }) -> PreviewCreateResponse</code> |
| 927 | |
| 928 | ### References |
| 929 | |
| 930 | Types: |
| 931 | |
| 932 | - <code><a href="./src/resources/load-balancers/monitors/references.ts">ReferenceGetResponse</a></code> |
| 933 | |
| 934 | Methods: |
| 935 | |
| 936 | - <code title="get /accounts/{account_id}/load_balancers/monitors/{monitor_id}/references">client.loadBalancers.monitors.references.<a href="./src/resources/load-balancers/monitors/references.ts">get</a>(monitorId, { ...params }) -> ReferenceGetResponse | null</code> |
| 937 | |
| 938 | ## Pools |
| 939 | |
| 940 | Types: |
| 941 | |
| 942 | - <code><a href="./src/resources/load-balancers/pools/pools.ts">Pool</a></code> |
| 943 | - <code><a href="./src/resources/load-balancers/pools/pools.ts">PoolDeleteResponse</a></code> |
| 944 | |
| 945 | Methods: |
| 946 | |
| 947 | - <code title="post /accounts/{account_id}/load_balancers/pools">client.loadBalancers.pools.<a href="./src/resources/load-balancers/pools/pools.ts">create</a>({ ...params }) -> Pool</code> |
| 948 | - <code title="put /accounts/{account_id}/load_balancers/pools/{pool_id}">client.loadBalancers.pools.<a href="./src/resources/load-balancers/pools/pools.ts">update</a>(poolId, { ...params }) -> Pool</code> |
| 949 | - <code title="get /accounts/{account_id}/load_balancers/pools">client.loadBalancers.pools.<a href="./src/resources/load-balancers/pools/pools.ts">list</a>({ ...params }) -> PoolsSinglePage</code> |
| 950 | - <code title="delete /accounts/{account_id}/load_balancers/pools/{pool_id}">client.loadBalancers.pools.<a href="./src/resources/load-balancers/pools/pools.ts">delete</a>(poolId, { ...params }) -> PoolDeleteResponse</code> |
| 951 | - <code title="patch /accounts/{account_id}/load_balancers/pools/{pool_id}">client.loadBalancers.pools.<a href="./src/resources/load-balancers/pools/pools.ts">edit</a>(poolId, { ...params }) -> Pool</code> |
| 952 | - <code title="get /accounts/{account_id}/load_balancers/pools/{pool_id}">client.loadBalancers.pools.<a href="./src/resources/load-balancers/pools/pools.ts">get</a>(poolId, { ...params }) -> Pool</code> |
| 953 | |
| 954 | ### Health |
| 955 | |
| 956 | Types: |
| 957 | |
| 958 | - <code><a href="./src/resources/load-balancers/pools/health.ts">HealthCreateResponse</a></code> |
| 959 | - <code><a href="./src/resources/load-balancers/pools/health.ts">HealthGetResponse</a></code> |
| 960 | |
| 961 | Methods: |
| 962 | |
| 963 | - <code title="post /accounts/{account_id}/load_balancers/pools/{pool_id}/preview">client.loadBalancers.pools.health.<a href="./src/resources/load-balancers/pools/health.ts">create</a>(poolId, { ...params }) -> HealthCreateResponse</code> |
| 964 | - <code title="get /accounts/{account_id}/load_balancers/pools/{pool_id}/health">client.loadBalancers.pools.health.<a href="./src/resources/load-balancers/pools/health.ts">get</a>(poolId, { ...params }) -> HealthGetResponse</code> |
| 965 | |
| 966 | ### References |
| 967 | |
| 968 | Types: |
| 969 | |
| 970 | - <code><a href="./src/resources/load-balancers/pools/references.ts">ReferenceGetResponse</a></code> |
| 971 | |
| 972 | Methods: |
| 973 | |
| 974 | - <code title="get /accounts/{account_id}/load_balancers/pools/{pool_id}/references">client.loadBalancers.pools.references.<a href="./src/resources/load-balancers/pools/references.ts">get</a>(poolId, { ...params }) -> ReferenceGetResponse | null</code> |
| 975 | |
| 976 | ## Previews |
| 977 | |
| 978 | Types: |
| 979 | |
| 980 | - <code><a href="./src/resources/load-balancers/previews.ts">PreviewGetResponse</a></code> |
| 981 | |
| 982 | Methods: |
| 983 | |
| 984 | - <code title="get /accounts/{account_id}/load_balancers/preview/{preview_id}">client.loadBalancers.previews.<a href="./src/resources/load-balancers/previews.ts">get</a>(previewId, { ...params }) -> PreviewGetResponse</code> |
| 985 | |
| 986 | ## Regions |
| 987 | |
| 988 | Types: |
| 989 | |
| 990 | - <code><a href="./src/resources/load-balancers/regions.ts">RegionListResponse</a></code> |
| 991 | - <code><a href="./src/resources/load-balancers/regions.ts">RegionGetResponse</a></code> |
| 992 | |
| 993 | Methods: |
| 994 | |
| 995 | - <code title="get /accounts/{account_id}/load_balancers/regions">client.loadBalancers.regions.<a href="./src/resources/load-balancers/regions.ts">list</a>({ ...params }) -> RegionListResponse</code> |
| 996 | - <code title="get /accounts/{account_id}/load_balancers/regions/{region_id}">client.loadBalancers.regions.<a href="./src/resources/load-balancers/regions.ts">get</a>(regionId, { ...params }) -> RegionGetResponse</code> |
| 997 | |
| 998 | ## Searches |
| 999 | |
| 1000 | Types: |
| 1001 | |
| 1002 | - <code><a href="./src/resources/load-balancers/searches.ts">SearchGetResponse</a></code> |
| 1003 | |
| 1004 | Methods: |
| 1005 | |
| 1006 | - <code title="get /accounts/{account_id}/load_balancers/search">client.loadBalancers.searches.<a href="./src/resources/load-balancers/searches.ts">get</a>({ ...params }) -> SearchGetResponse | null</code> |
| 1007 | |
| 1008 | # Cache |
| 1009 | |
| 1010 | Types: |
| 1011 | |
| 1012 | - <code><a href="./src/resources/cache/cache.ts">CachePurgeResponse</a></code> |
| 1013 | |
| 1014 | Methods: |
| 1015 | |
| 1016 | - <code title="post /zones/{zone_id}/purge_cache">client.cache.<a href="./src/resources/cache/cache.ts">purge</a>({ ...params }) -> CachePurgeResponse | null</code> |
| 1017 | |
| 1018 | ## CacheReserve |
| 1019 | |
| 1020 | Types: |
| 1021 | |
| 1022 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserve</a></code> |
| 1023 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveClear</a></code> |
| 1024 | - <code><a href="./src/resources/cache/cache-reserve.ts">State</a></code> |
| 1025 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveClearResponse</a></code> |
| 1026 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveEditResponse</a></code> |
| 1027 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveGetResponse</a></code> |
| 1028 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveStatusResponse</a></code> |
| 1029 | |
| 1030 | Methods: |
| 1031 | |
| 1032 | - <code title="post /zones/{zone_id}/cache/cache_reserve_clear">client.cache.cacheReserve.<a href="./src/resources/cache/cache-reserve.ts">clear</a>({ ...params }) -> CacheReserveClearResponse</code> |
| 1033 | - <code title="patch /zones/{zone_id}/cache/cache_reserve">client.cache.cacheReserve.<a href="./src/resources/cache/cache-reserve.ts">edit</a>({ ...params }) -> CacheReserveEditResponse</code> |
| 1034 | - <code title="get /zones/{zone_id}/cache/cache_reserve">client.cache.cacheReserve.<a href="./src/resources/cache/cache-reserve.ts">get</a>({ ...params }) -> CacheReserveGetResponse</code> |
| 1035 | - <code title="get /zones/{zone_id}/cache/cache_reserve_clear">client.cache.cacheReserve.<a href="./src/resources/cache/cache-reserve.ts">status</a>({ ...params }) -> CacheReserveStatusResponse</code> |
| 1036 | |
| 1037 | ## SmartTieredCache |
| 1038 | |
| 1039 | Types: |
| 1040 | |
| 1041 | - <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheDeleteResponse</a></code> |
| 1042 | - <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheEditResponse</a></code> |
| 1043 | - <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheGetResponse</a></code> |
| 1044 | |
| 1045 | Methods: |
| 1046 | |
| 1047 | - <code title="delete /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">delete</a>({ ...params }) -> SmartTieredCacheDeleteResponse</code> |
| 1048 | - <code title="patch /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">edit</a>({ ...params }) -> SmartTieredCacheEditResponse</code> |
| 1049 | - <code title="get /zones/{zone_id}/cache/tiered_cache_smart_topology_enable">client.cache.smartTieredCache.<a href="./src/resources/cache/smart-tiered-cache.ts">get</a>({ ...params }) -> SmartTieredCacheGetResponse</code> |
| 1050 | |
| 1051 | ## Variants |
| 1052 | |
| 1053 | Types: |
| 1054 | |
| 1055 | - <code><a href="./src/resources/cache/variants.ts">CacheVariant</a></code> |
| 1056 | - <code><a href="./src/resources/cache/variants.ts">CacheVariantIdentifier</a></code> |
| 1057 | - <code><a href="./src/resources/cache/variants.ts">VariantEditResponse</a></code> |
| 1058 | - <code><a href="./src/resources/cache/variants.ts">VariantGetResponse</a></code> |
| 1059 | |
| 1060 | Methods: |
| 1061 | |
| 1062 | - <code title="delete /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">delete</a>({ ...params }) -> CacheVariant</code> |
| 1063 | - <code title="patch /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">edit</a>({ ...params }) -> VariantEditResponse</code> |
| 1064 | - <code title="get /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">get</a>({ ...params }) -> VariantGetResponse</code> |
| 1065 | |
| 1066 | ## RegionalTieredCache |
| 1067 | |
| 1068 | Types: |
| 1069 | |
| 1070 | - <code><a href="./src/resources/cache/regional-tiered-cache.ts">RegionalTieredCache</a></code> |
| 1071 | - <code><a href="./src/resources/cache/regional-tiered-cache.ts">RegionalTieredCacheEditResponse</a></code> |
| 1072 | - <code><a href="./src/resources/cache/regional-tiered-cache.ts">RegionalTieredCacheGetResponse</a></code> |
| 1073 | |
| 1074 | Methods: |
| 1075 | |
| 1076 | - <code title="patch /zones/{zone_id}/cache/regional_tiered_cache">client.cache.regionalTieredCache.<a href="./src/resources/cache/regional-tiered-cache.ts">edit</a>({ ...params }) -> RegionalTieredCacheEditResponse</code> |
| 1077 | - <code title="get /zones/{zone_id}/cache/regional_tiered_cache">client.cache.regionalTieredCache.<a href="./src/resources/cache/regional-tiered-cache.ts">get</a>({ ...params }) -> RegionalTieredCacheGetResponse</code> |
| 1078 | |
| 1079 | # SSL |
| 1080 | |
| 1081 | ## Analyze |
| 1082 | |
| 1083 | Types: |
| 1084 | |
| 1085 | - <code><a href="./src/resources/ssl/analyze.ts">AnalyzeCreateResponse</a></code> |
| 1086 | |
| 1087 | Methods: |
| 1088 | |
| 1089 | - <code title="post /zones/{zone_id}/ssl/analyze">client.ssl.analyze.<a href="./src/resources/ssl/analyze.ts">create</a>({ ...params }) -> AnalyzeCreateResponse</code> |
| 1090 | |
| 1091 | ## CertificatePacks |
| 1092 | |
| 1093 | Types: |
| 1094 | |
| 1095 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">Host</a></code> |
| 1096 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">RequestValidity</a></code> |
| 1097 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">Status</a></code> |
| 1098 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">ValidationMethod</a></code> |
| 1099 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">CertificatePackListResponse</a></code> |
| 1100 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">CertificatePackDeleteResponse</a></code> |
| 1101 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">CertificatePackEditResponse</a></code> |
| 1102 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">CertificatePackGetResponse</a></code> |
| 1103 | |
| 1104 | Methods: |
| 1105 | |
| 1106 | - <code title="get /zones/{zone_id}/ssl/certificate_packs">client.ssl.certificatePacks.<a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">list</a>({ ...params }) -> CertificatePackListResponsesSinglePage</code> |
| 1107 | - <code title="delete /zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}">client.ssl.certificatePacks.<a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">delete</a>(certificatePackId, { ...params }) -> CertificatePackDeleteResponse</code> |
| 1108 | - <code title="patch /zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}">client.ssl.certificatePacks.<a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">edit</a>(certificatePackId, { ...params }) -> CertificatePackEditResponse</code> |
| 1109 | - <code title="get /zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}">client.ssl.certificatePacks.<a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">get</a>(certificatePackId, { ...params }) -> CertificatePackGetResponse</code> |
| 1110 | |
| 1111 | ### Order |
| 1112 | |
| 1113 | Types: |
| 1114 | |
| 1115 | - <code><a href="./src/resources/ssl/certificate-packs/order.ts">OrderCreateResponse</a></code> |
| 1116 | |
| 1117 | Methods: |
| 1118 | |
| 1119 | - <code title="post /zones/{zone_id}/ssl/certificate_packs/order">client.ssl.certificatePacks.order.<a href="./src/resources/ssl/certificate-packs/order.ts">create</a>({ ...params }) -> OrderCreateResponse</code> |
| 1120 | |
| 1121 | ### Quota |
| 1122 | |
| 1123 | Types: |
| 1124 | |
| 1125 | - <code><a href="./src/resources/ssl/certificate-packs/quota.ts">QuotaGetResponse</a></code> |
| 1126 | |
| 1127 | Methods: |
| 1128 | |
| 1129 | - <code title="get /zones/{zone_id}/ssl/certificate_packs/quota">client.ssl.certificatePacks.quota.<a href="./src/resources/ssl/certificate-packs/quota.ts">get</a>({ ...params }) -> QuotaGetResponse</code> |
| 1130 | |
| 1131 | ## Recommendations |
| 1132 | |
| 1133 | Types: |
| 1134 | |
| 1135 | - <code><a href="./src/resources/ssl/recommendations.ts">RecommendationGetResponse</a></code> |
| 1136 | |
| 1137 | Methods: |
| 1138 | |
| 1139 | - <code title="get /zones/{zone_identifier}/ssl/recommendation">client.ssl.recommendations.<a href="./src/resources/ssl/recommendations.ts">get</a>(zoneIdentifier) -> RecommendationGetResponse | null</code> |
| 1140 | |
| 1141 | ## Universal |
| 1142 | |
| 1143 | ### Settings |
| 1144 | |
| 1145 | Types: |
| 1146 | |
| 1147 | - <code><a href="./src/resources/ssl/universal/settings.ts">UniversalSSLSettings</a></code> |
| 1148 | |
| 1149 | Methods: |
| 1150 | |
| 1151 | - <code title="patch /zones/{zone_id}/ssl/universal/settings">client.ssl.universal.settings.<a href="./src/resources/ssl/universal/settings.ts">edit</a>({ ...params }) -> UniversalSSLSettings</code> |
| 1152 | - <code title="get /zones/{zone_id}/ssl/universal/settings">client.ssl.universal.settings.<a href="./src/resources/ssl/universal/settings.ts">get</a>({ ...params }) -> UniversalSSLSettings</code> |
| 1153 | |
| 1154 | ## Verification |
| 1155 | |
| 1156 | Types: |
| 1157 | |
| 1158 | - <code><a href="./src/resources/ssl/verification.ts">Verification</a></code> |
| 1159 | - <code><a href="./src/resources/ssl/verification.ts">VerificationEditResponse</a></code> |
| 1160 | - <code><a href="./src/resources/ssl/verification.ts">VerificationGetResponse</a></code> |
| 1161 | |
| 1162 | Methods: |
| 1163 | |
| 1164 | - <code title="patch /zones/{zone_id}/ssl/verification/{certificate_pack_id}">client.ssl.verification.<a href="./src/resources/ssl/verification.ts">edit</a>(certificatePackId, { ...params }) -> VerificationEditResponse</code> |
| 1165 | - <code title="get /zones/{zone_id}/ssl/verification">client.ssl.verification.<a href="./src/resources/ssl/verification.ts">get</a>({ ...params }) -> VerificationGetResponse</code> |
| 1166 | |
| 1167 | # Subscriptions |
| 1168 | |
| 1169 | Types: |
| 1170 | |
| 1171 | - <code><a href="./src/resources/subscriptions.ts">SubscriptionCreateResponse</a></code> |
| 1172 | - <code><a href="./src/resources/subscriptions.ts">SubscriptionUpdateResponse</a></code> |
| 1173 | - <code><a href="./src/resources/subscriptions.ts">SubscriptionDeleteResponse</a></code> |
| 1174 | - <code><a href="./src/resources/subscriptions.ts">SubscriptionGetResponse</a></code> |
| 1175 | |
| 1176 | Methods: |
| 1177 | |
| 1178 | - <code title="post /zones/{identifier}/subscription">client.subscriptions.<a href="./src/resources/subscriptions.ts">create</a>(identifier, { ...params }) -> SubscriptionCreateResponse</code> |
| 1179 | - <code title="put /accounts/{account_identifier}/subscriptions/{subscription_identifier}">client.subscriptions.<a href="./src/resources/subscriptions.ts">update</a>(accountIdentifier, subscriptionIdentifier, { ...params }) -> SubscriptionUpdateResponse</code> |
| 1180 | - <code title="get /accounts/{account_identifier}/subscriptions">client.subscriptions.<a href="./src/resources/subscriptions.ts">list</a>(accountIdentifier) -> SubscriptionsSinglePage</code> |
| 1181 | - <code title="delete /accounts/{account_identifier}/subscriptions/{subscription_identifier}">client.subscriptions.<a href="./src/resources/subscriptions.ts">delete</a>(accountIdentifier, subscriptionIdentifier) -> SubscriptionDeleteResponse</code> |
| 1182 | - <code title="get /zones/{identifier}/subscription">client.subscriptions.<a href="./src/resources/subscriptions.ts">get</a>(identifier) -> SubscriptionGetResponse</code> |
| 1183 | |
| 1184 | # ACM |
| 1185 | |
| 1186 | ## TotalTLS |
| 1187 | |
| 1188 | Types: |
| 1189 | |
| 1190 | - <code><a href="./src/resources/acm/total-tls.ts">CertificateAuthority</a></code> |
| 1191 | - <code><a href="./src/resources/acm/total-tls.ts">TotalTLSCreateResponse</a></code> |
| 1192 | - <code><a href="./src/resources/acm/total-tls.ts">TotalTLSGetResponse</a></code> |
| 1193 | |
| 1194 | Methods: |
| 1195 | |
| 1196 | - <code title="post /zones/{zone_id}/acm/total_tls">client.acm.totalTLS.<a href="./src/resources/acm/total-tls.ts">create</a>({ ...params }) -> TotalTLSCreateResponse</code> |
| 1197 | - <code title="get /zones/{zone_id}/acm/total_tls">client.acm.totalTLS.<a href="./src/resources/acm/total-tls.ts">get</a>({ ...params }) -> TotalTLSGetResponse</code> |
| 1198 | |
| 1199 | # Argo |
| 1200 | |
| 1201 | ## SmartRouting |
| 1202 | |
| 1203 | Types: |
| 1204 | |
| 1205 | - <code><a href="./src/resources/argo/smart-routing.ts">SmartRoutingEditResponse</a></code> |
| 1206 | - <code><a href="./src/resources/argo/smart-routing.ts">SmartRoutingGetResponse</a></code> |
| 1207 | |
| 1208 | Methods: |
| 1209 | |
| 1210 | - <code title="patch /zones/{zone_id}/argo/smart_routing">client.argo.smartRouting.<a href="./src/resources/argo/smart-routing.ts">edit</a>({ ...params }) -> SmartRoutingEditResponse</code> |
| 1211 | - <code title="get /zones/{zone_id}/argo/smart_routing">client.argo.smartRouting.<a href="./src/resources/argo/smart-routing.ts">get</a>({ ...params }) -> SmartRoutingGetResponse</code> |
| 1212 | |
| 1213 | ## TieredCaching |
| 1214 | |
| 1215 | Types: |
| 1216 | |
| 1217 | - <code><a href="./src/resources/argo/tiered-caching.ts">TieredCachingEditResponse</a></code> |
| 1218 | - <code><a href="./src/resources/argo/tiered-caching.ts">TieredCachingGetResponse</a></code> |
| 1219 | |
| 1220 | Methods: |
| 1221 | |
| 1222 | - <code title="patch /zones/{zone_id}/argo/tiered_caching">client.argo.tieredCaching.<a href="./src/resources/argo/tiered-caching.ts">edit</a>({ ...params }) -> TieredCachingEditResponse</code> |
| 1223 | - <code title="get /zones/{zone_id}/argo/tiered_caching">client.argo.tieredCaching.<a href="./src/resources/argo/tiered-caching.ts">get</a>({ ...params }) -> TieredCachingGetResponse</code> |
| 1224 | |
| 1225 | # Plans |
| 1226 | |
| 1227 | Types: |
| 1228 | |
| 1229 | - <code><a href="./src/resources/plans.ts">AvailableRatePlan</a></code> |
| 1230 | |
| 1231 | Methods: |
| 1232 | |
| 1233 | - <code title="get /zones/{zone_identifier}/available_plans">client.plans.<a href="./src/resources/plans.ts">list</a>(zoneIdentifier) -> AvailableRatePlansSinglePage</code> |
| 1234 | - <code title="get /zones/{zone_identifier}/available_plans/{plan_identifier}">client.plans.<a href="./src/resources/plans.ts">get</a>(zoneIdentifier, planIdentifier) -> AvailableRatePlan</code> |
| 1235 | |
| 1236 | # RatePlans |
| 1237 | |
| 1238 | Types: |
| 1239 | |
| 1240 | - <code><a href="./src/resources/rate-plans.ts">RatePlan</a></code> |
| 1241 | - <code><a href="./src/resources/rate-plans.ts">RatePlanGetResponse</a></code> |
| 1242 | |
| 1243 | Methods: |
| 1244 | |
| 1245 | - <code title="get /zones/{zone_identifier}/available_rate_plans">client.ratePlans.<a href="./src/resources/rate-plans.ts">get</a>(zoneIdentifier) -> RatePlanGetResponse | null</code> |
| 1246 | |
| 1247 | # CertificateAuthorities |
| 1248 | |
| 1249 | ## HostnameAssociations |
| 1250 | |
| 1251 | Types: |
| 1252 | |
| 1253 | - <code><a href="./src/resources/certificate-authorities/hostname-associations.ts">HostnameAssociation</a></code> |
| 1254 | - <code><a href="./src/resources/certificate-authorities/hostname-associations.ts">TLSHostnameAssociation</a></code> |
| 1255 | - <code><a href="./src/resources/certificate-authorities/hostname-associations.ts">HostnameAssociationUpdateResponse</a></code> |
| 1256 | - <code><a href="./src/resources/certificate-authorities/hostname-associations.ts">HostnameAssociationGetResponse</a></code> |
| 1257 | |
| 1258 | Methods: |
| 1259 | |
| 1260 | - <code title="put /zones/{zone_id}/certificate_authorities/hostname_associations">client.certificateAuthorities.hostnameAssociations.<a href="./src/resources/certificate-authorities/hostname-associations.ts">update</a>({ ...params }) -> HostnameAssociationUpdateResponse</code> |
| 1261 | - <code title="get /zones/{zone_id}/certificate_authorities/hostname_associations">client.certificateAuthorities.hostnameAssociations.<a href="./src/resources/certificate-authorities/hostname-associations.ts">get</a>({ ...params }) -> HostnameAssociationGetResponse</code> |
| 1262 | |
| 1263 | # ClientCertificates |
| 1264 | |
| 1265 | Types: |
| 1266 | |
| 1267 | - <code><a href="./src/resources/client-certificates.ts">ClientCertificate</a></code> |
| 1268 | |
| 1269 | Methods: |
| 1270 | |
| 1271 | - <code title="post /zones/{zone_id}/client_certificates">client.clientCertificates.<a href="./src/resources/client-certificates.ts">create</a>({ ...params }) -> ClientCertificate</code> |
| 1272 | - <code title="get /zones/{zone_id}/client_certificates">client.clientCertificates.<a href="./src/resources/client-certificates.ts">list</a>({ ...params }) -> ClientCertificatesV4PagePaginationArray</code> |
| 1273 | - <code title="delete /zones/{zone_id}/client_certificates/{client_certificate_id}">client.clientCertificates.<a href="./src/resources/client-certificates.ts">delete</a>(clientCertificateId, { ...params }) -> ClientCertificate</code> |
| 1274 | - <code title="patch /zones/{zone_id}/client_certificates/{client_certificate_id}">client.clientCertificates.<a href="./src/resources/client-certificates.ts">edit</a>(clientCertificateId, { ...params }) -> ClientCertificate</code> |
| 1275 | - <code title="get /zones/{zone_id}/client_certificates/{client_certificate_id}">client.clientCertificates.<a href="./src/resources/client-certificates.ts">get</a>(clientCertificateId, { ...params }) -> ClientCertificate</code> |
| 1276 | |
| 1277 | # CustomCertificates |
| 1278 | |
| 1279 | Types: |
| 1280 | |
| 1281 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">CustomCertificate</a></code> |
| 1282 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">GeoRestrictions</a></code> |
| 1283 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">Status</a></code> |
| 1284 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">CustomCertificateCreateResponse</a></code> |
| 1285 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">CustomCertificateDeleteResponse</a></code> |
| 1286 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">CustomCertificateEditResponse</a></code> |
| 1287 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">CustomCertificateGetResponse</a></code> |
| 1288 | |
| 1289 | Methods: |
| 1290 | |
| 1291 | - <code title="post /zones/{zone_id}/custom_certificates">client.customCertificates.<a href="./src/resources/custom-certificates/custom-certificates.ts">create</a>({ ...params }) -> CustomCertificateCreateResponse</code> |
| 1292 | - <code title="get /zones/{zone_id}/custom_certificates">client.customCertificates.<a href="./src/resources/custom-certificates/custom-certificates.ts">list</a>({ ...params }) -> CustomCertificatesV4PagePaginationArray</code> |
| 1293 | - <code title="delete /zones/{zone_id}/custom_certificates/{custom_certificate_id}">client.customCertificates.<a href="./src/resources/custom-certificates/custom-certificates.ts">delete</a>(customCertificateId, { ...params }) -> CustomCertificateDeleteResponse</code> |
| 1294 | - <code title="patch /zones/{zone_id}/custom_certificates/{custom_certificate_id}">client.customCertificates.<a href="./src/resources/custom-certificates/custom-certificates.ts">edit</a>(customCertificateId, { ...params }) -> CustomCertificateEditResponse</code> |
| 1295 | - <code title="get /zones/{zone_id}/custom_certificates/{custom_certificate_id}">client.customCertificates.<a href="./src/resources/custom-certificates/custom-certificates.ts">get</a>(customCertificateId, { ...params }) -> CustomCertificateGetResponse</code> |
| 1296 | |
| 1297 | ## Prioritize |
| 1298 | |
| 1299 | Types: |
| 1300 | |
| 1301 | - <code><a href="./src/resources/custom-certificates/prioritize.ts">PrioritizeUpdateResponse</a></code> |
| 1302 | |
| 1303 | Methods: |
| 1304 | |
| 1305 | - <code title="put /zones/{zone_id}/custom_certificates/prioritize">client.customCertificates.prioritize.<a href="./src/resources/custom-certificates/prioritize.ts">update</a>({ ...params }) -> PrioritizeUpdateResponse | null</code> |
| 1306 | |
| 1307 | # CustomHostnames |
| 1308 | |
| 1309 | Types: |
| 1310 | |
| 1311 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">BundleMethod</a></code> |
| 1312 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostname</a></code> |
| 1313 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">DCVMethod</a></code> |
| 1314 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">DomainValidationType</a></code> |
| 1315 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameCreateResponse</a></code> |
| 1316 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameListResponse</a></code> |
| 1317 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameDeleteResponse</a></code> |
| 1318 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameEditResponse</a></code> |
| 1319 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameGetResponse</a></code> |
| 1320 | |
| 1321 | Methods: |
| 1322 | |
| 1323 | - <code title="post /zones/{zone_id}/custom_hostnames">client.customHostnames.<a href="./src/resources/custom-hostnames/custom-hostnames.ts">create</a>({ ...params }) -> CustomHostnameCreateResponse</code> |
| 1324 | - <code title="get /zones/{zone_id}/custom_hostnames">client.customHostnames.<a href="./src/resources/custom-hostnames/custom-hostnames.ts">list</a>({ ...params }) -> CustomHostnameListResponsesV4PagePaginationArray</code> |
| 1325 | - <code title="delete /zones/{zone_id}/custom_hostnames/{custom_hostname_id}">client.customHostnames.<a href="./src/resources/custom-hostnames/custom-hostnames.ts">delete</a>(customHostnameId, { ...params }) -> CustomHostnameDeleteResponse</code> |
| 1326 | - <code title="patch /zones/{zone_id}/custom_hostnames/{custom_hostname_id}">client.customHostnames.<a href="./src/resources/custom-hostnames/custom-hostnames.ts">edit</a>(customHostnameId, { ...params }) -> CustomHostnameEditResponse</code> |
| 1327 | - <code title="get /zones/{zone_id}/custom_hostnames/{custom_hostname_id}">client.customHostnames.<a href="./src/resources/custom-hostnames/custom-hostnames.ts">get</a>(customHostnameId, { ...params }) -> CustomHostnameGetResponse</code> |
| 1328 | |
| 1329 | ## FallbackOrigin |
| 1330 | |
| 1331 | Types: |
| 1332 | |
| 1333 | - <code><a href="./src/resources/custom-hostnames/fallback-origin.ts">FallbackOriginUpdateResponse</a></code> |
| 1334 | - <code><a href="./src/resources/custom-hostnames/fallback-origin.ts">FallbackOriginDeleteResponse</a></code> |
| 1335 | - <code><a href="./src/resources/custom-hostnames/fallback-origin.ts">FallbackOriginGetResponse</a></code> |
| 1336 | |
| 1337 | Methods: |
| 1338 | |
| 1339 | - <code title="put /zones/{zone_id}/custom_hostnames/fallback_origin">client.customHostnames.fallbackOrigin.<a href="./src/resources/custom-hostnames/fallback-origin.ts">update</a>({ ...params }) -> FallbackOriginUpdateResponse</code> |
| 1340 | - <code title="delete /zones/{zone_id}/custom_hostnames/fallback_origin">client.customHostnames.fallbackOrigin.<a href="./src/resources/custom-hostnames/fallback-origin.ts">delete</a>({ ...params }) -> FallbackOriginDeleteResponse</code> |
| 1341 | - <code title="get /zones/{zone_id}/custom_hostnames/fallback_origin">client.customHostnames.fallbackOrigin.<a href="./src/resources/custom-hostnames/fallback-origin.ts">get</a>({ ...params }) -> FallbackOriginGetResponse</code> |
| 1342 | |
| 1343 | # CustomNameservers |
| 1344 | |
| 1345 | Types: |
| 1346 | |
| 1347 | - <code><a href="./src/resources/custom-nameservers.ts">CustomNameserver</a></code> |
| 1348 | - <code><a href="./src/resources/custom-nameservers.ts">CustomNameserverDeleteResponse</a></code> |
| 1349 | - <code><a href="./src/resources/custom-nameservers.ts">CustomNameserverAvailabiltyResponse</a></code> |
| 1350 | - <code><a href="./src/resources/custom-nameservers.ts">CustomNameserverGetResponse</a></code> |
| 1351 | |
| 1352 | Methods: |
| 1353 | |
| 1354 | - <code title="post /accounts/{account_id}/custom_ns">client.customNameservers.<a href="./src/resources/custom-nameservers.ts">create</a>({ ...params }) -> CustomNameserver</code> |
| 1355 | - <code title="delete /accounts/{account_id}/custom_ns/{custom_ns_id}">client.customNameservers.<a href="./src/resources/custom-nameservers.ts">delete</a>(customNSId, { ...params }) -> CustomNameserverDeleteResponse | null</code> |
| 1356 | - <code title="get /accounts/{account_id}/custom_ns/availability">client.customNameservers.<a href="./src/resources/custom-nameservers.ts">availabilty</a>({ ...params }) -> CustomNameserverAvailabiltyResponse | null</code> |
| 1357 | - <code title="get /accounts/{account_id}/custom_ns">client.customNameservers.<a href="./src/resources/custom-nameservers.ts">get</a>({ ...params }) -> CustomNameserverGetResponse | null</code> |
| 1358 | |
| 1359 | # DNS |
| 1360 | |
| 1361 | Types: |
| 1362 | |
| 1363 | - <code><a href="./src/resources/dns/dns.ts">DNSAnalyticsNominalMetric</a></code> |
| 1364 | - <code><a href="./src/resources/dns/dns.ts">DNSAnalyticsQuery</a></code> |
| 1365 | |
| 1366 | ## Records |
| 1367 | |
| 1368 | Types: |
| 1369 | |
| 1370 | - <code><a href="./src/resources/dns/records.ts">ARecord</a></code> |
| 1371 | - <code><a href="./src/resources/dns/records.ts">AAAARecord</a></code> |
| 1372 | - <code><a href="./src/resources/dns/records.ts">CAARecord</a></code> |
| 1373 | - <code><a href="./src/resources/dns/records.ts">CERTRecord</a></code> |
| 1374 | - <code><a href="./src/resources/dns/records.ts">CNAMERecord</a></code> |
| 1375 | - <code><a href="./src/resources/dns/records.ts">DNSKEYRecord</a></code> |
| 1376 | - <code><a href="./src/resources/dns/records.ts">DSRecord</a></code> |
| 1377 | - <code><a href="./src/resources/dns/records.ts">HTTPSRecord</a></code> |
| 1378 | - <code><a href="./src/resources/dns/records.ts">LOCRecord</a></code> |
| 1379 | - <code><a href="./src/resources/dns/records.ts">MXRecord</a></code> |
| 1380 | - <code><a href="./src/resources/dns/records.ts">NAPTRRecord</a></code> |
| 1381 | - <code><a href="./src/resources/dns/records.ts">NSRecord</a></code> |
| 1382 | - <code><a href="./src/resources/dns/records.ts">PTRRecord</a></code> |
| 1383 | - <code><a href="./src/resources/dns/records.ts">Record</a></code> |
| 1384 | - <code><a href="./src/resources/dns/records.ts">RecordMetadata</a></code> |
| 1385 | - <code><a href="./src/resources/dns/records.ts">RecordProcessTiming</a></code> |
| 1386 | - <code><a href="./src/resources/dns/records.ts">RecordTags</a></code> |
| 1387 | - <code><a href="./src/resources/dns/records.ts">SMIMEARecord</a></code> |
| 1388 | - <code><a href="./src/resources/dns/records.ts">SRVRecord</a></code> |
| 1389 | - <code><a href="./src/resources/dns/records.ts">SSHFPRecord</a></code> |
| 1390 | - <code><a href="./src/resources/dns/records.ts">SVCBRecord</a></code> |
| 1391 | - <code><a href="./src/resources/dns/records.ts">TLSARecord</a></code> |
| 1392 | - <code><a href="./src/resources/dns/records.ts">TTL</a></code> |
| 1393 | - <code><a href="./src/resources/dns/records.ts">TXTRecord</a></code> |
| 1394 | - <code><a href="./src/resources/dns/records.ts">URIRecord</a></code> |
| 1395 | - <code><a href="./src/resources/dns/records.ts">RecordDeleteResponse</a></code> |
| 1396 | - <code><a href="./src/resources/dns/records.ts">RecordExportResponse</a></code> |
| 1397 | - <code><a href="./src/resources/dns/records.ts">RecordImportResponse</a></code> |
| 1398 | - <code><a href="./src/resources/dns/records.ts">RecordScanResponse</a></code> |
| 1399 | |
| 1400 | Methods: |
| 1401 | |
| 1402 | - <code title="post /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/resources/dns/records.ts">create</a>({ ...params }) -> Record</code> |
| 1403 | - <code title="put /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">update</a>(dnsRecordId, { ...params }) -> Record</code> |
| 1404 | - <code title="get /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/resources/dns/records.ts">list</a>({ ...params }) -> RecordsV4PagePaginationArray</code> |
| 1405 | - <code title="delete /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">delete</a>(dnsRecordId, { ...params }) -> RecordDeleteResponse</code> |
| 1406 | - <code title="patch /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">edit</a>(dnsRecordId, { ...params }) -> Record</code> |
| 1407 | - <code title="get /zones/{zone_id}/dns_records/export">client.dns.records.<a href="./src/resources/dns/records.ts">export</a>({ ...params }) -> string</code> |
| 1408 | - <code title="get /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/resources/dns/records.ts">get</a>(dnsRecordId, { ...params }) -> Record</code> |
| 1409 | - <code title="post /zones/{zone_id}/dns_records/import">client.dns.records.<a href="./src/resources/dns/records.ts">import</a>({ ...params }) -> RecordImportResponse</code> |
| 1410 | - <code title="post /zones/{zone_id}/dns_records/scan">client.dns.records.<a href="./src/resources/dns/records.ts">scan</a>({ ...params }) -> RecordScanResponse</code> |
| 1411 | |
| 1412 | ## Settings |
| 1413 | |
| 1414 | Types: |
| 1415 | |
| 1416 | - <code><a href="./src/resources/dns/settings.ts">DNSSetting</a></code> |
| 1417 | - <code><a href="./src/resources/dns/settings.ts">Nameserver</a></code> |
| 1418 | - <code><a href="./src/resources/dns/settings.ts">SettingEditResponse</a></code> |
| 1419 | - <code><a href="./src/resources/dns/settings.ts">SettingGetResponse</a></code> |
| 1420 | |
| 1421 | Methods: |
| 1422 | |
| 1423 | - <code title="patch /{account_or_zone}/{account_or_zone_id}/dns_settings">client.dns.settings.<a href="./src/resources/dns/settings.ts">edit</a>({ ...params }) -> SettingEditResponse</code> |
| 1424 | - <code title="get /{account_or_zone}/{account_or_zone_id}/dns_settings">client.dns.settings.<a href="./src/resources/dns/settings.ts">get</a>({ ...params }) -> SettingGetResponse</code> |
| 1425 | |
| 1426 | ## Analytics |
| 1427 | |
| 1428 | ### Reports |
| 1429 | |
| 1430 | Types: |
| 1431 | |
| 1432 | - <code><a href="./src/resources/dns/analytics/reports/reports.ts">Report</a></code> |
| 1433 | |
| 1434 | Methods: |
| 1435 | |
| 1436 | - <code title="get /zones/{zone_id}/dns_analytics/report">client.dns.analytics.reports.<a href="./src/resources/dns/analytics/reports/reports.ts">get</a>({ ...params }) -> Report</code> |
| 1437 | |
| 1438 | #### Bytimes |
| 1439 | |
| 1440 | Types: |
| 1441 | |
| 1442 | - <code><a href="./src/resources/dns/analytics/reports/bytimes.ts">ByTime</a></code> |
| 1443 | |
| 1444 | Methods: |
| 1445 | |
| 1446 | - <code title="get /zones/{zone_id}/dns_analytics/report/bytime">client.dns.analytics.reports.bytimes.<a href="./src/resources/dns/analytics/reports/bytimes.ts">get</a>({ ...params }) -> ByTime</code> |
| 1447 | |
| 1448 | ## Firewall |
| 1449 | |
| 1450 | Types: |
| 1451 | |
| 1452 | - <code><a href="./src/resources/dns/firewall/firewall.ts">AttackMitigation</a></code> |
| 1453 | - <code><a href="./src/resources/dns/firewall/firewall.ts">Firewall</a></code> |
| 1454 | - <code><a href="./src/resources/dns/firewall/firewall.ts">FirewallIPs</a></code> |
| 1455 | - <code><a href="./src/resources/dns/firewall/firewall.ts">UpstreamIPs</a></code> |
| 1456 | - <code><a href="./src/resources/dns/firewall/firewall.ts">FirewallDeleteResponse</a></code> |
| 1457 | |
| 1458 | Methods: |
| 1459 | |
| 1460 | - <code title="post /accounts/{account_id}/dns_firewall">client.dns.firewall.<a href="./src/resources/dns/firewall/firewall.ts">create</a>({ ...params }) -> Firewall</code> |
| 1461 | - <code title="get /accounts/{account_id}/dns_firewall">client.dns.firewall.<a href="./src/resources/dns/firewall/firewall.ts">list</a>({ ...params }) -> FirewallsV4PagePaginationArray</code> |
| 1462 | - <code title="delete /accounts/{account_id}/dns_firewall/{dns_firewall_id}">client.dns.firewall.<a href="./src/resources/dns/firewall/firewall.ts">delete</a>(dnsFirewallId, { ...params }) -> FirewallDeleteResponse</code> |
| 1463 | - <code title="patch /accounts/{account_id}/dns_firewall/{dns_firewall_id}">client.dns.firewall.<a href="./src/resources/dns/firewall/firewall.ts">edit</a>(dnsFirewallId, { ...params }) -> Firewall</code> |
| 1464 | - <code title="get /accounts/{account_id}/dns_firewall/{dns_firewall_id}">client.dns.firewall.<a href="./src/resources/dns/firewall/firewall.ts">get</a>(dnsFirewallId, { ...params }) -> Firewall</code> |
| 1465 | |
| 1466 | ### Analytics |
| 1467 | |
| 1468 | Types: |
| 1469 | |
| 1470 | - <code><a href="./src/resources/dns/firewall/analytics/analytics.ts">Delta</a></code> |
| 1471 | |
| 1472 | #### Reports |
| 1473 | |
| 1474 | Methods: |
| 1475 | |
| 1476 | - <code title="get /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report">client.dns.firewall.analytics.reports.<a href="./src/resources/dns/firewall/analytics/reports/reports.ts">get</a>(dnsFirewallId, { ...params }) -> Report</code> |
| 1477 | |
| 1478 | ##### Bytimes |
| 1479 | |
| 1480 | Methods: |
| 1481 | |
| 1482 | - <code title="get /accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime">client.dns.firewall.analytics.reports.bytimes.<a href="./src/resources/dns/firewall/analytics/reports/bytimes.ts">get</a>(dnsFirewallId, { ...params }) -> ByTime</code> |
| 1483 | |
| 1484 | # DNSSEC |
| 1485 | |
| 1486 | Types: |
| 1487 | |
| 1488 | - <code><a href="./src/resources/dnssec.ts">DNSSEC</a></code> |
| 1489 | - <code><a href="./src/resources/dnssec.ts">DNSSECDeleteResponse</a></code> |
| 1490 | |
| 1491 | Methods: |
| 1492 | |
| 1493 | - <code title="delete /zones/{zone_id}/dnssec">client.dnssec.<a href="./src/resources/dnssec.ts">delete</a>({ ...params }) -> DNSSECDeleteResponse</code> |
| 1494 | - <code title="patch /zones/{zone_id}/dnssec">client.dnssec.<a href="./src/resources/dnssec.ts">edit</a>({ ...params }) -> DNSSEC</code> |
| 1495 | - <code title="get /zones/{zone_id}/dnssec">client.dnssec.<a href="./src/resources/dnssec.ts">get</a>({ ...params }) -> DNSSEC</code> |
| 1496 | |
| 1497 | # EmailRouting |
| 1498 | |
| 1499 | Types: |
| 1500 | |
| 1501 | - <code><a href="./src/resources/email-routing/email-routing.ts">Settings</a></code> |
| 1502 | |
| 1503 | Methods: |
| 1504 | |
| 1505 | - <code title="post /zones/{zone_identifier}/email/routing/disable">client.emailRouting.<a href="./src/resources/email-routing/email-routing.ts">disable</a>(zoneIdentifier, { ...params }) -> Settings</code> |
| 1506 | - <code title="post /zones/{zone_identifier}/email/routing/enable">client.emailRouting.<a href="./src/resources/email-routing/email-routing.ts">enable</a>(zoneIdentifier, { ...params }) -> Settings</code> |
| 1507 | - <code title="get /zones/{zone_identifier}/email/routing">client.emailRouting.<a href="./src/resources/email-routing/email-routing.ts">get</a>(zoneIdentifier) -> Settings</code> |
| 1508 | |
| 1509 | ## DNS |
| 1510 | |
| 1511 | Types: |
| 1512 | |
| 1513 | - <code><a href="./src/resources/email-routing/dns.ts">DNSRecord</a></code> |
| 1514 | - <code><a href="./src/resources/email-routing/dns.ts">DNSGetResponse</a></code> |
| 1515 | |
| 1516 | Methods: |
| 1517 | |
| 1518 | - <code title="get /zones/{zone_identifier}/email/routing/dns">client.emailRouting.dns.<a href="./src/resources/email-routing/dns.ts">get</a>(zoneIdentifier) -> DNSGetResponse | null</code> |
| 1519 | |
| 1520 | ## Rules |
| 1521 | |
| 1522 | Types: |
| 1523 | |
| 1524 | - <code><a href="./src/resources/email-routing/rules/rules.ts">Action</a></code> |
| 1525 | - <code><a href="./src/resources/email-routing/rules/rules.ts">EmailRoutingRule</a></code> |
| 1526 | - <code><a href="./src/resources/email-routing/rules/rules.ts">Matcher</a></code> |
| 1527 | |
| 1528 | Methods: |
| 1529 | |
| 1530 | - <code title="post /zones/{zone_identifier}/email/routing/rules">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">create</a>(zoneIdentifier, { ...params }) -> EmailRoutingRule</code> |
| 1531 | - <code title="put /zones/{zone_identifier}/email/routing/rules/{rule_identifier}">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">update</a>(zoneIdentifier, ruleIdentifier, { ...params }) -> EmailRoutingRule</code> |
| 1532 | - <code title="get /zones/{zone_identifier}/email/routing/rules">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">list</a>(zoneIdentifier, { ...params }) -> EmailRoutingRulesV4PagePaginationArray</code> |
| 1533 | - <code title="delete /zones/{zone_identifier}/email/routing/rules/{rule_identifier}">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">delete</a>(zoneIdentifier, ruleIdentifier) -> EmailRoutingRule</code> |
| 1534 | - <code title="get /zones/{zone_identifier}/email/routing/rules/{rule_identifier}">client.emailRouting.rules.<a href="./src/resources/email-routing/rules/rules.ts">get</a>(zoneIdentifier, ruleIdentifier) -> EmailRoutingRule</code> |
| 1535 | |
| 1536 | ### CatchAlls |
| 1537 | |
| 1538 | Types: |
| 1539 | |
| 1540 | - <code><a href="./src/resources/email-routing/rules/catch-alls.ts">CatchAllAction</a></code> |
| 1541 | - <code><a href="./src/resources/email-routing/rules/catch-alls.ts">CatchAllMatcher</a></code> |
| 1542 | - <code><a href="./src/resources/email-routing/rules/catch-alls.ts">CatchAllUpdateResponse</a></code> |
| 1543 | - <code><a href="./src/resources/email-routing/rules/catch-alls.ts">CatchAllGetResponse</a></code> |
| 1544 | |
| 1545 | Methods: |
| 1546 | |
| 1547 | - <code title="put /zones/{zone_identifier}/email/routing/rules/catch_all">client.emailRouting.rules.catchAlls.<a href="./src/resources/email-routing/rules/catch-alls.ts">update</a>(zoneIdentifier, { ...params }) -> CatchAllUpdateResponse</code> |
| 1548 | - <code title="get /zones/{zone_identifier}/email/routing/rules/catch_all">client.emailRouting.rules.catchAlls.<a href="./src/resources/email-routing/rules/catch-alls.ts">get</a>(zoneIdentifier) -> CatchAllGetResponse</code> |
| 1549 | |
| 1550 | ## Addresses |
| 1551 | |
| 1552 | Types: |
| 1553 | |
| 1554 | - <code><a href="./src/resources/email-routing/addresses.ts">Address</a></code> |
| 1555 | |
| 1556 | Methods: |
| 1557 | |
| 1558 | - <code title="post /accounts/{account_identifier}/email/routing/addresses">client.emailRouting.addresses.<a href="./src/resources/email-routing/addresses.ts">create</a>(accountIdentifier, { ...params }) -> Address</code> |
| 1559 | - <code title="get /accounts/{account_identifier}/email/routing/addresses">client.emailRouting.addresses.<a href="./src/resources/email-routing/addresses.ts">list</a>(accountIdentifier, { ...params }) -> AddressesV4PagePaginationArray</code> |
| 1560 | - <code title="delete /accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}">client.emailRouting.addresses.<a href="./src/resources/email-routing/addresses.ts">delete</a>(accountIdentifier, destinationAddressIdentifier) -> Address</code> |
| 1561 | - <code title="get /accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}">client.emailRouting.addresses.<a href="./src/resources/email-routing/addresses.ts">get</a>(accountIdentifier, destinationAddressIdentifier) -> Address</code> |
| 1562 | |
| 1563 | # Filters |
| 1564 | |
| 1565 | Types: |
| 1566 | |
| 1567 | - <code><a href="./src/resources/filters.ts">FirewallFilter</a></code> |
| 1568 | - <code><a href="./src/resources/filters.ts">FilterCreateResponse</a></code> |
| 1569 | |
| 1570 | Methods: |
| 1571 | |
| 1572 | - <code title="post /zones/{zone_identifier}/filters">client.filters.<a href="./src/resources/filters.ts">create</a>(zoneIdentifier, { ...params }) -> FilterCreateResponse | null</code> |
| 1573 | - <code title="put /zones/{zone_identifier}/filters/{id}">client.filters.<a href="./src/resources/filters.ts">update</a>(zoneIdentifier, id, { ...params }) -> FirewallFilter</code> |
| 1574 | - <code title="get /zones/{zone_identifier}/filters">client.filters.<a href="./src/resources/filters.ts">list</a>(zoneIdentifier, { ...params }) -> FirewallFiltersV4PagePaginationArray</code> |
| 1575 | - <code title="delete /zones/{zone_identifier}/filters/{id}">client.filters.<a href="./src/resources/filters.ts">delete</a>(zoneIdentifier, id) -> FirewallFilter</code> |
| 1576 | - <code title="get /zones/{zone_identifier}/filters/{id}">client.filters.<a href="./src/resources/filters.ts">get</a>(zoneIdentifier, id) -> FirewallFilter</code> |
| 1577 | |
| 1578 | # Firewall |
| 1579 | |
| 1580 | ## Lockdowns |
| 1581 | |
| 1582 | Types: |
| 1583 | |
| 1584 | - <code><a href="./src/resources/firewall/lockdowns.ts">Configuration</a></code> |
| 1585 | - <code><a href="./src/resources/firewall/lockdowns.ts">Lockdown</a></code> |
| 1586 | - <code><a href="./src/resources/firewall/lockdowns.ts">LockdownCIDRConfiguration</a></code> |
| 1587 | - <code><a href="./src/resources/firewall/lockdowns.ts">LockdownIPConfiguration</a></code> |
| 1588 | - <code><a href="./src/resources/firewall/lockdowns.ts">LockdownURL</a></code> |
| 1589 | - <code><a href="./src/resources/firewall/lockdowns.ts">LockdownDeleteResponse</a></code> |
| 1590 | |
| 1591 | Methods: |
| 1592 | |
| 1593 | - <code title="post /zones/{zone_identifier}/firewall/lockdowns">client.firewall.lockdowns.<a href="./src/resources/firewall/lockdowns.ts">create</a>(zoneIdentifier, { ...params }) -> Lockdown</code> |
| 1594 | - <code title="put /zones/{zone_identifier}/firewall/lockdowns/{id}">client.firewall.lockdowns.<a href="./src/resources/firewall/lockdowns.ts">update</a>(zoneIdentifier, id, { ...params }) -> Lockdown</code> |
| 1595 | - <code title="get /zones/{zone_identifier}/firewall/lockdowns">client.firewall.lockdowns.<a href="./src/resources/firewall/lockdowns.ts">list</a>(zoneIdentifier, { ...params }) -> LockdownsV4PagePaginationArray</code> |
| 1596 | - <code title="delete /zones/{zone_identifier}/firewall/lockdowns/{id}">client.firewall.lockdowns.<a href="./src/resources/firewall/lockdowns.ts">delete</a>(zoneIdentifier, id) -> LockdownDeleteResponse</code> |
| 1597 | - <code title="get /zones/{zone_identifier}/firewall/lockdowns/{id}">client.firewall.lockdowns.<a href="./src/resources/firewall/lockdowns.ts">get</a>(zoneIdentifier, id) -> Lockdown</code> |
| 1598 | |
| 1599 | ## Rules |
| 1600 | |
| 1601 | Types: |
| 1602 | |
| 1603 | - <code><a href="./src/resources/firewall/rules.ts">FirewallRule</a></code> |
| 1604 | - <code><a href="./src/resources/firewall/rules.ts">Product</a></code> |
| 1605 | - <code><a href="./src/resources/firewall/rules.ts">DeletedFilter</a></code> |
| 1606 | - <code><a href="./src/resources/firewall/rules.ts">RuleCreateResponse</a></code> |
| 1607 | - <code><a href="./src/resources/firewall/rules.ts">RuleEditResponse</a></code> |
| 1608 | |
| 1609 | Methods: |
| 1610 | |
| 1611 | - <code title="post /zones/{zone_identifier}/firewall/rules">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">create</a>(zoneIdentifier, { ...params }) -> RuleCreateResponse | null</code> |
| 1612 | - <code title="put /zones/{zone_identifier}/firewall/rules/{id}">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">update</a>(zoneIdentifier, id, { ...params }) -> FirewallRule</code> |
| 1613 | - <code title="get /zones/{zone_identifier}/firewall/rules">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">list</a>(zoneIdentifier, { ...params }) -> FirewallRulesV4PagePaginationArray</code> |
| 1614 | - <code title="delete /zones/{zone_identifier}/firewall/rules/{id}">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">delete</a>(zoneIdentifier, id) -> FirewallRule</code> |
| 1615 | - <code title="patch /zones/{zone_identifier}/firewall/rules/{id}">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">edit</a>(zoneIdentifier, id, { ...params }) -> RuleEditResponse | null</code> |
| 1616 | - <code title="get /zones/{zone_identifier}/firewall/rules/{id}">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">get</a>(zoneIdentifier, { ...params }) -> FirewallRule</code> |
| 1617 | |
| 1618 | ## AccessRules |
| 1619 | |
| 1620 | Types: |
| 1621 | |
| 1622 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleCIDRConfiguration</a></code> |
| 1623 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleIPConfiguration</a></code> |
| 1624 | - <code><a href="./src/resources/firewall/access-rules.ts">ASNConfiguration</a></code> |
| 1625 | - <code><a href="./src/resources/firewall/access-rules.ts">CountryConfiguration</a></code> |
| 1626 | - <code><a href="./src/resources/firewall/access-rules.ts">IPV6Configuration</a></code> |
| 1627 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleCreateResponse</a></code> |
| 1628 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleListResponse</a></code> |
| 1629 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleDeleteResponse</a></code> |
| 1630 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleEditResponse</a></code> |
| 1631 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleGetResponse</a></code> |
| 1632 | |
| 1633 | Methods: |
| 1634 | |
| 1635 | - <code title="post /{account_or_zone}/{account_or_zone_id}/firewall/access_rules/rules">client.firewall.accessRules.<a href="./src/resources/firewall/access-rules.ts">create</a>({ ...params }) -> AccessRuleCreateResponse</code> |
| 1636 | - <code title="get /{account_or_zone}/{account_or_zone_id}/firewall/access_rules/rules">client.firewall.accessRules.<a href="./src/resources/firewall/access-rules.ts">list</a>({ ...params }) -> AccessRuleListResponsesV4PagePaginationArray</code> |
| 1637 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/firewall/access_rules/rules/{identifier}">client.firewall.accessRules.<a href="./src/resources/firewall/access-rules.ts">delete</a>(identifier, { ...params }) -> AccessRuleDeleteResponse | null</code> |
| 1638 | - <code title="patch /{account_or_zone}/{account_or_zone_id}/firewall/access_rules/rules/{identifier}">client.firewall.accessRules.<a href="./src/resources/firewall/access-rules.ts">edit</a>(identifier, { ...params }) -> AccessRuleEditResponse</code> |
| 1639 | - <code title="get /{account_or_zone}/{account_or_zone_id}/firewall/access_rules/rules/{identifier}">client.firewall.accessRules.<a href="./src/resources/firewall/access-rules.ts">get</a>(identifier, { ...params }) -> AccessRuleGetResponse</code> |
| 1640 | |
| 1641 | ## UARules |
| 1642 | |
| 1643 | Types: |
| 1644 | |
| 1645 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleCreateResponse</a></code> |
| 1646 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleUpdateResponse</a></code> |
| 1647 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleListResponse</a></code> |
| 1648 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleDeleteResponse</a></code> |
| 1649 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleGetResponse</a></code> |
| 1650 | |
| 1651 | Methods: |
| 1652 | |
| 1653 | - <code title="post /zones/{zone_identifier}/firewall/ua_rules">client.firewall.uaRules.<a href="./src/resources/firewall/ua-rules.ts">create</a>(zoneIdentifier, { ...params }) -> UARuleCreateResponse</code> |
| 1654 | - <code title="put /zones/{zone_identifier}/firewall/ua_rules/{id}">client.firewall.uaRules.<a href="./src/resources/firewall/ua-rules.ts">update</a>(zoneIdentifier, id, { ...params }) -> UARuleUpdateResponse</code> |
| 1655 | - <code title="get /zones/{zone_identifier}/firewall/ua_rules">client.firewall.uaRules.<a href="./src/resources/firewall/ua-rules.ts">list</a>(zoneIdentifier, { ...params }) -> UARuleListResponsesV4PagePaginationArray</code> |
| 1656 | - <code title="delete /zones/{zone_identifier}/firewall/ua_rules/{id}">client.firewall.uaRules.<a href="./src/resources/firewall/ua-rules.ts">delete</a>(zoneIdentifier, id) -> UARuleDeleteResponse</code> |
| 1657 | - <code title="get /zones/{zone_identifier}/firewall/ua_rules/{id}">client.firewall.uaRules.<a href="./src/resources/firewall/ua-rules.ts">get</a>(zoneIdentifier, id) -> UARuleGetResponse</code> |
| 1658 | |
| 1659 | ## WAF |
| 1660 | |
| 1661 | ### Overrides |
| 1662 | |
| 1663 | Types: |
| 1664 | |
| 1665 | - <code><a href="./src/resources/firewall/waf/overrides.ts">Override</a></code> |
| 1666 | - <code><a href="./src/resources/firewall/waf/overrides.ts">OverrideURL</a></code> |
| 1667 | - <code><a href="./src/resources/firewall/waf/overrides.ts">RewriteAction</a></code> |
| 1668 | - <code><a href="./src/resources/firewall/waf/overrides.ts">WAFRule</a></code> |
| 1669 | - <code><a href="./src/resources/firewall/waf/overrides.ts">OverrideDeleteResponse</a></code> |
| 1670 | |
| 1671 | Methods: |
| 1672 | |
| 1673 | - <code title="post /zones/{zone_identifier}/firewall/waf/overrides">client.firewall.waf.overrides.<a href="./src/resources/firewall/waf/overrides.ts">create</a>(zoneIdentifier, { ...params }) -> Override</code> |
| 1674 | - <code title="put /zones/{zone_identifier}/firewall/waf/overrides/{id}">client.firewall.waf.overrides.<a href="./src/resources/firewall/waf/overrides.ts">update</a>(zoneIdentifier, id, { ...params }) -> Override</code> |
| 1675 | - <code title="get /zones/{zone_identifier}/firewall/waf/overrides">client.firewall.waf.overrides.<a href="./src/resources/firewall/waf/overrides.ts">list</a>(zoneIdentifier, { ...params }) -> OverridesV4PagePaginationArray</code> |
| 1676 | - <code title="delete /zones/{zone_identifier}/firewall/waf/overrides/{id}">client.firewall.waf.overrides.<a href="./src/resources/firewall/waf/overrides.ts">delete</a>(zoneIdentifier, id) -> OverrideDeleteResponse</code> |
| 1677 | - <code title="get /zones/{zone_identifier}/firewall/waf/overrides/{id}">client.firewall.waf.overrides.<a href="./src/resources/firewall/waf/overrides.ts">get</a>(zoneIdentifier, id) -> Override</code> |
| 1678 | |
| 1679 | ### Packages |
| 1680 | |
| 1681 | Types: |
| 1682 | |
| 1683 | - <code><a href="./src/resources/firewall/waf/packages/packages.ts">PackageListResponse</a></code> |
| 1684 | - <code><a href="./src/resources/firewall/waf/packages/packages.ts">PackageGetResponse</a></code> |
| 1685 | |
| 1686 | Methods: |
| 1687 | |
| 1688 | - <code title="get /zones/{zone_identifier}/firewall/waf/packages">client.firewall.waf.packages.<a href="./src/resources/firewall/waf/packages/packages.ts">list</a>(zoneIdentifier, { ...params }) -> PackageListResponsesV4PagePaginationArray</code> |
| 1689 | - <code title="get /zones/{zone_identifier}/firewall/waf/packages/{identifier}">client.firewall.waf.packages.<a href="./src/resources/firewall/waf/packages/packages.ts">get</a>(zoneIdentifier, identifier) -> PackageGetResponse</code> |
| 1690 | |
| 1691 | #### Groups |
| 1692 | |
| 1693 | Types: |
| 1694 | |
| 1695 | - <code><a href="./src/resources/firewall/waf/packages/groups.ts">Group</a></code> |
| 1696 | - <code><a href="./src/resources/firewall/waf/packages/groups.ts">GroupEditResponse</a></code> |
| 1697 | - <code><a href="./src/resources/firewall/waf/packages/groups.ts">GroupGetResponse</a></code> |
| 1698 | |
| 1699 | Methods: |
| 1700 | |
| 1701 | - <code title="get /zones/{zone_id}/firewall/waf/packages/{package_id}/groups">client.firewall.waf.packages.groups.<a href="./src/resources/firewall/waf/packages/groups.ts">list</a>(packageId, { ...params }) -> GroupsV4PagePaginationArray</code> |
| 1702 | - <code title="patch /zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}">client.firewall.waf.packages.groups.<a href="./src/resources/firewall/waf/packages/groups.ts">edit</a>(packageId, groupId, { ...params }) -> GroupEditResponse</code> |
| 1703 | - <code title="get /zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}">client.firewall.waf.packages.groups.<a href="./src/resources/firewall/waf/packages/groups.ts">get</a>(packageId, groupId, { ...params }) -> GroupGetResponse</code> |
| 1704 | |
| 1705 | #### Rules |
| 1706 | |
| 1707 | Types: |
| 1708 | |
| 1709 | - <code><a href="./src/resources/firewall/waf/packages/rules.ts">AllowedModesAnomaly</a></code> |
| 1710 | - <code><a href="./src/resources/firewall/waf/packages/rules.ts">WAFRuleGroup</a></code> |
| 1711 | - <code><a href="./src/resources/firewall/waf/packages/rules.ts">RuleListResponse</a></code> |
| 1712 | - <code><a href="./src/resources/firewall/waf/packages/rules.ts">RuleEditResponse</a></code> |
| 1713 | - <code><a href="./src/resources/firewall/waf/packages/rules.ts">RuleGetResponse</a></code> |
| 1714 | |
| 1715 | Methods: |
| 1716 | |
| 1717 | - <code title="get /zones/{zone_id}/firewall/waf/packages/{package_id}/rules">client.firewall.waf.packages.rules.<a href="./src/resources/firewall/waf/packages/rules.ts">list</a>(packageId, { ...params }) -> RuleListResponsesV4PagePaginationArray</code> |
| 1718 | - <code title="patch /zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}">client.firewall.waf.packages.rules.<a href="./src/resources/firewall/waf/packages/rules.ts">edit</a>(packageId, ruleId, { ...params }) -> RuleEditResponse</code> |
| 1719 | - <code title="get /zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}">client.firewall.waf.packages.rules.<a href="./src/resources/firewall/waf/packages/rules.ts">get</a>(packageId, ruleId, { ...params }) -> RuleGetResponse</code> |
| 1720 | |
| 1721 | # Healthchecks |
| 1722 | |
| 1723 | Types: |
| 1724 | |
| 1725 | - <code><a href="./src/resources/healthchecks/healthchecks.ts">CheckRegion</a></code> |
| 1726 | - <code><a href="./src/resources/healthchecks/healthchecks.ts">Healthcheck</a></code> |
| 1727 | - <code><a href="./src/resources/healthchecks/healthchecks.ts">HTTPConfiguration</a></code> |
| 1728 | - <code><a href="./src/resources/healthchecks/healthchecks.ts">QueryHealthcheck</a></code> |
| 1729 | - <code><a href="./src/resources/healthchecks/healthchecks.ts">TCPConfiguration</a></code> |
| 1730 | - <code><a href="./src/resources/healthchecks/healthchecks.ts">HealthcheckDeleteResponse</a></code> |
| 1731 | |
| 1732 | Methods: |
| 1733 | |
| 1734 | - <code title="post /zones/{zone_id}/healthchecks">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">create</a>({ ...params }) -> Healthcheck</code> |
| 1735 | - <code title="put /zones/{zone_id}/healthchecks/{healthcheck_id}">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">update</a>(healthcheckId, { ...params }) -> Healthcheck</code> |
| 1736 | - <code title="get /zones/{zone_id}/healthchecks">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">list</a>({ ...params }) -> HealthchecksSinglePage</code> |
| 1737 | - <code title="delete /zones/{zone_id}/healthchecks/{healthcheck_id}">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">delete</a>(healthcheckId, { ...params }) -> HealthcheckDeleteResponse</code> |
| 1738 | - <code title="patch /zones/{zone_id}/healthchecks/{healthcheck_id}">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">edit</a>(healthcheckId, { ...params }) -> Healthcheck</code> |
| 1739 | - <code title="get /zones/{zone_id}/healthchecks/{healthcheck_id}">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">get</a>(healthcheckId, { ...params }) -> Healthcheck</code> |
| 1740 | |
| 1741 | ## Previews |
| 1742 | |
| 1743 | Types: |
| 1744 | |
| 1745 | - <code><a href="./src/resources/healthchecks/previews.ts">PreviewDeleteResponse</a></code> |
| 1746 | |
| 1747 | Methods: |
| 1748 | |
| 1749 | - <code title="post /zones/{zone_id}/healthchecks/preview">client.healthchecks.previews.<a href="./src/resources/healthchecks/previews.ts">create</a>({ ...params }) -> Healthcheck</code> |
| 1750 | - <code title="delete /zones/{zone_id}/healthchecks/preview/{healthcheck_id}">client.healthchecks.previews.<a href="./src/resources/healthchecks/previews.ts">delete</a>(healthcheckId, { ...params }) -> PreviewDeleteResponse</code> |
| 1751 | - <code title="get /zones/{zone_id}/healthchecks/preview/{healthcheck_id}">client.healthchecks.previews.<a href="./src/resources/healthchecks/previews.ts">get</a>(healthcheckId, { ...params }) -> Healthcheck</code> |
| 1752 | |
| 1753 | # KeylessCertificates |
| 1754 | |
| 1755 | Types: |
| 1756 | |
| 1757 | - <code><a href="./src/resources/keyless-certificates.ts">KeylessCertificate</a></code> |
| 1758 | - <code><a href="./src/resources/keyless-certificates.ts">Tunnel</a></code> |
| 1759 | - <code><a href="./src/resources/keyless-certificates.ts">KeylessCertificateDeleteResponse</a></code> |
| 1760 | |
| 1761 | Methods: |
| 1762 | |
| 1763 | - <code title="post /zones/{zone_id}/keyless_certificates">client.keylessCertificates.<a href="./src/resources/keyless-certificates.ts">create</a>({ ...params }) -> KeylessCertificate</code> |
| 1764 | - <code title="get /zones/{zone_id}/keyless_certificates">client.keylessCertificates.<a href="./src/resources/keyless-certificates.ts">list</a>({ ...params }) -> KeylessCertificatesSinglePage</code> |
| 1765 | - <code title="delete /zones/{zone_id}/keyless_certificates/{keyless_certificate_id}">client.keylessCertificates.<a href="./src/resources/keyless-certificates.ts">delete</a>(keylessCertificateId, { ...params }) -> KeylessCertificateDeleteResponse</code> |
| 1766 | - <code title="patch /zones/{zone_id}/keyless_certificates/{keyless_certificate_id}">client.keylessCertificates.<a href="./src/resources/keyless-certificates.ts">edit</a>(keylessCertificateId, { ...params }) -> KeylessCertificate</code> |
| 1767 | - <code title="get /zones/{zone_id}/keyless_certificates/{keyless_certificate_id}">client.keylessCertificates.<a href="./src/resources/keyless-certificates.ts">get</a>(keylessCertificateId, { ...params }) -> KeylessCertificate</code> |
| 1768 | |
| 1769 | # Logpush |
| 1770 | |
| 1771 | ## Datasets |
| 1772 | |
| 1773 | ### Fields |
| 1774 | |
| 1775 | Types: |
| 1776 | |
| 1777 | - <code><a href="./src/resources/logpush/datasets/fields.ts">FieldGetResponse</a></code> |
| 1778 | |
| 1779 | Methods: |
| 1780 | |
| 1781 | - <code title="get /{account_or_zone}/{account_or_zone_id}/logpush/datasets/{dataset_id}/fields">client.logpush.datasets.fields.<a href="./src/resources/logpush/datasets/fields.ts">get</a>(datasetId, { ...params }) -> FieldGetResponse</code> |
| 1782 | |
| 1783 | ### Jobs |
| 1784 | |
| 1785 | Types: |
| 1786 | |
| 1787 | - <code><a href="./src/resources/logpush/datasets/jobs.ts">JobGetResponse</a></code> |
| 1788 | |
| 1789 | Methods: |
| 1790 | |
| 1791 | - <code title="get /{account_or_zone}/{account_or_zone_id}/logpush/datasets/{dataset_id}/jobs">client.logpush.datasets.jobs.<a href="./src/resources/logpush/datasets/jobs.ts">get</a>(datasetId, { ...params }) -> JobGetResponse</code> |
| 1792 | |
| 1793 | ## Edge |
| 1794 | |
| 1795 | Types: |
| 1796 | |
| 1797 | - <code><a href="./src/resources/logpush/edge.ts">InstantLogpushJob</a></code> |
| 1798 | - <code><a href="./src/resources/logpush/edge.ts">EdgeGetResponse</a></code> |
| 1799 | |
| 1800 | Methods: |
| 1801 | |
| 1802 | - <code title="post /zones/{zone_id}/logpush/edge">client.logpush.edge.<a href="./src/resources/logpush/edge.ts">create</a>({ ...params }) -> InstantLogpushJob | null</code> |
| 1803 | - <code title="get /zones/{zone_id}/logpush/edge">client.logpush.edge.<a href="./src/resources/logpush/edge.ts">get</a>({ ...params }) -> EdgeGetResponse</code> |
| 1804 | |
| 1805 | ## Jobs |
| 1806 | |
| 1807 | Types: |
| 1808 | |
| 1809 | - <code><a href="./src/resources/logpush/jobs.ts">LogpushJob</a></code> |
| 1810 | - <code><a href="./src/resources/logpush/jobs.ts">OutputOptions</a></code> |
| 1811 | - <code><a href="./src/resources/logpush/jobs.ts">JobDeleteResponse</a></code> |
| 1812 | |
| 1813 | Methods: |
| 1814 | |
| 1815 | - <code title="post /{account_or_zone}/{account_or_zone_id}/logpush/jobs">client.logpush.jobs.<a href="./src/resources/logpush/jobs.ts">create</a>({ ...params }) -> LogpushJob | null</code> |
| 1816 | - <code title="put /{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}">client.logpush.jobs.<a href="./src/resources/logpush/jobs.ts">update</a>(jobId, { ...params }) -> LogpushJob | null</code> |
| 1817 | - <code title="get /{account_or_zone}/{account_or_zone_id}/logpush/jobs">client.logpush.jobs.<a href="./src/resources/logpush/jobs.ts">list</a>({ ...params }) -> LogpushJobsSinglePage</code> |
| 1818 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}">client.logpush.jobs.<a href="./src/resources/logpush/jobs.ts">delete</a>(jobId, { ...params }) -> JobDeleteResponse | null</code> |
| 1819 | - <code title="get /{account_or_zone}/{account_or_zone_id}/logpush/jobs/{job_id}">client.logpush.jobs.<a href="./src/resources/logpush/jobs.ts">get</a>(jobId, { ...params }) -> LogpushJob | null</code> |
| 1820 | |
| 1821 | ## Ownership |
| 1822 | |
| 1823 | Types: |
| 1824 | |
| 1825 | - <code><a href="./src/resources/logpush/ownership.ts">OwnershipValidation</a></code> |
| 1826 | - <code><a href="./src/resources/logpush/ownership.ts">OwnershipCreateResponse</a></code> |
| 1827 | |
| 1828 | Methods: |
| 1829 | |
| 1830 | - <code title="post /{account_or_zone}/{account_or_zone_id}/logpush/ownership">client.logpush.ownership.<a href="./src/resources/logpush/ownership.ts">create</a>({ ...params }) -> OwnershipCreateResponse | null</code> |
| 1831 | - <code title="post /{account_or_zone}/{account_or_zone_id}/logpush/ownership/validate">client.logpush.ownership.<a href="./src/resources/logpush/ownership.ts">validate</a>({ ...params }) -> OwnershipValidation | null</code> |
| 1832 | |
| 1833 | ## Validate |
| 1834 | |
| 1835 | Types: |
| 1836 | |
| 1837 | - <code><a href="./src/resources/logpush/validate.ts">ValidateDestinationResponse</a></code> |
| 1838 | - <code><a href="./src/resources/logpush/validate.ts">ValidateOriginResponse</a></code> |
| 1839 | |
| 1840 | Methods: |
| 1841 | |
| 1842 | - <code title="post /{account_or_zone}/{account_or_zone_id}/logpush/validate/destination/exists">client.logpush.validate.<a href="./src/resources/logpush/validate.ts">destination</a>({ ...params }) -> ValidateDestinationResponse | null</code> |
| 1843 | - <code title="post /{account_or_zone}/{account_or_zone_id}/logpush/validate/origin">client.logpush.validate.<a href="./src/resources/logpush/validate.ts">origin</a>({ ...params }) -> ValidateOriginResponse | null</code> |
| 1844 | |
| 1845 | # Logs |
| 1846 | |
| 1847 | ## Control |
| 1848 | |
| 1849 | ### Retention |
| 1850 | |
| 1851 | Types: |
| 1852 | |
| 1853 | - <code><a href="./src/resources/logs/control/retention.ts">RetentionCreateResponse</a></code> |
| 1854 | - <code><a href="./src/resources/logs/control/retention.ts">RetentionGetResponse</a></code> |
| 1855 | |
| 1856 | Methods: |
| 1857 | |
| 1858 | - <code title="post /zones/{zone_identifier}/logs/control/retention/flag">client.logs.control.retention.<a href="./src/resources/logs/control/retention.ts">create</a>(zoneIdentifier, { ...params }) -> RetentionCreateResponse</code> |
| 1859 | - <code title="get /zones/{zone_identifier}/logs/control/retention/flag">client.logs.control.retention.<a href="./src/resources/logs/control/retention.ts">get</a>(zoneIdentifier) -> RetentionGetResponse</code> |
| 1860 | |
| 1861 | ### Cmb |
| 1862 | |
| 1863 | #### Config |
| 1864 | |
| 1865 | Types: |
| 1866 | |
| 1867 | - <code><a href="./src/resources/logs/control/cmb/config.ts">CmbConfig</a></code> |
| 1868 | - <code><a href="./src/resources/logs/control/cmb/config.ts">ConfigDeleteResponse</a></code> |
| 1869 | |
| 1870 | Methods: |
| 1871 | |
| 1872 | - <code title="post /accounts/{account_id}/logs/control/cmb/config">client.logs.control.cmb.config.<a href="./src/resources/logs/control/cmb/config.ts">create</a>({ ...params }) -> CmbConfig | null</code> |
| 1873 | - <code title="delete /accounts/{account_id}/logs/control/cmb/config">client.logs.control.cmb.config.<a href="./src/resources/logs/control/cmb/config.ts">delete</a>({ ...params }) -> ConfigDeleteResponse | null</code> |
| 1874 | - <code title="get /accounts/{account_id}/logs/control/cmb/config">client.logs.control.cmb.config.<a href="./src/resources/logs/control/cmb/config.ts">get</a>({ ...params }) -> CmbConfig | null</code> |
| 1875 | |
| 1876 | ## RayID |
| 1877 | |
| 1878 | Types: |
| 1879 | |
| 1880 | - <code><a href="./src/resources/logs/rayid.ts">RayIDGetResponse</a></code> |
| 1881 | |
| 1882 | Methods: |
| 1883 | |
| 1884 | - <code title="get /zones/{zone_identifier}/logs/rayids/{ray_identifier}">client.logs.RayID.<a href="./src/resources/logs/rayid.ts">get</a>(zoneIdentifier, rayIdentifier, { ...params }) -> RayIDGetResponse</code> |
| 1885 | |
| 1886 | ## Received |
| 1887 | |
| 1888 | Types: |
| 1889 | |
| 1890 | - <code><a href="./src/resources/logs/received/received.ts">ReceivedGetResponse</a></code> |
| 1891 | |
| 1892 | Methods: |
| 1893 | |
| 1894 | - <code title="get /zones/{zone_identifier}/logs/received">client.logs.received.<a href="./src/resources/logs/received/received.ts">get</a>(zoneIdentifier, { ...params }) -> ReceivedGetResponse</code> |
| 1895 | |
| 1896 | ### Fields |
| 1897 | |
| 1898 | Types: |
| 1899 | |
| 1900 | - <code><a href="./src/resources/logs/received/fields.ts">FieldGetResponse</a></code> |
| 1901 | |
| 1902 | Methods: |
| 1903 | |
| 1904 | - <code title="get /zones/{zone_identifier}/logs/received/fields">client.logs.received.fields.<a href="./src/resources/logs/received/fields.ts">get</a>(zoneIdentifier) -> FieldGetResponse</code> |
| 1905 | |
| 1906 | # OriginTLSClientAuth |
| 1907 | |
| 1908 | Types: |
| 1909 | |
| 1910 | - <code><a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">ZoneAuthenticatedOriginPull</a></code> |
| 1911 | - <code><a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">OriginTLSClientAuthCreateResponse</a></code> |
| 1912 | - <code><a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">OriginTLSClientAuthDeleteResponse</a></code> |
| 1913 | - <code><a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">OriginTLSClientAuthGetResponse</a></code> |
| 1914 | |
| 1915 | Methods: |
| 1916 | |
| 1917 | - <code title="post /zones/{zone_id}/origin_tls_client_auth">client.originTLSClientAuth.<a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">create</a>({ ...params }) -> OriginTLSClientAuthCreateResponse</code> |
| 1918 | - <code title="get /zones/{zone_id}/origin_tls_client_auth">client.originTLSClientAuth.<a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">list</a>({ ...params }) -> ZoneAuthenticatedOriginPullsSinglePage</code> |
| 1919 | - <code title="delete /zones/{zone_id}/origin_tls_client_auth/{certificate_id}">client.originTLSClientAuth.<a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">delete</a>(certificateId, { ...params }) -> OriginTLSClientAuthDeleteResponse</code> |
| 1920 | - <code title="get /zones/{zone_id}/origin_tls_client_auth/{certificate_id}">client.originTLSClientAuth.<a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">get</a>(certificateId, { ...params }) -> OriginTLSClientAuthGetResponse</code> |
| 1921 | |
| 1922 | ## Hostnames |
| 1923 | |
| 1924 | Types: |
| 1925 | |
| 1926 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/hostnames.ts">AuthenticatedOriginPull</a></code> |
| 1927 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/hostnames.ts">HostnameUpdateResponse</a></code> |
| 1928 | |
| 1929 | Methods: |
| 1930 | |
| 1931 | - <code title="put /zones/{zone_id}/origin_tls_client_auth/hostnames">client.originTLSClientAuth.hostnames.<a href="./src/resources/origin-tls-client-auth/hostnames/hostnames.ts">update</a>({ ...params }) -> HostnameUpdateResponse | null</code> |
| 1932 | - <code title="get /zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}">client.originTLSClientAuth.hostnames.<a href="./src/resources/origin-tls-client-auth/hostnames/hostnames.ts">get</a>(hostname, { ...params }) -> AuthenticatedOriginPull</code> |
| 1933 | |
| 1934 | ### Certificates |
| 1935 | |
| 1936 | Types: |
| 1937 | |
| 1938 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">Certificate</a></code> |
| 1939 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">CertificateCreateResponse</a></code> |
| 1940 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">CertificateDeleteResponse</a></code> |
| 1941 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">CertificateGetResponse</a></code> |
| 1942 | |
| 1943 | Methods: |
| 1944 | |
| 1945 | - <code title="post /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates">client.originTLSClientAuth.hostnames.certificates.<a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">create</a>({ ...params }) -> CertificateCreateResponse</code> |
| 1946 | - <code title="get /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates">client.originTLSClientAuth.hostnames.certificates.<a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">list</a>({ ...params }) -> AuthenticatedOriginPullsSinglePage</code> |
| 1947 | - <code title="delete /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}">client.originTLSClientAuth.hostnames.certificates.<a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">delete</a>(certificateId, { ...params }) -> CertificateDeleteResponse</code> |
| 1948 | - <code title="get /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}">client.originTLSClientAuth.hostnames.certificates.<a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">get</a>(certificateId, { ...params }) -> CertificateGetResponse</code> |
| 1949 | |
| 1950 | ## Settings |
| 1951 | |
| 1952 | Types: |
| 1953 | |
| 1954 | - <code><a href="./src/resources/origin-tls-client-auth/settings.ts">SettingUpdateResponse</a></code> |
| 1955 | - <code><a href="./src/resources/origin-tls-client-auth/settings.ts">SettingGetResponse</a></code> |
| 1956 | |
| 1957 | Methods: |
| 1958 | |
| 1959 | - <code title="put /zones/{zone_id}/origin_tls_client_auth/settings">client.originTLSClientAuth.settings.<a href="./src/resources/origin-tls-client-auth/settings.ts">update</a>({ ...params }) -> SettingUpdateResponse</code> |
| 1960 | - <code title="get /zones/{zone_id}/origin_tls_client_auth/settings">client.originTLSClientAuth.settings.<a href="./src/resources/origin-tls-client-auth/settings.ts">get</a>({ ...params }) -> SettingGetResponse</code> |
| 1961 | |
| 1962 | # Pagerules |
| 1963 | |
| 1964 | Types: |
| 1965 | |
| 1966 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageRule</a></code> |
| 1967 | - <code><a href="./src/resources/pagerules/pagerules.ts">Route</a></code> |
| 1968 | - <code><a href="./src/resources/pagerules/pagerules.ts">Target</a></code> |
| 1969 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleCreateResponse</a></code> |
| 1970 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleUpdateResponse</a></code> |
| 1971 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleListResponse</a></code> |
| 1972 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleDeleteResponse</a></code> |
| 1973 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleEditResponse</a></code> |
| 1974 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleGetResponse</a></code> |
| 1975 | |
| 1976 | Methods: |
| 1977 | |
| 1978 | - <code title="post /zones/{zone_id}/pagerules">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">create</a>({ ...params }) -> PageruleCreateResponse</code> |
| 1979 | - <code title="put /zones/{zone_id}/pagerules/{pagerule_id}">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">update</a>(pageruleId, { ...params }) -> PageruleUpdateResponse</code> |
| 1980 | - <code title="get /zones/{zone_id}/pagerules">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">list</a>({ ...params }) -> PageruleListResponse</code> |
| 1981 | - <code title="delete /zones/{zone_id}/pagerules/{pagerule_id}">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">delete</a>(pageruleId, { ...params }) -> PageruleDeleteResponse | null</code> |
| 1982 | - <code title="patch /zones/{zone_id}/pagerules/{pagerule_id}">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">edit</a>(pageruleId, { ...params }) -> PageruleEditResponse</code> |
| 1983 | - <code title="get /zones/{zone_id}/pagerules/{pagerule_id}">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">get</a>(pageruleId, { ...params }) -> PageruleGetResponse</code> |
| 1984 | |
| 1985 | ## Settings |
| 1986 | |
| 1987 | Types: |
| 1988 | |
| 1989 | - <code><a href="./src/resources/pagerules/settings.ts">SettingListResponse</a></code> |
| 1990 | |
| 1991 | Methods: |
| 1992 | |
| 1993 | - <code title="get /zones/{zone_id}/pagerules/settings">client.pagerules.settings.<a href="./src/resources/pagerules/settings.ts">list</a>({ ...params }) -> SettingListResponse</code> |
| 1994 | |
| 1995 | # RateLimits |
| 1996 | |
| 1997 | Types: |
| 1998 | |
| 1999 | - <code><a href="./src/resources/rate-limits.ts">Action</a></code> |
| 2000 | - <code><a href="./src/resources/rate-limits.ts">Methods</a></code> |
| 2001 | - <code><a href="./src/resources/rate-limits.ts">RateLimit</a></code> |
| 2002 | - <code><a href="./src/resources/rate-limits.ts">RateLimitCreateResponse</a></code> |
| 2003 | - <code><a href="./src/resources/rate-limits.ts">RateLimitDeleteResponse</a></code> |
| 2004 | - <code><a href="./src/resources/rate-limits.ts">RateLimitEditResponse</a></code> |
| 2005 | - <code><a href="./src/resources/rate-limits.ts">RateLimitGetResponse</a></code> |
| 2006 | |
| 2007 | Methods: |
| 2008 | |
| 2009 | - <code title="post /zones/{zone_identifier}/rate_limits">client.rateLimits.<a href="./src/resources/rate-limits.ts">create</a>(zoneIdentifier, { ...params }) -> RateLimitCreateResponse</code> |
| 2010 | - <code title="get /zones/{zone_identifier}/rate_limits">client.rateLimits.<a href="./src/resources/rate-limits.ts">list</a>(zoneIdentifier, { ...params }) -> RateLimitsV4PagePaginationArray</code> |
| 2011 | - <code title="delete /zones/{zone_identifier}/rate_limits/{id}">client.rateLimits.<a href="./src/resources/rate-limits.ts">delete</a>(zoneIdentifier, id) -> RateLimitDeleteResponse</code> |
| 2012 | - <code title="put /zones/{zone_identifier}/rate_limits/{id}">client.rateLimits.<a href="./src/resources/rate-limits.ts">edit</a>(zoneIdentifier, id, { ...params }) -> RateLimitEditResponse</code> |
| 2013 | - <code title="get /zones/{zone_identifier}/rate_limits/{id}">client.rateLimits.<a href="./src/resources/rate-limits.ts">get</a>(zoneIdentifier, id) -> RateLimitGetResponse</code> |
| 2014 | |
| 2015 | # SecondaryDNS |
| 2016 | |
| 2017 | ## ForceAXFR |
| 2018 | |
| 2019 | Types: |
| 2020 | |
| 2021 | - <code><a href="./src/resources/secondary-dns/force-axfr.ts">ForceAXFR</a></code> |
| 2022 | |
| 2023 | Methods: |
| 2024 | |
| 2025 | - <code title="post /zones/{zone_id}/secondary_dns/force_axfr">client.secondaryDNS.forceAXFR.<a href="./src/resources/secondary-dns/force-axfr.ts">create</a>({ ...params }) -> ForceAXFR</code> |
| 2026 | |
| 2027 | ## Incoming |
| 2028 | |
| 2029 | Types: |
| 2030 | |
| 2031 | - <code><a href="./src/resources/secondary-dns/incoming.ts">Incoming</a></code> |
| 2032 | - <code><a href="./src/resources/secondary-dns/incoming.ts">IncomingCreateResponse</a></code> |
| 2033 | - <code><a href="./src/resources/secondary-dns/incoming.ts">IncomingUpdateResponse</a></code> |
| 2034 | - <code><a href="./src/resources/secondary-dns/incoming.ts">IncomingDeleteResponse</a></code> |
| 2035 | - <code><a href="./src/resources/secondary-dns/incoming.ts">IncomingGetResponse</a></code> |
| 2036 | |
| 2037 | Methods: |
| 2038 | |
| 2039 | - <code title="post /zones/{zone_id}/secondary_dns/incoming">client.secondaryDNS.incoming.<a href="./src/resources/secondary-dns/incoming.ts">create</a>({ ...params }) -> IncomingCreateResponse</code> |
| 2040 | - <code title="put /zones/{zone_id}/secondary_dns/incoming">client.secondaryDNS.incoming.<a href="./src/resources/secondary-dns/incoming.ts">update</a>({ ...params }) -> IncomingUpdateResponse</code> |
| 2041 | - <code title="delete /zones/{zone_id}/secondary_dns/incoming">client.secondaryDNS.incoming.<a href="./src/resources/secondary-dns/incoming.ts">delete</a>({ ...params }) -> IncomingDeleteResponse</code> |
| 2042 | - <code title="get /zones/{zone_id}/secondary_dns/incoming">client.secondaryDNS.incoming.<a href="./src/resources/secondary-dns/incoming.ts">get</a>({ ...params }) -> IncomingGetResponse</code> |
| 2043 | |
| 2044 | ## Outgoing |
| 2045 | |
| 2046 | Types: |
| 2047 | |
| 2048 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">DisableTransfer</a></code> |
| 2049 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">EnableTransfer</a></code> |
| 2050 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">Outgoing</a></code> |
| 2051 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingStatus</a></code> |
| 2052 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingCreateResponse</a></code> |
| 2053 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingUpdateResponse</a></code> |
| 2054 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingDeleteResponse</a></code> |
| 2055 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingForceNotifyResponse</a></code> |
| 2056 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingGetResponse</a></code> |
| 2057 | |
| 2058 | Methods: |
| 2059 | |
| 2060 | - <code title="post /zones/{zone_id}/secondary_dns/outgoing">client.secondaryDNS.outgoing.<a href="./src/resources/secondary-dns/outgoing/outgoing.ts">create</a>({ ...params }) -> OutgoingCreateResponse</code> |
| 2061 | - <code title="put /zones/{zone_id}/secondary_dns/outgoing">client.secondaryDNS.outgoing.<a href="./src/resources/secondary-dns/outgoing/outgoing.ts">update</a>({ ...params }) -> OutgoingUpdateResponse</code> |
| 2062 | - <code title="delete /zones/{zone_id}/secondary_dns/outgoing">client.secondaryDNS.outgoing.<a href="./src/resources/secondary-dns/outgoing/outgoing.ts">delete</a>({ ...params }) -> OutgoingDeleteResponse</code> |
| 2063 | - <code title="post /zones/{zone_id}/secondary_dns/outgoing/disable">client.secondaryDNS.outgoing.<a href="./src/resources/secondary-dns/outgoing/outgoing.ts">disable</a>({ ...params }) -> DisableTransfer</code> |
| 2064 | - <code title="post /zones/{zone_id}/secondary_dns/outgoing/enable">client.secondaryDNS.outgoing.<a href="./src/resources/secondary-dns/outgoing/outgoing.ts">enable</a>({ ...params }) -> EnableTransfer</code> |
| 2065 | - <code title="post /zones/{zone_id}/secondary_dns/outgoing/force_notify">client.secondaryDNS.outgoing.<a href="./src/resources/secondary-dns/outgoing/outgoing.ts">forceNotify</a>({ ...params }) -> OutgoingForceNotifyResponse</code> |
| 2066 | - <code title="get /zones/{zone_id}/secondary_dns/outgoing">client.secondaryDNS.outgoing.<a href="./src/resources/secondary-dns/outgoing/outgoing.ts">get</a>({ ...params }) -> OutgoingGetResponse</code> |
| 2067 | |
| 2068 | ### Status |
| 2069 | |
| 2070 | Methods: |
| 2071 | |
| 2072 | - <code title="get /zones/{zone_id}/secondary_dns/outgoing/status">client.secondaryDNS.outgoing.status.<a href="./src/resources/secondary-dns/outgoing/status.ts">get</a>({ ...params }) -> EnableTransfer</code> |
| 2073 | |
| 2074 | ## ACLs |
| 2075 | |
| 2076 | Types: |
| 2077 | |
| 2078 | - <code><a href="./src/resources/secondary-dns/acls.ts">ACL</a></code> |
| 2079 | - <code><a href="./src/resources/secondary-dns/acls.ts">ACLDeleteResponse</a></code> |
| 2080 | |
| 2081 | Methods: |
| 2082 | |
| 2083 | - <code title="post /accounts/{account_id}/secondary_dns/acls">client.secondaryDNS.acls.<a href="./src/resources/secondary-dns/acls.ts">create</a>({ ...params }) -> ACL</code> |
| 2084 | - <code title="put /accounts/{account_id}/secondary_dns/acls/{acl_id}">client.secondaryDNS.acls.<a href="./src/resources/secondary-dns/acls.ts">update</a>(aclId, { ...params }) -> ACL</code> |
| 2085 | - <code title="get /accounts/{account_id}/secondary_dns/acls">client.secondaryDNS.acls.<a href="./src/resources/secondary-dns/acls.ts">list</a>({ ...params }) -> ACLsSinglePage</code> |
| 2086 | - <code title="delete /accounts/{account_id}/secondary_dns/acls/{acl_id}">client.secondaryDNS.acls.<a href="./src/resources/secondary-dns/acls.ts">delete</a>(aclId, { ...params }) -> ACLDeleteResponse</code> |
| 2087 | - <code title="get /accounts/{account_id}/secondary_dns/acls/{acl_id}">client.secondaryDNS.acls.<a href="./src/resources/secondary-dns/acls.ts">get</a>(aclId, { ...params }) -> ACL</code> |
| 2088 | |
| 2089 | ## Peers |
| 2090 | |
| 2091 | Types: |
| 2092 | |
| 2093 | - <code><a href="./src/resources/secondary-dns/peers.ts">Peer</a></code> |
| 2094 | - <code><a href="./src/resources/secondary-dns/peers.ts">PeerDeleteResponse</a></code> |
| 2095 | |
| 2096 | Methods: |
| 2097 | |
| 2098 | - <code title="post /accounts/{account_id}/secondary_dns/peers">client.secondaryDNS.peers.<a href="./src/resources/secondary-dns/peers.ts">create</a>({ ...params }) -> Peer</code> |
| 2099 | - <code title="put /accounts/{account_id}/secondary_dns/peers/{peer_id}">client.secondaryDNS.peers.<a href="./src/resources/secondary-dns/peers.ts">update</a>(peerId, { ...params }) -> Peer</code> |
| 2100 | - <code title="get /accounts/{account_id}/secondary_dns/peers">client.secondaryDNS.peers.<a href="./src/resources/secondary-dns/peers.ts">list</a>({ ...params }) -> PeersSinglePage</code> |
| 2101 | - <code title="delete /accounts/{account_id}/secondary_dns/peers/{peer_id}">client.secondaryDNS.peers.<a href="./src/resources/secondary-dns/peers.ts">delete</a>(peerId, { ...params }) -> PeerDeleteResponse</code> |
| 2102 | - <code title="get /accounts/{account_id}/secondary_dns/peers/{peer_id}">client.secondaryDNS.peers.<a href="./src/resources/secondary-dns/peers.ts">get</a>(peerId, { ...params }) -> Peer</code> |
| 2103 | |
| 2104 | ## TSIGs |
| 2105 | |
| 2106 | Types: |
| 2107 | |
| 2108 | - <code><a href="./src/resources/secondary-dns/tsigs.ts">TSIG</a></code> |
| 2109 | - <code><a href="./src/resources/secondary-dns/tsigs.ts">TSIGDeleteResponse</a></code> |
| 2110 | |
| 2111 | Methods: |
| 2112 | |
| 2113 | - <code title="post /accounts/{account_id}/secondary_dns/tsigs">client.secondaryDNS.tsigs.<a href="./src/resources/secondary-dns/tsigs.ts">create</a>({ ...params }) -> TSIG</code> |
| 2114 | - <code title="put /accounts/{account_id}/secondary_dns/tsigs/{tsig_id}">client.secondaryDNS.tsigs.<a href="./src/resources/secondary-dns/tsigs.ts">update</a>(tsigId, { ...params }) -> TSIG</code> |
| 2115 | - <code title="get /accounts/{account_id}/secondary_dns/tsigs">client.secondaryDNS.tsigs.<a href="./src/resources/secondary-dns/tsigs.ts">list</a>({ ...params }) -> TSIGsSinglePage</code> |
| 2116 | - <code title="delete /accounts/{account_id}/secondary_dns/tsigs/{tsig_id}">client.secondaryDNS.tsigs.<a href="./src/resources/secondary-dns/tsigs.ts">delete</a>(tsigId, { ...params }) -> TSIGDeleteResponse</code> |
| 2117 | - <code title="get /accounts/{account_id}/secondary_dns/tsigs/{tsig_id}">client.secondaryDNS.tsigs.<a href="./src/resources/secondary-dns/tsigs.ts">get</a>(tsigId, { ...params }) -> TSIG</code> |
| 2118 | |
| 2119 | # WaitingRooms |
| 2120 | |
| 2121 | Types: |
| 2122 | |
| 2123 | - <code><a href="./src/resources/waiting-rooms/waiting-rooms.ts">AdditionalRoutes</a></code> |
| 2124 | - <code><a href="./src/resources/waiting-rooms/waiting-rooms.ts">CookieAttributes</a></code> |
| 2125 | - <code><a href="./src/resources/waiting-rooms/waiting-rooms.ts">Query</a></code> |
| 2126 | - <code><a href="./src/resources/waiting-rooms/waiting-rooms.ts">WaitingRoom</a></code> |
| 2127 | - <code><a href="./src/resources/waiting-rooms/waiting-rooms.ts">WaitingRoomDeleteResponse</a></code> |
| 2128 | |
| 2129 | Methods: |
| 2130 | |
| 2131 | - <code title="post /zones/{zone_id}/waiting_rooms">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">create</a>({ ...params }) -> WaitingRoom</code> |
| 2132 | - <code title="put /zones/{zone_id}/waiting_rooms/{waiting_room_id}">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">update</a>(waitingRoomId, { ...params }) -> WaitingRoom</code> |
| 2133 | - <code title="get /zones/{zone_id}/waiting_rooms">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">list</a>({ ...params }) -> WaitingRoomsSinglePage</code> |
| 2134 | - <code title="delete /zones/{zone_id}/waiting_rooms/{waiting_room_id}">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">delete</a>(waitingRoomId, { ...params }) -> WaitingRoomDeleteResponse</code> |
| 2135 | - <code title="patch /zones/{zone_id}/waiting_rooms/{waiting_room_id}">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">edit</a>(waitingRoomId, { ...params }) -> WaitingRoom</code> |
| 2136 | - <code title="get /zones/{zone_id}/waiting_rooms/{waiting_room_id}">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">get</a>(waitingRoomId, { ...params }) -> WaitingRoom</code> |
| 2137 | |
| 2138 | ## Page |
| 2139 | |
| 2140 | Types: |
| 2141 | |
| 2142 | - <code><a href="./src/resources/waiting-rooms/page.ts">PagePreviewResponse</a></code> |
| 2143 | |
| 2144 | Methods: |
| 2145 | |
| 2146 | - <code title="post /zones/{zone_id}/waiting_rooms/preview">client.waitingRooms.page.<a href="./src/resources/waiting-rooms/page.ts">preview</a>({ ...params }) -> PagePreviewResponse</code> |
| 2147 | |
| 2148 | ## Events |
| 2149 | |
| 2150 | Types: |
| 2151 | |
| 2152 | - <code><a href="./src/resources/waiting-rooms/events/events.ts">Event</a></code> |
| 2153 | - <code><a href="./src/resources/waiting-rooms/events/events.ts">EventDeleteResponse</a></code> |
| 2154 | |
| 2155 | Methods: |
| 2156 | |
| 2157 | - <code title="post /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">create</a>(waitingRoomId, { ...params }) -> Event</code> |
| 2158 | - <code title="put /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">update</a>(waitingRoomId, eventId, { ...params }) -> Event</code> |
| 2159 | - <code title="get /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">list</a>(waitingRoomId, { ...params }) -> EventsSinglePage</code> |
| 2160 | - <code title="delete /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">delete</a>(waitingRoomId, eventId, { ...params }) -> EventDeleteResponse</code> |
| 2161 | - <code title="patch /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">edit</a>(waitingRoomId, eventId, { ...params }) -> Event</code> |
| 2162 | - <code title="get /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">get</a>(waitingRoomId, eventId, { ...params }) -> Event</code> |
| 2163 | |
| 2164 | ### Details |
| 2165 | |
| 2166 | Types: |
| 2167 | |
| 2168 | - <code><a href="./src/resources/waiting-rooms/events/details.ts">EventQuery</a></code> |
| 2169 | - <code><a href="./src/resources/waiting-rooms/events/details.ts">DetailGetResponse</a></code> |
| 2170 | |
| 2171 | Methods: |
| 2172 | |
| 2173 | - <code title="get /zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}/details">client.waitingRooms.events.details.<a href="./src/resources/waiting-rooms/events/details.ts">get</a>(waitingRoomId, eventId, { ...params }) -> DetailGetResponse</code> |
| 2174 | |
| 2175 | ## Rules |
| 2176 | |
| 2177 | Types: |
| 2178 | |
| 2179 | - <code><a href="./src/resources/waiting-rooms/rules.ts">WaitingRoomRule</a></code> |
| 2180 | - <code><a href="./src/resources/waiting-rooms/rules.ts">RuleCreateResponse</a></code> |
| 2181 | - <code><a href="./src/resources/waiting-rooms/rules.ts">RuleUpdateResponse</a></code> |
| 2182 | - <code><a href="./src/resources/waiting-rooms/rules.ts">RuleDeleteResponse</a></code> |
| 2183 | - <code><a href="./src/resources/waiting-rooms/rules.ts">RuleEditResponse</a></code> |
| 2184 | |
| 2185 | Methods: |
| 2186 | |
| 2187 | - <code title="post /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">create</a>(waitingRoomId, { ...params }) -> RuleCreateResponse | null</code> |
| 2188 | - <code title="put /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">update</a>(waitingRoomId, [ ...body ]) -> RuleUpdateResponse | null</code> |
| 2189 | - <code title="get /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">list</a>(waitingRoomId, { ...params }) -> WaitingRoomRulesSinglePage</code> |
| 2190 | - <code title="delete /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">delete</a>(waitingRoomId, ruleId, { ...params }) -> RuleDeleteResponse | null</code> |
| 2191 | - <code title="patch /zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">edit</a>(waitingRoomId, ruleId, { ...params }) -> RuleEditResponse | null</code> |
| 2192 | |
| 2193 | ## Statuses |
| 2194 | |
| 2195 | Types: |
| 2196 | |
| 2197 | - <code><a href="./src/resources/waiting-rooms/statuses.ts">StatusGetResponse</a></code> |
| 2198 | |
| 2199 | Methods: |
| 2200 | |
| 2201 | - <code title="get /zones/{zone_id}/waiting_rooms/{waiting_room_id}/status">client.waitingRooms.statuses.<a href="./src/resources/waiting-rooms/statuses.ts">get</a>(waitingRoomId, { ...params }) -> StatusGetResponse</code> |
| 2202 | |
| 2203 | ## Settings |
| 2204 | |
| 2205 | Types: |
| 2206 | |
| 2207 | - <code><a href="./src/resources/waiting-rooms/settings.ts">Setting</a></code> |
| 2208 | - <code><a href="./src/resources/waiting-rooms/settings.ts">SettingUpdateResponse</a></code> |
| 2209 | - <code><a href="./src/resources/waiting-rooms/settings.ts">SettingEditResponse</a></code> |
| 2210 | - <code><a href="./src/resources/waiting-rooms/settings.ts">SettingGetResponse</a></code> |
| 2211 | |
| 2212 | Methods: |
| 2213 | |
| 2214 | - <code title="put /zones/{zone_id}/waiting_rooms/settings">client.waitingRooms.settings.<a href="./src/resources/waiting-rooms/settings.ts">update</a>({ ...params }) -> SettingUpdateResponse</code> |
| 2215 | - <code title="patch /zones/{zone_id}/waiting_rooms/settings">client.waitingRooms.settings.<a href="./src/resources/waiting-rooms/settings.ts">edit</a>({ ...params }) -> SettingEditResponse</code> |
| 2216 | - <code title="get /zones/{zone_id}/waiting_rooms/settings">client.waitingRooms.settings.<a href="./src/resources/waiting-rooms/settings.ts">get</a>({ ...params }) -> SettingGetResponse</code> |
| 2217 | |
| 2218 | # Web3 |
| 2219 | |
| 2220 | ## Hostnames |
| 2221 | |
| 2222 | Types: |
| 2223 | |
| 2224 | - <code><a href="./src/resources/web3/hostnames/hostnames.ts">Hostname</a></code> |
| 2225 | - <code><a href="./src/resources/web3/hostnames/hostnames.ts">HostnameDeleteResponse</a></code> |
| 2226 | |
| 2227 | Methods: |
| 2228 | |
| 2229 | - <code title="post /zones/{zone_identifier}/web3/hostnames">client.web3.hostnames.<a href="./src/resources/web3/hostnames/hostnames.ts">create</a>(zoneIdentifier, { ...params }) -> Hostname</code> |
| 2230 | - <code title="get /zones/{zone_identifier}/web3/hostnames">client.web3.hostnames.<a href="./src/resources/web3/hostnames/hostnames.ts">list</a>(zoneIdentifier) -> HostnamesSinglePage</code> |
| 2231 | - <code title="delete /zones/{zone_identifier}/web3/hostnames/{identifier}">client.web3.hostnames.<a href="./src/resources/web3/hostnames/hostnames.ts">delete</a>(zoneIdentifier, identifier) -> HostnameDeleteResponse | null</code> |
| 2232 | - <code title="patch /zones/{zone_identifier}/web3/hostnames/{identifier}">client.web3.hostnames.<a href="./src/resources/web3/hostnames/hostnames.ts">edit</a>(zoneIdentifier, identifier, { ...params }) -> Hostname</code> |
| 2233 | - <code title="get /zones/{zone_identifier}/web3/hostnames/{identifier}">client.web3.hostnames.<a href="./src/resources/web3/hostnames/hostnames.ts">get</a>(zoneIdentifier, identifier) -> Hostname</code> |
| 2234 | |
| 2235 | ### IPFSUniversalPaths |
| 2236 | |
| 2237 | #### ContentLists |
| 2238 | |
| 2239 | Types: |
| 2240 | |
| 2241 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/content-lists.ts">ContentList</a></code> |
| 2242 | |
| 2243 | Methods: |
| 2244 | |
| 2245 | - <code title="put /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list">client.web3.hostnames.ipfsUniversalPaths.contentLists.<a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/content-lists.ts">update</a>(zoneIdentifier, identifier, { ...params }) -> ContentList</code> |
| 2246 | - <code title="get /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list">client.web3.hostnames.ipfsUniversalPaths.contentLists.<a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/content-lists.ts">get</a>(zoneIdentifier, identifier) -> ContentList</code> |
| 2247 | |
| 2248 | ##### Entries |
| 2249 | |
| 2250 | Types: |
| 2251 | |
| 2252 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">EntryCreateResponse</a></code> |
| 2253 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">EntryUpdateResponse</a></code> |
| 2254 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">EntryListResponse</a></code> |
| 2255 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">EntryDeleteResponse</a></code> |
| 2256 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">EntryGetResponse</a></code> |
| 2257 | |
| 2258 | Methods: |
| 2259 | |
| 2260 | - <code title="post /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries">client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.<a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">create</a>(zoneIdentifier, identifier, { ...params }) -> EntryCreateResponse</code> |
| 2261 | - <code title="put /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}">client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.<a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">update</a>(zoneIdentifier, identifier, contentListEntryIdentifier, { ...params }) -> EntryUpdateResponse</code> |
| 2262 | - <code title="get /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries">client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.<a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">list</a>(zoneIdentifier, identifier) -> EntryListResponse | null</code> |
| 2263 | - <code title="delete /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}">client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.<a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">delete</a>(zoneIdentifier, identifier, contentListEntryIdentifier) -> EntryDeleteResponse | null</code> |
| 2264 | - <code title="get /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}">client.web3.hostnames.ipfsUniversalPaths.contentLists.entries.<a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">get</a>(zoneIdentifier, identifier, contentListEntryIdentifier) -> EntryGetResponse</code> |
| 2265 | |
| 2266 | # Workers |
| 2267 | |
| 2268 | Types: |
| 2269 | |
| 2270 | - <code><a href="./src/resources/workers/workers.ts">Binding</a></code> |
| 2271 | - <code><a href="./src/resources/workers/workers.ts">D1Binding</a></code> |
| 2272 | - <code><a href="./src/resources/workers/workers.ts">DispatchNamespaceBinding</a></code> |
| 2273 | - <code><a href="./src/resources/workers/workers.ts">DurableObjectBinding</a></code> |
| 2274 | - <code><a href="./src/resources/workers/workers.ts">KVNamespaceBinding</a></code> |
| 2275 | - <code><a href="./src/resources/workers/workers.ts">MigrationStep</a></code> |
| 2276 | - <code><a href="./src/resources/workers/workers.ts">MTLSCERTBinding</a></code> |
| 2277 | - <code><a href="./src/resources/workers/workers.ts">PlacementConfiguration</a></code> |
| 2278 | - <code><a href="./src/resources/workers/workers.ts">R2Binding</a></code> |
| 2279 | - <code><a href="./src/resources/workers/workers.ts">ServiceBinding</a></code> |
| 2280 | - <code><a href="./src/resources/workers/workers.ts">SingleStepMigration</a></code> |
| 2281 | - <code><a href="./src/resources/workers/workers.ts">SteppedMigration</a></code> |
| 2282 | - <code><a href="./src/resources/workers/workers.ts">WorkerMetadata</a></code> |
| 2283 | |
| 2284 | ## AI |
| 2285 | |
| 2286 | Types: |
| 2287 | |
| 2288 | - <code><a href="./src/resources/workers/ai/ai.ts">AIRunResponse</a></code> |
| 2289 | |
| 2290 | Methods: |
| 2291 | |
| 2292 | - <code title="post /accounts/{account_id}/ai/run/{model_name}">client.workers.ai.<a href="./src/resources/workers/ai/ai.ts">run</a>(modelName, { ...params }) -> AIRunResponse</code> |
| 2293 | |
| 2294 | ### Models |
| 2295 | |
| 2296 | #### Schema |
| 2297 | |
| 2298 | Types: |
| 2299 | |
| 2300 | - <code><a href="./src/resources/workers/ai/models/schema.ts">SchemaGetResponse</a></code> |
| 2301 | |
| 2302 | Methods: |
| 2303 | |
| 2304 | - <code title="get /accounts/{account_id}/ai/models/schema">client.workers.ai.models.schema.<a href="./src/resources/workers/ai/models/schema.ts">get</a>({ ...params }) -> SchemaGetResponse</code> |
| 2305 | |
| 2306 | ## Scripts |
| 2307 | |
| 2308 | Types: |
| 2309 | |
| 2310 | - <code><a href="./src/resources/workers/scripts/scripts.ts">Script</a></code> |
| 2311 | - <code><a href="./src/resources/workers/scripts/scripts.ts">ScriptSetting</a></code> |
| 2312 | |
| 2313 | Methods: |
| 2314 | |
| 2315 | - <code title="put /accounts/{account_id}/workers/scripts/{script_name}">client.workers.scripts.<a href="./src/resources/workers/scripts/scripts.ts">update</a>(scriptName, { ...params }) -> Script</code> |
| 2316 | - <code title="get /accounts/{account_id}/workers/scripts">client.workers.scripts.<a href="./src/resources/workers/scripts/scripts.ts">list</a>({ ...params }) -> ScriptsSinglePage</code> |
| 2317 | - <code title="delete /accounts/{account_id}/workers/scripts/{script_name}">client.workers.scripts.<a href="./src/resources/workers/scripts/scripts.ts">delete</a>(scriptName, { ...params }) -> void</code> |
| 2318 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}">client.workers.scripts.<a href="./src/resources/workers/scripts/scripts.ts">get</a>(scriptName, { ...params }) -> Response</code> |
| 2319 | |
| 2320 | ### Schedules |
| 2321 | |
| 2322 | Types: |
| 2323 | |
| 2324 | - <code><a href="./src/resources/workers/scripts/schedules.ts">Schedule</a></code> |
| 2325 | - <code><a href="./src/resources/workers/scripts/schedules.ts">ScheduleUpdateResponse</a></code> |
| 2326 | - <code><a href="./src/resources/workers/scripts/schedules.ts">ScheduleGetResponse</a></code> |
| 2327 | |
| 2328 | Methods: |
| 2329 | |
| 2330 | - <code title="put /accounts/{account_id}/workers/scripts/{script_name}/schedules">client.workers.scripts.schedules.<a href="./src/resources/workers/scripts/schedules.ts">update</a>(scriptName, { ...params }) -> ScheduleUpdateResponse</code> |
| 2331 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/schedules">client.workers.scripts.schedules.<a href="./src/resources/workers/scripts/schedules.ts">get</a>(scriptName, { ...params }) -> ScheduleGetResponse</code> |
| 2332 | |
| 2333 | ### Tail |
| 2334 | |
| 2335 | Types: |
| 2336 | |
| 2337 | - <code><a href="./src/resources/workers/scripts/tail.ts">ConsumerScript</a></code> |
| 2338 | - <code><a href="./src/resources/workers/scripts/tail.ts">TailCreateResponse</a></code> |
| 2339 | - <code><a href="./src/resources/workers/scripts/tail.ts">TailDeleteResponse</a></code> |
| 2340 | - <code><a href="./src/resources/workers/scripts/tail.ts">TailGetResponse</a></code> |
| 2341 | |
| 2342 | Methods: |
| 2343 | |
| 2344 | - <code title="post /accounts/{account_id}/workers/scripts/{script_name}/tails">client.workers.scripts.tail.<a href="./src/resources/workers/scripts/tail.ts">create</a>(scriptName, { ...params }) -> TailCreateResponse</code> |
| 2345 | - <code title="delete /accounts/{account_id}/workers/scripts/{script_name}/tails/{id}">client.workers.scripts.tail.<a href="./src/resources/workers/scripts/tail.ts">delete</a>(scriptName, id, { ...params }) -> TailDeleteResponse</code> |
| 2346 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/tails">client.workers.scripts.tail.<a href="./src/resources/workers/scripts/tail.ts">get</a>(scriptName, { ...params }) -> TailGetResponse</code> |
| 2347 | |
| 2348 | ### Content |
| 2349 | |
| 2350 | Methods: |
| 2351 | |
| 2352 | - <code title="put /accounts/{account_id}/workers/scripts/{script_name}/content">client.workers.scripts.content.<a href="./src/resources/workers/scripts/content.ts">update</a>(scriptName, { ...params }) -> Script</code> |
| 2353 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/content/v2">client.workers.scripts.content.<a href="./src/resources/workers/scripts/content.ts">get</a>(scriptName, { ...params }) -> Response</code> |
| 2354 | |
| 2355 | ### Settings |
| 2356 | |
| 2357 | Methods: |
| 2358 | |
| 2359 | - <code title="patch /accounts/{account_id}/workers/scripts/{script_name}/script-settings">client.workers.scripts.settings.<a href="./src/resources/workers/scripts/settings.ts">edit</a>(scriptName, { ...params }) -> ScriptSetting</code> |
| 2360 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/script-settings">client.workers.scripts.settings.<a href="./src/resources/workers/scripts/settings.ts">get</a>(scriptName, { ...params }) -> ScriptSetting</code> |
| 2361 | |
| 2362 | ### Deployments |
| 2363 | |
| 2364 | Types: |
| 2365 | |
| 2366 | - <code><a href="./src/resources/workers/scripts/deployments.ts">Deployment</a></code> |
| 2367 | - <code><a href="./src/resources/workers/scripts/deployments.ts">DeploymentCreateResponse</a></code> |
| 2368 | - <code><a href="./src/resources/workers/scripts/deployments.ts">DeploymentGetResponse</a></code> |
| 2369 | |
| 2370 | Methods: |
| 2371 | |
| 2372 | - <code title="post /accounts/{account_id}/workers/scripts/{script_name}/deployments">client.workers.scripts.deployments.<a href="./src/resources/workers/scripts/deployments.ts">create</a>(scriptName, { ...params }) -> DeploymentCreateResponse</code> |
| 2373 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/deployments">client.workers.scripts.deployments.<a href="./src/resources/workers/scripts/deployments.ts">get</a>(scriptName, { ...params }) -> DeploymentGetResponse</code> |
| 2374 | |
| 2375 | ### Versions |
| 2376 | |
| 2377 | Types: |
| 2378 | |
| 2379 | - <code><a href="./src/resources/workers/scripts/versions.ts">VersionCreateResponse</a></code> |
| 2380 | - <code><a href="./src/resources/workers/scripts/versions.ts">VersionListResponse</a></code> |
| 2381 | - <code><a href="./src/resources/workers/scripts/versions.ts">VersionGetResponse</a></code> |
| 2382 | |
| 2383 | Methods: |
| 2384 | |
| 2385 | - <code title="post /accounts/{account_id}/workers/scripts/{script_name}/versions">client.workers.scripts.versions.<a href="./src/resources/workers/scripts/versions.ts">create</a>(scriptName, { ...params }) -> VersionCreateResponse</code> |
| 2386 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/versions">client.workers.scripts.versions.<a href="./src/resources/workers/scripts/versions.ts">list</a>(scriptName, { ...params }) -> VersionListResponsesV4PagePagination</code> |
| 2387 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id}">client.workers.scripts.versions.<a href="./src/resources/workers/scripts/versions.ts">get</a>(scriptName, versionId, { ...params }) -> VersionGetResponse</code> |
| 2388 | |
| 2389 | ## AccountSettings |
| 2390 | |
| 2391 | Types: |
| 2392 | |
| 2393 | - <code><a href="./src/resources/workers/account-settings.ts">AccountSettingUpdateResponse</a></code> |
| 2394 | - <code><a href="./src/resources/workers/account-settings.ts">AccountSettingGetResponse</a></code> |
| 2395 | |
| 2396 | Methods: |
| 2397 | |
| 2398 | - <code title="put /accounts/{account_id}/workers/account-settings">client.workers.accountSettings.<a href="./src/resources/workers/account-settings.ts">update</a>({ ...params }) -> AccountSettingUpdateResponse</code> |
| 2399 | - <code title="get /accounts/{account_id}/workers/account-settings">client.workers.accountSettings.<a href="./src/resources/workers/account-settings.ts">get</a>({ ...params }) -> AccountSettingGetResponse</code> |
| 2400 | |
| 2401 | ## Domains |
| 2402 | |
| 2403 | Types: |
| 2404 | |
| 2405 | - <code><a href="./src/resources/workers/domains.ts">Domain</a></code> |
| 2406 | |
| 2407 | Methods: |
| 2408 | |
| 2409 | - <code title="put /accounts/{account_id}/workers/domains">client.workers.domains.<a href="./src/resources/workers/domains.ts">update</a>({ ...params }) -> Domain</code> |
| 2410 | - <code title="get /accounts/{account_id}/workers/domains">client.workers.domains.<a href="./src/resources/workers/domains.ts">list</a>({ ...params }) -> DomainsSinglePage</code> |
| 2411 | - <code title="delete /accounts/{account_id}/workers/domains/{domain_id}">client.workers.domains.<a href="./src/resources/workers/domains.ts">delete</a>(domainId, { ...params }) -> void</code> |
| 2412 | - <code title="get /accounts/{account_id}/workers/domains/{domain_id}">client.workers.domains.<a href="./src/resources/workers/domains.ts">get</a>(domainId, { ...params }) -> Domain</code> |
| 2413 | |
| 2414 | ## Subdomains |
| 2415 | |
| 2416 | Types: |
| 2417 | |
| 2418 | - <code><a href="./src/resources/workers/subdomains.ts">SubdomainUpdateResponse</a></code> |
| 2419 | - <code><a href="./src/resources/workers/subdomains.ts">SubdomainGetResponse</a></code> |
| 2420 | |
| 2421 | Methods: |
| 2422 | |
| 2423 | - <code title="put /accounts/{account_id}/workers/subdomain">client.workers.subdomains.<a href="./src/resources/workers/subdomains.ts">update</a>({ ...params }) -> SubdomainUpdateResponse</code> |
| 2424 | - <code title="get /accounts/{account_id}/workers/subdomain">client.workers.subdomains.<a href="./src/resources/workers/subdomains.ts">get</a>({ ...params }) -> SubdomainGetResponse</code> |
| 2425 | |
| 2426 | # KV |
| 2427 | |
| 2428 | ## Namespaces |
| 2429 | |
| 2430 | Types: |
| 2431 | |
| 2432 | - <code><a href="./src/resources/kv/namespaces/namespaces.ts">Namespace</a></code> |
| 2433 | - <code><a href="./src/resources/kv/namespaces/namespaces.ts">NamespaceUpdateResponse</a></code> |
| 2434 | - <code><a href="./src/resources/kv/namespaces/namespaces.ts">NamespaceDeleteResponse</a></code> |
| 2435 | |
| 2436 | Methods: |
| 2437 | |
| 2438 | - <code title="post /accounts/{account_id}/storage/kv/namespaces">client.kv.namespaces.<a href="./src/resources/kv/namespaces/namespaces.ts">create</a>({ ...params }) -> Namespace</code> |
| 2439 | - <code title="put /accounts/{account_id}/storage/kv/namespaces/{namespace_id}">client.kv.namespaces.<a href="./src/resources/kv/namespaces/namespaces.ts">update</a>(namespaceId, { ...params }) -> NamespaceUpdateResponse | null</code> |
| 2440 | - <code title="get /accounts/{account_id}/storage/kv/namespaces">client.kv.namespaces.<a href="./src/resources/kv/namespaces/namespaces.ts">list</a>({ ...params }) -> NamespacesV4PagePaginationArray</code> |
| 2441 | - <code title="delete /accounts/{account_id}/storage/kv/namespaces/{namespace_id}">client.kv.namespaces.<a href="./src/resources/kv/namespaces/namespaces.ts">delete</a>(namespaceId, { ...params }) -> NamespaceDeleteResponse | null</code> |
| 2442 | - <code title="get /accounts/{account_id}/storage/kv/namespaces/{namespace_id}">client.kv.namespaces.<a href="./src/resources/kv/namespaces/namespaces.ts">get</a>(namespaceId, { ...params }) -> Namespace</code> |
| 2443 | |
| 2444 | ### Bulk |
| 2445 | |
| 2446 | Types: |
| 2447 | |
| 2448 | - <code><a href="./src/resources/kv/namespaces/bulk.ts">BulkUpdateResponse</a></code> |
| 2449 | - <code><a href="./src/resources/kv/namespaces/bulk.ts">BulkDeleteResponse</a></code> |
| 2450 | |
| 2451 | Methods: |
| 2452 | |
| 2453 | - <code title="put /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk">client.kv.namespaces.bulk.<a href="./src/resources/kv/namespaces/bulk.ts">update</a>(namespaceId, [ ...body ]) -> BulkUpdateResponse | null</code> |
| 2454 | - <code title="delete /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk">client.kv.namespaces.bulk.<a href="./src/resources/kv/namespaces/bulk.ts">delete</a>(namespaceId, { ...params }) -> BulkDeleteResponse | null</code> |
| 2455 | |
| 2456 | ### Keys |
| 2457 | |
| 2458 | Types: |
| 2459 | |
| 2460 | - <code><a href="./src/resources/kv/namespaces/keys.ts">Key</a></code> |
| 2461 | |
| 2462 | Methods: |
| 2463 | |
| 2464 | - <code title="get /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys">client.kv.namespaces.keys.<a href="./src/resources/kv/namespaces/keys.ts">list</a>(namespaceId, { ...params }) -> KeysCursorLimitPagination</code> |
| 2465 | |
| 2466 | ### Metadata |
| 2467 | |
| 2468 | Types: |
| 2469 | |
| 2470 | - <code><a href="./src/resources/kv/namespaces/metadata.ts">MetadataGetResponse</a></code> |
| 2471 | |
| 2472 | Methods: |
| 2473 | |
| 2474 | - <code title="get /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}">client.kv.namespaces.metadata.<a href="./src/resources/kv/namespaces/metadata.ts">get</a>(namespaceId, keyName, { ...params }) -> MetadataGetResponse</code> |
| 2475 | |
| 2476 | ### Values |
| 2477 | |
| 2478 | Types: |
| 2479 | |
| 2480 | - <code><a href="./src/resources/kv/namespaces/values.ts">ValueUpdateResponse</a></code> |
| 2481 | - <code><a href="./src/resources/kv/namespaces/values.ts">ValueDeleteResponse</a></code> |
| 2482 | |
| 2483 | Methods: |
| 2484 | |
| 2485 | - <code title="put /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}">client.kv.namespaces.values.<a href="./src/resources/kv/namespaces/values.ts">update</a>(namespaceId, keyName, { ...params }) -> ValueUpdateResponse | null</code> |
| 2486 | - <code title="delete /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}">client.kv.namespaces.values.<a href="./src/resources/kv/namespaces/values.ts">delete</a>(namespaceId, keyName, { ...params }) -> ValueDeleteResponse | null</code> |
| 2487 | - <code title="get /accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}">client.kv.namespaces.values.<a href="./src/resources/kv/namespaces/values.ts">get</a>(namespaceId, keyName, { ...params }) -> Response</code> |
| 2488 | |
| 2489 | # DurableObjects |
| 2490 | |
| 2491 | ## Namespaces |
| 2492 | |
| 2493 | Types: |
| 2494 | |
| 2495 | - <code><a href="./src/resources/durable-objects/namespaces/namespaces.ts">Namespace</a></code> |
| 2496 | |
| 2497 | Methods: |
| 2498 | |
| 2499 | - <code title="get /accounts/{account_id}/workers/durable_objects/namespaces">client.durableObjects.namespaces.<a href="./src/resources/durable-objects/namespaces/namespaces.ts">list</a>({ ...params }) -> NamespacesSinglePage</code> |
| 2500 | |
| 2501 | ### Objects |
| 2502 | |
| 2503 | Types: |
| 2504 | |
| 2505 | - <code><a href="./src/resources/durable-objects/namespaces/objects.ts">DurableObject</a></code> |
| 2506 | |
| 2507 | Methods: |
| 2508 | |
| 2509 | - <code title="get /accounts/{account_id}/workers/durable_objects/namespaces/{id}/objects">client.durableObjects.namespaces.objects.<a href="./src/resources/durable-objects/namespaces/objects.ts">list</a>(id, { ...params }) -> DurableObjectsCursorLimitPagination</code> |
| 2510 | |
| 2511 | # Queues |
| 2512 | |
| 2513 | Types: |
| 2514 | |
| 2515 | - <code><a href="./src/resources/queues/queues.ts">Queue</a></code> |
| 2516 | - <code><a href="./src/resources/queues/queues.ts">QueueCreated</a></code> |
| 2517 | - <code><a href="./src/resources/queues/queues.ts">QueueUpdated</a></code> |
| 2518 | - <code><a href="./src/resources/queues/queues.ts">QueueDeleteResponse</a></code> |
| 2519 | |
| 2520 | Methods: |
| 2521 | |
| 2522 | - <code title="post /accounts/{account_id}/queues">client.queues.<a href="./src/resources/queues/queues.ts">create</a>({ ...params }) -> QueueCreated | null</code> |
| 2523 | - <code title="put /accounts/{account_id}/queues/{queue_id}">client.queues.<a href="./src/resources/queues/queues.ts">update</a>(queueId, { ...params }) -> QueueUpdated | null</code> |
| 2524 | - <code title="get /accounts/{account_id}/queues">client.queues.<a href="./src/resources/queues/queues.ts">list</a>({ ...params }) -> QueuesSinglePage</code> |
| 2525 | - <code title="delete /accounts/{account_id}/queues/{queue_id}">client.queues.<a href="./src/resources/queues/queues.ts">delete</a>(queueId, { ...params }) -> QueueDeleteResponse | null</code> |
| 2526 | - <code title="get /accounts/{account_id}/queues/{queue_id}">client.queues.<a href="./src/resources/queues/queues.ts">get</a>(queueId, { ...params }) -> Queue | null</code> |
| 2527 | |
| 2528 | ## Consumers |
| 2529 | |
| 2530 | Types: |
| 2531 | |
| 2532 | - <code><a href="./src/resources/queues/consumers.ts">Consumer</a></code> |
| 2533 | - <code><a href="./src/resources/queues/consumers.ts">ConsumerCreateResponse</a></code> |
| 2534 | - <code><a href="./src/resources/queues/consumers.ts">ConsumerUpdateResponse</a></code> |
| 2535 | - <code><a href="./src/resources/queues/consumers.ts">ConsumerDeleteResponse</a></code> |
| 2536 | - <code><a href="./src/resources/queues/consumers.ts">ConsumerGetResponse</a></code> |
| 2537 | |
| 2538 | Methods: |
| 2539 | |
| 2540 | - <code title="post /accounts/{account_id}/queues/{queue_id}/consumers">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">create</a>(queueId, { ...params }) -> ConsumerCreateResponse | null</code> |
| 2541 | - <code title="put /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">update</a>(queueId, consumerId, { ...params }) -> ConsumerUpdateResponse | null</code> |
| 2542 | - <code title="delete /accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">delete</a>(queueId, consumerId, { ...params }) -> ConsumerDeleteResponse | null</code> |
| 2543 | - <code title="get /accounts/{account_id}/queues/{queue_id}/consumers">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">get</a>(queueId, { ...params }) -> ConsumerGetResponse | null</code> |
| 2544 | |
| 2545 | ## Messages |
| 2546 | |
| 2547 | Types: |
| 2548 | |
| 2549 | - <code><a href="./src/resources/queues/messages.ts">MessageAckResponse</a></code> |
| 2550 | - <code><a href="./src/resources/queues/messages.ts">MessagePullResponse</a></code> |
| 2551 | |
| 2552 | Methods: |
| 2553 | |
| 2554 | - <code title="post /accounts/{account_id}/queues/{queue_id}/messages/ack">client.queues.messages.<a href="./src/resources/queues/messages.ts">ack</a>(queueId, { ...params }) -> MessageAckResponse | null</code> |
| 2555 | - <code title="post /accounts/{account_id}/queues/{queue_id}/messages/pull">client.queues.messages.<a href="./src/resources/queues/messages.ts">pull</a>(queueId, { ...params }) -> MessagePullResponse | null</code> |
| 2556 | |
| 2557 | # APIGateway |
| 2558 | |
| 2559 | ## Configurations |
| 2560 | |
| 2561 | Types: |
| 2562 | |
| 2563 | - <code><a href="./src/resources/api-gateway/configurations.ts">Configuration</a></code> |
| 2564 | - <code><a href="./src/resources/api-gateway/configurations.ts">ConfigurationUpdateResponse</a></code> |
| 2565 | |
| 2566 | Methods: |
| 2567 | |
| 2568 | - <code title="put /zones/{zone_id}/api_gateway/configuration">client.apiGateway.configurations.<a href="./src/resources/api-gateway/configurations.ts">update</a>({ ...params }) -> ConfigurationUpdateResponse</code> |
| 2569 | - <code title="get /zones/{zone_id}/api_gateway/configuration">client.apiGateway.configurations.<a href="./src/resources/api-gateway/configurations.ts">get</a>({ ...params }) -> Configuration</code> |
| 2570 | |
| 2571 | ## Discovery |
| 2572 | |
| 2573 | Types: |
| 2574 | |
| 2575 | - <code><a href="./src/resources/api-gateway/discovery/discovery.ts">DiscoveryOperation</a></code> |
| 2576 | - <code><a href="./src/resources/api-gateway/discovery/discovery.ts">DiscoveryGetResponse</a></code> |
| 2577 | |
| 2578 | Methods: |
| 2579 | |
| 2580 | - <code title="get /zones/{zone_id}/api_gateway/discovery">client.apiGateway.discovery.<a href="./src/resources/api-gateway/discovery/discovery.ts">get</a>({ ...params }) -> DiscoveryGetResponse</code> |
| 2581 | |
| 2582 | ### Operations |
| 2583 | |
| 2584 | Types: |
| 2585 | |
| 2586 | - <code><a href="./src/resources/api-gateway/discovery/operations.ts">OperationEditResponse</a></code> |
| 2587 | |
| 2588 | Methods: |
| 2589 | |
| 2590 | - <code title="get /zones/{zone_id}/api_gateway/discovery/operations">client.apiGateway.discovery.operations.<a href="./src/resources/api-gateway/discovery/operations.ts">list</a>({ ...params }) -> DiscoveryOperationsSinglePage</code> |
| 2591 | - <code title="patch /zones/{zone_id}/api_gateway/discovery/operations/{operation_id}">client.apiGateway.discovery.operations.<a href="./src/resources/api-gateway/discovery/operations.ts">edit</a>(operationId, { ...params }) -> OperationEditResponse</code> |
| 2592 | |
| 2593 | ## Operations |
| 2594 | |
| 2595 | Types: |
| 2596 | |
| 2597 | - <code><a href="./src/resources/api-gateway/operations/operations.ts">APIShield</a></code> |
| 2598 | - <code><a href="./src/resources/api-gateway/operations/operations.ts">OperationCreateResponse</a></code> |
| 2599 | - <code><a href="./src/resources/api-gateway/operations/operations.ts">OperationDeleteResponse</a></code> |
| 2600 | |
| 2601 | Methods: |
| 2602 | |
| 2603 | - <code title="post /zones/{zone_id}/api_gateway/operations">client.apiGateway.operations.<a href="./src/resources/api-gateway/operations/operations.ts">create</a>([ ...body ]) -> OperationCreateResponse | null</code> |
| 2604 | - <code title="get /zones/{zone_id}/api_gateway/operations">client.apiGateway.operations.<a href="./src/resources/api-gateway/operations/operations.ts">list</a>({ ...params }) -> APIShieldsSinglePage</code> |
| 2605 | - <code title="delete /zones/{zone_id}/api_gateway/operations/{operation_id}">client.apiGateway.operations.<a href="./src/resources/api-gateway/operations/operations.ts">delete</a>(operationId, { ...params }) -> OperationDeleteResponse</code> |
| 2606 | - <code title="get /zones/{zone_id}/api_gateway/operations/{operation_id}">client.apiGateway.operations.<a href="./src/resources/api-gateway/operations/operations.ts">get</a>(operationId, { ...params }) -> APIShield</code> |
| 2607 | |
| 2608 | ### SchemaValidation |
| 2609 | |
| 2610 | Types: |
| 2611 | |
| 2612 | - <code><a href="./src/resources/api-gateway/operations/schema-validation.ts">SettingsMultipleRequest</a></code> |
| 2613 | - <code><a href="./src/resources/api-gateway/operations/schema-validation.ts">SchemaValidationUpdateResponse</a></code> |
| 2614 | - <code><a href="./src/resources/api-gateway/operations/schema-validation.ts">SchemaValidationGetResponse</a></code> |
| 2615 | |
| 2616 | Methods: |
| 2617 | |
| 2618 | - <code title="put /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation">client.apiGateway.operations.schemaValidation.<a href="./src/resources/api-gateway/operations/schema-validation.ts">update</a>(operationId, { ...params }) -> SchemaValidationUpdateResponse</code> |
| 2619 | - <code title="patch /zones/{zone_id}/api_gateway/operations/schema_validation">client.apiGateway.operations.schemaValidation.<a href="./src/resources/api-gateway/operations/schema-validation.ts">edit</a>({ ...params }) -> SettingsMultipleRequest</code> |
| 2620 | - <code title="get /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation">client.apiGateway.operations.schemaValidation.<a href="./src/resources/api-gateway/operations/schema-validation.ts">get</a>(operationId, { ...params }) -> SchemaValidationGetResponse</code> |
| 2621 | |
| 2622 | ## Schemas |
| 2623 | |
| 2624 | Types: |
| 2625 | |
| 2626 | - <code><a href="./src/resources/api-gateway/schemas.ts">SchemaListResponse</a></code> |
| 2627 | |
| 2628 | Methods: |
| 2629 | |
| 2630 | - <code title="get /zones/{zone_id}/api_gateway/schemas">client.apiGateway.schemas.<a href="./src/resources/api-gateway/schemas.ts">list</a>({ ...params }) -> SchemaListResponse</code> |
| 2631 | |
| 2632 | ## Settings |
| 2633 | |
| 2634 | ### SchemaValidation |
| 2635 | |
| 2636 | Types: |
| 2637 | |
| 2638 | - <code><a href="./src/resources/api-gateway/settings/schema-validation.ts">Settings</a></code> |
| 2639 | |
| 2640 | Methods: |
| 2641 | |
| 2642 | - <code title="put /zones/{zone_id}/api_gateway/settings/schema_validation">client.apiGateway.settings.schemaValidation.<a href="./src/resources/api-gateway/settings/schema-validation.ts">update</a>({ ...params }) -> Settings</code> |
| 2643 | - <code title="get /zones/{zone_id}/api_gateway/settings/schema_validation">client.apiGateway.settings.schemaValidation.<a href="./src/resources/api-gateway/settings/schema-validation.ts">get</a>({ ...params }) -> Settings</code> |
| 2644 | |
| 2645 | ## UserSchemas |
| 2646 | |
| 2647 | Types: |
| 2648 | |
| 2649 | - <code><a href="./src/resources/api-gateway/user-schemas/user-schemas.ts">Message</a></code> |
| 2650 | - <code><a href="./src/resources/api-gateway/user-schemas/user-schemas.ts">PublicSchema</a></code> |
| 2651 | - <code><a href="./src/resources/api-gateway/user-schemas/user-schemas.ts">SchemaUpload</a></code> |
| 2652 | - <code><a href="./src/resources/api-gateway/user-schemas/user-schemas.ts">UserSchemaDeleteResponse</a></code> |
| 2653 | |
| 2654 | Methods: |
| 2655 | |
| 2656 | - <code title="post /zones/{zone_id}/api_gateway/user_schemas">client.apiGateway.userSchemas.<a href="./src/resources/api-gateway/user-schemas/user-schemas.ts">create</a>({ ...params }) -> SchemaUpload</code> |
| 2657 | - <code title="get /zones/{zone_id}/api_gateway/user_schemas">client.apiGateway.userSchemas.<a href="./src/resources/api-gateway/user-schemas/user-schemas.ts">list</a>({ ...params }) -> PublicSchemasSinglePage</code> |
| 2658 | - <code title="delete /zones/{zone_id}/api_gateway/user_schemas/{schema_id}">client.apiGateway.userSchemas.<a href="./src/resources/api-gateway/user-schemas/user-schemas.ts">delete</a>(schemaId, { ...params }) -> UserSchemaDeleteResponse</code> |
| 2659 | - <code title="patch /zones/{zone_id}/api_gateway/user_schemas/{schema_id}">client.apiGateway.userSchemas.<a href="./src/resources/api-gateway/user-schemas/user-schemas.ts">edit</a>(schemaId, { ...params }) -> PublicSchema</code> |
| 2660 | - <code title="get /zones/{zone_id}/api_gateway/user_schemas/{schema_id}">client.apiGateway.userSchemas.<a href="./src/resources/api-gateway/user-schemas/user-schemas.ts">get</a>(schemaId, { ...params }) -> PublicSchema</code> |
| 2661 | |
| 2662 | ### Operations |
| 2663 | |
| 2664 | Types: |
| 2665 | |
| 2666 | - <code><a href="./src/resources/api-gateway/user-schemas/operations.ts">OperationListResponse</a></code> |
| 2667 | |
| 2668 | Methods: |
| 2669 | |
| 2670 | - <code title="get /zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations">client.apiGateway.userSchemas.operations.<a href="./src/resources/api-gateway/user-schemas/operations.ts">list</a>(schemaId, { ...params }) -> OperationListResponsesSinglePage</code> |
| 2671 | |
| 2672 | ## SchemaValidation |
| 2673 | |
| 2674 | Methods: |
| 2675 | |
| 2676 | - <code title="patch /zones/{zone_id}/api_gateway/settings/schema_validation">client.apiGateway.schemaValidation.<a href="./src/resources/api-gateway/schema-validation.ts">edit</a>({ ...params }) -> Settings</code> |
| 2677 | |
| 2678 | # ManagedHeaders |
| 2679 | |
| 2680 | Types: |
| 2681 | |
| 2682 | - <code><a href="./src/resources/managed-headers.ts">RequestModel</a></code> |
| 2683 | - <code><a href="./src/resources/managed-headers.ts">ManagedHeaderListResponse</a></code> |
| 2684 | - <code><a href="./src/resources/managed-headers.ts">ManagedHeaderEditResponse</a></code> |
| 2685 | |
| 2686 | Methods: |
| 2687 | |
| 2688 | - <code title="get /zones/{zone_id}/managed_headers">client.managedHeaders.<a href="./src/resources/managed-headers.ts">list</a>({ ...params }) -> ManagedHeaderListResponse</code> |
| 2689 | - <code title="patch /zones/{zone_id}/managed_headers">client.managedHeaders.<a href="./src/resources/managed-headers.ts">edit</a>({ ...params }) -> ManagedHeaderEditResponse</code> |
| 2690 | |
| 2691 | # PageShield |
| 2692 | |
| 2693 | Types: |
| 2694 | |
| 2695 | - <code><a href="./src/resources/page-shield/page-shield.ts">Setting</a></code> |
| 2696 | - <code><a href="./src/resources/page-shield/page-shield.ts">PageShieldUpdateResponse</a></code> |
| 2697 | |
| 2698 | Methods: |
| 2699 | |
| 2700 | - <code title="put /zones/{zone_id}/page_shield">client.pageShield.<a href="./src/resources/page-shield/page-shield.ts">update</a>({ ...params }) -> PageShieldUpdateResponse</code> |
| 2701 | - <code title="get /zones/{zone_id}/page_shield">client.pageShield.<a href="./src/resources/page-shield/page-shield.ts">get</a>({ ...params }) -> Setting | null</code> |
| 2702 | |
| 2703 | ## Policies |
| 2704 | |
| 2705 | Types: |
| 2706 | |
| 2707 | - <code><a href="./src/resources/page-shield/policies.ts">Policy</a></code> |
| 2708 | - <code><a href="./src/resources/page-shield/policies.ts">PolicyCreateResponse</a></code> |
| 2709 | - <code><a href="./src/resources/page-shield/policies.ts">PolicyUpdateResponse</a></code> |
| 2710 | - <code><a href="./src/resources/page-shield/policies.ts">PolicyListResponse</a></code> |
| 2711 | - <code><a href="./src/resources/page-shield/policies.ts">PolicyGetResponse</a></code> |
| 2712 | |
| 2713 | Methods: |
| 2714 | |
| 2715 | - <code title="post /zones/{zone_id}/page_shield/policies">client.pageShield.policies.<a href="./src/resources/page-shield/policies.ts">create</a>({ ...params }) -> PolicyCreateResponse | null</code> |
| 2716 | - <code title="put /zones/{zone_id}/page_shield/policies/{policy_id}">client.pageShield.policies.<a href="./src/resources/page-shield/policies.ts">update</a>(policyId, { ...params }) -> PolicyUpdateResponse | null</code> |
| 2717 | - <code title="get /zones/{zone_id}/page_shield/policies">client.pageShield.policies.<a href="./src/resources/page-shield/policies.ts">list</a>({ ...params }) -> PolicyListResponsesSinglePage</code> |
| 2718 | - <code title="delete /zones/{zone_id}/page_shield/policies/{policy_id}">client.pageShield.policies.<a href="./src/resources/page-shield/policies.ts">delete</a>(policyId, { ...params }) -> void</code> |
| 2719 | - <code title="get /zones/{zone_id}/page_shield/policies/{policy_id}">client.pageShield.policies.<a href="./src/resources/page-shield/policies.ts">get</a>(policyId, { ...params }) -> PolicyGetResponse | null</code> |
| 2720 | |
| 2721 | ## Connections |
| 2722 | |
| 2723 | Types: |
| 2724 | |
| 2725 | - <code><a href="./src/resources/page-shield/connections.ts">Connection</a></code> |
| 2726 | |
| 2727 | Methods: |
| 2728 | |
| 2729 | - <code title="get /zones/{zone_id}/page_shield/connections">client.pageShield.connections.<a href="./src/resources/page-shield/connections.ts">list</a>({ ...params }) -> ConnectionsSinglePage</code> |
| 2730 | - <code title="get /zones/{zone_id}/page_shield/connections/{connection_id}">client.pageShield.connections.<a href="./src/resources/page-shield/connections.ts">get</a>(connectionId, { ...params }) -> Connection | null</code> |
| 2731 | |
| 2732 | ## Scripts |
| 2733 | |
| 2734 | Types: |
| 2735 | |
| 2736 | - <code><a href="./src/resources/page-shield/scripts.ts">Script</a></code> |
| 2737 | - <code><a href="./src/resources/page-shield/scripts.ts">ScriptGetResponse</a></code> |
| 2738 | |
| 2739 | Methods: |
| 2740 | |
| 2741 | - <code title="get /zones/{zone_id}/page_shield/scripts">client.pageShield.scripts.<a href="./src/resources/page-shield/scripts.ts">list</a>({ ...params }) -> ScriptsSinglePage</code> |
| 2742 | - <code title="get /zones/{zone_id}/page_shield/scripts/{script_id}">client.pageShield.scripts.<a href="./src/resources/page-shield/scripts.ts">get</a>(scriptId, { ...params }) -> ScriptGetResponse | null</code> |
| 2743 | |
| 2744 | ## Cookies |
| 2745 | |
| 2746 | Types: |
| 2747 | |
| 2748 | - <code><a href="./src/resources/page-shield/cookies.ts">CookieListResponse</a></code> |
| 2749 | - <code><a href="./src/resources/page-shield/cookies.ts">CookieGetResponse</a></code> |
| 2750 | |
| 2751 | Methods: |
| 2752 | |
| 2753 | - <code title="get /zones/{zone_id}/page_shield/cookies">client.pageShield.cookies.<a href="./src/resources/page-shield/cookies.ts">list</a>({ ...params }) -> CookieListResponsesSinglePage</code> |
| 2754 | - <code title="get /zones/{zone_id}/page_shield/cookies/{cookie_id}">client.pageShield.cookies.<a href="./src/resources/page-shield/cookies.ts">get</a>(cookieId, { ...params }) -> CookieGetResponse | null</code> |
| 2755 | |
| 2756 | # Rulesets |
| 2757 | |
| 2758 | Types: |
| 2759 | |
| 2760 | - <code><a href="./src/resources/rulesets/rulesets.ts">Kind</a></code> |
| 2761 | - <code><a href="./src/resources/rulesets/rulesets.ts">Phase</a></code> |
| 2762 | - <code><a href="./src/resources/rulesets/rulesets.ts">Ruleset</a></code> |
| 2763 | - <code><a href="./src/resources/rulesets/rulesets.ts">RulesetCreateResponse</a></code> |
| 2764 | - <code><a href="./src/resources/rulesets/rulesets.ts">RulesetUpdateResponse</a></code> |
| 2765 | - <code><a href="./src/resources/rulesets/rulesets.ts">RulesetListResponse</a></code> |
| 2766 | - <code><a href="./src/resources/rulesets/rulesets.ts">RulesetGetResponse</a></code> |
| 2767 | |
| 2768 | Methods: |
| 2769 | |
| 2770 | - <code title="post /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">create</a>({ ...params }) -> RulesetCreateResponse</code> |
| 2771 | - <code title="put /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">update</a>(rulesetId, { ...params }) -> RulesetUpdateResponse</code> |
| 2772 | - <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">list</a>({ ...params }) -> RulesetListResponsesSinglePage</code> |
| 2773 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">delete</a>(rulesetId, { ...params }) -> void</code> |
| 2774 | - <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">get</a>(rulesetId, { ...params }) -> RulesetGetResponse</code> |
| 2775 | |
| 2776 | ## Phases |
| 2777 | |
| 2778 | Types: |
| 2779 | |
| 2780 | - <code><a href="./src/resources/rulesets/phases/phases.ts">PhaseUpdateResponse</a></code> |
| 2781 | - <code><a href="./src/resources/rulesets/phases/phases.ts">PhaseGetResponse</a></code> |
| 2782 | |
| 2783 | Methods: |
| 2784 | |
| 2785 | - <code title="put /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint">client.rulesets.phases.<a href="./src/resources/rulesets/phases/phases.ts">update</a>(rulesetPhase, { ...params }) -> PhaseUpdateResponse</code> |
| 2786 | - <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint">client.rulesets.phases.<a href="./src/resources/rulesets/phases/phases.ts">get</a>(rulesetPhase, { ...params }) -> PhaseGetResponse</code> |
| 2787 | |
| 2788 | ### Versions |
| 2789 | |
| 2790 | Types: |
| 2791 | |
| 2792 | - <code><a href="./src/resources/rulesets/phases/versions.ts">VersionListResponse</a></code> |
| 2793 | - <code><a href="./src/resources/rulesets/phases/versions.ts">VersionGetResponse</a></code> |
| 2794 | |
| 2795 | Methods: |
| 2796 | |
| 2797 | - <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions">client.rulesets.phases.versions.<a href="./src/resources/rulesets/phases/versions.ts">list</a>(rulesetPhase, { ...params }) -> VersionListResponsesSinglePage</code> |
| 2798 | - <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}">client.rulesets.phases.versions.<a href="./src/resources/rulesets/phases/versions.ts">get</a>(rulesetPhase, rulesetVersion, { ...params }) -> VersionGetResponse</code> |
| 2799 | |
| 2800 | ## Rules |
| 2801 | |
| 2802 | Types: |
| 2803 | |
| 2804 | - <code><a href="./src/resources/rulesets/rules.ts">BlockRule</a></code> |
| 2805 | - <code><a href="./src/resources/rulesets/rules.ts">ChallengeRule</a></code> |
| 2806 | - <code><a href="./src/resources/rulesets/rules.ts">CompressResponseRule</a></code> |
| 2807 | - <code><a href="./src/resources/rulesets/rules.ts">ExecuteRule</a></code> |
| 2808 | - <code><a href="./src/resources/rulesets/rules.ts">JSChallengeRule</a></code> |
| 2809 | - <code><a href="./src/resources/rulesets/rules.ts">LogRule</a></code> |
| 2810 | - <code><a href="./src/resources/rulesets/rules.ts">Logging</a></code> |
| 2811 | - <code><a href="./src/resources/rulesets/rules.ts">ManagedChallengeRule</a></code> |
| 2812 | - <code><a href="./src/resources/rulesets/rules.ts">RedirectRule</a></code> |
| 2813 | - <code><a href="./src/resources/rulesets/rules.ts">RewriteRule</a></code> |
| 2814 | - <code><a href="./src/resources/rulesets/rules.ts">RewriteURIPart</a></code> |
| 2815 | - <code><a href="./src/resources/rulesets/rules.ts">RouteRule</a></code> |
| 2816 | - <code><a href="./src/resources/rulesets/rules.ts">RulesetRule</a></code> |
| 2817 | - <code><a href="./src/resources/rulesets/rules.ts">ScoreRule</a></code> |
| 2818 | - <code><a href="./src/resources/rulesets/rules.ts">ServeErrorRule</a></code> |
| 2819 | - <code><a href="./src/resources/rulesets/rules.ts">SetCacheSettingsRule</a></code> |
| 2820 | - <code><a href="./src/resources/rulesets/rules.ts">SetConfigRule</a></code> |
| 2821 | - <code><a href="./src/resources/rulesets/rules.ts">SkipRule</a></code> |
| 2822 | - <code><a href="./src/resources/rulesets/rules.ts">RuleCreateResponse</a></code> |
| 2823 | - <code><a href="./src/resources/rulesets/rules.ts">RuleDeleteResponse</a></code> |
| 2824 | - <code><a href="./src/resources/rulesets/rules.ts">RuleEditResponse</a></code> |
| 2825 | |
| 2826 | Methods: |
| 2827 | |
| 2828 | - <code title="post /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/rules">client.rulesets.rules.<a href="./src/resources/rulesets/rules.ts">create</a>(rulesetId, { ...params }) -> RuleCreateResponse</code> |
| 2829 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/rules/{rule_id}">client.rulesets.rules.<a href="./src/resources/rulesets/rules.ts">delete</a>(rulesetId, ruleId, { ...params }) -> RuleDeleteResponse</code> |
| 2830 | - <code title="patch /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/rules/{rule_id}">client.rulesets.rules.<a href="./src/resources/rulesets/rules.ts">edit</a>(rulesetId, ruleId, { ...params }) -> RuleEditResponse</code> |
| 2831 | |
| 2832 | ## Versions |
| 2833 | |
| 2834 | Types: |
| 2835 | |
| 2836 | - <code><a href="./src/resources/rulesets/versions/versions.ts">VersionListResponse</a></code> |
| 2837 | - <code><a href="./src/resources/rulesets/versions/versions.ts">VersionGetResponse</a></code> |
| 2838 | |
| 2839 | Methods: |
| 2840 | |
| 2841 | - <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions">client.rulesets.versions.<a href="./src/resources/rulesets/versions/versions.ts">list</a>(rulesetId, { ...params }) -> VersionListResponsesSinglePage</code> |
| 2842 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}">client.rulesets.versions.<a href="./src/resources/rulesets/versions/versions.ts">delete</a>(rulesetId, rulesetVersion, { ...params }) -> void</code> |
| 2843 | - <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}">client.rulesets.versions.<a href="./src/resources/rulesets/versions/versions.ts">get</a>(rulesetId, rulesetVersion, { ...params }) -> VersionGetResponse</code> |
| 2844 | |
| 2845 | ### ByTag |
| 2846 | |
| 2847 | Types: |
| 2848 | |
| 2849 | - <code><a href="./src/resources/rulesets/versions/by-tag.ts">ByTagGetResponse</a></code> |
| 2850 | |
| 2851 | Methods: |
| 2852 | |
| 2853 | - <code title="get /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}">client.rulesets.versions.byTag.<a href="./src/resources/rulesets/versions/by-tag.ts">get</a>(rulesetId, rulesetVersion, ruleTag, { ...params }) -> ByTagGetResponse</code> |
| 2854 | |
| 2855 | # URLNormalization |
| 2856 | |
| 2857 | Types: |
| 2858 | |
| 2859 | - <code><a href="./src/resources/url-normalization.ts">URLNormalizationUpdateResponse</a></code> |
| 2860 | - <code><a href="./src/resources/url-normalization.ts">URLNormalizationGetResponse</a></code> |
| 2861 | |
| 2862 | Methods: |
| 2863 | |
| 2864 | - <code title="put /zones/{zone_id}/url_normalization">client.urlNormalization.<a href="./src/resources/url-normalization.ts">update</a>({ ...params }) -> URLNormalizationUpdateResponse</code> |
| 2865 | - <code title="get /zones/{zone_id}/url_normalization">client.urlNormalization.<a href="./src/resources/url-normalization.ts">get</a>({ ...params }) -> URLNormalizationGetResponse</code> |
| 2866 | |
| 2867 | # Spectrum |
| 2868 | |
| 2869 | Types: |
| 2870 | |
| 2871 | - <code><a href="./src/resources/spectrum/spectrum.ts">DNS</a></code> |
| 2872 | - <code><a href="./src/resources/spectrum/spectrum.ts">EdgeIPs</a></code> |
| 2873 | - <code><a href="./src/resources/spectrum/spectrum.ts">OriginDNS</a></code> |
| 2874 | - <code><a href="./src/resources/spectrum/spectrum.ts">OriginPort</a></code> |
| 2875 | |
| 2876 | ## Analytics |
| 2877 | |
| 2878 | ### Aggregates |
| 2879 | |
| 2880 | #### Currents |
| 2881 | |
| 2882 | Types: |
| 2883 | |
| 2884 | - <code><a href="./src/resources/spectrum/analytics/aggregates/currents.ts">CurrentGetResponse</a></code> |
| 2885 | |
| 2886 | Methods: |
| 2887 | |
| 2888 | - <code title="get /zones/{zone}/spectrum/analytics/aggregate/current">client.spectrum.analytics.aggregates.currents.<a href="./src/resources/spectrum/analytics/aggregates/currents.ts">get</a>(zone, { ...params }) -> CurrentGetResponse</code> |
| 2889 | |
| 2890 | ### Events |
| 2891 | |
| 2892 | Types: |
| 2893 | |
| 2894 | - <code><a href="./src/resources/spectrum/analytics/events/events.ts">Dimension</a></code> |
| 2895 | |
| 2896 | #### Bytimes |
| 2897 | |
| 2898 | Types: |
| 2899 | |
| 2900 | - <code><a href="./src/resources/spectrum/analytics/events/bytimes.ts">BytimeGetResponse</a></code> |
| 2901 | |
| 2902 | Methods: |
| 2903 | |
| 2904 | - <code title="get /zones/{zone}/spectrum/analytics/events/bytime">client.spectrum.analytics.events.bytimes.<a href="./src/resources/spectrum/analytics/events/bytimes.ts">get</a>(zone, { ...params }) -> BytimeGetResponse | null</code> |
| 2905 | |
| 2906 | #### Summaries |
| 2907 | |
| 2908 | Types: |
| 2909 | |
| 2910 | - <code><a href="./src/resources/spectrum/analytics/events/summaries.ts">SummaryGetResponse</a></code> |
| 2911 | |
| 2912 | Methods: |
| 2913 | |
| 2914 | - <code title="get /zones/{zone}/spectrum/analytics/events/summary">client.spectrum.analytics.events.summaries.<a href="./src/resources/spectrum/analytics/events/summaries.ts">get</a>(zone, { ...params }) -> SummaryGetResponse | null</code> |
| 2915 | |
| 2916 | ## Apps |
| 2917 | |
| 2918 | Types: |
| 2919 | |
| 2920 | - <code><a href="./src/resources/spectrum/apps.ts">AppCreateResponse</a></code> |
| 2921 | - <code><a href="./src/resources/spectrum/apps.ts">AppUpdateResponse</a></code> |
| 2922 | - <code><a href="./src/resources/spectrum/apps.ts">AppListResponse</a></code> |
| 2923 | - <code><a href="./src/resources/spectrum/apps.ts">AppDeleteResponse</a></code> |
| 2924 | - <code><a href="./src/resources/spectrum/apps.ts">AppGetResponse</a></code> |
| 2925 | |
| 2926 | Methods: |
| 2927 | |
| 2928 | - <code title="post /zones/{zone}/spectrum/apps">client.spectrum.apps.<a href="./src/resources/spectrum/apps.ts">create</a>(zone, { ...params }) -> AppCreateResponse | null</code> |
| 2929 | - <code title="put /zones/{zone}/spectrum/apps/{app_id}">client.spectrum.apps.<a href="./src/resources/spectrum/apps.ts">update</a>(zone, appId, { ...params }) -> AppUpdateResponse | null</code> |
| 2930 | - <code title="get /zones/{zone}/spectrum/apps">client.spectrum.apps.<a href="./src/resources/spectrum/apps.ts">list</a>(zone, { ...params }) -> AppListResponsesV4PagePaginationArray</code> |
| 2931 | - <code title="delete /zones/{zone}/spectrum/apps/{app_id}">client.spectrum.apps.<a href="./src/resources/spectrum/apps.ts">delete</a>(zone, appId) -> AppDeleteResponse | null</code> |
| 2932 | - <code title="get /zones/{zone}/spectrum/apps/{app_id}">client.spectrum.apps.<a href="./src/resources/spectrum/apps.ts">get</a>(zone, appId) -> AppGetResponse</code> |
| 2933 | |
| 2934 | # Addressing |
| 2935 | |
| 2936 | ## RegionalHostnames |
| 2937 | |
| 2938 | Types: |
| 2939 | |
| 2940 | - <code><a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">RegionalHostnameCreateResponse</a></code> |
| 2941 | - <code><a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">RegionalHostnameListResponse</a></code> |
| 2942 | - <code><a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">RegionalHostnameDeleteResponse</a></code> |
| 2943 | - <code><a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">RegionalHostnameEditResponse</a></code> |
| 2944 | - <code><a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">RegionalHostnameGetResponse</a></code> |
| 2945 | |
| 2946 | Methods: |
| 2947 | |
| 2948 | - <code title="post /zones/{zone_id}/addressing/regional_hostnames">client.addressing.regionalHostnames.<a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">create</a>({ ...params }) -> RegionalHostnameCreateResponse</code> |
| 2949 | - <code title="get /zones/{zone_id}/addressing/regional_hostnames">client.addressing.regionalHostnames.<a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">list</a>({ ...params }) -> RegionalHostnameListResponsesSinglePage</code> |
| 2950 | - <code title="delete /zones/{zone_id}/addressing/regional_hostnames/{hostname}">client.addressing.regionalHostnames.<a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">delete</a>(hostname, { ...params }) -> RegionalHostnameDeleteResponse</code> |
| 2951 | - <code title="patch /zones/{zone_id}/addressing/regional_hostnames/{hostname}">client.addressing.regionalHostnames.<a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">edit</a>(hostname, { ...params }) -> RegionalHostnameEditResponse</code> |
| 2952 | - <code title="get /zones/{zone_id}/addressing/regional_hostnames/{hostname}">client.addressing.regionalHostnames.<a href="./src/resources/addressing/regional-hostnames/regional-hostnames.ts">get</a>(hostname, { ...params }) -> RegionalHostnameGetResponse</code> |
| 2953 | |
| 2954 | ### Regions |
| 2955 | |
| 2956 | Types: |
| 2957 | |
| 2958 | - <code><a href="./src/resources/addressing/regional-hostnames/regions.ts">RegionListResponse</a></code> |
| 2959 | |
| 2960 | Methods: |
| 2961 | |
| 2962 | - <code title="get /accounts/{account_id}/addressing/regional_hostnames/regions">client.addressing.regionalHostnames.regions.<a href="./src/resources/addressing/regional-hostnames/regions.ts">list</a>({ ...params }) -> RegionListResponsesSinglePage</code> |
| 2963 | |
| 2964 | ## Services |
| 2965 | |
| 2966 | Types: |
| 2967 | |
| 2968 | - <code><a href="./src/resources/addressing/services.ts">ServiceListResponse</a></code> |
| 2969 | |
| 2970 | Methods: |
| 2971 | |
| 2972 | - <code title="get /accounts/{account_id}/addressing/services">client.addressing.services.<a href="./src/resources/addressing/services.ts">list</a>({ ...params }) -> ServiceListResponsesSinglePage</code> |
| 2973 | |
| 2974 | ## AddressMaps |
| 2975 | |
| 2976 | Types: |
| 2977 | |
| 2978 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">AddressMap</a></code> |
| 2979 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">Kind</a></code> |
| 2980 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">AddressMapCreateResponse</a></code> |
| 2981 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">AddressMapDeleteResponse</a></code> |
| 2982 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">AddressMapGetResponse</a></code> |
| 2983 | |
| 2984 | Methods: |
| 2985 | |
| 2986 | - <code title="post /accounts/{account_id}/addressing/address_maps">client.addressing.addressMaps.<a href="./src/resources/addressing/address-maps/address-maps.ts">create</a>({ ...params }) -> AddressMapCreateResponse</code> |
| 2987 | - <code title="get /accounts/{account_id}/addressing/address_maps">client.addressing.addressMaps.<a href="./src/resources/addressing/address-maps/address-maps.ts">list</a>({ ...params }) -> AddressMapsSinglePage</code> |
| 2988 | - <code title="delete /accounts/{account_id}/addressing/address_maps/{address_map_id}">client.addressing.addressMaps.<a href="./src/resources/addressing/address-maps/address-maps.ts">delete</a>(addressMapId, { ...params }) -> AddressMapDeleteResponse | null</code> |
| 2989 | - <code title="patch /accounts/{account_id}/addressing/address_maps/{address_map_id}">client.addressing.addressMaps.<a href="./src/resources/addressing/address-maps/address-maps.ts">edit</a>(addressMapId, { ...params }) -> AddressMap</code> |
| 2990 | - <code title="get /accounts/{account_id}/addressing/address_maps/{address_map_id}">client.addressing.addressMaps.<a href="./src/resources/addressing/address-maps/address-maps.ts">get</a>(addressMapId, { ...params }) -> AddressMapGetResponse</code> |
| 2991 | |
| 2992 | ### Accounts |
| 2993 | |
| 2994 | Types: |
| 2995 | |
| 2996 | - <code><a href="./src/resources/addressing/address-maps/accounts.ts">AccountUpdateResponse</a></code> |
| 2997 | - <code><a href="./src/resources/addressing/address-maps/accounts.ts">AccountDeleteResponse</a></code> |
| 2998 | |
| 2999 | Methods: |
| 3000 | |
| 3001 | - <code title="put /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}">client.addressing.addressMaps.accounts.<a href="./src/resources/addressing/address-maps/accounts.ts">update</a>(addressMapId, { ...params }) -> AccountUpdateResponse | null</code> |
| 3002 | - <code title="delete /accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}">client.addressing.addressMaps.accounts.<a href="./src/resources/addressing/address-maps/accounts.ts">delete</a>(addressMapId, { ...params }) -> AccountDeleteResponse | null</code> |
| 3003 | |
| 3004 | ### IPs |
| 3005 | |
| 3006 | Types: |
| 3007 | |
| 3008 | - <code><a href="./src/resources/addressing/address-maps/ips.ts">IPUpdateResponse</a></code> |
| 3009 | - <code><a href="./src/resources/addressing/address-maps/ips.ts">IPDeleteResponse</a></code> |
| 3010 | |
| 3011 | Methods: |
| 3012 | |
| 3013 | - <code title="put /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}">client.addressing.addressMaps.ips.<a href="./src/resources/addressing/address-maps/ips.ts">update</a>(addressMapId, ipAddress, { ...params }) -> IPUpdateResponse | null</code> |
| 3014 | - <code title="delete /accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}">client.addressing.addressMaps.ips.<a href="./src/resources/addressing/address-maps/ips.ts">delete</a>(addressMapId, ipAddress, { ...params }) -> IPDeleteResponse | null</code> |
| 3015 | |
| 3016 | ### Zones |
| 3017 | |
| 3018 | Types: |
| 3019 | |
| 3020 | - <code><a href="./src/resources/addressing/address-maps/zones.ts">ZoneUpdateResponse</a></code> |
| 3021 | - <code><a href="./src/resources/addressing/address-maps/zones.ts">ZoneDeleteResponse</a></code> |
| 3022 | |
| 3023 | Methods: |
| 3024 | |
| 3025 | - <code title="put /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}">client.addressing.addressMaps.zones.<a href="./src/resources/addressing/address-maps/zones.ts">update</a>(addressMapId, { ...params }) -> ZoneUpdateResponse | null</code> |
| 3026 | - <code title="delete /accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}">client.addressing.addressMaps.zones.<a href="./src/resources/addressing/address-maps/zones.ts">delete</a>(addressMapId, { ...params }) -> ZoneDeleteResponse | null</code> |
| 3027 | |
| 3028 | ## LOADocuments |
| 3029 | |
| 3030 | Types: |
| 3031 | |
| 3032 | - <code><a href="./src/resources/addressing/loa-documents/loa-documents.ts">LOADocumentCreateResponse</a></code> |
| 3033 | |
| 3034 | Methods: |
| 3035 | |
| 3036 | - <code title="post /accounts/{account_id}/addressing/loa_documents">client.addressing.loaDocuments.<a href="./src/resources/addressing/loa-documents/loa-documents.ts">create</a>({ ...params }) -> LOADocumentCreateResponse</code> |
| 3037 | |
| 3038 | ### Downloads |
| 3039 | |
| 3040 | Methods: |
| 3041 | |
| 3042 | - <code title="get /accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download">client.addressing.loaDocuments.downloads.<a href="./src/resources/addressing/loa-documents/downloads.ts">get</a>(loaDocumentId, { ...params }) -> Response</code> |
| 3043 | |
| 3044 | ## Prefixes |
| 3045 | |
| 3046 | Types: |
| 3047 | |
| 3048 | - <code><a href="./src/resources/addressing/prefixes/prefixes.ts">Prefix</a></code> |
| 3049 | - <code><a href="./src/resources/addressing/prefixes/prefixes.ts">PrefixDeleteResponse</a></code> |
| 3050 | |
| 3051 | Methods: |
| 3052 | |
| 3053 | - <code title="post /accounts/{account_id}/addressing/prefixes">client.addressing.prefixes.<a href="./src/resources/addressing/prefixes/prefixes.ts">create</a>({ ...params }) -> Prefix</code> |
| 3054 | - <code title="get /accounts/{account_id}/addressing/prefixes">client.addressing.prefixes.<a href="./src/resources/addressing/prefixes/prefixes.ts">list</a>({ ...params }) -> PrefixesSinglePage</code> |
| 3055 | - <code title="delete /accounts/{account_id}/addressing/prefixes/{prefix_id}">client.addressing.prefixes.<a href="./src/resources/addressing/prefixes/prefixes.ts">delete</a>(prefixId, { ...params }) -> PrefixDeleteResponse | null</code> |
| 3056 | - <code title="patch /accounts/{account_id}/addressing/prefixes/{prefix_id}">client.addressing.prefixes.<a href="./src/resources/addressing/prefixes/prefixes.ts">edit</a>(prefixId, { ...params }) -> Prefix</code> |
| 3057 | - <code title="get /accounts/{account_id}/addressing/prefixes/{prefix_id}">client.addressing.prefixes.<a href="./src/resources/addressing/prefixes/prefixes.ts">get</a>(prefixId, { ...params }) -> Prefix</code> |
| 3058 | |
| 3059 | ### BGP |
| 3060 | |
| 3061 | #### Bindings |
| 3062 | |
| 3063 | Types: |
| 3064 | |
| 3065 | - <code><a href="./src/resources/addressing/prefixes/bgp/bindings.ts">ServiceBinding</a></code> |
| 3066 | - <code><a href="./src/resources/addressing/prefixes/bgp/bindings.ts">BindingDeleteResponse</a></code> |
| 3067 | |
| 3068 | Methods: |
| 3069 | |
| 3070 | - <code title="post /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings">client.addressing.prefixes.bgp.bindings.<a href="./src/resources/addressing/prefixes/bgp/bindings.ts">create</a>(prefixId, { ...params }) -> ServiceBinding</code> |
| 3071 | - <code title="get /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings">client.addressing.prefixes.bgp.bindings.<a href="./src/resources/addressing/prefixes/bgp/bindings.ts">list</a>(prefixId, { ...params }) -> ServiceBindingsSinglePage</code> |
| 3072 | - <code title="delete /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}">client.addressing.prefixes.bgp.bindings.<a href="./src/resources/addressing/prefixes/bgp/bindings.ts">delete</a>(prefixId, bindingId, { ...params }) -> BindingDeleteResponse</code> |
| 3073 | - <code title="get /accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}">client.addressing.prefixes.bgp.bindings.<a href="./src/resources/addressing/prefixes/bgp/bindings.ts">get</a>(prefixId, bindingId, { ...params }) -> ServiceBinding</code> |
| 3074 | |
| 3075 | #### Prefixes |
| 3076 | |
| 3077 | Types: |
| 3078 | |
| 3079 | - <code><a href="./src/resources/addressing/prefixes/bgp/prefixes.ts">BGPPrefix</a></code> |
| 3080 | |
| 3081 | Methods: |
| 3082 | |
| 3083 | - <code title="get /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes">client.addressing.prefixes.bgp.prefixes.<a href="./src/resources/addressing/prefixes/bgp/prefixes.ts">list</a>(prefixId, { ...params }) -> BGPPrefixesSinglePage</code> |
| 3084 | - <code title="patch /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}">client.addressing.prefixes.bgp.prefixes.<a href="./src/resources/addressing/prefixes/bgp/prefixes.ts">edit</a>(prefixId, bgpPrefixId, { ...params }) -> BGPPrefix</code> |
| 3085 | - <code title="get /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}">client.addressing.prefixes.bgp.prefixes.<a href="./src/resources/addressing/prefixes/bgp/prefixes.ts">get</a>(prefixId, bgpPrefixId, { ...params }) -> BGPPrefix</code> |
| 3086 | |
| 3087 | #### Statuses |
| 3088 | |
| 3089 | Types: |
| 3090 | |
| 3091 | - <code><a href="./src/resources/addressing/prefixes/bgp/statuses.ts">StatusEditResponse</a></code> |
| 3092 | - <code><a href="./src/resources/addressing/prefixes/bgp/statuses.ts">StatusGetResponse</a></code> |
| 3093 | |
| 3094 | Methods: |
| 3095 | |
| 3096 | - <code title="patch /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status">client.addressing.prefixes.bgp.statuses.<a href="./src/resources/addressing/prefixes/bgp/statuses.ts">edit</a>(prefixId, { ...params }) -> StatusEditResponse</code> |
| 3097 | - <code title="get /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status">client.addressing.prefixes.bgp.statuses.<a href="./src/resources/addressing/prefixes/bgp/statuses.ts">get</a>(prefixId, { ...params }) -> StatusGetResponse</code> |
| 3098 | |
| 3099 | ### Delegations |
| 3100 | |
| 3101 | Types: |
| 3102 | |
| 3103 | - <code><a href="./src/resources/addressing/prefixes/delegations.ts">Delegations</a></code> |
| 3104 | - <code><a href="./src/resources/addressing/prefixes/delegations.ts">DelegationDeleteResponse</a></code> |
| 3105 | |
| 3106 | Methods: |
| 3107 | |
| 3108 | - <code title="post /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations">client.addressing.prefixes.delegations.<a href="./src/resources/addressing/prefixes/delegations.ts">create</a>(prefixId, { ...params }) -> Delegations</code> |
| 3109 | - <code title="get /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations">client.addressing.prefixes.delegations.<a href="./src/resources/addressing/prefixes/delegations.ts">list</a>(prefixId, { ...params }) -> DelegationsSinglePage</code> |
| 3110 | - <code title="delete /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}">client.addressing.prefixes.delegations.<a href="./src/resources/addressing/prefixes/delegations.ts">delete</a>(prefixId, delegationId, { ...params }) -> DelegationDeleteResponse</code> |
| 3111 | |
| 3112 | # AuditLogs |
| 3113 | |
| 3114 | Methods: |
| 3115 | |
| 3116 | - <code title="get /accounts/{account_id}/audit_logs">client.auditLogs.<a href="./src/resources/audit-logs.ts">list</a>({ ...params }) -> AuditLogsV4PagePaginationArray</code> |
| 3117 | |
| 3118 | # Billing |
| 3119 | |
| 3120 | ## Profiles |
| 3121 | |
| 3122 | Types: |
| 3123 | |
| 3124 | - <code><a href="./src/resources/billing/profiles.ts">ProfileGetResponse</a></code> |
| 3125 | |
| 3126 | Methods: |
| 3127 | |
| 3128 | - <code title="get /accounts/{account_identifier}/billing/profile">client.billing.profiles.<a href="./src/resources/billing/profiles.ts">get</a>(accountIdentifier) -> ProfileGetResponse</code> |
| 3129 | |
| 3130 | # BrandProtection |
| 3131 | |
| 3132 | Types: |
| 3133 | |
| 3134 | - <code><a href="./src/resources/brand-protection.ts">Info</a></code> |
| 3135 | - <code><a href="./src/resources/brand-protection.ts">RuleMatch</a></code> |
| 3136 | - <code><a href="./src/resources/brand-protection.ts">ScanStatus</a></code> |
| 3137 | - <code><a href="./src/resources/brand-protection.ts">Submit</a></code> |
| 3138 | - <code><a href="./src/resources/brand-protection.ts">URLInfoModelResults</a></code> |
| 3139 | |
| 3140 | Methods: |
| 3141 | |
| 3142 | - <code title="post /accounts/{account_id}/brand-protection/submit">client.brandProtection.<a href="./src/resources/brand-protection.ts">submit</a>({ ...params }) -> Submit</code> |
| 3143 | - <code title="get /accounts/{account_id}/brand-protection/url-info">client.brandProtection.<a href="./src/resources/brand-protection.ts">urlInfo</a>({ ...params }) -> Info</code> |
| 3144 | |
| 3145 | # Diagnostics |
| 3146 | |
| 3147 | ## Traceroutes |
| 3148 | |
| 3149 | Types: |
| 3150 | |
| 3151 | - <code><a href="./src/resources/diagnostics/traceroutes.ts">Traceroute</a></code> |
| 3152 | - <code><a href="./src/resources/diagnostics/traceroutes.ts">TracerouteCreateResponse</a></code> |
| 3153 | |
| 3154 | Methods: |
| 3155 | |
| 3156 | - <code title="post /accounts/{account_id}/diagnostics/traceroute">client.diagnostics.traceroutes.<a href="./src/resources/diagnostics/traceroutes.ts">create</a>({ ...params }) -> TracerouteCreateResponse | null</code> |
| 3157 | |
| 3158 | # Images |
| 3159 | |
| 3160 | ## V1 |
| 3161 | |
| 3162 | Types: |
| 3163 | |
| 3164 | - <code><a href="./src/resources/images/v1/v1.ts">Image</a></code> |
| 3165 | - <code><a href="./src/resources/images/v1/v1.ts">V1ListResponse</a></code> |
| 3166 | - <code><a href="./src/resources/images/v1/v1.ts">V1DeleteResponse</a></code> |
| 3167 | |
| 3168 | Methods: |
| 3169 | |
| 3170 | - <code title="post /accounts/{account_id}/images/v1">client.images.v1.<a href="./src/resources/images/v1/v1.ts">create</a>({ ...params }) -> Image</code> |
| 3171 | - <code title="get /accounts/{account_id}/images/v1">client.images.v1.<a href="./src/resources/images/v1/v1.ts">list</a>({ ...params }) -> V1ListResponsesV4PagePagination</code> |
| 3172 | - <code title="delete /accounts/{account_id}/images/v1/{image_id}">client.images.v1.<a href="./src/resources/images/v1/v1.ts">delete</a>(imageId, { ...params }) -> V1DeleteResponse</code> |
| 3173 | - <code title="patch /accounts/{account_id}/images/v1/{image_id}">client.images.v1.<a href="./src/resources/images/v1/v1.ts">edit</a>(imageId, { ...params }) -> Image</code> |
| 3174 | - <code title="get /accounts/{account_id}/images/v1/{image_id}">client.images.v1.<a href="./src/resources/images/v1/v1.ts">get</a>(imageId, { ...params }) -> Image</code> |
| 3175 | |
| 3176 | ### Keys |
| 3177 | |
| 3178 | Types: |
| 3179 | |
| 3180 | - <code><a href="./src/resources/images/v1/keys.ts">Key</a></code> |
| 3181 | - <code><a href="./src/resources/images/v1/keys.ts">KeyUpdateResponse</a></code> |
| 3182 | - <code><a href="./src/resources/images/v1/keys.ts">KeyListResponse</a></code> |
| 3183 | - <code><a href="./src/resources/images/v1/keys.ts">KeyDeleteResponse</a></code> |
| 3184 | |
| 3185 | Methods: |
| 3186 | |
| 3187 | - <code title="put /accounts/{account_id}/images/v1/keys/{signing_key_name}">client.images.v1.keys.<a href="./src/resources/images/v1/keys.ts">update</a>(signingKeyName, { ...params }) -> KeyUpdateResponse</code> |
| 3188 | - <code title="get /accounts/{account_id}/images/v1/keys">client.images.v1.keys.<a href="./src/resources/images/v1/keys.ts">list</a>({ ...params }) -> KeyListResponse</code> |
| 3189 | - <code title="delete /accounts/{account_id}/images/v1/keys/{signing_key_name}">client.images.v1.keys.<a href="./src/resources/images/v1/keys.ts">delete</a>(signingKeyName, { ...params }) -> KeyDeleteResponse</code> |
| 3190 | |
| 3191 | ### Stats |
| 3192 | |
| 3193 | Types: |
| 3194 | |
| 3195 | - <code><a href="./src/resources/images/v1/stats.ts">Stat</a></code> |
| 3196 | |
| 3197 | Methods: |
| 3198 | |
| 3199 | - <code title="get /accounts/{account_id}/images/v1/stats">client.images.v1.stats.<a href="./src/resources/images/v1/stats.ts">get</a>({ ...params }) -> Stat</code> |
| 3200 | |
| 3201 | ### Variants |
| 3202 | |
| 3203 | Types: |
| 3204 | |
| 3205 | - <code><a href="./src/resources/images/v1/variants.ts">Variant</a></code> |
| 3206 | - <code><a href="./src/resources/images/v1/variants.ts">VariantCreateResponse</a></code> |
| 3207 | - <code><a href="./src/resources/images/v1/variants.ts">VariantDeleteResponse</a></code> |
| 3208 | - <code><a href="./src/resources/images/v1/variants.ts">VariantEditResponse</a></code> |
| 3209 | - <code><a href="./src/resources/images/v1/variants.ts">VariantGetResponse</a></code> |
| 3210 | |
| 3211 | Methods: |
| 3212 | |
| 3213 | - <code title="post /accounts/{account_id}/images/v1/variants">client.images.v1.variants.<a href="./src/resources/images/v1/variants.ts">create</a>({ ...params }) -> VariantCreateResponse</code> |
| 3214 | - <code title="get /accounts/{account_id}/images/v1/variants">client.images.v1.variants.<a href="./src/resources/images/v1/variants.ts">list</a>({ ...params }) -> Variant</code> |
| 3215 | - <code title="delete /accounts/{account_id}/images/v1/variants/{variant_id}">client.images.v1.variants.<a href="./src/resources/images/v1/variants.ts">delete</a>(variantId, { ...params }) -> VariantDeleteResponse</code> |
| 3216 | - <code title="patch /accounts/{account_id}/images/v1/variants/{variant_id}">client.images.v1.variants.<a href="./src/resources/images/v1/variants.ts">edit</a>(variantId, { ...params }) -> VariantEditResponse</code> |
| 3217 | - <code title="get /accounts/{account_id}/images/v1/variants/{variant_id}">client.images.v1.variants.<a href="./src/resources/images/v1/variants.ts">get</a>(variantId, { ...params }) -> VariantGetResponse</code> |
| 3218 | |
| 3219 | ### Blobs |
| 3220 | |
| 3221 | Methods: |
| 3222 | |
| 3223 | - <code title="get /accounts/{account_id}/images/v1/{image_id}/blob">client.images.v1.blobs.<a href="./src/resources/images/v1/blobs.ts">get</a>(imageId, { ...params }) -> Response</code> |
| 3224 | |
| 3225 | ## V2 |
| 3226 | |
| 3227 | Types: |
| 3228 | |
| 3229 | - <code><a href="./src/resources/images/v2/v2.ts">V2ListResponse</a></code> |
| 3230 | |
| 3231 | Methods: |
| 3232 | |
| 3233 | - <code title="get /accounts/{account_id}/images/v2">client.images.v2.<a href="./src/resources/images/v2/v2.ts">list</a>({ ...params }) -> V2ListResponse</code> |
| 3234 | |
| 3235 | ### DirectUploads |
| 3236 | |
| 3237 | Types: |
| 3238 | |
| 3239 | - <code><a href="./src/resources/images/v2/direct-uploads.ts">DirectUploadCreateResponse</a></code> |
| 3240 | |
| 3241 | Methods: |
| 3242 | |
| 3243 | - <code title="post /accounts/{account_id}/images/v2/direct_upload">client.images.v2.directUploads.<a href="./src/resources/images/v2/direct-uploads.ts">create</a>({ ...params }) -> DirectUploadCreateResponse</code> |
| 3244 | |
| 3245 | # Intel |
| 3246 | |
| 3247 | ## ASN |
| 3248 | |
| 3249 | Methods: |
| 3250 | |
| 3251 | - <code title="get /accounts/{account_id}/intel/asn/{asn}">client.intel.asn.<a href="./src/resources/intel/asn/asn.ts">get</a>(asn, { ...params }) -> ASN</code> |
| 3252 | |
| 3253 | ### Subnets |
| 3254 | |
| 3255 | Types: |
| 3256 | |
| 3257 | - <code><a href="./src/resources/intel/asn/subnets.ts">SubnetGetResponse</a></code> |
| 3258 | |
| 3259 | Methods: |
| 3260 | |
| 3261 | - <code title="get /accounts/{account_id}/intel/asn/{asn}/subnets">client.intel.asn.subnets.<a href="./src/resources/intel/asn/subnets.ts">get</a>(asn, { ...params }) -> SubnetGetResponse</code> |
| 3262 | |
| 3263 | ## DNS |
| 3264 | |
| 3265 | Types: |
| 3266 | |
| 3267 | - <code><a href="./src/resources/intel/dns.ts">DNS</a></code> |
| 3268 | - <code><a href="./src/resources/intel/dns.ts">DNSListResponse</a></code> |
| 3269 | |
| 3270 | Methods: |
| 3271 | |
| 3272 | - <code title="get /accounts/{account_id}/intel/dns">client.intel.dns.<a href="./src/resources/intel/dns.ts">list</a>({ ...params }) -> DNSListResponsesV4PagePagination</code> |
| 3273 | |
| 3274 | ## Domains |
| 3275 | |
| 3276 | Types: |
| 3277 | |
| 3278 | - <code><a href="./src/resources/intel/domains/domains.ts">Domain</a></code> |
| 3279 | |
| 3280 | Methods: |
| 3281 | |
| 3282 | - <code title="get /accounts/{account_id}/intel/domain">client.intel.domains.<a href="./src/resources/intel/domains/domains.ts">get</a>({ ...params }) -> Domain</code> |
| 3283 | |
| 3284 | ### Bulks |
| 3285 | |
| 3286 | Types: |
| 3287 | |
| 3288 | - <code><a href="./src/resources/intel/domains/bulks.ts">BulkGetResponse</a></code> |
| 3289 | |
| 3290 | Methods: |
| 3291 | |
| 3292 | - <code title="get /accounts/{account_id}/intel/domain/bulk">client.intel.domains.bulks.<a href="./src/resources/intel/domains/bulks.ts">get</a>({ ...params }) -> BulkGetResponse | null</code> |
| 3293 | |
| 3294 | ## DomainHistory |
| 3295 | |
| 3296 | Types: |
| 3297 | |
| 3298 | - <code><a href="./src/resources/intel/domain-history.ts">DomainHistory</a></code> |
| 3299 | - <code><a href="./src/resources/intel/domain-history.ts">DomainHistoryGetResponse</a></code> |
| 3300 | |
| 3301 | Methods: |
| 3302 | |
| 3303 | - <code title="get /accounts/{account_id}/intel/domain-history">client.intel.domainHistory.<a href="./src/resources/intel/domain-history.ts">get</a>({ ...params }) -> DomainHistoryGetResponse | null</code> |
| 3304 | |
| 3305 | ## IPs |
| 3306 | |
| 3307 | Types: |
| 3308 | |
| 3309 | - <code><a href="./src/resources/intel/ips.ts">IP</a></code> |
| 3310 | - <code><a href="./src/resources/intel/ips.ts">IPGetResponse</a></code> |
| 3311 | |
| 3312 | Methods: |
| 3313 | |
| 3314 | - <code title="get /accounts/{account_id}/intel/ip">client.intel.ips.<a href="./src/resources/intel/ips.ts">get</a>({ ...params }) -> IPGetResponse | null</code> |
| 3315 | |
| 3316 | ## IPLists |
| 3317 | |
| 3318 | Types: |
| 3319 | |
| 3320 | - <code><a href="./src/resources/intel/ip-lists.ts">IPList</a></code> |
| 3321 | - <code><a href="./src/resources/intel/ip-lists.ts">IPListGetResponse</a></code> |
| 3322 | |
| 3323 | Methods: |
| 3324 | |
| 3325 | - <code title="get /accounts/{account_id}/intel/ip-list">client.intel.ipLists.<a href="./src/resources/intel/ip-lists.ts">get</a>({ ...params }) -> IPListGetResponse | null</code> |
| 3326 | |
| 3327 | ## Miscategorizations |
| 3328 | |
| 3329 | Types: |
| 3330 | |
| 3331 | - <code><a href="./src/resources/intel/miscategorizations.ts">MiscategorizationCreateResponse</a></code> |
| 3332 | |
| 3333 | Methods: |
| 3334 | |
| 3335 | - <code title="post /accounts/{account_id}/intel/miscategorization">client.intel.miscategorizations.<a href="./src/resources/intel/miscategorizations.ts">create</a>({ ...params }) -> MiscategorizationCreateResponse</code> |
| 3336 | |
| 3337 | ## Whois |
| 3338 | |
| 3339 | Types: |
| 3340 | |
| 3341 | - <code><a href="./src/resources/intel/whois.ts">Whois</a></code> |
| 3342 | - <code><a href="./src/resources/intel/whois.ts">WhoisGetResponse</a></code> |
| 3343 | |
| 3344 | Methods: |
| 3345 | |
| 3346 | - <code title="get /accounts/{account_id}/intel/whois">client.intel.whois.<a href="./src/resources/intel/whois.ts">get</a>({ ...params }) -> WhoisGetResponse</code> |
| 3347 | |
| 3348 | ## IndicatorFeeds |
| 3349 | |
| 3350 | Types: |
| 3351 | |
| 3352 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedCreateResponse</a></code> |
| 3353 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedUpdateResponse</a></code> |
| 3354 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedListResponse</a></code> |
| 3355 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedDataResponse</a></code> |
| 3356 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedGetResponse</a></code> |
| 3357 | |
| 3358 | Methods: |
| 3359 | |
| 3360 | - <code title="post /accounts/{account_id}/intel/indicator-feeds">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">create</a>({ ...params }) -> IndicatorFeedCreateResponse</code> |
| 3361 | - <code title="put /accounts/{account_id}/intel/indicator-feeds/{feed_id}">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">update</a>(feedId, { ...params }) -> IndicatorFeedUpdateResponse</code> |
| 3362 | - <code title="get /accounts/{account_id}/intel/indicator-feeds">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">list</a>({ ...params }) -> IndicatorFeedListResponsesSinglePage</code> |
| 3363 | - <code title="get /accounts/{account_id}/intel/indicator-feeds/{feed_id}/data">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">data</a>(feedId, { ...params }) -> string</code> |
| 3364 | - <code title="get /accounts/{account_id}/intel/indicator-feeds/{feed_id}">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">get</a>(feedId, { ...params }) -> IndicatorFeedGetResponse</code> |
| 3365 | |
| 3366 | ### Snapshots |
| 3367 | |
| 3368 | Types: |
| 3369 | |
| 3370 | - <code><a href="./src/resources/intel/indicator-feeds/snapshots.ts">SnapshotUpdateResponse</a></code> |
| 3371 | |
| 3372 | Methods: |
| 3373 | |
| 3374 | - <code title="put /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot">client.intel.indicatorFeeds.snapshots.<a href="./src/resources/intel/indicator-feeds/snapshots.ts">update</a>(feedId, { ...params }) -> SnapshotUpdateResponse</code> |
| 3375 | |
| 3376 | ### Permissions |
| 3377 | |
| 3378 | Types: |
| 3379 | |
| 3380 | - <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionCreateResponse</a></code> |
| 3381 | - <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionListResponse</a></code> |
| 3382 | - <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionDeleteResponse</a></code> |
| 3383 | |
| 3384 | Methods: |
| 3385 | |
| 3386 | - <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/add">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">create</a>({ ...params }) -> PermissionCreateResponse</code> |
| 3387 | - <code title="get /accounts/{account_id}/intel/indicator-feeds/permissions/view">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">list</a>({ ...params }) -> PermissionListResponse</code> |
| 3388 | - <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/remove">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">delete</a>({ ...params }) -> PermissionDeleteResponse</code> |
| 3389 | |
| 3390 | ## Sinkholes |
| 3391 | |
| 3392 | Types: |
| 3393 | |
| 3394 | - <code><a href="./src/resources/intel/sinkholes.ts">Sinkhole</a></code> |
| 3395 | |
| 3396 | Methods: |
| 3397 | |
| 3398 | - <code title="get /accounts/{account_id}/intel/sinkholes">client.intel.sinkholes.<a href="./src/resources/intel/sinkholes.ts">list</a>({ ...params }) -> SinkholesSinglePage</code> |
| 3399 | |
| 3400 | ## AttackSurfaceReport |
| 3401 | |
| 3402 | ### IssueTypes |
| 3403 | |
| 3404 | Types: |
| 3405 | |
| 3406 | - <code><a href="./src/resources/intel/attack-surface-report/issue-types.ts">IssueTypeGetResponse</a></code> |
| 3407 | |
| 3408 | Methods: |
| 3409 | |
| 3410 | - <code title="get /accounts/{account_id}/intel/attack-surface-report/issue-types">client.intel.attackSurfaceReport.issueTypes.<a href="./src/resources/intel/attack-surface-report/issue-types.ts">get</a>({ ...params }) -> IssueTypeGetResponse</code> |
| 3411 | |
| 3412 | ### Issues |
| 3413 | |
| 3414 | Types: |
| 3415 | |
| 3416 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueType</a></code> |
| 3417 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">SeverityQueryParam</a></code> |
| 3418 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueListResponse</a></code> |
| 3419 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueClassResponse</a></code> |
| 3420 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueDismissResponse</a></code> |
| 3421 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueSeverityResponse</a></code> |
| 3422 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueTypeResponse</a></code> |
| 3423 | |
| 3424 | Methods: |
| 3425 | |
| 3426 | - <code title="get /accounts/{account_id}/intel/attack-surface-report/issues">client.intel.attackSurfaceReport.issues.<a href="./src/resources/intel/attack-surface-report/issues.ts">list</a>({ ...params }) -> IssueListResponsesV4PagePagination</code> |
| 3427 | - <code title="get /accounts/{account_id}/intel/attack-surface-report/issues/class">client.intel.attackSurfaceReport.issues.<a href="./src/resources/intel/attack-surface-report/issues.ts">class</a>({ ...params }) -> IssueClassResponse</code> |
| 3428 | - <code title="put /accounts/{account_id}/intel/attack-surface-report/{issue_id}/dismiss">client.intel.attackSurfaceReport.issues.<a href="./src/resources/intel/attack-surface-report/issues.ts">dismiss</a>(issueId, { ...params }) -> IssueDismissResponse</code> |
| 3429 | - <code title="get /accounts/{account_id}/intel/attack-surface-report/issues/severity">client.intel.attackSurfaceReport.issues.<a href="./src/resources/intel/attack-surface-report/issues.ts">severity</a>({ ...params }) -> IssueSeverityResponse</code> |
| 3430 | - <code title="get /accounts/{account_id}/intel/attack-surface-report/issues/type">client.intel.attackSurfaceReport.issues.<a href="./src/resources/intel/attack-surface-report/issues.ts">type</a>({ ...params }) -> IssueTypeResponse</code> |
| 3431 | |
| 3432 | # MagicTransit |
| 3433 | |
| 3434 | Types: |
| 3435 | |
| 3436 | - <code><a href="./src/resources/magic-transit/magic-transit.ts">HealthCheck</a></code> |
| 3437 | - <code><a href="./src/resources/magic-transit/magic-transit.ts">HealthCheckRate</a></code> |
| 3438 | - <code><a href="./src/resources/magic-transit/magic-transit.ts">HealthCheckType</a></code> |
| 3439 | |
| 3440 | ## Apps |
| 3441 | |
| 3442 | Types: |
| 3443 | |
| 3444 | - <code><a href="./src/resources/magic-transit/apps.ts">AppCreateResponse</a></code> |
| 3445 | - <code><a href="./src/resources/magic-transit/apps.ts">AppUpdateResponse</a></code> |
| 3446 | - <code><a href="./src/resources/magic-transit/apps.ts">AppListResponse</a></code> |
| 3447 | - <code><a href="./src/resources/magic-transit/apps.ts">AppDeleteResponse</a></code> |
| 3448 | |
| 3449 | Methods: |
| 3450 | |
| 3451 | - <code title="post /accounts/{account_id}/magic/apps">client.magicTransit.apps.<a href="./src/resources/magic-transit/apps.ts">create</a>({ ...params }) -> AppCreateResponse | null</code> |
| 3452 | - <code title="put /accounts/{account_id}/magic/apps/{account_app_id}">client.magicTransit.apps.<a href="./src/resources/magic-transit/apps.ts">update</a>(accountAppId, { ...params }) -> AppUpdateResponse | null</code> |
| 3453 | - <code title="get /accounts/{account_id}/magic/apps">client.magicTransit.apps.<a href="./src/resources/magic-transit/apps.ts">list</a>({ ...params }) -> AppListResponsesSinglePage</code> |
| 3454 | - <code title="delete /accounts/{account_id}/magic/apps/{account_app_id}">client.magicTransit.apps.<a href="./src/resources/magic-transit/apps.ts">delete</a>(accountAppId, { ...params }) -> AppDeleteResponse | null</code> |
| 3455 | |
| 3456 | ## CfInterconnects |
| 3457 | |
| 3458 | Types: |
| 3459 | |
| 3460 | - <code><a href="./src/resources/magic-transit/cf-interconnects.ts">CfInterconnectUpdateResponse</a></code> |
| 3461 | - <code><a href="./src/resources/magic-transit/cf-interconnects.ts">CfInterconnectListResponse</a></code> |
| 3462 | - <code><a href="./src/resources/magic-transit/cf-interconnects.ts">CfInterconnectGetResponse</a></code> |
| 3463 | |
| 3464 | Methods: |
| 3465 | |
| 3466 | - <code title="put /accounts/{account_id}/magic/cf_interconnects/{tunnel_identifier}">client.magicTransit.cfInterconnects.<a href="./src/resources/magic-transit/cf-interconnects.ts">update</a>(tunnelIdentifier, { ...params }) -> CfInterconnectUpdateResponse</code> |
| 3467 | - <code title="get /accounts/{account_id}/magic/cf_interconnects">client.magicTransit.cfInterconnects.<a href="./src/resources/magic-transit/cf-interconnects.ts">list</a>({ ...params }) -> CfInterconnectListResponse</code> |
| 3468 | - <code title="get /accounts/{account_id}/magic/cf_interconnects/{tunnel_identifier}">client.magicTransit.cfInterconnects.<a href="./src/resources/magic-transit/cf-interconnects.ts">get</a>(tunnelIdentifier, { ...params }) -> CfInterconnectGetResponse</code> |
| 3469 | |
| 3470 | ## GRETunnels |
| 3471 | |
| 3472 | Types: |
| 3473 | |
| 3474 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelCreateResponse</a></code> |
| 3475 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelUpdateResponse</a></code> |
| 3476 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelListResponse</a></code> |
| 3477 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelDeleteResponse</a></code> |
| 3478 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelGetResponse</a></code> |
| 3479 | |
| 3480 | Methods: |
| 3481 | |
| 3482 | - <code title="post /accounts/{account_id}/magic/gre_tunnels">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">create</a>({ ...params }) -> GRETunnelCreateResponse</code> |
| 3483 | - <code title="put /accounts/{account_id}/magic/gre_tunnels/{tunnel_identifier}">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">update</a>(tunnelIdentifier, { ...params }) -> GRETunnelUpdateResponse</code> |
| 3484 | - <code title="get /accounts/{account_id}/magic/gre_tunnels">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">list</a>({ ...params }) -> GRETunnelListResponse</code> |
| 3485 | - <code title="delete /accounts/{account_id}/magic/gre_tunnels/{tunnel_identifier}">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">delete</a>(tunnelIdentifier, { ...params }) -> GRETunnelDeleteResponse</code> |
| 3486 | - <code title="get /accounts/{account_id}/magic/gre_tunnels/{tunnel_identifier}">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">get</a>(tunnelIdentifier, { ...params }) -> GRETunnelGetResponse</code> |
| 3487 | |
| 3488 | ## IPSECTunnels |
| 3489 | |
| 3490 | Types: |
| 3491 | |
| 3492 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">PSKMetadata</a></code> |
| 3493 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelCreateResponse</a></code> |
| 3494 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelUpdateResponse</a></code> |
| 3495 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelListResponse</a></code> |
| 3496 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelDeleteResponse</a></code> |
| 3497 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelGetResponse</a></code> |
| 3498 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelPSKGenerateResponse</a></code> |
| 3499 | |
| 3500 | Methods: |
| 3501 | |
| 3502 | - <code title="post /accounts/{account_id}/magic/ipsec_tunnels">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">create</a>({ ...params }) -> IPSECTunnelCreateResponse</code> |
| 3503 | - <code title="put /accounts/{account_id}/magic/ipsec_tunnels/{tunnel_identifier}">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">update</a>(tunnelIdentifier, { ...params }) -> IPSECTunnelUpdateResponse</code> |
| 3504 | - <code title="get /accounts/{account_id}/magic/ipsec_tunnels">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">list</a>({ ...params }) -> IPSECTunnelListResponse</code> |
| 3505 | - <code title="delete /accounts/{account_id}/magic/ipsec_tunnels/{tunnel_identifier}">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">delete</a>(tunnelIdentifier, { ...params }) -> IPSECTunnelDeleteResponse</code> |
| 3506 | - <code title="get /accounts/{account_id}/magic/ipsec_tunnels/{tunnel_identifier}">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">get</a>(tunnelIdentifier, { ...params }) -> IPSECTunnelGetResponse</code> |
| 3507 | - <code title="post /accounts/{account_id}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">pskGenerate</a>(tunnelIdentifier, { ...params }) -> IPSECTunnelPSKGenerateResponse</code> |
| 3508 | |
| 3509 | ## Routes |
| 3510 | |
| 3511 | Types: |
| 3512 | |
| 3513 | - <code><a href="./src/resources/magic-transit/routes.ts">Scope</a></code> |
| 3514 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteCreateResponse</a></code> |
| 3515 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteUpdateResponse</a></code> |
| 3516 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteListResponse</a></code> |
| 3517 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteDeleteResponse</a></code> |
| 3518 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteEmptyResponse</a></code> |
| 3519 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteGetResponse</a></code> |
| 3520 | |
| 3521 | Methods: |
| 3522 | |
| 3523 | - <code title="post /accounts/{account_id}/magic/routes">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">create</a>({ ...params }) -> RouteCreateResponse</code> |
| 3524 | - <code title="put /accounts/{account_id}/magic/routes/{route_identifier}">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">update</a>(routeIdentifier, { ...params }) -> RouteUpdateResponse</code> |
| 3525 | - <code title="get /accounts/{account_id}/magic/routes">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">list</a>({ ...params }) -> RouteListResponse</code> |
| 3526 | - <code title="delete /accounts/{account_id}/magic/routes/{route_identifier}">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">delete</a>(routeIdentifier, { ...params }) -> RouteDeleteResponse</code> |
| 3527 | - <code title="delete /accounts/{account_id}/magic/routes">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">empty</a>({ ...params }) -> RouteEmptyResponse</code> |
| 3528 | - <code title="get /accounts/{account_id}/magic/routes/{route_identifier}">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">get</a>(routeIdentifier, { ...params }) -> RouteGetResponse</code> |
| 3529 | |
| 3530 | ## Sites |
| 3531 | |
| 3532 | Types: |
| 3533 | |
| 3534 | - <code><a href="./src/resources/magic-transit/sites/sites.ts">Site</a></code> |
| 3535 | - <code><a href="./src/resources/magic-transit/sites/sites.ts">SiteLocation</a></code> |
| 3536 | |
| 3537 | Methods: |
| 3538 | |
| 3539 | - <code title="post /accounts/{account_id}/magic/sites">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">create</a>({ ...params }) -> Site</code> |
| 3540 | - <code title="put /accounts/{account_id}/magic/sites/{site_id}">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">update</a>(siteId, { ...params }) -> Site</code> |
| 3541 | - <code title="get /accounts/{account_id}/magic/sites">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">list</a>({ ...params }) -> SitesSinglePage</code> |
| 3542 | - <code title="delete /accounts/{account_id}/magic/sites/{site_id}">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">delete</a>(siteId, { ...params }) -> Site</code> |
| 3543 | - <code title="patch /accounts/{account_id}/magic/sites/{site_id}">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">edit</a>(siteId, { ...params }) -> Site</code> |
| 3544 | - <code title="get /accounts/{account_id}/magic/sites/{site_id}">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">get</a>(siteId, { ...params }) -> Site</code> |
| 3545 | |
| 3546 | ### ACLs |
| 3547 | |
| 3548 | Types: |
| 3549 | |
| 3550 | - <code><a href="./src/resources/magic-transit/sites/acls.ts">ACL</a></code> |
| 3551 | - <code><a href="./src/resources/magic-transit/sites/acls.ts">ACLConfiguration</a></code> |
| 3552 | - <code><a href="./src/resources/magic-transit/sites/acls.ts">AllowedProtocol</a></code> |
| 3553 | - <code><a href="./src/resources/magic-transit/sites/acls.ts">Subnet</a></code> |
| 3554 | |
| 3555 | Methods: |
| 3556 | |
| 3557 | - <code title="post /accounts/{account_id}/magic/sites/{site_id}/acls">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">create</a>(siteId, { ...params }) -> ACL</code> |
| 3558 | - <code title="put /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_identifier}">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">update</a>(siteId, aclIdentifier, { ...params }) -> ACL</code> |
| 3559 | - <code title="get /accounts/{account_id}/magic/sites/{site_id}/acls">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">list</a>(siteId, { ...params }) -> ACLsSinglePage</code> |
| 3560 | - <code title="delete /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_identifier}">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">delete</a>(siteId, aclIdentifier, { ...params }) -> ACL</code> |
| 3561 | - <code title="patch /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_identifier}">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">edit</a>(siteId, aclIdentifier, { ...params }) -> ACL</code> |
| 3562 | - <code title="get /accounts/{account_id}/magic/sites/{site_id}/acls/{acl_identifier}">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">get</a>(siteId, aclIdentifier, { ...params }) -> ACL</code> |
| 3563 | |
| 3564 | ### LANs |
| 3565 | |
| 3566 | Types: |
| 3567 | |
| 3568 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">DHCPRelay</a></code> |
| 3569 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">DHCPServer</a></code> |
| 3570 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">LAN</a></code> |
| 3571 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">LANStaticAddressing</a></code> |
| 3572 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">Nat</a></code> |
| 3573 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">RoutedSubnet</a></code> |
| 3574 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">LANCreateResponse</a></code> |
| 3575 | |
| 3576 | Methods: |
| 3577 | |
| 3578 | - <code title="post /accounts/{account_id}/magic/sites/{site_id}/lans">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">create</a>(siteId, { ...params }) -> LANCreateResponse</code> |
| 3579 | - <code title="put /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">update</a>(siteId, lanId, { ...params }) -> LAN</code> |
| 3580 | - <code title="get /accounts/{account_id}/magic/sites/{site_id}/lans">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">list</a>(siteId, { ...params }) -> LANsSinglePage</code> |
| 3581 | - <code title="delete /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">delete</a>(siteId, lanId, { ...params }) -> LAN</code> |
| 3582 | - <code title="patch /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">edit</a>(siteId, lanId, { ...params }) -> LAN</code> |
| 3583 | - <code title="get /accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">get</a>(siteId, lanId, { ...params }) -> LAN</code> |
| 3584 | |
| 3585 | ### WANs |
| 3586 | |
| 3587 | Types: |
| 3588 | |
| 3589 | - <code><a href="./src/resources/magic-transit/sites/wans.ts">WAN</a></code> |
| 3590 | - <code><a href="./src/resources/magic-transit/sites/wans.ts">WANStaticAddressing</a></code> |
| 3591 | - <code><a href="./src/resources/magic-transit/sites/wans.ts">WANCreateResponse</a></code> |
| 3592 | |
| 3593 | Methods: |
| 3594 | |
| 3595 | - <code title="post /accounts/{account_id}/magic/sites/{site_id}/wans">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">create</a>(siteId, { ...params }) -> WANCreateResponse</code> |
| 3596 | - <code title="put /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">update</a>(siteId, wanId, { ...params }) -> WAN</code> |
| 3597 | - <code title="get /accounts/{account_id}/magic/sites/{site_id}/wans">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">list</a>(siteId, { ...params }) -> WANsSinglePage</code> |
| 3598 | - <code title="delete /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">delete</a>(siteId, wanId, { ...params }) -> WAN</code> |
| 3599 | - <code title="patch /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">edit</a>(siteId, wanId, { ...params }) -> WAN</code> |
| 3600 | - <code title="get /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">get</a>(siteId, wanId, { ...params }) -> WAN</code> |
| 3601 | |
| 3602 | ## Connectors |
| 3603 | |
| 3604 | Types: |
| 3605 | |
| 3606 | - <code><a href="./src/resources/magic-transit/connectors.ts">ConnectorUpdateResponse</a></code> |
| 3607 | - <code><a href="./src/resources/magic-transit/connectors.ts">ConnectorListResponse</a></code> |
| 3608 | - <code><a href="./src/resources/magic-transit/connectors.ts">ConnectorEditResponse</a></code> |
| 3609 | - <code><a href="./src/resources/magic-transit/connectors.ts">ConnectorGetResponse</a></code> |
| 3610 | |
| 3611 | Methods: |
| 3612 | |
| 3613 | - <code title="put /accounts/{account_id}/magic/connectors/{connector_id}">client.magicTransit.connectors.<a href="./src/resources/magic-transit/connectors.ts">update</a>(connectorId, { ...params }) -> ConnectorUpdateResponse</code> |
| 3614 | - <code title="get /accounts/{account_id}/magic/connectors">client.magicTransit.connectors.<a href="./src/resources/magic-transit/connectors.ts">list</a>({ ...params }) -> ConnectorListResponsesSinglePage</code> |
| 3615 | - <code title="patch /accounts/{account_id}/magic/connectors/{connector_id}">client.magicTransit.connectors.<a href="./src/resources/magic-transit/connectors.ts">edit</a>(connectorId, { ...params }) -> ConnectorEditResponse</code> |
| 3616 | - <code title="get /accounts/{account_id}/magic/connectors/{connector_id}">client.magicTransit.connectors.<a href="./src/resources/magic-transit/connectors.ts">get</a>(connectorId, { ...params }) -> ConnectorGetResponse</code> |
| 3617 | |
| 3618 | # MagicNetworkMonitoring |
| 3619 | |
| 3620 | ## Configs |
| 3621 | |
| 3622 | Types: |
| 3623 | |
| 3624 | - <code><a href="./src/resources/magic-network-monitoring/configs/configs.ts">Configuration</a></code> |
| 3625 | |
| 3626 | Methods: |
| 3627 | |
| 3628 | - <code title="post /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">create</a>({ ...params }) -> Configuration</code> |
| 3629 | - <code title="put /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">update</a>({ ...params }) -> Configuration</code> |
| 3630 | - <code title="delete /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">delete</a>({ ...params }) -> Configuration</code> |
| 3631 | - <code title="patch /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">edit</a>({ ...params }) -> Configuration</code> |
| 3632 | - <code title="get /accounts/{account_id}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">get</a>({ ...params }) -> Configuration</code> |
| 3633 | |
| 3634 | ### Full |
| 3635 | |
| 3636 | Methods: |
| 3637 | |
| 3638 | - <code title="get /accounts/{account_id}/mnm/config/full">client.magicNetworkMonitoring.configs.full.<a href="./src/resources/magic-network-monitoring/configs/full.ts">get</a>({ ...params }) -> Configuration</code> |
| 3639 | |
| 3640 | ## Rules |
| 3641 | |
| 3642 | Types: |
| 3643 | |
| 3644 | - <code><a href="./src/resources/magic-network-monitoring/rules/rules.ts">MagicNetworkMonitoringRule</a></code> |
| 3645 | |
| 3646 | Methods: |
| 3647 | |
| 3648 | - <code title="post /accounts/{account_id}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">create</a>({ ...params }) -> MagicNetworkMonitoringRule | null</code> |
| 3649 | - <code title="put /accounts/{account_id}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">update</a>({ ...params }) -> MagicNetworkMonitoringRule | null</code> |
| 3650 | - <code title="get /accounts/{account_id}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">list</a>({ ...params }) -> MagicNetworkMonitoringRulesSinglePage</code> |
| 3651 | - <code title="delete /accounts/{account_id}/mnm/rules/{rule_id}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">delete</a>(ruleId, { ...params }) -> MagicNetworkMonitoringRule | null</code> |
| 3652 | - <code title="patch /accounts/{account_id}/mnm/rules/{rule_id}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">edit</a>(ruleId, { ...params }) -> MagicNetworkMonitoringRule | null</code> |
| 3653 | - <code title="get /accounts/{account_id}/mnm/rules/{rule_id}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">get</a>(ruleId, { ...params }) -> MagicNetworkMonitoringRule | null</code> |
| 3654 | |
| 3655 | ### Advertisements |
| 3656 | |
| 3657 | Types: |
| 3658 | |
| 3659 | - <code><a href="./src/resources/magic-network-monitoring/rules/advertisements.ts">Advertisement</a></code> |
| 3660 | |
| 3661 | Methods: |
| 3662 | |
| 3663 | - <code title="patch /accounts/{account_id}/mnm/rules/{rule_id}/advertisement">client.magicNetworkMonitoring.rules.advertisements.<a href="./src/resources/magic-network-monitoring/rules/advertisements.ts">edit</a>(ruleId, { ...params }) -> Advertisement | null</code> |
| 3664 | |
| 3665 | # MTLSCertificates |
| 3666 | |
| 3667 | Types: |
| 3668 | |
| 3669 | - <code><a href="./src/resources/mtls-certificates/mtls-certificates.ts">MTLSCertificate</a></code> |
| 3670 | - <code><a href="./src/resources/mtls-certificates/mtls-certificates.ts">MTLSCertificateCreateResponse</a></code> |
| 3671 | |
| 3672 | Methods: |
| 3673 | |
| 3674 | - <code title="post /accounts/{account_id}/mtls_certificates">client.mtlsCertificates.<a href="./src/resources/mtls-certificates/mtls-certificates.ts">create</a>({ ...params }) -> MTLSCertificateCreateResponse</code> |
| 3675 | - <code title="get /accounts/{account_id}/mtls_certificates">client.mtlsCertificates.<a href="./src/resources/mtls-certificates/mtls-certificates.ts">list</a>({ ...params }) -> MTLSCertificatesSinglePage</code> |
| 3676 | - <code title="delete /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}">client.mtlsCertificates.<a href="./src/resources/mtls-certificates/mtls-certificates.ts">delete</a>(mtlsCertificateId, { ...params }) -> MTLSCertificate</code> |
| 3677 | - <code title="get /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}">client.mtlsCertificates.<a href="./src/resources/mtls-certificates/mtls-certificates.ts">get</a>(mtlsCertificateId, { ...params }) -> MTLSCertificate</code> |
| 3678 | |
| 3679 | ## Associations |
| 3680 | |
| 3681 | Types: |
| 3682 | |
| 3683 | - <code><a href="./src/resources/mtls-certificates/associations.ts">CertificateAsssociation</a></code> |
| 3684 | - <code><a href="./src/resources/mtls-certificates/associations.ts">AssociationGetResponse</a></code> |
| 3685 | |
| 3686 | Methods: |
| 3687 | |
| 3688 | - <code title="get /accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations">client.mtlsCertificates.associations.<a href="./src/resources/mtls-certificates/associations.ts">get</a>(mtlsCertificateId, { ...params }) -> AssociationGetResponse | null</code> |
| 3689 | |
| 3690 | # Pages |
| 3691 | |
| 3692 | ## Projects |
| 3693 | |
| 3694 | Types: |
| 3695 | |
| 3696 | - <code><a href="./src/resources/pages/projects/projects.ts">Deployment</a></code> |
| 3697 | - <code><a href="./src/resources/pages/projects/projects.ts">Project</a></code> |
| 3698 | - <code><a href="./src/resources/pages/projects/projects.ts">Stage</a></code> |
| 3699 | - <code><a href="./src/resources/pages/projects/projects.ts">ProjectCreateResponse</a></code> |
| 3700 | - <code><a href="./src/resources/pages/projects/projects.ts">ProjectDeleteResponse</a></code> |
| 3701 | - <code><a href="./src/resources/pages/projects/projects.ts">ProjectEditResponse</a></code> |
| 3702 | - <code><a href="./src/resources/pages/projects/projects.ts">ProjectPurgeBuildCacheResponse</a></code> |
| 3703 | |
| 3704 | Methods: |
| 3705 | |
| 3706 | - <code title="post /accounts/{account_id}/pages/projects">client.pages.projects.<a href="./src/resources/pages/projects/projects.ts">create</a>({ ...params }) -> ProjectCreateResponse</code> |
| 3707 | - <code title="get /accounts/{account_id}/pages/projects">client.pages.projects.<a href="./src/resources/pages/projects/projects.ts">list</a>({ ...params }) -> DeploymentsSinglePage</code> |
| 3708 | - <code title="delete /accounts/{account_id}/pages/projects/{project_name}">client.pages.projects.<a href="./src/resources/pages/projects/projects.ts">delete</a>(projectName, { ...params }) -> unknown</code> |
| 3709 | - <code title="patch /accounts/{account_id}/pages/projects/{project_name}">client.pages.projects.<a href="./src/resources/pages/projects/projects.ts">edit</a>(projectName, { ...params }) -> ProjectEditResponse</code> |
| 3710 | - <code title="get /accounts/{account_id}/pages/projects/{project_name}">client.pages.projects.<a href="./src/resources/pages/projects/projects.ts">get</a>(projectName, { ...params }) -> Project</code> |
| 3711 | - <code title="post /accounts/{account_id}/pages/projects/{project_name}/purge_build_cache">client.pages.projects.<a href="./src/resources/pages/projects/projects.ts">purgeBuildCache</a>(projectName, { ...params }) -> unknown</code> |
| 3712 | |
| 3713 | ### Deployments |
| 3714 | |
| 3715 | Types: |
| 3716 | |
| 3717 | - <code><a href="./src/resources/pages/projects/deployments/deployments.ts">DeploymentDeleteResponse</a></code> |
| 3718 | |
| 3719 | Methods: |
| 3720 | |
| 3721 | - <code title="post /accounts/{account_id}/pages/projects/{project_name}/deployments">client.pages.projects.deployments.<a href="./src/resources/pages/projects/deployments/deployments.ts">create</a>(projectName, { ...params }) -> Deployment</code> |
| 3722 | - <code title="get /accounts/{account_id}/pages/projects/{project_name}/deployments">client.pages.projects.deployments.<a href="./src/resources/pages/projects/deployments/deployments.ts">list</a>(projectName, { ...params }) -> DeploymentsSinglePage</code> |
| 3723 | - <code title="delete /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}">client.pages.projects.deployments.<a href="./src/resources/pages/projects/deployments/deployments.ts">delete</a>(projectName, deploymentId, { ...params }) -> unknown</code> |
| 3724 | - <code title="get /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}">client.pages.projects.deployments.<a href="./src/resources/pages/projects/deployments/deployments.ts">get</a>(projectName, deploymentId, { ...params }) -> Deployment</code> |
| 3725 | - <code title="post /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry">client.pages.projects.deployments.<a href="./src/resources/pages/projects/deployments/deployments.ts">retry</a>(projectName, deploymentId, { ...params }) -> Deployment</code> |
| 3726 | - <code title="post /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback">client.pages.projects.deployments.<a href="./src/resources/pages/projects/deployments/deployments.ts">rollback</a>(projectName, deploymentId, { ...params }) -> Deployment</code> |
| 3727 | |
| 3728 | #### History |
| 3729 | |
| 3730 | ##### Logs |
| 3731 | |
| 3732 | Types: |
| 3733 | |
| 3734 | - <code><a href="./src/resources/pages/projects/deployments/history/logs.ts">LogGetResponse</a></code> |
| 3735 | |
| 3736 | Methods: |
| 3737 | |
| 3738 | - <code title="get /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs">client.pages.projects.deployments.history.logs.<a href="./src/resources/pages/projects/deployments/history/logs.ts">get</a>(projectName, deploymentId, { ...params }) -> LogGetResponse</code> |
| 3739 | |
| 3740 | ### Domains |
| 3741 | |
| 3742 | Types: |
| 3743 | |
| 3744 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainCreateResponse</a></code> |
| 3745 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainListResponse</a></code> |
| 3746 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainDeleteResponse</a></code> |
| 3747 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainEditResponse</a></code> |
| 3748 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainGetResponse</a></code> |
| 3749 | |
| 3750 | Methods: |
| 3751 | |
| 3752 | - <code title="post /accounts/{account_id}/pages/projects/{project_name}/domains">client.pages.projects.domains.<a href="./src/resources/pages/projects/domains.ts">create</a>(projectName, { ...params }) -> DomainCreateResponse | null</code> |
| 3753 | - <code title="get /accounts/{account_id}/pages/projects/{project_name}/domains">client.pages.projects.domains.<a href="./src/resources/pages/projects/domains.ts">list</a>(projectName, { ...params }) -> DomainListResponsesSinglePage</code> |
| 3754 | - <code title="delete /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}">client.pages.projects.domains.<a href="./src/resources/pages/projects/domains.ts">delete</a>(projectName, domainName, { ...params }) -> unknown</code> |
| 3755 | - <code title="patch /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}">client.pages.projects.domains.<a href="./src/resources/pages/projects/domains.ts">edit</a>(projectName, domainName, { ...params }) -> DomainEditResponse | null</code> |
| 3756 | - <code title="get /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}">client.pages.projects.domains.<a href="./src/resources/pages/projects/domains.ts">get</a>(projectName, domainName, { ...params }) -> DomainGetResponse | null</code> |
| 3757 | |
| 3758 | # PCAPs |
| 3759 | |
| 3760 | Types: |
| 3761 | |
| 3762 | - <code><a href="./src/resources/pcaps/pcaps.ts">PCAP</a></code> |
| 3763 | - <code><a href="./src/resources/pcaps/pcaps.ts">PCAPFilter</a></code> |
| 3764 | - <code><a href="./src/resources/pcaps/pcaps.ts">PCAPCreateResponse</a></code> |
| 3765 | - <code><a href="./src/resources/pcaps/pcaps.ts">PCAPListResponse</a></code> |
| 3766 | - <code><a href="./src/resources/pcaps/pcaps.ts">PCAPGetResponse</a></code> |
| 3767 | |
| 3768 | Methods: |
| 3769 | |
| 3770 | - <code title="post /accounts/{account_id}/pcaps">client.pcaps.<a href="./src/resources/pcaps/pcaps.ts">create</a>({ ...params }) -> PCAPCreateResponse</code> |
| 3771 | - <code title="get /accounts/{account_id}/pcaps">client.pcaps.<a href="./src/resources/pcaps/pcaps.ts">list</a>({ ...params }) -> PCAPListResponsesSinglePage</code> |
| 3772 | - <code title="get /accounts/{account_id}/pcaps/{pcap_id}">client.pcaps.<a href="./src/resources/pcaps/pcaps.ts">get</a>(pcapId, { ...params }) -> PCAPGetResponse</code> |
| 3773 | |
| 3774 | ## Ownership |
| 3775 | |
| 3776 | Types: |
| 3777 | |
| 3778 | - <code><a href="./src/resources/pcaps/ownership.ts">Ownership</a></code> |
| 3779 | - <code><a href="./src/resources/pcaps/ownership.ts">OwnershipGetResponse</a></code> |
| 3780 | |
| 3781 | Methods: |
| 3782 | |
| 3783 | - <code title="post /accounts/{account_id}/pcaps/ownership">client.pcaps.ownership.<a href="./src/resources/pcaps/ownership.ts">create</a>({ ...params }) -> Ownership</code> |
| 3784 | - <code title="delete /accounts/{account_id}/pcaps/ownership/{ownership_id}">client.pcaps.ownership.<a href="./src/resources/pcaps/ownership.ts">delete</a>(ownershipId, { ...params }) -> void</code> |
| 3785 | - <code title="get /accounts/{account_id}/pcaps/ownership">client.pcaps.ownership.<a href="./src/resources/pcaps/ownership.ts">get</a>({ ...params }) -> OwnershipGetResponse | null</code> |
| 3786 | - <code title="post /accounts/{account_id}/pcaps/ownership/validate">client.pcaps.ownership.<a href="./src/resources/pcaps/ownership.ts">validate</a>({ ...params }) -> Ownership</code> |
| 3787 | |
| 3788 | ## Download |
| 3789 | |
| 3790 | Methods: |
| 3791 | |
| 3792 | - <code title="get /accounts/{account_id}/pcaps/{pcap_id}/download">client.pcaps.download.<a href="./src/resources/pcaps/download.ts">get</a>(pcapId, { ...params }) -> Response</code> |
| 3793 | |
| 3794 | # Registrar |
| 3795 | |
| 3796 | ## Domains |
| 3797 | |
| 3798 | Types: |
| 3799 | |
| 3800 | - <code><a href="./src/resources/registrar/domains.ts">Domain</a></code> |
| 3801 | - <code><a href="./src/resources/registrar/domains.ts">DomainUpdateResponse</a></code> |
| 3802 | - <code><a href="./src/resources/registrar/domains.ts">DomainGetResponse</a></code> |
| 3803 | |
| 3804 | Methods: |
| 3805 | |
| 3806 | - <code title="put /accounts/{account_id}/registrar/domains/{domain_name}">client.registrar.domains.<a href="./src/resources/registrar/domains.ts">update</a>(domainName, { ...params }) -> DomainUpdateResponse | null</code> |
| 3807 | - <code title="get /accounts/{account_id}/registrar/domains">client.registrar.domains.<a href="./src/resources/registrar/domains.ts">list</a>({ ...params }) -> DomainsSinglePage</code> |
| 3808 | - <code title="get /accounts/{account_id}/registrar/domains/{domain_name}">client.registrar.domains.<a href="./src/resources/registrar/domains.ts">get</a>(domainName, { ...params }) -> DomainGetResponse | null</code> |
| 3809 | |
| 3810 | # RequestTracers |
| 3811 | |
| 3812 | ## Traces |
| 3813 | |
| 3814 | Types: |
| 3815 | |
| 3816 | - <code><a href="./src/resources/request-tracers/traces.ts">Trace</a></code> |
| 3817 | - <code><a href="./src/resources/request-tracers/traces.ts">TraceItem</a></code> |
| 3818 | - <code><a href="./src/resources/request-tracers/traces.ts">TraceCreateResponse</a></code> |
| 3819 | |
| 3820 | Methods: |
| 3821 | |
| 3822 | - <code title="post /accounts/{account_id}/request-tracer/trace">client.requestTracers.traces.<a href="./src/resources/request-tracers/traces.ts">create</a>({ ...params }) -> TraceCreateResponse</code> |
| 3823 | |
| 3824 | # Rules |
| 3825 | |
| 3826 | ## Lists |
| 3827 | |
| 3828 | Types: |
| 3829 | |
| 3830 | - <code><a href="./src/resources/rules/lists/lists.ts">Hostname</a></code> |
| 3831 | - <code><a href="./src/resources/rules/lists/lists.ts">ListsList</a></code> |
| 3832 | - <code><a href="./src/resources/rules/lists/lists.ts">Redirect</a></code> |
| 3833 | - <code><a href="./src/resources/rules/lists/lists.ts">ListDeleteResponse</a></code> |
| 3834 | |
| 3835 | Methods: |
| 3836 | |
| 3837 | - <code title="post /accounts/{account_id}/rules/lists">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">create</a>({ ...params }) -> ListsList | null</code> |
| 3838 | - <code title="put /accounts/{account_id}/rules/lists/{list_id}">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">update</a>(listId, { ...params }) -> ListsList | null</code> |
| 3839 | - <code title="get /accounts/{account_id}/rules/lists">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">list</a>({ ...params }) -> ListsListsSinglePage</code> |
| 3840 | - <code title="delete /accounts/{account_id}/rules/lists/{list_id}">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">delete</a>(listId, { ...params }) -> ListDeleteResponse | null</code> |
| 3841 | - <code title="get /accounts/{account_id}/rules/lists/{list_id}">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">get</a>(listId, { ...params }) -> ListsList | null</code> |
| 3842 | |
| 3843 | ### BulkOperations |
| 3844 | |
| 3845 | Types: |
| 3846 | |
| 3847 | - <code><a href="./src/resources/rules/lists/bulk-operations.ts">OperationStatus</a></code> |
| 3848 | - <code><a href="./src/resources/rules/lists/bulk-operations.ts">BulkOperationGetResponse</a></code> |
| 3849 | |
| 3850 | Methods: |
| 3851 | |
| 3852 | - <code title="get /accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}">client.rules.lists.bulkOperations.<a href="./src/resources/rules/lists/bulk-operations.ts">get</a>(accountIdentifier, operationId) -> BulkOperationGetResponse | null</code> |
| 3853 | |
| 3854 | ### Items |
| 3855 | |
| 3856 | Types: |
| 3857 | |
| 3858 | - <code><a href="./src/resources/rules/lists/items.ts">ListCursor</a></code> |
| 3859 | - <code><a href="./src/resources/rules/lists/items.ts">ListItem</a></code> |
| 3860 | - <code><a href="./src/resources/rules/lists/items.ts">ItemCreateResponse</a></code> |
| 3861 | - <code><a href="./src/resources/rules/lists/items.ts">ItemUpdateResponse</a></code> |
| 3862 | - <code><a href="./src/resources/rules/lists/items.ts">ItemListResponse</a></code> |
| 3863 | - <code><a href="./src/resources/rules/lists/items.ts">ItemDeleteResponse</a></code> |
| 3864 | - <code><a href="./src/resources/rules/lists/items.ts">ItemGetResponse</a></code> |
| 3865 | |
| 3866 | Methods: |
| 3867 | |
| 3868 | - <code title="post /accounts/{account_id}/rules/lists/{list_id}/items">client.rules.lists.items.<a href="./src/resources/rules/lists/items.ts">create</a>(listId, [ ...body ]) -> ItemCreateResponse | null</code> |
| 3869 | - <code title="put /accounts/{account_id}/rules/lists/{list_id}/items">client.rules.lists.items.<a href="./src/resources/rules/lists/items.ts">update</a>(listId, [ ...body ]) -> ItemUpdateResponse | null</code> |
| 3870 | - <code title="get /accounts/{account_id}/rules/lists/{list_id}/items">client.rules.lists.items.<a href="./src/resources/rules/lists/items.ts">list</a>(listId, { ...params }) -> ItemListResponsesCursorPagination</code> |
| 3871 | - <code title="delete /accounts/{account_id}/rules/lists/{list_id}/items">client.rules.lists.items.<a href="./src/resources/rules/lists/items.ts">delete</a>(listId, { ...params }) -> ItemDeleteResponse | null</code> |
| 3872 | - <code title="get /accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}">client.rules.lists.items.<a href="./src/resources/rules/lists/items.ts">get</a>(accountIdentifier, listId, itemId) -> ItemGetResponse | null</code> |
| 3873 | |
| 3874 | # Storage |
| 3875 | |
| 3876 | ## Analytics |
| 3877 | |
| 3878 | Types: |
| 3879 | |
| 3880 | - <code><a href="./src/resources/storage/analytics.ts">Components</a></code> |
| 3881 | - <code><a href="./src/resources/storage/analytics.ts">Schema</a></code> |
| 3882 | |
| 3883 | Methods: |
| 3884 | |
| 3885 | - <code title="get /accounts/{account_id}/storage/analytics">client.storage.analytics.<a href="./src/resources/storage/analytics.ts">list</a>({ ...params }) -> Schema</code> |
| 3886 | - <code title="get /accounts/{account_id}/storage/analytics/stored">client.storage.analytics.<a href="./src/resources/storage/analytics.ts">stored</a>({ ...params }) -> Components</code> |
| 3887 | |
| 3888 | # Stream |
| 3889 | |
| 3890 | Types: |
| 3891 | |
| 3892 | - <code><a href="./src/resources/stream/stream.ts">AllowedOrigins</a></code> |
| 3893 | - <code><a href="./src/resources/stream/stream.ts">Video</a></code> |
| 3894 | |
| 3895 | Methods: |
| 3896 | |
| 3897 | - <code title="post /accounts/{account_id}/stream">client.stream.<a href="./src/resources/stream/stream.ts">create</a>({ ...params }) -> void</code> |
| 3898 | - <code title="get /accounts/{account_id}/stream">client.stream.<a href="./src/resources/stream/stream.ts">list</a>({ ...params }) -> VideosSinglePage</code> |
| 3899 | - <code title="delete /accounts/{account_id}/stream/{identifier}">client.stream.<a href="./src/resources/stream/stream.ts">delete</a>(identifier, { ...params }) -> void</code> |
| 3900 | - <code title="get /accounts/{account_id}/stream/{identifier}">client.stream.<a href="./src/resources/stream/stream.ts">get</a>(identifier, { ...params }) -> Video</code> |
| 3901 | |
| 3902 | ## AudioTracks |
| 3903 | |
| 3904 | Types: |
| 3905 | |
| 3906 | - <code><a href="./src/resources/stream/audio-tracks.ts">Audio</a></code> |
| 3907 | - <code><a href="./src/resources/stream/audio-tracks.ts">AudioTrackDeleteResponse</a></code> |
| 3908 | - <code><a href="./src/resources/stream/audio-tracks.ts">AudioTrackGetResponse</a></code> |
| 3909 | |
| 3910 | Methods: |
| 3911 | |
| 3912 | - <code title="delete /accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}">client.stream.audioTracks.<a href="./src/resources/stream/audio-tracks.ts">delete</a>(identifier, audioIdentifier, { ...params }) -> AudioTrackDeleteResponse</code> |
| 3913 | - <code title="post /accounts/{account_id}/stream/{identifier}/audio/copy">client.stream.audioTracks.<a href="./src/resources/stream/audio-tracks.ts">copy</a>(identifier, { ...params }) -> Audio</code> |
| 3914 | - <code title="patch /accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}">client.stream.audioTracks.<a href="./src/resources/stream/audio-tracks.ts">edit</a>(identifier, audioIdentifier, { ...params }) -> Audio</code> |
| 3915 | - <code title="get /accounts/{account_id}/stream/{identifier}/audio">client.stream.audioTracks.<a href="./src/resources/stream/audio-tracks.ts">get</a>(identifier, { ...params }) -> AudioTrackGetResponse</code> |
| 3916 | |
| 3917 | ## Videos |
| 3918 | |
| 3919 | Types: |
| 3920 | |
| 3921 | - <code><a href="./src/resources/stream/videos.ts">VideoStorageUsageResponse</a></code> |
| 3922 | |
| 3923 | Methods: |
| 3924 | |
| 3925 | - <code title="get /accounts/{account_id}/stream/storage-usage">client.stream.videos.<a href="./src/resources/stream/videos.ts">storageUsage</a>({ ...params }) -> VideoStorageUsageResponse</code> |
| 3926 | |
| 3927 | ## Clip |
| 3928 | |
| 3929 | Types: |
| 3930 | |
| 3931 | - <code><a href="./src/resources/stream/clip.ts">Clip</a></code> |
| 3932 | |
| 3933 | Methods: |
| 3934 | |
| 3935 | - <code title="post /accounts/{account_id}/stream/clip">client.stream.clip.<a href="./src/resources/stream/clip.ts">create</a>({ ...params }) -> Clip</code> |
| 3936 | |
| 3937 | ## Copy |
| 3938 | |
| 3939 | Methods: |
| 3940 | |
| 3941 | - <code title="post /accounts/{account_id}/stream/copy">client.stream.copy.<a href="./src/resources/stream/copy.ts">create</a>({ ...params }) -> Video</code> |
| 3942 | |
| 3943 | ## DirectUpload |
| 3944 | |
| 3945 | Types: |
| 3946 | |
| 3947 | - <code><a href="./src/resources/stream/direct-upload.ts">DirectUploadCreateResponse</a></code> |
| 3948 | |
| 3949 | Methods: |
| 3950 | |
| 3951 | - <code title="post /accounts/{account_id}/stream/direct_upload">client.stream.directUpload.<a href="./src/resources/stream/direct-upload.ts">create</a>({ ...params }) -> DirectUploadCreateResponse</code> |
| 3952 | |
| 3953 | ## Keys |
| 3954 | |
| 3955 | Types: |
| 3956 | |
| 3957 | - <code><a href="./src/resources/stream/keys.ts">Keys</a></code> |
| 3958 | - <code><a href="./src/resources/stream/keys.ts">KeyDeleteResponse</a></code> |
| 3959 | - <code><a href="./src/resources/stream/keys.ts">KeyGetResponse</a></code> |
| 3960 | |
| 3961 | Methods: |
| 3962 | |
| 3963 | - <code title="post /accounts/{account_id}/stream/keys">client.stream.keys.<a href="./src/resources/stream/keys.ts">create</a>({ ...params }) -> Keys</code> |
| 3964 | - <code title="delete /accounts/{account_id}/stream/keys/{identifier}">client.stream.keys.<a href="./src/resources/stream/keys.ts">delete</a>(identifier, { ...params }) -> KeyDeleteResponse</code> |
| 3965 | - <code title="get /accounts/{account_id}/stream/keys">client.stream.keys.<a href="./src/resources/stream/keys.ts">get</a>({ ...params }) -> KeyGetResponse</code> |
| 3966 | |
| 3967 | ## LiveInputs |
| 3968 | |
| 3969 | Types: |
| 3970 | |
| 3971 | - <code><a href="./src/resources/stream/live-inputs/live-inputs.ts">LiveInput</a></code> |
| 3972 | - <code><a href="./src/resources/stream/live-inputs/live-inputs.ts">LiveInputListResponse</a></code> |
| 3973 | |
| 3974 | Methods: |
| 3975 | |
| 3976 | - <code title="post /accounts/{account_id}/stream/live_inputs">client.stream.liveInputs.<a href="./src/resources/stream/live-inputs/live-inputs.ts">create</a>({ ...params }) -> LiveInput</code> |
| 3977 | - <code title="put /accounts/{account_id}/stream/live_inputs/{live_input_identifier}">client.stream.liveInputs.<a href="./src/resources/stream/live-inputs/live-inputs.ts">update</a>(liveInputIdentifier, { ...params }) -> LiveInput</code> |
| 3978 | - <code title="get /accounts/{account_id}/stream/live_inputs">client.stream.liveInputs.<a href="./src/resources/stream/live-inputs/live-inputs.ts">list</a>({ ...params }) -> LiveInputListResponse</code> |
| 3979 | - <code title="delete /accounts/{account_id}/stream/live_inputs/{live_input_identifier}">client.stream.liveInputs.<a href="./src/resources/stream/live-inputs/live-inputs.ts">delete</a>(liveInputIdentifier, { ...params }) -> void</code> |
| 3980 | - <code title="get /accounts/{account_id}/stream/live_inputs/{live_input_identifier}">client.stream.liveInputs.<a href="./src/resources/stream/live-inputs/live-inputs.ts">get</a>(liveInputIdentifier, { ...params }) -> LiveInput</code> |
| 3981 | |
| 3982 | ### Outputs |
| 3983 | |
| 3984 | Types: |
| 3985 | |
| 3986 | - <code><a href="./src/resources/stream/live-inputs/outputs.ts">Output</a></code> |
| 3987 | |
| 3988 | Methods: |
| 3989 | |
| 3990 | - <code title="post /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs">client.stream.liveInputs.outputs.<a href="./src/resources/stream/live-inputs/outputs.ts">create</a>(liveInputIdentifier, { ...params }) -> Output</code> |
| 3991 | - <code title="put /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}">client.stream.liveInputs.outputs.<a href="./src/resources/stream/live-inputs/outputs.ts">update</a>(liveInputIdentifier, outputIdentifier, { ...params }) -> Output</code> |
| 3992 | - <code title="get /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs">client.stream.liveInputs.outputs.<a href="./src/resources/stream/live-inputs/outputs.ts">list</a>(liveInputIdentifier, { ...params }) -> OutputsSinglePage</code> |
| 3993 | - <code title="delete /accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}">client.stream.liveInputs.outputs.<a href="./src/resources/stream/live-inputs/outputs.ts">delete</a>(liveInputIdentifier, outputIdentifier, { ...params }) -> void</code> |
| 3994 | |
| 3995 | ## Watermarks |
| 3996 | |
| 3997 | Types: |
| 3998 | |
| 3999 | - <code><a href="./src/resources/stream/watermarks.ts">Watermark</a></code> |
| 4000 | - <code><a href="./src/resources/stream/watermarks.ts">WatermarkDeleteResponse</a></code> |
| 4001 | |
| 4002 | Methods: |
| 4003 | |
| 4004 | - <code title="post /accounts/{account_id}/stream/watermarks">client.stream.watermarks.<a href="./src/resources/stream/watermarks.ts">create</a>({ ...params }) -> Watermark</code> |
| 4005 | - <code title="get /accounts/{account_id}/stream/watermarks">client.stream.watermarks.<a href="./src/resources/stream/watermarks.ts">list</a>({ ...params }) -> WatermarksSinglePage</code> |
| 4006 | - <code title="delete /accounts/{account_id}/stream/watermarks/{identifier}">client.stream.watermarks.<a href="./src/resources/stream/watermarks.ts">delete</a>(identifier, { ...params }) -> WatermarkDeleteResponse</code> |
| 4007 | - <code title="get /accounts/{account_id}/stream/watermarks/{identifier}">client.stream.watermarks.<a href="./src/resources/stream/watermarks.ts">get</a>(identifier, { ...params }) -> Watermark</code> |
| 4008 | |
| 4009 | ## Webhooks |
| 4010 | |
| 4011 | Types: |
| 4012 | |
| 4013 | - <code><a href="./src/resources/stream/webhooks.ts">WebhookUpdateResponse</a></code> |
| 4014 | - <code><a href="./src/resources/stream/webhooks.ts">WebhookDeleteResponse</a></code> |
| 4015 | - <code><a href="./src/resources/stream/webhooks.ts">WebhookGetResponse</a></code> |
| 4016 | |
| 4017 | Methods: |
| 4018 | |
| 4019 | - <code title="put /accounts/{account_id}/stream/webhook">client.stream.webhooks.<a href="./src/resources/stream/webhooks.ts">update</a>({ ...params }) -> WebhookUpdateResponse</code> |
| 4020 | - <code title="delete /accounts/{account_id}/stream/webhook">client.stream.webhooks.<a href="./src/resources/stream/webhooks.ts">delete</a>({ ...params }) -> WebhookDeleteResponse</code> |
| 4021 | - <code title="get /accounts/{account_id}/stream/webhook">client.stream.webhooks.<a href="./src/resources/stream/webhooks.ts">get</a>({ ...params }) -> WebhookGetResponse</code> |
| 4022 | |
| 4023 | ## Captions |
| 4024 | |
| 4025 | Types: |
| 4026 | |
| 4027 | - <code><a href="./src/resources/stream/captions/captions.ts">Caption</a></code> |
| 4028 | - <code><a href="./src/resources/stream/captions/captions.ts">CaptionGetResponse</a></code> |
| 4029 | |
| 4030 | Methods: |
| 4031 | |
| 4032 | - <code title="get /accounts/{account_id}/stream/{identifier}/captions">client.stream.captions.<a href="./src/resources/stream/captions/captions.ts">get</a>(identifier, { ...params }) -> CaptionGetResponse</code> |
| 4033 | |
| 4034 | ### Language |
| 4035 | |
| 4036 | Types: |
| 4037 | |
| 4038 | - <code><a href="./src/resources/stream/captions/language/language.ts">LanguageDeleteResponse</a></code> |
| 4039 | |
| 4040 | Methods: |
| 4041 | |
| 4042 | - <code title="put /accounts/{account_id}/stream/{identifier}/captions/{language}">client.stream.captions.language.<a href="./src/resources/stream/captions/language/language.ts">update</a>(identifier, language, { ...params }) -> Caption</code> |
| 4043 | - <code title="delete /accounts/{account_id}/stream/{identifier}/captions/{language}">client.stream.captions.language.<a href="./src/resources/stream/captions/language/language.ts">delete</a>(identifier, language, { ...params }) -> LanguageDeleteResponse</code> |
| 4044 | - <code title="get /accounts/{account_id}/stream/{identifier}/captions/{language}">client.stream.captions.language.<a href="./src/resources/stream/captions/language/language.ts">get</a>(identifier, language, { ...params }) -> Caption</code> |
| 4045 | |
| 4046 | #### Vtt |
| 4047 | |
| 4048 | Types: |
| 4049 | |
| 4050 | - <code><a href="./src/resources/stream/captions/language/vtt.ts">VttGetResponse</a></code> |
| 4051 | |
| 4052 | Methods: |
| 4053 | |
| 4054 | - <code title="get /accounts/{account_id}/stream/{identifier}/captions/{language}/vtt">client.stream.captions.language.vtt.<a href="./src/resources/stream/captions/language/vtt.ts">get</a>(identifier, language, { ...params }) -> string</code> |
| 4055 | |
| 4056 | ## Downloads |
| 4057 | |
| 4058 | Types: |
| 4059 | |
| 4060 | - <code><a href="./src/resources/stream/downloads.ts">DownloadCreateResponse</a></code> |
| 4061 | - <code><a href="./src/resources/stream/downloads.ts">DownloadDeleteResponse</a></code> |
| 4062 | - <code><a href="./src/resources/stream/downloads.ts">DownloadGetResponse</a></code> |
| 4063 | |
| 4064 | Methods: |
| 4065 | |
| 4066 | - <code title="post /accounts/{account_id}/stream/{identifier}/downloads">client.stream.downloads.<a href="./src/resources/stream/downloads.ts">create</a>(identifier, { ...params }) -> DownloadCreateResponse</code> |
| 4067 | - <code title="delete /accounts/{account_id}/stream/{identifier}/downloads">client.stream.downloads.<a href="./src/resources/stream/downloads.ts">delete</a>(identifier, { ...params }) -> DownloadDeleteResponse</code> |
| 4068 | - <code title="get /accounts/{account_id}/stream/{identifier}/downloads">client.stream.downloads.<a href="./src/resources/stream/downloads.ts">get</a>(identifier, { ...params }) -> DownloadGetResponse</code> |
| 4069 | |
| 4070 | ## Embed |
| 4071 | |
| 4072 | Types: |
| 4073 | |
| 4074 | - <code><a href="./src/resources/stream/embed.ts">EmbedGetResponse</a></code> |
| 4075 | |
| 4076 | Methods: |
| 4077 | |
| 4078 | - <code title="get /accounts/{account_id}/stream/{identifier}/embed">client.stream.embed.<a href="./src/resources/stream/embed.ts">get</a>(identifier, { ...params }) -> string</code> |
| 4079 | |
| 4080 | ## Token |
| 4081 | |
| 4082 | Types: |
| 4083 | |
| 4084 | - <code><a href="./src/resources/stream/token.ts">TokenCreateResponse</a></code> |
| 4085 | |
| 4086 | Methods: |
| 4087 | |
| 4088 | - <code title="post /accounts/{account_id}/stream/{identifier}/token">client.stream.token.<a href="./src/resources/stream/token.ts">create</a>(identifier, { ...params }) -> TokenCreateResponse</code> |
| 4089 | |
| 4090 | # Alerting |
| 4091 | |
| 4092 | ## AvailableAlerts |
| 4093 | |
| 4094 | Types: |
| 4095 | |
| 4096 | - <code><a href="./src/resources/alerting/available-alerts.ts">AvailableAlertListResponse</a></code> |
| 4097 | |
| 4098 | Methods: |
| 4099 | |
| 4100 | - <code title="get /accounts/{account_id}/alerting/v3/available_alerts">client.alerting.availableAlerts.<a href="./src/resources/alerting/available-alerts.ts">list</a>({ ...params }) -> AvailableAlertListResponse</code> |
| 4101 | |
| 4102 | ## Destinations |
| 4103 | |
| 4104 | ### Eligible |
| 4105 | |
| 4106 | Types: |
| 4107 | |
| 4108 | - <code><a href="./src/resources/alerting/destinations/eligible.ts">EligibleGetResponse</a></code> |
| 4109 | |
| 4110 | Methods: |
| 4111 | |
| 4112 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/eligible">client.alerting.destinations.eligible.<a href="./src/resources/alerting/destinations/eligible.ts">get</a>({ ...params }) -> EligibleGetResponse</code> |
| 4113 | |
| 4114 | ### Pagerduty |
| 4115 | |
| 4116 | Types: |
| 4117 | |
| 4118 | - <code><a href="./src/resources/alerting/destinations/pagerduty.ts">Pagerduty</a></code> |
| 4119 | - <code><a href="./src/resources/alerting/destinations/pagerduty.ts">PagerdutyCreateResponse</a></code> |
| 4120 | - <code><a href="./src/resources/alerting/destinations/pagerduty.ts">PagerdutyDeleteResponse</a></code> |
| 4121 | - <code><a href="./src/resources/alerting/destinations/pagerduty.ts">PagerdutyGetResponse</a></code> |
| 4122 | - <code><a href="./src/resources/alerting/destinations/pagerduty.ts">PagerdutyLinkResponse</a></code> |
| 4123 | |
| 4124 | Methods: |
| 4125 | |
| 4126 | - <code title="post /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect">client.alerting.destinations.pagerduty.<a href="./src/resources/alerting/destinations/pagerduty.ts">create</a>({ ...params }) -> PagerdutyCreateResponse</code> |
| 4127 | - <code title="delete /accounts/{account_id}/alerting/v3/destinations/pagerduty">client.alerting.destinations.pagerduty.<a href="./src/resources/alerting/destinations/pagerduty.ts">delete</a>({ ...params }) -> PagerdutyDeleteResponse</code> |
| 4128 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/pagerduty">client.alerting.destinations.pagerduty.<a href="./src/resources/alerting/destinations/pagerduty.ts">get</a>({ ...params }) -> PagerdutyGetResponse</code> |
| 4129 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}">client.alerting.destinations.pagerduty.<a href="./src/resources/alerting/destinations/pagerduty.ts">link</a>(tokenId, { ...params }) -> PagerdutyLinkResponse</code> |
| 4130 | |
| 4131 | ### Webhooks |
| 4132 | |
| 4133 | Types: |
| 4134 | |
| 4135 | - <code><a href="./src/resources/alerting/destinations/webhooks.ts">Webhooks</a></code> |
| 4136 | - <code><a href="./src/resources/alerting/destinations/webhooks.ts">WebhookCreateResponse</a></code> |
| 4137 | - <code><a href="./src/resources/alerting/destinations/webhooks.ts">WebhookUpdateResponse</a></code> |
| 4138 | - <code><a href="./src/resources/alerting/destinations/webhooks.ts">WebhookDeleteResponse</a></code> |
| 4139 | |
| 4140 | Methods: |
| 4141 | |
| 4142 | - <code title="post /accounts/{account_id}/alerting/v3/destinations/webhooks">client.alerting.destinations.webhooks.<a href="./src/resources/alerting/destinations/webhooks.ts">create</a>({ ...params }) -> WebhookCreateResponse</code> |
| 4143 | - <code title="put /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}">client.alerting.destinations.webhooks.<a href="./src/resources/alerting/destinations/webhooks.ts">update</a>(webhookId, { ...params }) -> WebhookUpdateResponse</code> |
| 4144 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/webhooks">client.alerting.destinations.webhooks.<a href="./src/resources/alerting/destinations/webhooks.ts">list</a>({ ...params }) -> WebhooksSinglePage</code> |
| 4145 | - <code title="delete /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}">client.alerting.destinations.webhooks.<a href="./src/resources/alerting/destinations/webhooks.ts">delete</a>(webhookId, { ...params }) -> WebhookDeleteResponse</code> |
| 4146 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}">client.alerting.destinations.webhooks.<a href="./src/resources/alerting/destinations/webhooks.ts">get</a>(webhookId, { ...params }) -> Webhooks</code> |
| 4147 | |
| 4148 | ## History |
| 4149 | |
| 4150 | Types: |
| 4151 | |
| 4152 | - <code><a href="./src/resources/alerting/history.ts">History</a></code> |
| 4153 | |
| 4154 | Methods: |
| 4155 | |
| 4156 | - <code title="get /accounts/{account_id}/alerting/v3/history">client.alerting.history.<a href="./src/resources/alerting/history.ts">list</a>({ ...params }) -> HistoriesV4PagePaginationArray</code> |
| 4157 | |
| 4158 | ## Policies |
| 4159 | |
| 4160 | Types: |
| 4161 | |
| 4162 | - <code><a href="./src/resources/alerting/policies.ts">Mechanism</a></code> |
| 4163 | - <code><a href="./src/resources/alerting/policies.ts">Policy</a></code> |
| 4164 | - <code><a href="./src/resources/alerting/policies.ts">PolicyFilter</a></code> |
| 4165 | - <code><a href="./src/resources/alerting/policies.ts">PolicyCreateResponse</a></code> |
| 4166 | - <code><a href="./src/resources/alerting/policies.ts">PolicyUpdateResponse</a></code> |
| 4167 | - <code><a href="./src/resources/alerting/policies.ts">PolicyDeleteResponse</a></code> |
| 4168 | |
| 4169 | Methods: |
| 4170 | |
| 4171 | - <code title="post /accounts/{account_id}/alerting/v3/policies">client.alerting.policies.<a href="./src/resources/alerting/policies.ts">create</a>({ ...params }) -> PolicyCreateResponse</code> |
| 4172 | - <code title="put /accounts/{account_id}/alerting/v3/policies/{policy_id}">client.alerting.policies.<a href="./src/resources/alerting/policies.ts">update</a>(policyId, { ...params }) -> PolicyUpdateResponse</code> |
| 4173 | - <code title="get /accounts/{account_id}/alerting/v3/policies">client.alerting.policies.<a href="./src/resources/alerting/policies.ts">list</a>({ ...params }) -> PoliciesSinglePage</code> |
| 4174 | - <code title="delete /accounts/{account_id}/alerting/v3/policies/{policy_id}">client.alerting.policies.<a href="./src/resources/alerting/policies.ts">delete</a>(policyId, { ...params }) -> PolicyDeleteResponse</code> |
| 4175 | - <code title="get /accounts/{account_id}/alerting/v3/policies/{policy_id}">client.alerting.policies.<a href="./src/resources/alerting/policies.ts">get</a>(policyId, { ...params }) -> Policy</code> |
| 4176 | |
| 4177 | # D1 |
| 4178 | |
| 4179 | Types: |
| 4180 | |
| 4181 | - <code><a href="./src/resources/d1/d1.ts">D1</a></code> |
| 4182 | |
| 4183 | ## Database |
| 4184 | |
| 4185 | Types: |
| 4186 | |
| 4187 | - <code><a href="./src/resources/d1/database.ts">QueryResult</a></code> |
| 4188 | - <code><a href="./src/resources/d1/database.ts">DatabaseCreateResponse</a></code> |
| 4189 | - <code><a href="./src/resources/d1/database.ts">DatabaseListResponse</a></code> |
| 4190 | - <code><a href="./src/resources/d1/database.ts">DatabaseDeleteResponse</a></code> |
| 4191 | - <code><a href="./src/resources/d1/database.ts">DatabaseQueryResponse</a></code> |
| 4192 | - <code><a href="./src/resources/d1/database.ts">DatabaseRawResponse</a></code> |
| 4193 | |
| 4194 | Methods: |
| 4195 | |
| 4196 | - <code title="post /accounts/{account_id}/d1/database">client.d1.database.<a href="./src/resources/d1/database.ts">create</a>({ ...params }) -> DatabaseCreateResponse</code> |
| 4197 | - <code title="get /accounts/{account_id}/d1/database">client.d1.database.<a href="./src/resources/d1/database.ts">list</a>({ ...params }) -> DatabaseListResponsesV4PagePaginationArray</code> |
| 4198 | - <code title="delete /accounts/{account_id}/d1/database/{database_id}">client.d1.database.<a href="./src/resources/d1/database.ts">delete</a>(databaseId, { ...params }) -> DatabaseDeleteResponse</code> |
| 4199 | - <code title="get /accounts/{account_id}/d1/database/{database_id}">client.d1.database.<a href="./src/resources/d1/database.ts">get</a>(databaseId, { ...params }) -> D1</code> |
| 4200 | - <code title="post /accounts/{account_id}/d1/database/{database_id}/query">client.d1.database.<a href="./src/resources/d1/database.ts">query</a>(databaseId, { ...params }) -> DatabaseQueryResponse</code> |
| 4201 | - <code title="post /accounts/{account_id}/d1/database/{database_id}/raw">client.d1.database.<a href="./src/resources/d1/database.ts">raw</a>(databaseId, { ...params }) -> DatabaseRawResponse</code> |
| 4202 | |
| 4203 | # R2 |
| 4204 | |
| 4205 | ## Buckets |
| 4206 | |
| 4207 | Types: |
| 4208 | |
| 4209 | - <code><a href="./src/resources/r2/buckets.ts">Bucket</a></code> |
| 4210 | - <code><a href="./src/resources/r2/buckets.ts">BucketDeleteResponse</a></code> |
| 4211 | |
| 4212 | Methods: |
| 4213 | |
| 4214 | - <code title="post /accounts/{account_id}/r2/buckets">client.r2.buckets.<a href="./src/resources/r2/buckets.ts">create</a>({ ...params }) -> Bucket</code> |
| 4215 | - <code title="get /accounts/{account_id}/r2/buckets">client.r2.buckets.<a href="./src/resources/r2/buckets.ts">list</a>({ ...params }) -> BucketsCursorPagination</code> |
| 4216 | - <code title="delete /accounts/{account_id}/r2/buckets/{bucket_name}">client.r2.buckets.<a href="./src/resources/r2/buckets.ts">delete</a>(bucketName, { ...params }) -> BucketDeleteResponse</code> |
| 4217 | - <code title="get /accounts/{account_id}/r2/buckets/{bucket_name}">client.r2.buckets.<a href="./src/resources/r2/buckets.ts">get</a>(bucketName, { ...params }) -> Bucket</code> |
| 4218 | |
| 4219 | ## Sippy |
| 4220 | |
| 4221 | Types: |
| 4222 | |
| 4223 | - <code><a href="./src/resources/r2/sippy.ts">Provider</a></code> |
| 4224 | - <code><a href="./src/resources/r2/sippy.ts">Sippy</a></code> |
| 4225 | - <code><a href="./src/resources/r2/sippy.ts">SippyDeleteResponse</a></code> |
| 4226 | |
| 4227 | Methods: |
| 4228 | |
| 4229 | - <code title="put /accounts/{account_id}/r2/buckets/{bucket_name}/sippy">client.r2.sippy.<a href="./src/resources/r2/sippy.ts">update</a>(bucketName, { ...params }) -> Sippy</code> |
| 4230 | - <code title="delete /accounts/{account_id}/r2/buckets/{bucket_name}/sippy">client.r2.sippy.<a href="./src/resources/r2/sippy.ts">delete</a>(bucketName, { ...params }) -> SippyDeleteResponse</code> |
| 4231 | - <code title="get /accounts/{account_id}/r2/buckets/{bucket_name}/sippy">client.r2.sippy.<a href="./src/resources/r2/sippy.ts">get</a>(bucketName, { ...params }) -> Sippy</code> |
| 4232 | |
| 4233 | ## TemporaryCredentials |
| 4234 | |
| 4235 | Types: |
| 4236 | |
| 4237 | - <code><a href="./src/resources/r2/temporary-credentials.ts">TemporaryCredential</a></code> |
| 4238 | - <code><a href="./src/resources/r2/temporary-credentials.ts">TemporaryCredentialCreateResponse</a></code> |
| 4239 | |
| 4240 | Methods: |
| 4241 | |
| 4242 | - <code title="post /accounts/{account_id}/r2/temp-access-credentials">client.r2.temporaryCredentials.<a href="./src/resources/r2/temporary-credentials.ts">create</a>({ ...params }) -> TemporaryCredentialCreateResponse</code> |
| 4243 | |
| 4244 | # WARPConnector |
| 4245 | |
| 4246 | Types: |
| 4247 | |
| 4248 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorCreateResponse</a></code> |
| 4249 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorListResponse</a></code> |
| 4250 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorDeleteResponse</a></code> |
| 4251 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorEditResponse</a></code> |
| 4252 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorGetResponse</a></code> |
| 4253 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorTokenResponse</a></code> |
| 4254 | |
| 4255 | Methods: |
| 4256 | |
| 4257 | - <code title="post /accounts/{account_id}/warp_connector">client.warpConnector.<a href="./src/resources/warp-connector.ts">create</a>({ ...params }) -> WARPConnectorCreateResponse</code> |
| 4258 | - <code title="get /accounts/{account_id}/warp_connector">client.warpConnector.<a href="./src/resources/warp-connector.ts">list</a>({ ...params }) -> WARPConnectorListResponsesV4PagePaginationArray</code> |
| 4259 | - <code title="delete /accounts/{account_id}/warp_connector/{tunnel_id}">client.warpConnector.<a href="./src/resources/warp-connector.ts">delete</a>(tunnelId, { ...params }) -> WARPConnectorDeleteResponse</code> |
| 4260 | - <code title="patch /accounts/{account_id}/warp_connector/{tunnel_id}">client.warpConnector.<a href="./src/resources/warp-connector.ts">edit</a>(tunnelId, { ...params }) -> WARPConnectorEditResponse</code> |
| 4261 | - <code title="get /accounts/{account_id}/warp_connector/{tunnel_id}">client.warpConnector.<a href="./src/resources/warp-connector.ts">get</a>(tunnelId, { ...params }) -> WARPConnectorGetResponse</code> |
| 4262 | - <code title="get /accounts/{account_id}/warp_connector/{tunnel_id}/token">client.warpConnector.<a href="./src/resources/warp-connector.ts">token</a>(tunnelId, { ...params }) -> WARPConnectorTokenResponse</code> |
| 4263 | |
| 4264 | # WorkersForPlatforms |
| 4265 | |
| 4266 | ## Dispatch |
| 4267 | |
| 4268 | ### Namespaces |
| 4269 | |
| 4270 | Types: |
| 4271 | |
| 4272 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">NamespaceCreateResponse</a></code> |
| 4273 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">NamespaceListResponse</a></code> |
| 4274 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">NamespaceDeleteResponse</a></code> |
| 4275 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">NamespaceGetResponse</a></code> |
| 4276 | |
| 4277 | Methods: |
| 4278 | |
| 4279 | - <code title="post /accounts/{account_id}/workers/dispatch/namespaces">client.workersForPlatforms.dispatch.namespaces.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">create</a>({ ...params }) -> NamespaceCreateResponse</code> |
| 4280 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces">client.workersForPlatforms.dispatch.namespaces.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">list</a>({ ...params }) -> NamespaceListResponsesSinglePage</code> |
| 4281 | - <code title="delete /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}">client.workersForPlatforms.dispatch.namespaces.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">delete</a>(dispatchNamespace, { ...params }) -> NamespaceDeleteResponse | null</code> |
| 4282 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}">client.workersForPlatforms.dispatch.namespaces.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">get</a>(dispatchNamespace, { ...params }) -> NamespaceGetResponse</code> |
| 4283 | |
| 4284 | #### Scripts |
| 4285 | |
| 4286 | Types: |
| 4287 | |
| 4288 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.ts">Script</a></code> |
| 4289 | |
| 4290 | Methods: |
| 4291 | |
| 4292 | - <code title="put /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}">client.workersForPlatforms.dispatch.namespaces.scripts.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.ts">update</a>(dispatchNamespace, scriptName, { ...params }) -> Script</code> |
| 4293 | - <code title="delete /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}">client.workersForPlatforms.dispatch.namespaces.scripts.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.ts">delete</a>(dispatchNamespace, scriptName, { ...params }) -> void</code> |
| 4294 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}">client.workersForPlatforms.dispatch.namespaces.scripts.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.ts">get</a>(dispatchNamespace, scriptName, { ...params }) -> Script</code> |
| 4295 | |
| 4296 | ##### Content |
| 4297 | |
| 4298 | Methods: |
| 4299 | |
| 4300 | - <code title="put /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content">client.workersForPlatforms.dispatch.namespaces.scripts.content.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content.ts">update</a>(dispatchNamespace, scriptName, { ...params }) -> Script</code> |
| 4301 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content">client.workersForPlatforms.dispatch.namespaces.scripts.content.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content.ts">get</a>(dispatchNamespace, scriptName, { ...params }) -> Response</code> |
| 4302 | |
| 4303 | ##### Settings |
| 4304 | |
| 4305 | Types: |
| 4306 | |
| 4307 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/settings.ts">SettingEditResponse</a></code> |
| 4308 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/settings.ts">SettingGetResponse</a></code> |
| 4309 | |
| 4310 | Methods: |
| 4311 | |
| 4312 | - <code title="patch /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings">client.workersForPlatforms.dispatch.namespaces.scripts.settings.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/settings.ts">edit</a>(dispatchNamespace, scriptName, { ...params }) -> SettingEditResponse</code> |
| 4313 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings">client.workersForPlatforms.dispatch.namespaces.scripts.settings.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/settings.ts">get</a>(dispatchNamespace, scriptName, { ...params }) -> SettingGetResponse</code> |
| 4314 | |
| 4315 | ##### Bindings |
| 4316 | |
| 4317 | Types: |
| 4318 | |
| 4319 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/bindings.ts">BindingGetResponse</a></code> |
| 4320 | |
| 4321 | Methods: |
| 4322 | |
| 4323 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/bindings">client.workersForPlatforms.dispatch.namespaces.scripts.bindings.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/bindings.ts">get</a>(dispatchNamespace, scriptName, { ...params }) -> BindingGetResponse</code> |
| 4324 | |
| 4325 | ##### Secrets |
| 4326 | |
| 4327 | Types: |
| 4328 | |
| 4329 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.ts">SecretUpdateResponse</a></code> |
| 4330 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.ts">SecretListResponse</a></code> |
| 4331 | |
| 4332 | Methods: |
| 4333 | |
| 4334 | - <code title="put /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets">client.workersForPlatforms.dispatch.namespaces.scripts.secrets.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.ts">update</a>(dispatchNamespace, scriptName, { ...params }) -> SecretUpdateResponse</code> |
| 4335 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets">client.workersForPlatforms.dispatch.namespaces.scripts.secrets.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/secrets.ts">list</a>(dispatchNamespace, scriptName, { ...params }) -> SecretListResponsesSinglePage</code> |
| 4336 | |
| 4337 | ##### Tags |
| 4338 | |
| 4339 | Types: |
| 4340 | |
| 4341 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.ts">TagUpdateResponse</a></code> |
| 4342 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.ts">TagListResponse</a></code> |
| 4343 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.ts">TagDeleteResponse</a></code> |
| 4344 | |
| 4345 | Methods: |
| 4346 | |
| 4347 | - <code title="put /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags">client.workersForPlatforms.dispatch.namespaces.scripts.tags.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.ts">update</a>(dispatchNamespace, scriptName, [ ...body ]) -> TagUpdateResponse</code> |
| 4348 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags">client.workersForPlatforms.dispatch.namespaces.scripts.tags.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.ts">list</a>(dispatchNamespace, scriptName, { ...params }) -> TagListResponsesSinglePage</code> |
| 4349 | - <code title="delete /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag}">client.workersForPlatforms.dispatch.namespaces.scripts.tags.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/tags.ts">delete</a>(dispatchNamespace, scriptName, tag, { ...params }) -> TagDeleteResponse | null</code> |
| 4350 | |
| 4351 | # ZeroTrust |
| 4352 | |
| 4353 | ## Devices |
| 4354 | |
| 4355 | Types: |
| 4356 | |
| 4357 | - <code><a href="./src/resources/zero-trust/devices/devices.ts">Device</a></code> |
| 4358 | - <code><a href="./src/resources/zero-trust/devices/devices.ts">DeviceGetResponse</a></code> |
| 4359 | |
| 4360 | Methods: |
| 4361 | |
| 4362 | - <code title="get /accounts/{account_id}/devices">client.zeroTrust.devices.<a href="./src/resources/zero-trust/devices/devices.ts">list</a>({ ...params }) -> DevicesSinglePage</code> |
| 4363 | - <code title="get /accounts/{account_id}/devices/{device_id}">client.zeroTrust.devices.<a href="./src/resources/zero-trust/devices/devices.ts">get</a>(deviceId, { ...params }) -> DeviceGetResponse</code> |
| 4364 | |
| 4365 | ### DEXTests |
| 4366 | |
| 4367 | Types: |
| 4368 | |
| 4369 | - <code><a href="./src/resources/zero-trust/devices/dex-tests.ts">DEXTest</a></code> |
| 4370 | - <code><a href="./src/resources/zero-trust/devices/dex-tests.ts">SchemaData</a></code> |
| 4371 | - <code><a href="./src/resources/zero-trust/devices/dex-tests.ts">SchemaHTTP</a></code> |
| 4372 | - <code><a href="./src/resources/zero-trust/devices/dex-tests.ts">DEXTestDeleteResponse</a></code> |
| 4373 | |
| 4374 | Methods: |
| 4375 | |
| 4376 | - <code title="post /accounts/{account_id}/devices/dex_tests">client.zeroTrust.devices.dexTests.<a href="./src/resources/zero-trust/devices/dex-tests.ts">create</a>({ ...params }) -> SchemaHTTP | null</code> |
| 4377 | - <code title="put /accounts/{account_id}/devices/dex_tests/{dex_test_id}">client.zeroTrust.devices.dexTests.<a href="./src/resources/zero-trust/devices/dex-tests.ts">update</a>(dexTestId, { ...params }) -> SchemaHTTP | null</code> |
| 4378 | - <code title="get /accounts/{account_id}/devices/dex_tests">client.zeroTrust.devices.dexTests.<a href="./src/resources/zero-trust/devices/dex-tests.ts">list</a>({ ...params }) -> SchemaHTTPSSinglePage</code> |
| 4379 | - <code title="delete /accounts/{account_id}/devices/dex_tests/{dex_test_id}">client.zeroTrust.devices.dexTests.<a href="./src/resources/zero-trust/devices/dex-tests.ts">delete</a>(dexTestId, { ...params }) -> DEXTestDeleteResponse | null</code> |
| 4380 | - <code title="get /accounts/{account_id}/devices/dex_tests/{dex_test_id}">client.zeroTrust.devices.dexTests.<a href="./src/resources/zero-trust/devices/dex-tests.ts">get</a>(dexTestId, { ...params }) -> SchemaHTTP | null</code> |
| 4381 | |
| 4382 | ### Networks |
| 4383 | |
| 4384 | Types: |
| 4385 | |
| 4386 | - <code><a href="./src/resources/zero-trust/devices/networks.ts">DeviceNetwork</a></code> |
| 4387 | - <code><a href="./src/resources/zero-trust/devices/networks.ts">NetworkDeleteResponse</a></code> |
| 4388 | |
| 4389 | Methods: |
| 4390 | |
| 4391 | - <code title="post /accounts/{account_id}/devices/networks">client.zeroTrust.devices.networks.<a href="./src/resources/zero-trust/devices/networks.ts">create</a>({ ...params }) -> DeviceNetwork | null</code> |
| 4392 | - <code title="put /accounts/{account_id}/devices/networks/{network_id}">client.zeroTrust.devices.networks.<a href="./src/resources/zero-trust/devices/networks.ts">update</a>(networkId, { ...params }) -> DeviceNetwork | null</code> |
| 4393 | - <code title="get /accounts/{account_id}/devices/networks">client.zeroTrust.devices.networks.<a href="./src/resources/zero-trust/devices/networks.ts">list</a>({ ...params }) -> DeviceNetworksSinglePage</code> |
| 4394 | - <code title="delete /accounts/{account_id}/devices/networks/{network_id}">client.zeroTrust.devices.networks.<a href="./src/resources/zero-trust/devices/networks.ts">delete</a>(networkId, { ...params }) -> NetworkDeleteResponse | null</code> |
| 4395 | - <code title="get /accounts/{account_id}/devices/networks/{network_id}">client.zeroTrust.devices.networks.<a href="./src/resources/zero-trust/devices/networks.ts">get</a>(networkId, { ...params }) -> DeviceNetwork | null</code> |
| 4396 | |
| 4397 | ### Policies |
| 4398 | |
| 4399 | Types: |
| 4400 | |
| 4401 | - <code><a href="./src/resources/zero-trust/devices/policies/policies.ts">SettingsPolicy</a></code> |
| 4402 | - <code><a href="./src/resources/zero-trust/devices/policies/policies.ts">PolicyDeleteResponse</a></code> |
| 4403 | |
| 4404 | Methods: |
| 4405 | |
| 4406 | - <code title="post /accounts/{account_id}/devices/policy">client.zeroTrust.devices.policies.<a href="./src/resources/zero-trust/devices/policies/policies.ts">create</a>({ ...params }) -> SettingsPolicy | null</code> |
| 4407 | - <code title="get /accounts/{account_id}/devices/policies">client.zeroTrust.devices.policies.<a href="./src/resources/zero-trust/devices/policies/policies.ts">list</a>({ ...params }) -> SettingsPoliciesSinglePage</code> |
| 4408 | - <code title="delete /accounts/{account_id}/devices/policy/{policy_id}">client.zeroTrust.devices.policies.<a href="./src/resources/zero-trust/devices/policies/policies.ts">delete</a>(policyId, { ...params }) -> PolicyDeleteResponse | null</code> |
| 4409 | - <code title="patch /accounts/{account_id}/devices/policy/{policy_id}">client.zeroTrust.devices.policies.<a href="./src/resources/zero-trust/devices/policies/policies.ts">edit</a>(policyId, { ...params }) -> SettingsPolicy | null</code> |
| 4410 | - <code title="get /accounts/{account_id}/devices/policy/{policy_id}">client.zeroTrust.devices.policies.<a href="./src/resources/zero-trust/devices/policies/policies.ts">get</a>(policyId, { ...params }) -> SettingsPolicy | null</code> |
| 4411 | |
| 4412 | #### DefaultPolicy |
| 4413 | |
| 4414 | Types: |
| 4415 | |
| 4416 | - <code><a href="./src/resources/zero-trust/devices/policies/default-policy.ts">DefaultPolicyGetResponse</a></code> |
| 4417 | |
| 4418 | Methods: |
| 4419 | |
| 4420 | - <code title="get /accounts/{account_id}/devices/policy">client.zeroTrust.devices.policies.defaultPolicy.<a href="./src/resources/zero-trust/devices/policies/default-policy.ts">get</a>({ ...params }) -> DefaultPolicyGetResponse | null</code> |
| 4421 | |
| 4422 | #### Excludes |
| 4423 | |
| 4424 | Types: |
| 4425 | |
| 4426 | - <code><a href="./src/resources/zero-trust/devices/policies/excludes.ts">SplitTunnelExclude</a></code> |
| 4427 | - <code><a href="./src/resources/zero-trust/devices/policies/excludes.ts">ExcludeUpdateResponse</a></code> |
| 4428 | - <code><a href="./src/resources/zero-trust/devices/policies/excludes.ts">ExcludeGetResponse</a></code> |
| 4429 | |
| 4430 | Methods: |
| 4431 | |
| 4432 | - <code title="put /accounts/{account_id}/devices/policy/exclude">client.zeroTrust.devices.policies.excludes.<a href="./src/resources/zero-trust/devices/policies/excludes.ts">update</a>([ ...body ]) -> ExcludeUpdateResponse | null</code> |
| 4433 | - <code title="get /accounts/{account_id}/devices/policy/exclude">client.zeroTrust.devices.policies.excludes.<a href="./src/resources/zero-trust/devices/policies/excludes.ts">list</a>({ ...params }) -> SplitTunnelExcludesSinglePage</code> |
| 4434 | - <code title="get /accounts/{account_id}/devices/policy/{policy_id}/exclude">client.zeroTrust.devices.policies.excludes.<a href="./src/resources/zero-trust/devices/policies/excludes.ts">get</a>(policyId, { ...params }) -> ExcludeGetResponse | null</code> |
| 4435 | |
| 4436 | #### FallbackDomains |
| 4437 | |
| 4438 | Types: |
| 4439 | |
| 4440 | - <code><a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">FallbackDomain</a></code> |
| 4441 | - <code><a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">FallbackDomainPolicy</a></code> |
| 4442 | - <code><a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">FallbackDomainUpdateResponse</a></code> |
| 4443 | - <code><a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">FallbackDomainGetResponse</a></code> |
| 4444 | |
| 4445 | Methods: |
| 4446 | |
| 4447 | - <code title="put /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains">client.zeroTrust.devices.policies.fallbackDomains.<a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">update</a>(policyId, [ ...body ]) -> FallbackDomainUpdateResponse | null</code> |
| 4448 | - <code title="get /accounts/{account_id}/devices/policy/fallback_domains">client.zeroTrust.devices.policies.fallbackDomains.<a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">list</a>({ ...params }) -> FallbackDomainsSinglePage</code> |
| 4449 | - <code title="get /accounts/{account_id}/devices/policy/{policy_id}/fallback_domains">client.zeroTrust.devices.policies.fallbackDomains.<a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">get</a>(policyId, { ...params }) -> FallbackDomainGetResponse | null</code> |
| 4450 | |
| 4451 | #### Includes |
| 4452 | |
| 4453 | Types: |
| 4454 | |
| 4455 | - <code><a href="./src/resources/zero-trust/devices/policies/includes.ts">SplitTunnelInclude</a></code> |
| 4456 | - <code><a href="./src/resources/zero-trust/devices/policies/includes.ts">IncludeUpdateResponse</a></code> |
| 4457 | - <code><a href="./src/resources/zero-trust/devices/policies/includes.ts">IncludeGetResponse</a></code> |
| 4458 | |
| 4459 | Methods: |
| 4460 | |
| 4461 | - <code title="put /accounts/{account_id}/devices/policy/include">client.zeroTrust.devices.policies.includes.<a href="./src/resources/zero-trust/devices/policies/includes.ts">update</a>([ ...body ]) -> IncludeUpdateResponse | null</code> |
| 4462 | - <code title="get /accounts/{account_id}/devices/policy/include">client.zeroTrust.devices.policies.includes.<a href="./src/resources/zero-trust/devices/policies/includes.ts">list</a>({ ...params }) -> SplitTunnelIncludesSinglePage</code> |
| 4463 | - <code title="get /accounts/{account_id}/devices/policy/{policy_id}/include">client.zeroTrust.devices.policies.includes.<a href="./src/resources/zero-trust/devices/policies/includes.ts">get</a>(policyId, { ...params }) -> IncludeGetResponse | null</code> |
| 4464 | |
| 4465 | ### Posture |
| 4466 | |
| 4467 | Types: |
| 4468 | |
| 4469 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">CarbonblackInput</a></code> |
| 4470 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">ClientCertificateInput</a></code> |
| 4471 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">CrowdstrikeInput</a></code> |
| 4472 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">DeviceInput</a></code> |
| 4473 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">DeviceMatch</a></code> |
| 4474 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">DevicePostureRule</a></code> |
| 4475 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">DiskEncryptionInput</a></code> |
| 4476 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">DomainJoinedInput</a></code> |
| 4477 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">FileInput</a></code> |
| 4478 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">FirewallInput</a></code> |
| 4479 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">IntuneInput</a></code> |
| 4480 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">KolideInput</a></code> |
| 4481 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">OSVersionInput</a></code> |
| 4482 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">SentineloneInput</a></code> |
| 4483 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">SentineloneS2sInput</a></code> |
| 4484 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">TaniumInput</a></code> |
| 4485 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">UniqueClientIDInput</a></code> |
| 4486 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">WorkspaceOneInput</a></code> |
| 4487 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">PostureDeleteResponse</a></code> |
| 4488 | |
| 4489 | Methods: |
| 4490 | |
| 4491 | - <code title="post /accounts/{account_id}/devices/posture">client.zeroTrust.devices.posture.<a href="./src/resources/zero-trust/devices/posture/posture.ts">create</a>({ ...params }) -> DevicePostureRule | null</code> |
| 4492 | - <code title="put /accounts/{account_id}/devices/posture/{rule_id}">client.zeroTrust.devices.posture.<a href="./src/resources/zero-trust/devices/posture/posture.ts">update</a>(ruleId, { ...params }) -> DevicePostureRule | null</code> |
| 4493 | - <code title="get /accounts/{account_id}/devices/posture">client.zeroTrust.devices.posture.<a href="./src/resources/zero-trust/devices/posture/posture.ts">list</a>({ ...params }) -> DevicePostureRulesSinglePage</code> |
| 4494 | - <code title="delete /accounts/{account_id}/devices/posture/{rule_id}">client.zeroTrust.devices.posture.<a href="./src/resources/zero-trust/devices/posture/posture.ts">delete</a>(ruleId, { ...params }) -> PostureDeleteResponse | null</code> |
| 4495 | - <code title="get /accounts/{account_id}/devices/posture/{rule_id}">client.zeroTrust.devices.posture.<a href="./src/resources/zero-trust/devices/posture/posture.ts">get</a>(ruleId, { ...params }) -> DevicePostureRule | null</code> |
| 4496 | |
| 4497 | #### Integrations |
| 4498 | |
| 4499 | Types: |
| 4500 | |
| 4501 | - <code><a href="./src/resources/zero-trust/devices/posture/integrations.ts">Integration</a></code> |
| 4502 | - <code><a href="./src/resources/zero-trust/devices/posture/integrations.ts">IntegrationDeleteResponse</a></code> |
| 4503 | |
| 4504 | Methods: |
| 4505 | |
| 4506 | - <code title="post /accounts/{account_id}/devices/posture/integration">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">create</a>({ ...params }) -> Integration | null</code> |
| 4507 | - <code title="get /accounts/{account_id}/devices/posture/integration">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">list</a>({ ...params }) -> IntegrationsSinglePage</code> |
| 4508 | - <code title="delete /accounts/{account_id}/devices/posture/integration/{integration_id}">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">delete</a>(integrationId, { ...params }) -> IntegrationDeleteResponse</code> |
| 4509 | - <code title="patch /accounts/{account_id}/devices/posture/integration/{integration_id}">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">edit</a>(integrationId, { ...params }) -> Integration | null</code> |
| 4510 | - <code title="get /accounts/{account_id}/devices/posture/integration/{integration_id}">client.zeroTrust.devices.posture.integrations.<a href="./src/resources/zero-trust/devices/posture/integrations.ts">get</a>(integrationId, { ...params }) -> Integration | null</code> |
| 4511 | |
| 4512 | ### Revoke |
| 4513 | |
| 4514 | Types: |
| 4515 | |
| 4516 | - <code><a href="./src/resources/zero-trust/devices/revoke.ts">RevokeCreateResponse</a></code> |
| 4517 | |
| 4518 | Methods: |
| 4519 | |
| 4520 | - <code title="post /accounts/{account_id}/devices/revoke">client.zeroTrust.devices.revoke.<a href="./src/resources/zero-trust/devices/revoke.ts">create</a>([ ...body ]) -> RevokeCreateResponse</code> |
| 4521 | |
| 4522 | ### Settings |
| 4523 | |
| 4524 | Types: |
| 4525 | |
| 4526 | - <code><a href="./src/resources/zero-trust/devices/settings.ts">DeviceSettings</a></code> |
| 4527 | |
| 4528 | Methods: |
| 4529 | |
| 4530 | - <code title="put /accounts/{account_id}/devices/settings">client.zeroTrust.devices.settings.<a href="./src/resources/zero-trust/devices/settings.ts">update</a>({ ...params }) -> DeviceSettings | null</code> |
| 4531 | - <code title="get /accounts/{account_id}/devices/settings">client.zeroTrust.devices.settings.<a href="./src/resources/zero-trust/devices/settings.ts">list</a>({ ...params }) -> DeviceSettings | null</code> |
| 4532 | |
| 4533 | ### Unrevoke |
| 4534 | |
| 4535 | Types: |
| 4536 | |
| 4537 | - <code><a href="./src/resources/zero-trust/devices/unrevoke.ts">UnrevokeCreateResponse</a></code> |
| 4538 | |
| 4539 | Methods: |
| 4540 | |
| 4541 | - <code title="post /accounts/{account_id}/devices/unrevoke">client.zeroTrust.devices.unrevoke.<a href="./src/resources/zero-trust/devices/unrevoke.ts">create</a>([ ...body ]) -> UnrevokeCreateResponse</code> |
| 4542 | |
| 4543 | ### OverrideCodes |
| 4544 | |
| 4545 | Types: |
| 4546 | |
| 4547 | - <code><a href="./src/resources/zero-trust/devices/override-codes.ts">OverrideCodeListResponse</a></code> |
| 4548 | |
| 4549 | Methods: |
| 4550 | |
| 4551 | - <code title="get /accounts/{account_id}/devices/{device_id}/override_codes">client.zeroTrust.devices.overrideCodes.<a href="./src/resources/zero-trust/devices/override-codes.ts">list</a>(deviceId, { ...params }) -> OverrideCodeListResponse | null</code> |
| 4552 | |
| 4553 | ## IdentityProviders |
| 4554 | |
| 4555 | Types: |
| 4556 | |
| 4557 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">AzureAD</a></code> |
| 4558 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">GenericOAuthConfig</a></code> |
| 4559 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">IdentityProvider</a></code> |
| 4560 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">IdentityProviderType</a></code> |
| 4561 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">SCIMConfig</a></code> |
| 4562 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">IdentityProviderListResponse</a></code> |
| 4563 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">IdentityProviderDeleteResponse</a></code> |
| 4564 | |
| 4565 | Methods: |
| 4566 | |
| 4567 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/identity_providers">client.zeroTrust.identityProviders.<a href="./src/resources/zero-trust/identity-providers.ts">create</a>({ ...params }) -> IdentityProvider</code> |
| 4568 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/identity_providers/{identity_provider_id}">client.zeroTrust.identityProviders.<a href="./src/resources/zero-trust/identity-providers.ts">update</a>(identityProviderId, { ...params }) -> IdentityProvider</code> |
| 4569 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/identity_providers">client.zeroTrust.identityProviders.<a href="./src/resources/zero-trust/identity-providers.ts">list</a>({ ...params }) -> IdentityProviderListResponsesSinglePage</code> |
| 4570 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/identity_providers/{identity_provider_id}">client.zeroTrust.identityProviders.<a href="./src/resources/zero-trust/identity-providers.ts">delete</a>(identityProviderId, { ...params }) -> IdentityProviderDeleteResponse</code> |
| 4571 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/identity_providers/{identity_provider_id}">client.zeroTrust.identityProviders.<a href="./src/resources/zero-trust/identity-providers.ts">get</a>(identityProviderId, { ...params }) -> IdentityProvider</code> |
| 4572 | |
| 4573 | ## Organizations |
| 4574 | |
| 4575 | Types: |
| 4576 | |
| 4577 | - <code><a href="./src/resources/zero-trust/organizations.ts">LoginDesign</a></code> |
| 4578 | - <code><a href="./src/resources/zero-trust/organizations.ts">Organization</a></code> |
| 4579 | - <code><a href="./src/resources/zero-trust/organizations.ts">OrganizationRevokeUsersResponse</a></code> |
| 4580 | |
| 4581 | Methods: |
| 4582 | |
| 4583 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/organizations">client.zeroTrust.organizations.<a href="./src/resources/zero-trust/organizations.ts">create</a>({ ...params }) -> Organization</code> |
| 4584 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/organizations">client.zeroTrust.organizations.<a href="./src/resources/zero-trust/organizations.ts">update</a>({ ...params }) -> Organization</code> |
| 4585 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/organizations">client.zeroTrust.organizations.<a href="./src/resources/zero-trust/organizations.ts">list</a>({ ...params }) -> Organization</code> |
| 4586 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/organizations/revoke_user">client.zeroTrust.organizations.<a href="./src/resources/zero-trust/organizations.ts">revokeUsers</a>({ ...params }) -> OrganizationRevokeUsersResponse</code> |
| 4587 | |
| 4588 | ## Seats |
| 4589 | |
| 4590 | Types: |
| 4591 | |
| 4592 | - <code><a href="./src/resources/zero-trust/seats.ts">Seat</a></code> |
| 4593 | - <code><a href="./src/resources/zero-trust/seats.ts">SeatEditResponse</a></code> |
| 4594 | |
| 4595 | Methods: |
| 4596 | |
| 4597 | - <code title="patch /accounts/{account_id}/access/seats">client.zeroTrust.seats.<a href="./src/resources/zero-trust/seats.ts">edit</a>([ ...body ]) -> SeatEditResponse | null</code> |
| 4598 | |
| 4599 | ## Access |
| 4600 | |
| 4601 | Types: |
| 4602 | |
| 4603 | - <code><a href="./src/resources/zero-trust/access/access.ts">AccessDevicePostureRule</a></code> |
| 4604 | - <code><a href="./src/resources/zero-trust/access/access.ts">AccessRule</a></code> |
| 4605 | - <code><a href="./src/resources/zero-trust/access/access.ts">AnyValidServiceTokenRule</a></code> |
| 4606 | - <code><a href="./src/resources/zero-trust/access/access.ts">AuthenticationMethodRule</a></code> |
| 4607 | - <code><a href="./src/resources/zero-trust/access/access.ts">AzureGroupRule</a></code> |
| 4608 | - <code><a href="./src/resources/zero-trust/access/access.ts">CertificateRule</a></code> |
| 4609 | - <code><a href="./src/resources/zero-trust/access/access.ts">CountryRule</a></code> |
| 4610 | - <code><a href="./src/resources/zero-trust/access/access.ts">DomainRule</a></code> |
| 4611 | - <code><a href="./src/resources/zero-trust/access/access.ts">EmailListRule</a></code> |
| 4612 | - <code><a href="./src/resources/zero-trust/access/access.ts">EmailRule</a></code> |
| 4613 | - <code><a href="./src/resources/zero-trust/access/access.ts">EveryoneRule</a></code> |
| 4614 | - <code><a href="./src/resources/zero-trust/access/access.ts">ExternalEvaluationRule</a></code> |
| 4615 | - <code><a href="./src/resources/zero-trust/access/access.ts">GitHubOrganizationRule</a></code> |
| 4616 | - <code><a href="./src/resources/zero-trust/access/access.ts">GroupRule</a></code> |
| 4617 | - <code><a href="./src/resources/zero-trust/access/access.ts">GSuiteGroupRule</a></code> |
| 4618 | - <code><a href="./src/resources/zero-trust/access/access.ts">IPListRule</a></code> |
| 4619 | - <code><a href="./src/resources/zero-trust/access/access.ts">IPRule</a></code> |
| 4620 | - <code><a href="./src/resources/zero-trust/access/access.ts">OktaGroupRule</a></code> |
| 4621 | - <code><a href="./src/resources/zero-trust/access/access.ts">SAMLGroupRule</a></code> |
| 4622 | - <code><a href="./src/resources/zero-trust/access/access.ts">ServiceTokenRule</a></code> |
| 4623 | |
| 4624 | ### Applications |
| 4625 | |
| 4626 | Types: |
| 4627 | |
| 4628 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">AllowedHeaders</a></code> |
| 4629 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">AllowedIdPs</a></code> |
| 4630 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">AllowedMethods</a></code> |
| 4631 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">AllowedOrigins</a></code> |
| 4632 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">AppID</a></code> |
| 4633 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">Application</a></code> |
| 4634 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationType</a></code> |
| 4635 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">CORSHeaders</a></code> |
| 4636 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">Decision</a></code> |
| 4637 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">SaaSAppNameFormat</a></code> |
| 4638 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">SaaSAppNameIDFormat</a></code> |
| 4639 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">SaaSAppSource</a></code> |
| 4640 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">SAMLSaaSApp</a></code> |
| 4641 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">SelfHostedDomains</a></code> |
| 4642 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationCreateResponse</a></code> |
| 4643 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationUpdateResponse</a></code> |
| 4644 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationListResponse</a></code> |
| 4645 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationDeleteResponse</a></code> |
| 4646 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationGetResponse</a></code> |
| 4647 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationRevokeTokensResponse</a></code> |
| 4648 | |
| 4649 | Methods: |
| 4650 | |
| 4651 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/apps">client.zeroTrust.access.applications.<a href="./src/resources/zero-trust/access/applications/applications.ts">create</a>({ ...params }) -> ApplicationCreateResponse</code> |
| 4652 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}">client.zeroTrust.access.applications.<a href="./src/resources/zero-trust/access/applications/applications.ts">update</a>(appId, { ...params }) -> ApplicationUpdateResponse</code> |
| 4653 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps">client.zeroTrust.access.applications.<a href="./src/resources/zero-trust/access/applications/applications.ts">list</a>({ ...params }) -> ApplicationListResponsesSinglePage</code> |
| 4654 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}">client.zeroTrust.access.applications.<a href="./src/resources/zero-trust/access/applications/applications.ts">delete</a>(appId, { ...params }) -> ApplicationDeleteResponse</code> |
| 4655 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}">client.zeroTrust.access.applications.<a href="./src/resources/zero-trust/access/applications/applications.ts">get</a>(appId, { ...params }) -> ApplicationGetResponse</code> |
| 4656 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/revoke_tokens">client.zeroTrust.access.applications.<a href="./src/resources/zero-trust/access/applications/applications.ts">revokeTokens</a>(appId, { ...params }) -> ApplicationRevokeTokensResponse | null</code> |
| 4657 | |
| 4658 | #### CAs |
| 4659 | |
| 4660 | Types: |
| 4661 | |
| 4662 | - <code><a href="./src/resources/zero-trust/access/applications/cas.ts">CA</a></code> |
| 4663 | - <code><a href="./src/resources/zero-trust/access/applications/cas.ts">CACreateResponse</a></code> |
| 4664 | - <code><a href="./src/resources/zero-trust/access/applications/cas.ts">CADeleteResponse</a></code> |
| 4665 | - <code><a href="./src/resources/zero-trust/access/applications/cas.ts">CAGetResponse</a></code> |
| 4666 | |
| 4667 | Methods: |
| 4668 | |
| 4669 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/ca">client.zeroTrust.access.applications.cas.<a href="./src/resources/zero-trust/access/applications/cas.ts">create</a>(appId, { ...params }) -> CACreateResponse</code> |
| 4670 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps/ca">client.zeroTrust.access.applications.cas.<a href="./src/resources/zero-trust/access/applications/cas.ts">list</a>({ ...params }) -> CAsSinglePage</code> |
| 4671 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/ca">client.zeroTrust.access.applications.cas.<a href="./src/resources/zero-trust/access/applications/cas.ts">delete</a>(appId, { ...params }) -> CADeleteResponse</code> |
| 4672 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/ca">client.zeroTrust.access.applications.cas.<a href="./src/resources/zero-trust/access/applications/cas.ts">get</a>(appId, { ...params }) -> CAGetResponse</code> |
| 4673 | |
| 4674 | #### UserPolicyChecks |
| 4675 | |
| 4676 | Types: |
| 4677 | |
| 4678 | - <code><a href="./src/resources/zero-trust/access/applications/user-policy-checks.ts">UserPolicyCheckGeo</a></code> |
| 4679 | - <code><a href="./src/resources/zero-trust/access/applications/user-policy-checks.ts">UserPolicyCheckListResponse</a></code> |
| 4680 | |
| 4681 | Methods: |
| 4682 | |
| 4683 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/user_policy_checks">client.zeroTrust.access.applications.userPolicyChecks.<a href="./src/resources/zero-trust/access/applications/user-policy-checks.ts">list</a>(appId, { ...params }) -> UserPolicyCheckListResponse</code> |
| 4684 | |
| 4685 | #### Policies |
| 4686 | |
| 4687 | Types: |
| 4688 | |
| 4689 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">ApprovalGroup</a></code> |
| 4690 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">Policy</a></code> |
| 4691 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">PolicyCreateResponse</a></code> |
| 4692 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">PolicyUpdateResponse</a></code> |
| 4693 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">PolicyListResponse</a></code> |
| 4694 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">PolicyDeleteResponse</a></code> |
| 4695 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">PolicyGetResponse</a></code> |
| 4696 | |
| 4697 | Methods: |
| 4698 | |
| 4699 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/policies">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">create</a>(appId, { ...params }) -> PolicyCreateResponse</code> |
| 4700 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/policies/{policy_id}">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">update</a>(appId, policyId, { ...params }) -> PolicyUpdateResponse</code> |
| 4701 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/policies">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">list</a>(appId, { ...params }) -> PolicyListResponsesSinglePage</code> |
| 4702 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/policies/{policy_id}">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">delete</a>(appId, policyId, { ...params }) -> PolicyDeleteResponse</code> |
| 4703 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps/{app_id}/policies/{policy_id}">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">get</a>(appId, policyId, { ...params }) -> PolicyGetResponse</code> |
| 4704 | |
| 4705 | ### Certificates |
| 4706 | |
| 4707 | Types: |
| 4708 | |
| 4709 | - <code><a href="./src/resources/zero-trust/access/certificates/certificates.ts">AssociatedHostnames</a></code> |
| 4710 | - <code><a href="./src/resources/zero-trust/access/certificates/certificates.ts">Certificate</a></code> |
| 4711 | - <code><a href="./src/resources/zero-trust/access/certificates/certificates.ts">CertificateDeleteResponse</a></code> |
| 4712 | |
| 4713 | Methods: |
| 4714 | |
| 4715 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/certificates">client.zeroTrust.access.certificates.<a href="./src/resources/zero-trust/access/certificates/certificates.ts">create</a>({ ...params }) -> Certificate</code> |
| 4716 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/certificates/{certificate_id}">client.zeroTrust.access.certificates.<a href="./src/resources/zero-trust/access/certificates/certificates.ts">update</a>(certificateId, { ...params }) -> Certificate</code> |
| 4717 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/certificates">client.zeroTrust.access.certificates.<a href="./src/resources/zero-trust/access/certificates/certificates.ts">list</a>({ ...params }) -> CertificatesSinglePage</code> |
| 4718 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/certificates/{certificate_id}">client.zeroTrust.access.certificates.<a href="./src/resources/zero-trust/access/certificates/certificates.ts">delete</a>(certificateId, { ...params }) -> CertificateDeleteResponse</code> |
| 4719 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/certificates/{certificate_id}">client.zeroTrust.access.certificates.<a href="./src/resources/zero-trust/access/certificates/certificates.ts">get</a>(certificateId, { ...params }) -> Certificate</code> |
| 4720 | |
| 4721 | #### Settings |
| 4722 | |
| 4723 | Types: |
| 4724 | |
| 4725 | - <code><a href="./src/resources/zero-trust/access/certificates/settings.ts">CertificateSettings</a></code> |
| 4726 | - <code><a href="./src/resources/zero-trust/access/certificates/settings.ts">SettingUpdateResponse</a></code> |
| 4727 | - <code><a href="./src/resources/zero-trust/access/certificates/settings.ts">SettingGetResponse</a></code> |
| 4728 | |
| 4729 | Methods: |
| 4730 | |
| 4731 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/certificates/settings">client.zeroTrust.access.certificates.settings.<a href="./src/resources/zero-trust/access/certificates/settings.ts">update</a>({ ...params }) -> SettingUpdateResponse | null</code> |
| 4732 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/certificates/settings">client.zeroTrust.access.certificates.settings.<a href="./src/resources/zero-trust/access/certificates/settings.ts">get</a>({ ...params }) -> SettingGetResponse | null</code> |
| 4733 | |
| 4734 | ### Groups |
| 4735 | |
| 4736 | Types: |
| 4737 | |
| 4738 | - <code><a href="./src/resources/zero-trust/access/groups.ts">ZeroTrustGroup</a></code> |
| 4739 | - <code><a href="./src/resources/zero-trust/access/groups.ts">GroupDeleteResponse</a></code> |
| 4740 | |
| 4741 | Methods: |
| 4742 | |
| 4743 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/groups">client.zeroTrust.access.groups.<a href="./src/resources/zero-trust/access/groups.ts">create</a>({ ...params }) -> ZeroTrustGroup</code> |
| 4744 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/groups/{group_id}">client.zeroTrust.access.groups.<a href="./src/resources/zero-trust/access/groups.ts">update</a>(groupId, { ...params }) -> ZeroTrustGroup</code> |
| 4745 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/groups">client.zeroTrust.access.groups.<a href="./src/resources/zero-trust/access/groups.ts">list</a>({ ...params }) -> ZeroTrustGroupsSinglePage</code> |
| 4746 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/groups/{group_id}">client.zeroTrust.access.groups.<a href="./src/resources/zero-trust/access/groups.ts">delete</a>(groupId, { ...params }) -> GroupDeleteResponse</code> |
| 4747 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/groups/{group_id}">client.zeroTrust.access.groups.<a href="./src/resources/zero-trust/access/groups.ts">get</a>(groupId, { ...params }) -> ZeroTrustGroup</code> |
| 4748 | |
| 4749 | ### ServiceTokens |
| 4750 | |
| 4751 | Types: |
| 4752 | |
| 4753 | - <code><a href="./src/resources/zero-trust/access/service-tokens.ts">ServiceToken</a></code> |
| 4754 | - <code><a href="./src/resources/zero-trust/access/service-tokens.ts">ServiceTokenCreateResponse</a></code> |
| 4755 | - <code><a href="./src/resources/zero-trust/access/service-tokens.ts">ServiceTokenRotateResponse</a></code> |
| 4756 | |
| 4757 | Methods: |
| 4758 | |
| 4759 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/service_tokens">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">create</a>({ ...params }) -> ServiceTokenCreateResponse</code> |
| 4760 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/service_tokens/{service_token_id}">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">update</a>(serviceTokenId, { ...params }) -> ServiceToken</code> |
| 4761 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/service_tokens">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">list</a>({ ...params }) -> ServiceTokensSinglePage</code> |
| 4762 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/service_tokens/{service_token_id}">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">delete</a>(serviceTokenId, { ...params }) -> ServiceToken</code> |
| 4763 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/service_tokens/{service_token_id}">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">get</a>(serviceTokenId, { ...params }) -> ServiceToken</code> |
| 4764 | - <code title="post /accounts/{account_id}/access/service_tokens/{service_token_id}/refresh">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">refresh</a>(serviceTokenId, { ...params }) -> ServiceToken</code> |
| 4765 | - <code title="post /accounts/{account_id}/access/service_tokens/{service_token_id}/rotate">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">rotate</a>(serviceTokenId, { ...params }) -> ServiceTokenRotateResponse</code> |
| 4766 | |
| 4767 | ### Bookmarks |
| 4768 | |
| 4769 | Types: |
| 4770 | |
| 4771 | - <code><a href="./src/resources/zero-trust/access/bookmarks.ts">Bookmark</a></code> |
| 4772 | - <code><a href="./src/resources/zero-trust/access/bookmarks.ts">BookmarkDeleteResponse</a></code> |
| 4773 | |
| 4774 | Methods: |
| 4775 | |
| 4776 | - <code title="post /accounts/{account_id}/access/bookmarks/{bookmark_id}">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">create</a>(bookmarkId, { ...params }) -> Bookmark</code> |
| 4777 | - <code title="put /accounts/{account_id}/access/bookmarks/{bookmark_id}">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">update</a>(bookmarkId, { ...params }) -> Bookmark</code> |
| 4778 | - <code title="get /accounts/{account_id}/access/bookmarks">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">list</a>({ ...params }) -> BookmarksSinglePage</code> |
| 4779 | - <code title="delete /accounts/{account_id}/access/bookmarks/{bookmark_id}">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">delete</a>(bookmarkId, { ...params }) -> BookmarkDeleteResponse</code> |
| 4780 | - <code title="get /accounts/{account_id}/access/bookmarks/{bookmark_id}">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">get</a>(bookmarkId, { ...params }) -> Bookmark</code> |
| 4781 | |
| 4782 | ### Keys |
| 4783 | |
| 4784 | Types: |
| 4785 | |
| 4786 | - <code><a href="./src/resources/zero-trust/access/keys.ts">KeyUpdateResponse</a></code> |
| 4787 | - <code><a href="./src/resources/zero-trust/access/keys.ts">KeyGetResponse</a></code> |
| 4788 | - <code><a href="./src/resources/zero-trust/access/keys.ts">KeyRotateResponse</a></code> |
| 4789 | |
| 4790 | Methods: |
| 4791 | |
| 4792 | - <code title="put /accounts/{account_id}/access/keys">client.zeroTrust.access.keys.<a href="./src/resources/zero-trust/access/keys.ts">update</a>({ ...params }) -> KeyUpdateResponse</code> |
| 4793 | - <code title="get /accounts/{account_id}/access/keys">client.zeroTrust.access.keys.<a href="./src/resources/zero-trust/access/keys.ts">get</a>({ ...params }) -> KeyGetResponse</code> |
| 4794 | - <code title="post /accounts/{account_id}/access/keys/rotate">client.zeroTrust.access.keys.<a href="./src/resources/zero-trust/access/keys.ts">rotate</a>({ ...params }) -> KeyRotateResponse</code> |
| 4795 | |
| 4796 | ### Logs |
| 4797 | |
| 4798 | #### AccessRequests |
| 4799 | |
| 4800 | Types: |
| 4801 | |
| 4802 | - <code><a href="./src/resources/zero-trust/access/logs/access-requests.ts">AccessRequests</a></code> |
| 4803 | - <code><a href="./src/resources/zero-trust/access/logs/access-requests.ts">AccessRequestListResponse</a></code> |
| 4804 | |
| 4805 | Methods: |
| 4806 | |
| 4807 | - <code title="get /accounts/{account_id}/access/logs/access_requests">client.zeroTrust.access.logs.accessRequests.<a href="./src/resources/zero-trust/access/logs/access-requests.ts">list</a>({ ...params }) -> AccessRequestListResponse</code> |
| 4808 | |
| 4809 | ### Users |
| 4810 | |
| 4811 | Types: |
| 4812 | |
| 4813 | - <code><a href="./src/resources/zero-trust/access/users/users.ts">AccessUser</a></code> |
| 4814 | |
| 4815 | Methods: |
| 4816 | |
| 4817 | - <code title="get /accounts/{account_id}/access/users">client.zeroTrust.access.users.<a href="./src/resources/zero-trust/access/users/users.ts">list</a>({ ...params }) -> AccessUsersSinglePage</code> |
| 4818 | |
| 4819 | #### ActiveSessions |
| 4820 | |
| 4821 | Types: |
| 4822 | |
| 4823 | - <code><a href="./src/resources/zero-trust/access/users/active-sessions.ts">ActiveSessionListResponse</a></code> |
| 4824 | - <code><a href="./src/resources/zero-trust/access/users/active-sessions.ts">ActiveSessionGetResponse</a></code> |
| 4825 | |
| 4826 | Methods: |
| 4827 | |
| 4828 | - <code title="get /accounts/{account_id}/access/users/{user_id}/active_sessions">client.zeroTrust.access.users.activeSessions.<a href="./src/resources/zero-trust/access/users/active-sessions.ts">list</a>(userId, { ...params }) -> ActiveSessionListResponsesSinglePage</code> |
| 4829 | - <code title="get /accounts/{account_id}/access/users/{user_id}/active_sessions/{nonce}">client.zeroTrust.access.users.activeSessions.<a href="./src/resources/zero-trust/access/users/active-sessions.ts">get</a>(userId, nonce, { ...params }) -> ActiveSessionGetResponse</code> |
| 4830 | |
| 4831 | #### LastSeenIdentity |
| 4832 | |
| 4833 | Types: |
| 4834 | |
| 4835 | - <code><a href="./src/resources/zero-trust/access/users/last-seen-identity.ts">Identity</a></code> |
| 4836 | |
| 4837 | Methods: |
| 4838 | |
| 4839 | - <code title="get /accounts/{account_id}/access/users/{user_id}/last_seen_identity">client.zeroTrust.access.users.lastSeenIdentity.<a href="./src/resources/zero-trust/access/users/last-seen-identity.ts">get</a>(userId, { ...params }) -> Identity</code> |
| 4840 | |
| 4841 | #### FailedLogins |
| 4842 | |
| 4843 | Types: |
| 4844 | |
| 4845 | - <code><a href="./src/resources/zero-trust/access/users/failed-logins.ts">FailedLoginListResponse</a></code> |
| 4846 | |
| 4847 | Methods: |
| 4848 | |
| 4849 | - <code title="get /accounts/{account_id}/access/users/{user_id}/failed_logins">client.zeroTrust.access.users.failedLogins.<a href="./src/resources/zero-trust/access/users/failed-logins.ts">list</a>(userId, { ...params }) -> FailedLoginListResponsesSinglePage</code> |
| 4850 | |
| 4851 | ### CustomPages |
| 4852 | |
| 4853 | Types: |
| 4854 | |
| 4855 | - <code><a href="./src/resources/zero-trust/access/custom-pages.ts">CustomPage</a></code> |
| 4856 | - <code><a href="./src/resources/zero-trust/access/custom-pages.ts">CustomPageWithoutHTML</a></code> |
| 4857 | - <code><a href="./src/resources/zero-trust/access/custom-pages.ts">CustomPageDeleteResponse</a></code> |
| 4858 | |
| 4859 | Methods: |
| 4860 | |
| 4861 | - <code title="post /accounts/{account_id}/access/custom_pages">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">create</a>({ ...params }) -> CustomPageWithoutHTML</code> |
| 4862 | - <code title="put /accounts/{account_id}/access/custom_pages/{custom_page_id}">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">update</a>(customPageId, { ...params }) -> CustomPageWithoutHTML</code> |
| 4863 | - <code title="get /accounts/{account_id}/access/custom_pages">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">list</a>({ ...params }) -> CustomPageWithoutHTMLsSinglePage</code> |
| 4864 | - <code title="delete /accounts/{account_id}/access/custom_pages/{custom_page_id}">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">delete</a>(customPageId, { ...params }) -> CustomPageDeleteResponse</code> |
| 4865 | - <code title="get /accounts/{account_id}/access/custom_pages/{custom_page_id}">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">get</a>(customPageId, { ...params }) -> CustomPage</code> |
| 4866 | |
| 4867 | ### Tags |
| 4868 | |
| 4869 | Types: |
| 4870 | |
| 4871 | - <code><a href="./src/resources/zero-trust/access/tags.ts">Tag</a></code> |
| 4872 | - <code><a href="./src/resources/zero-trust/access/tags.ts">TagDeleteResponse</a></code> |
| 4873 | |
| 4874 | Methods: |
| 4875 | |
| 4876 | - <code title="post /accounts/{account_id}/access/tags">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">create</a>({ ...params }) -> Tag</code> |
| 4877 | - <code title="put /accounts/{account_id}/access/tags/{tag_name}">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">update</a>(tagName, { ...params }) -> Tag</code> |
| 4878 | - <code title="get /accounts/{account_id}/access/tags">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">list</a>({ ...params }) -> TagsSinglePage</code> |
| 4879 | - <code title="delete /accounts/{account_id}/access/tags/{tag_name}">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">delete</a>(tagName, { ...params }) -> TagDeleteResponse</code> |
| 4880 | - <code title="get /accounts/{account_id}/access/tags/{tag_name}">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">get</a>(tagName, { ...params }) -> Tag</code> |
| 4881 | |
| 4882 | ### Policies |
| 4883 | |
| 4884 | Types: |
| 4885 | |
| 4886 | - <code><a href="./src/resources/zero-trust/access/policies.ts">PolicyCreateResponse</a></code> |
| 4887 | - <code><a href="./src/resources/zero-trust/access/policies.ts">PolicyUpdateResponse</a></code> |
| 4888 | - <code><a href="./src/resources/zero-trust/access/policies.ts">PolicyListResponse</a></code> |
| 4889 | - <code><a href="./src/resources/zero-trust/access/policies.ts">PolicyDeleteResponse</a></code> |
| 4890 | - <code><a href="./src/resources/zero-trust/access/policies.ts">PolicyGetResponse</a></code> |
| 4891 | |
| 4892 | Methods: |
| 4893 | |
| 4894 | - <code title="post /accounts/{account_id}/access/policies">client.zeroTrust.access.policies.<a href="./src/resources/zero-trust/access/policies.ts">create</a>({ ...params }) -> PolicyCreateResponse</code> |
| 4895 | - <code title="put /accounts/{account_id}/access/policies/{policy_id}">client.zeroTrust.access.policies.<a href="./src/resources/zero-trust/access/policies.ts">update</a>(policyId, { ...params }) -> PolicyUpdateResponse</code> |
| 4896 | - <code title="get /accounts/{account_id}/access/policies">client.zeroTrust.access.policies.<a href="./src/resources/zero-trust/access/policies.ts">list</a>({ ...params }) -> PolicyListResponsesSinglePage</code> |
| 4897 | - <code title="delete /accounts/{account_id}/access/policies/{policy_id}">client.zeroTrust.access.policies.<a href="./src/resources/zero-trust/access/policies.ts">delete</a>(policyId, { ...params }) -> PolicyDeleteResponse</code> |
| 4898 | - <code title="get /accounts/{account_id}/access/policies/{policy_id}">client.zeroTrust.access.policies.<a href="./src/resources/zero-trust/access/policies.ts">get</a>(policyId, { ...params }) -> PolicyGetResponse</code> |
| 4899 | |
| 4900 | ## DEX |
| 4901 | |
| 4902 | Types: |
| 4903 | |
| 4904 | - <code><a href="./src/resources/zero-trust/dex/dex.ts">DeviceExperienceMonitor</a></code> |
| 4905 | - <code><a href="./src/resources/zero-trust/dex/dex.ts">NetworkPath</a></code> |
| 4906 | - <code><a href="./src/resources/zero-trust/dex/dex.ts">NetworkPathResponse</a></code> |
| 4907 | - <code><a href="./src/resources/zero-trust/dex/dex.ts">Percentiles</a></code> |
| 4908 | |
| 4909 | ### Colos |
| 4910 | |
| 4911 | Types: |
| 4912 | |
| 4913 | - <code><a href="./src/resources/zero-trust/dex/colos.ts">ColoListResponse</a></code> |
| 4914 | |
| 4915 | Methods: |
| 4916 | |
| 4917 | - <code title="get /accounts/{account_id}/dex/colos">client.zeroTrust.dex.colos.<a href="./src/resources/zero-trust/dex/colos.ts">list</a>({ ...params }) -> ColoListResponsesSinglePage</code> |
| 4918 | |
| 4919 | ### FleetStatus |
| 4920 | |
| 4921 | Types: |
| 4922 | |
| 4923 | - <code><a href="./src/resources/zero-trust/dex/fleet-status/fleet-status.ts">LiveStat</a></code> |
| 4924 | - <code><a href="./src/resources/zero-trust/dex/fleet-status/fleet-status.ts">FleetStatusLiveResponse</a></code> |
| 4925 | |
| 4926 | Methods: |
| 4927 | |
| 4928 | - <code title="get /accounts/{account_id}/dex/fleet-status/live">client.zeroTrust.dex.fleetStatus.<a href="./src/resources/zero-trust/dex/fleet-status/fleet-status.ts">live</a>({ ...params }) -> FleetStatusLiveResponse</code> |
| 4929 | - <code title="get /accounts/{account_id}/dex/fleet-status/over-time">client.zeroTrust.dex.fleetStatus.<a href="./src/resources/zero-trust/dex/fleet-status/fleet-status.ts">overTime</a>({ ...params }) -> void</code> |
| 4930 | |
| 4931 | #### Devices |
| 4932 | |
| 4933 | Types: |
| 4934 | |
| 4935 | - <code><a href="./src/resources/zero-trust/dex/fleet-status/devices.ts">DeviceListResponse</a></code> |
| 4936 | |
| 4937 | Methods: |
| 4938 | |
| 4939 | - <code title="get /accounts/{account_id}/dex/fleet-status/devices">client.zeroTrust.dex.fleetStatus.devices.<a href="./src/resources/zero-trust/dex/fleet-status/devices.ts">list</a>({ ...params }) -> DeviceListResponsesV4PagePaginationArray</code> |
| 4940 | |
| 4941 | ### HTTPTests |
| 4942 | |
| 4943 | Types: |
| 4944 | |
| 4945 | - <code><a href="./src/resources/zero-trust/dex/http-tests/http-tests.ts">HTTPDetails</a></code> |
| 4946 | |
| 4947 | Methods: |
| 4948 | |
| 4949 | - <code title="get /accounts/{account_id}/dex/http-tests/{test_id}">client.zeroTrust.dex.httpTests.<a href="./src/resources/zero-trust/dex/http-tests/http-tests.ts">get</a>(testId, { ...params }) -> HTTPDetails</code> |
| 4950 | |
| 4951 | #### Percentiles |
| 4952 | |
| 4953 | Types: |
| 4954 | |
| 4955 | - <code><a href="./src/resources/zero-trust/dex/http-tests/percentiles.ts">HTTPDetailsPercentiles</a></code> |
| 4956 | - <code><a href="./src/resources/zero-trust/dex/http-tests/percentiles.ts">TestStatOverTime</a></code> |
| 4957 | |
| 4958 | Methods: |
| 4959 | |
| 4960 | - <code title="get /accounts/{account_id}/dex/http-tests/{test_id}/percentiles">client.zeroTrust.dex.httpTests.percentiles.<a href="./src/resources/zero-trust/dex/http-tests/percentiles.ts">get</a>(testId, { ...params }) -> HTTPDetailsPercentiles</code> |
| 4961 | |
| 4962 | ### Tests |
| 4963 | |
| 4964 | Types: |
| 4965 | |
| 4966 | - <code><a href="./src/resources/zero-trust/dex/tests/tests.ts">AggregateTimePeriod</a></code> |
| 4967 | - <code><a href="./src/resources/zero-trust/dex/tests/tests.ts">Tests</a></code> |
| 4968 | - <code><a href="./src/resources/zero-trust/dex/tests/tests.ts">TestListResponse</a></code> |
| 4969 | |
| 4970 | Methods: |
| 4971 | |
| 4972 | - <code title="get /accounts/{account_id}/dex/tests">client.zeroTrust.dex.tests.<a href="./src/resources/zero-trust/dex/tests/tests.ts">list</a>({ ...params }) -> TestListResponsesV4PagePagination</code> |
| 4973 | |
| 4974 | #### UniqueDevices |
| 4975 | |
| 4976 | Types: |
| 4977 | |
| 4978 | - <code><a href="./src/resources/zero-trust/dex/tests/unique-devices.ts">UniqueDevices</a></code> |
| 4979 | |
| 4980 | Methods: |
| 4981 | |
| 4982 | - <code title="get /accounts/{account_id}/dex/tests/unique-devices">client.zeroTrust.dex.tests.uniqueDevices.<a href="./src/resources/zero-trust/dex/tests/unique-devices.ts">list</a>({ ...params }) -> UniqueDevices</code> |
| 4983 | |
| 4984 | ### TracerouteTestResults |
| 4985 | |
| 4986 | #### NetworkPath |
| 4987 | |
| 4988 | Types: |
| 4989 | |
| 4990 | - <code><a href="./src/resources/zero-trust/dex/traceroute-test-results/network-path.ts">NetworkPathGetResponse</a></code> |
| 4991 | |
| 4992 | Methods: |
| 4993 | |
| 4994 | - <code title="get /accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path">client.zeroTrust.dex.tracerouteTestResults.networkPath.<a href="./src/resources/zero-trust/dex/traceroute-test-results/network-path.ts">get</a>(testResultId, { ...params }) -> NetworkPathGetResponse</code> |
| 4995 | |
| 4996 | ### TracerouteTests |
| 4997 | |
| 4998 | Types: |
| 4999 | |
| 5000 | - <code><a href="./src/resources/zero-trust/dex/traceroute-tests.ts">Traceroute</a></code> |
| 5001 | - <code><a href="./src/resources/zero-trust/dex/traceroute-tests.ts">TracerouteTestPercentilesResponse</a></code> |
| 5002 | |
| 5003 | Methods: |
| 5004 | |
| 5005 | - <code title="get /accounts/{account_id}/dex/traceroute-tests/{test_id}">client.zeroTrust.dex.tracerouteTests.<a href="./src/resources/zero-trust/dex/traceroute-tests.ts">get</a>(testId, { ...params }) -> Traceroute</code> |
| 5006 | - <code title="get /accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path">client.zeroTrust.dex.tracerouteTests.<a href="./src/resources/zero-trust/dex/traceroute-tests.ts">networkPath</a>(testId, { ...params }) -> NetworkPathResponse</code> |
| 5007 | - <code title="get /accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles">client.zeroTrust.dex.tracerouteTests.<a href="./src/resources/zero-trust/dex/traceroute-tests.ts">percentiles</a>(testId, { ...params }) -> TracerouteTestPercentilesResponse</code> |
| 5008 | |
| 5009 | ## Tunnels |
| 5010 | |
| 5011 | Types: |
| 5012 | |
| 5013 | - <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">Connection</a></code> |
| 5014 | - <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">TunnelCreateResponse</a></code> |
| 5015 | - <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">TunnelListResponse</a></code> |
| 5016 | - <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">TunnelDeleteResponse</a></code> |
| 5017 | - <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">TunnelEditResponse</a></code> |
| 5018 | - <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">TunnelGetResponse</a></code> |
| 5019 | |
| 5020 | Methods: |
| 5021 | |
| 5022 | - <code title="post /accounts/{account_id}/tunnels">client.zeroTrust.tunnels.<a href="./src/resources/zero-trust/tunnels/tunnels.ts">create</a>({ ...params }) -> TunnelCreateResponse</code> |
| 5023 | - <code title="get /accounts/{account_id}/tunnels">client.zeroTrust.tunnels.<a href="./src/resources/zero-trust/tunnels/tunnels.ts">list</a>({ ...params }) -> TunnelListResponsesV4PagePaginationArray</code> |
| 5024 | - <code title="delete /accounts/{account_id}/tunnels/{tunnel_id}">client.zeroTrust.tunnels.<a href="./src/resources/zero-trust/tunnels/tunnels.ts">delete</a>(tunnelId, { ...params }) -> TunnelDeleteResponse</code> |
| 5025 | - <code title="patch /accounts/{account_id}/cfd_tunnel/{tunnel_id}">client.zeroTrust.tunnels.<a href="./src/resources/zero-trust/tunnels/tunnels.ts">edit</a>(tunnelId, { ...params }) -> TunnelEditResponse</code> |
| 5026 | - <code title="get /accounts/{account_id}/tunnels/{tunnel_id}">client.zeroTrust.tunnels.<a href="./src/resources/zero-trust/tunnels/tunnels.ts">get</a>(tunnelId, { ...params }) -> TunnelGetResponse</code> |
| 5027 | |
| 5028 | ### Configurations |
| 5029 | |
| 5030 | Types: |
| 5031 | |
| 5032 | - <code><a href="./src/resources/zero-trust/tunnels/configurations.ts">ConfigurationUpdateResponse</a></code> |
| 5033 | - <code><a href="./src/resources/zero-trust/tunnels/configurations.ts">ConfigurationGetResponse</a></code> |
| 5034 | |
| 5035 | Methods: |
| 5036 | |
| 5037 | - <code title="put /accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations">client.zeroTrust.tunnels.configurations.<a href="./src/resources/zero-trust/tunnels/configurations.ts">update</a>(tunnelId, { ...params }) -> ConfigurationUpdateResponse</code> |
| 5038 | - <code title="get /accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations">client.zeroTrust.tunnels.configurations.<a href="./src/resources/zero-trust/tunnels/configurations.ts">get</a>(tunnelId, { ...params }) -> ConfigurationGetResponse</code> |
| 5039 | |
| 5040 | ### Connections |
| 5041 | |
| 5042 | Types: |
| 5043 | |
| 5044 | - <code><a href="./src/resources/zero-trust/tunnels/connections.ts">Client</a></code> |
| 5045 | - <code><a href="./src/resources/zero-trust/tunnels/connections.ts">ConnectionDeleteResponse</a></code> |
| 5046 | - <code><a href="./src/resources/zero-trust/tunnels/connections.ts">ConnectionGetResponse</a></code> |
| 5047 | |
| 5048 | Methods: |
| 5049 | |
| 5050 | - <code title="delete /accounts/{account_id}/tunnels/{tunnel_id}/connections">client.zeroTrust.tunnels.connections.<a href="./src/resources/zero-trust/tunnels/connections.ts">delete</a>(tunnelId, { ...params }) -> ConnectionDeleteResponse</code> |
| 5051 | - <code title="get /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections">client.zeroTrust.tunnels.connections.<a href="./src/resources/zero-trust/tunnels/connections.ts">get</a>(tunnelId, { ...params }) -> ConnectionGetResponse | null</code> |
| 5052 | |
| 5053 | ### Token |
| 5054 | |
| 5055 | Types: |
| 5056 | |
| 5057 | - <code><a href="./src/resources/zero-trust/tunnels/token.ts">TokenGetResponse</a></code> |
| 5058 | |
| 5059 | Methods: |
| 5060 | |
| 5061 | - <code title="get /accounts/{account_id}/cfd_tunnel/{tunnel_id}/token">client.zeroTrust.tunnels.token.<a href="./src/resources/zero-trust/tunnels/token.ts">get</a>(tunnelId, { ...params }) -> TokenGetResponse</code> |
| 5062 | |
| 5063 | ### Connectors |
| 5064 | |
| 5065 | Methods: |
| 5066 | |
| 5067 | - <code title="get /accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}">client.zeroTrust.tunnels.connectors.<a href="./src/resources/zero-trust/tunnels/connectors.ts">get</a>(tunnelId, connectorId, { ...params }) -> Client</code> |
| 5068 | |
| 5069 | ### Management |
| 5070 | |
| 5071 | Types: |
| 5072 | |
| 5073 | - <code><a href="./src/resources/zero-trust/tunnels/management.ts">ManagementCreateResponse</a></code> |
| 5074 | |
| 5075 | Methods: |
| 5076 | |
| 5077 | - <code title="post /accounts/{account_id}/cfd_tunnel/{tunnel_id}/management">client.zeroTrust.tunnels.management.<a href="./src/resources/zero-trust/tunnels/management.ts">create</a>(tunnelId, { ...params }) -> ManagementCreateResponse</code> |
| 5078 | |
| 5079 | ## ConnectivitySettings |
| 5080 | |
| 5081 | Types: |
| 5082 | |
| 5083 | - <code><a href="./src/resources/zero-trust/connectivity-settings.ts">ConnectivitySettingEditResponse</a></code> |
| 5084 | - <code><a href="./src/resources/zero-trust/connectivity-settings.ts">ConnectivitySettingGetResponse</a></code> |
| 5085 | |
| 5086 | Methods: |
| 5087 | |
| 5088 | - <code title="patch /accounts/{account_id}/zerotrust/connectivity_settings">client.zeroTrust.connectivitySettings.<a href="./src/resources/zero-trust/connectivity-settings.ts">edit</a>({ ...params }) -> ConnectivitySettingEditResponse</code> |
| 5089 | - <code title="get /accounts/{account_id}/zerotrust/connectivity_settings">client.zeroTrust.connectivitySettings.<a href="./src/resources/zero-trust/connectivity-settings.ts">get</a>({ ...params }) -> ConnectivitySettingGetResponse</code> |
| 5090 | |
| 5091 | ## DLP |
| 5092 | |
| 5093 | ### Datasets |
| 5094 | |
| 5095 | Types: |
| 5096 | |
| 5097 | - <code><a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">Dataset</a></code> |
| 5098 | - <code><a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">DatasetArray</a></code> |
| 5099 | - <code><a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">DatasetCreation</a></code> |
| 5100 | |
| 5101 | Methods: |
| 5102 | |
| 5103 | - <code title="post /accounts/{account_id}/dlp/datasets">client.zeroTrust.dlp.datasets.<a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">create</a>({ ...params }) -> DatasetCreation</code> |
| 5104 | - <code title="put /accounts/{account_id}/dlp/datasets/{dataset_id}">client.zeroTrust.dlp.datasets.<a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">update</a>(datasetId, { ...params }) -> Dataset</code> |
| 5105 | - <code title="get /accounts/{account_id}/dlp/datasets">client.zeroTrust.dlp.datasets.<a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">list</a>({ ...params }) -> DatasetsSinglePage</code> |
| 5106 | - <code title="delete /accounts/{account_id}/dlp/datasets/{dataset_id}">client.zeroTrust.dlp.datasets.<a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">delete</a>(datasetId, { ...params }) -> void</code> |
| 5107 | - <code title="get /accounts/{account_id}/dlp/datasets/{dataset_id}">client.zeroTrust.dlp.datasets.<a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">get</a>(datasetId, { ...params }) -> Dataset</code> |
| 5108 | |
| 5109 | #### Upload |
| 5110 | |
| 5111 | Types: |
| 5112 | |
| 5113 | - <code><a href="./src/resources/zero-trust/dlp/datasets/upload.ts">NewVersion</a></code> |
| 5114 | |
| 5115 | Methods: |
| 5116 | |
| 5117 | - <code title="post /accounts/{account_id}/dlp/datasets/{dataset_id}/upload">client.zeroTrust.dlp.datasets.upload.<a href="./src/resources/zero-trust/dlp/datasets/upload.ts">create</a>(datasetId, { ...params }) -> NewVersion</code> |
| 5118 | - <code title="post /accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}">client.zeroTrust.dlp.datasets.upload.<a href="./src/resources/zero-trust/dlp/datasets/upload.ts">edit</a>(datasetId, version, { ...params }) -> Dataset</code> |
| 5119 | |
| 5120 | ### Patterns |
| 5121 | |
| 5122 | Methods: |
| 5123 | |
| 5124 | - <code title="post /accounts/{account_id}/dlp/patterns/validate">client.zeroTrust.dlp.patterns.<a href="./src/resources/zero-trust/dlp/patterns.ts">validate</a>({ ...params }) -> OwnershipValidation | null</code> |
| 5125 | |
| 5126 | ### PayloadLogs |
| 5127 | |
| 5128 | Types: |
| 5129 | |
| 5130 | - <code><a href="./src/resources/zero-trust/dlp/payload-logs.ts">PayloadLogUpdateResponse</a></code> |
| 5131 | - <code><a href="./src/resources/zero-trust/dlp/payload-logs.ts">PayloadLogGetResponse</a></code> |
| 5132 | |
| 5133 | Methods: |
| 5134 | |
| 5135 | - <code title="put /accounts/{account_id}/dlp/payload_log">client.zeroTrust.dlp.payloadLogs.<a href="./src/resources/zero-trust/dlp/payload-logs.ts">update</a>({ ...params }) -> PayloadLogUpdateResponse</code> |
| 5136 | - <code title="get /accounts/{account_id}/dlp/payload_log">client.zeroTrust.dlp.payloadLogs.<a href="./src/resources/zero-trust/dlp/payload-logs.ts">get</a>({ ...params }) -> PayloadLogGetResponse</code> |
| 5137 | |
| 5138 | ### Profiles |
| 5139 | |
| 5140 | Types: |
| 5141 | |
| 5142 | - <code><a href="./src/resources/zero-trust/dlp/profiles/profiles.ts">ContextAwareness</a></code> |
| 5143 | - <code><a href="./src/resources/zero-trust/dlp/profiles/profiles.ts">Profile</a></code> |
| 5144 | - <code><a href="./src/resources/zero-trust/dlp/profiles/profiles.ts">SkipConfiguration</a></code> |
| 5145 | - <code><a href="./src/resources/zero-trust/dlp/profiles/profiles.ts">ProfileGetResponse</a></code> |
| 5146 | |
| 5147 | Methods: |
| 5148 | |
| 5149 | - <code title="get /accounts/{account_id}/dlp/profiles">client.zeroTrust.dlp.profiles.<a href="./src/resources/zero-trust/dlp/profiles/profiles.ts">list</a>({ ...params }) -> ProfilesSinglePage</code> |
| 5150 | - <code title="get /accounts/{account_id}/dlp/profiles/{profile_id}">client.zeroTrust.dlp.profiles.<a href="./src/resources/zero-trust/dlp/profiles/profiles.ts">get</a>(profileId, { ...params }) -> ProfileGetResponse</code> |
| 5151 | |
| 5152 | #### Custom |
| 5153 | |
| 5154 | Types: |
| 5155 | |
| 5156 | - <code><a href="./src/resources/zero-trust/dlp/profiles/custom.ts">CustomProfile</a></code> |
| 5157 | - <code><a href="./src/resources/zero-trust/dlp/profiles/custom.ts">Pattern</a></code> |
| 5158 | - <code><a href="./src/resources/zero-trust/dlp/profiles/custom.ts">CustomCreateResponse</a></code> |
| 5159 | - <code><a href="./src/resources/zero-trust/dlp/profiles/custom.ts">CustomDeleteResponse</a></code> |
| 5160 | |
| 5161 | Methods: |
| 5162 | |
| 5163 | - <code title="post /accounts/{account_id}/dlp/profiles/custom">client.zeroTrust.dlp.profiles.custom.<a href="./src/resources/zero-trust/dlp/profiles/custom.ts">create</a>({ ...params }) -> CustomCreateResponse | null</code> |
| 5164 | - <code title="put /accounts/{account_id}/dlp/profiles/custom/{profile_id}">client.zeroTrust.dlp.profiles.custom.<a href="./src/resources/zero-trust/dlp/profiles/custom.ts">update</a>(profileId, { ...params }) -> CustomProfile</code> |
| 5165 | - <code title="delete /accounts/{account_id}/dlp/profiles/custom/{profile_id}">client.zeroTrust.dlp.profiles.custom.<a href="./src/resources/zero-trust/dlp/profiles/custom.ts">delete</a>(profileId, { ...params }) -> CustomDeleteResponse</code> |
| 5166 | - <code title="get /accounts/{account_id}/dlp/profiles/custom/{profile_id}">client.zeroTrust.dlp.profiles.custom.<a href="./src/resources/zero-trust/dlp/profiles/custom.ts">get</a>(profileId, { ...params }) -> CustomProfile</code> |
| 5167 | |
| 5168 | #### Predefined |
| 5169 | |
| 5170 | Types: |
| 5171 | |
| 5172 | - <code><a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">PredefinedProfile</a></code> |
| 5173 | |
| 5174 | Methods: |
| 5175 | |
| 5176 | - <code title="put /accounts/{account_id}/dlp/profiles/predefined/{profile_id}">client.zeroTrust.dlp.profiles.predefined.<a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">update</a>(profileId, { ...params }) -> PredefinedProfile</code> |
| 5177 | - <code title="get /accounts/{account_id}/dlp/profiles/predefined/{profile_id}">client.zeroTrust.dlp.profiles.predefined.<a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">get</a>(profileId, { ...params }) -> PredefinedProfile</code> |
| 5178 | |
| 5179 | ## Gateway |
| 5180 | |
| 5181 | Types: |
| 5182 | |
| 5183 | - <code><a href="./src/resources/zero-trust/gateway/gateway.ts">GatewayCreateResponse</a></code> |
| 5184 | - <code><a href="./src/resources/zero-trust/gateway/gateway.ts">GatewayListResponse</a></code> |
| 5185 | |
| 5186 | Methods: |
| 5187 | |
| 5188 | - <code title="post /accounts/{account_id}/gateway">client.zeroTrust.gateway.<a href="./src/resources/zero-trust/gateway/gateway.ts">create</a>({ ...params }) -> GatewayCreateResponse</code> |
| 5189 | - <code title="get /accounts/{account_id}/gateway">client.zeroTrust.gateway.<a href="./src/resources/zero-trust/gateway/gateway.ts">list</a>({ ...params }) -> GatewayListResponse</code> |
| 5190 | |
| 5191 | ### AuditSSHSettings |
| 5192 | |
| 5193 | Types: |
| 5194 | |
| 5195 | - <code><a href="./src/resources/zero-trust/gateway/audit-ssh-settings.ts">GatewaySettings</a></code> |
| 5196 | |
| 5197 | Methods: |
| 5198 | |
| 5199 | - <code title="put /accounts/{account_id}/gateway/audit_ssh_settings">client.zeroTrust.gateway.auditSSHSettings.<a href="./src/resources/zero-trust/gateway/audit-ssh-settings.ts">update</a>({ ...params }) -> GatewaySettings</code> |
| 5200 | - <code title="get /accounts/{account_id}/gateway/audit_ssh_settings">client.zeroTrust.gateway.auditSSHSettings.<a href="./src/resources/zero-trust/gateway/audit-ssh-settings.ts">get</a>({ ...params }) -> GatewaySettings</code> |
| 5201 | |
| 5202 | ### Categories |
| 5203 | |
| 5204 | Types: |
| 5205 | |
| 5206 | - <code><a href="./src/resources/zero-trust/gateway/categories.ts">Category</a></code> |
| 5207 | |
| 5208 | Methods: |
| 5209 | |
| 5210 | - <code title="get /accounts/{account_id}/gateway/categories">client.zeroTrust.gateway.categories.<a href="./src/resources/zero-trust/gateway/categories.ts">list</a>({ ...params }) -> CategoriesSinglePage</code> |
| 5211 | |
| 5212 | ### AppTypes |
| 5213 | |
| 5214 | Types: |
| 5215 | |
| 5216 | - <code><a href="./src/resources/zero-trust/gateway/app-types.ts">AppType</a></code> |
| 5217 | |
| 5218 | Methods: |
| 5219 | |
| 5220 | - <code title="get /accounts/{account_id}/gateway/app_types">client.zeroTrust.gateway.appTypes.<a href="./src/resources/zero-trust/gateway/app-types.ts">list</a>({ ...params }) -> AppTypesSinglePage</code> |
| 5221 | |
| 5222 | ### Configurations |
| 5223 | |
| 5224 | Types: |
| 5225 | |
| 5226 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">ActivityLogSettings</a></code> |
| 5227 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">AntiVirusSettings</a></code> |
| 5228 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">BlockPageSettings</a></code> |
| 5229 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">BodyScanningSettings</a></code> |
| 5230 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">BrowserIsolationSettings</a></code> |
| 5231 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">CustomCertificateSettings</a></code> |
| 5232 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">ExtendedEmailMatching</a></code> |
| 5233 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">FipsSettings</a></code> |
| 5234 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">GatewayConfigurationSettings</a></code> |
| 5235 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">NotificationSettings</a></code> |
| 5236 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">ProtocolDetection</a></code> |
| 5237 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">TLSSettings</a></code> |
| 5238 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">ConfigurationUpdateResponse</a></code> |
| 5239 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">ConfigurationEditResponse</a></code> |
| 5240 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">ConfigurationGetResponse</a></code> |
| 5241 | |
| 5242 | Methods: |
| 5243 | |
| 5244 | - <code title="put /accounts/{account_id}/gateway/configuration">client.zeroTrust.gateway.configurations.<a href="./src/resources/zero-trust/gateway/configurations.ts">update</a>({ ...params }) -> ConfigurationUpdateResponse</code> |
| 5245 | - <code title="patch /accounts/{account_id}/gateway/configuration">client.zeroTrust.gateway.configurations.<a href="./src/resources/zero-trust/gateway/configurations.ts">edit</a>({ ...params }) -> ConfigurationEditResponse</code> |
| 5246 | - <code title="get /accounts/{account_id}/gateway/configuration">client.zeroTrust.gateway.configurations.<a href="./src/resources/zero-trust/gateway/configurations.ts">get</a>({ ...params }) -> ConfigurationGetResponse</code> |
| 5247 | |
| 5248 | ### Lists |
| 5249 | |
| 5250 | Types: |
| 5251 | |
| 5252 | - <code><a href="./src/resources/zero-trust/gateway/lists/lists.ts">GatewayItem</a></code> |
| 5253 | - <code><a href="./src/resources/zero-trust/gateway/lists/lists.ts">GatewayList</a></code> |
| 5254 | - <code><a href="./src/resources/zero-trust/gateway/lists/lists.ts">ListCreateResponse</a></code> |
| 5255 | - <code><a href="./src/resources/zero-trust/gateway/lists/lists.ts">ListDeleteResponse</a></code> |
| 5256 | |
| 5257 | Methods: |
| 5258 | |
| 5259 | - <code title="post /accounts/{account_id}/gateway/lists">client.zeroTrust.gateway.lists.<a href="./src/resources/zero-trust/gateway/lists/lists.ts">create</a>({ ...params }) -> ListCreateResponse</code> |
| 5260 | - <code title="put /accounts/{account_id}/gateway/lists/{list_id}">client.zeroTrust.gateway.lists.<a href="./src/resources/zero-trust/gateway/lists/lists.ts">update</a>(listId, { ...params }) -> GatewayList</code> |
| 5261 | - <code title="get /accounts/{account_id}/gateway/lists">client.zeroTrust.gateway.lists.<a href="./src/resources/zero-trust/gateway/lists/lists.ts">list</a>({ ...params }) -> GatewayListsSinglePage</code> |
| 5262 | - <code title="delete /accounts/{account_id}/gateway/lists/{list_id}">client.zeroTrust.gateway.lists.<a href="./src/resources/zero-trust/gateway/lists/lists.ts">delete</a>(listId, { ...params }) -> ListDeleteResponse</code> |
| 5263 | - <code title="patch /accounts/{account_id}/gateway/lists/{list_id}">client.zeroTrust.gateway.lists.<a href="./src/resources/zero-trust/gateway/lists/lists.ts">edit</a>(listId, { ...params }) -> GatewayList</code> |
| 5264 | - <code title="get /accounts/{account_id}/gateway/lists/{list_id}">client.zeroTrust.gateway.lists.<a href="./src/resources/zero-trust/gateway/lists/lists.ts">get</a>(listId, { ...params }) -> GatewayList</code> |
| 5265 | |
| 5266 | #### Items |
| 5267 | |
| 5268 | Types: |
| 5269 | |
| 5270 | - <code><a href="./src/resources/zero-trust/gateway/lists/items.ts">ItemListResponse</a></code> |
| 5271 | |
| 5272 | Methods: |
| 5273 | |
| 5274 | - <code title="get /accounts/{account_id}/gateway/lists/{list_id}/items">client.zeroTrust.gateway.lists.items.<a href="./src/resources/zero-trust/gateway/lists/items.ts">list</a>(listId, { ...params }) -> ItemListResponsesSinglePage</code> |
| 5275 | |
| 5276 | ### Locations |
| 5277 | |
| 5278 | Types: |
| 5279 | |
| 5280 | - <code><a href="./src/resources/zero-trust/gateway/locations.ts">Location</a></code> |
| 5281 | - <code><a href="./src/resources/zero-trust/gateway/locations.ts">LocationNetwork</a></code> |
| 5282 | - <code><a href="./src/resources/zero-trust/gateway/locations.ts">LocationDeleteResponse</a></code> |
| 5283 | |
| 5284 | Methods: |
| 5285 | |
| 5286 | - <code title="post /accounts/{account_id}/gateway/locations">client.zeroTrust.gateway.locations.<a href="./src/resources/zero-trust/gateway/locations.ts">create</a>({ ...params }) -> Location</code> |
| 5287 | - <code title="put /accounts/{account_id}/gateway/locations/{location_id}">client.zeroTrust.gateway.locations.<a href="./src/resources/zero-trust/gateway/locations.ts">update</a>(locationId, { ...params }) -> Location</code> |
| 5288 | - <code title="get /accounts/{account_id}/gateway/locations">client.zeroTrust.gateway.locations.<a href="./src/resources/zero-trust/gateway/locations.ts">list</a>({ ...params }) -> LocationsSinglePage</code> |
| 5289 | - <code title="delete /accounts/{account_id}/gateway/locations/{location_id}">client.zeroTrust.gateway.locations.<a href="./src/resources/zero-trust/gateway/locations.ts">delete</a>(locationId, { ...params }) -> LocationDeleteResponse</code> |
| 5290 | - <code title="get /accounts/{account_id}/gateway/locations/{location_id}">client.zeroTrust.gateway.locations.<a href="./src/resources/zero-trust/gateway/locations.ts">get</a>(locationId, { ...params }) -> Location</code> |
| 5291 | |
| 5292 | ### Logging |
| 5293 | |
| 5294 | Types: |
| 5295 | |
| 5296 | - <code><a href="./src/resources/zero-trust/gateway/logging.ts">LoggingSetting</a></code> |
| 5297 | |
| 5298 | Methods: |
| 5299 | |
| 5300 | - <code title="put /accounts/{account_id}/gateway/logging">client.zeroTrust.gateway.logging.<a href="./src/resources/zero-trust/gateway/logging.ts">update</a>({ ...params }) -> LoggingSetting</code> |
| 5301 | - <code title="get /accounts/{account_id}/gateway/logging">client.zeroTrust.gateway.logging.<a href="./src/resources/zero-trust/gateway/logging.ts">get</a>({ ...params }) -> LoggingSetting</code> |
| 5302 | |
| 5303 | ### ProxyEndpoints |
| 5304 | |
| 5305 | Types: |
| 5306 | |
| 5307 | - <code><a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">GatewayIPs</a></code> |
| 5308 | - <code><a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">ProxyEndpoint</a></code> |
| 5309 | - <code><a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">ProxyEndpointDeleteResponse</a></code> |
| 5310 | - <code><a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">ProxyEndpointGetResponse</a></code> |
| 5311 | |
| 5312 | Methods: |
| 5313 | |
| 5314 | - <code title="post /accounts/{account_id}/gateway/proxy_endpoints">client.zeroTrust.gateway.proxyEndpoints.<a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">create</a>({ ...params }) -> ProxyEndpoint</code> |
| 5315 | - <code title="get /accounts/{account_id}/gateway/proxy_endpoints">client.zeroTrust.gateway.proxyEndpoints.<a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">list</a>({ ...params }) -> ProxyEndpoint</code> |
| 5316 | - <code title="delete /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}">client.zeroTrust.gateway.proxyEndpoints.<a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">delete</a>(proxyEndpointId, { ...params }) -> ProxyEndpointDeleteResponse</code> |
| 5317 | - <code title="patch /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}">client.zeroTrust.gateway.proxyEndpoints.<a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">edit</a>(proxyEndpointId, { ...params }) -> ProxyEndpoint</code> |
| 5318 | - <code title="get /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}">client.zeroTrust.gateway.proxyEndpoints.<a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">get</a>(proxyEndpointId, { ...params }) -> ProxyEndpointGetResponse | null</code> |
| 5319 | |
| 5320 | ### Rules |
| 5321 | |
| 5322 | Types: |
| 5323 | |
| 5324 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">DNSResolverSettingsV4</a></code> |
| 5325 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">DNSResolverSettingsV6</a></code> |
| 5326 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">GatewayFilter</a></code> |
| 5327 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">GatewayRule</a></code> |
| 5328 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">RuleSetting</a></code> |
| 5329 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">Schedule</a></code> |
| 5330 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">RuleDeleteResponse</a></code> |
| 5331 | |
| 5332 | Methods: |
| 5333 | |
| 5334 | - <code title="post /accounts/{account_id}/gateway/rules">client.zeroTrust.gateway.rules.<a href="./src/resources/zero-trust/gateway/rules.ts">create</a>({ ...params }) -> GatewayRule</code> |
| 5335 | - <code title="put /accounts/{account_id}/gateway/rules/{rule_id}">client.zeroTrust.gateway.rules.<a href="./src/resources/zero-trust/gateway/rules.ts">update</a>(ruleId, { ...params }) -> GatewayRule</code> |
| 5336 | - <code title="get /accounts/{account_id}/gateway/rules">client.zeroTrust.gateway.rules.<a href="./src/resources/zero-trust/gateway/rules.ts">list</a>({ ...params }) -> GatewayRulesSinglePage</code> |
| 5337 | - <code title="delete /accounts/{account_id}/gateway/rules/{rule_id}">client.zeroTrust.gateway.rules.<a href="./src/resources/zero-trust/gateway/rules.ts">delete</a>(ruleId, { ...params }) -> RuleDeleteResponse</code> |
| 5338 | - <code title="get /accounts/{account_id}/gateway/rules/{rule_id}">client.zeroTrust.gateway.rules.<a href="./src/resources/zero-trust/gateway/rules.ts">get</a>(ruleId, { ...params }) -> GatewayRule</code> |
| 5339 | |
| 5340 | ## Networks |
| 5341 | |
| 5342 | ### Routes |
| 5343 | |
| 5344 | Types: |
| 5345 | |
| 5346 | - <code><a href="./src/resources/zero-trust/networks/routes/routes.ts">NetworkRoute</a></code> |
| 5347 | - <code><a href="./src/resources/zero-trust/networks/routes/routes.ts">Route</a></code> |
| 5348 | - <code><a href="./src/resources/zero-trust/networks/routes/routes.ts">Teamnet</a></code> |
| 5349 | |
| 5350 | Methods: |
| 5351 | |
| 5352 | - <code title="post /accounts/{account_id}/teamnet/routes">client.zeroTrust.networks.routes.<a href="./src/resources/zero-trust/networks/routes/routes.ts">create</a>({ ...params }) -> Route</code> |
| 5353 | - <code title="get /accounts/{account_id}/teamnet/routes">client.zeroTrust.networks.routes.<a href="./src/resources/zero-trust/networks/routes/routes.ts">list</a>({ ...params }) -> TeamnetsV4PagePaginationArray</code> |
| 5354 | - <code title="delete /accounts/{account_id}/teamnet/routes/{route_id}">client.zeroTrust.networks.routes.<a href="./src/resources/zero-trust/networks/routes/routes.ts">delete</a>(routeId, { ...params }) -> Route</code> |
| 5355 | - <code title="patch /accounts/{account_id}/teamnet/routes/{route_id}">client.zeroTrust.networks.routes.<a href="./src/resources/zero-trust/networks/routes/routes.ts">edit</a>(routeId, { ...params }) -> Route</code> |
| 5356 | |
| 5357 | #### IPs |
| 5358 | |
| 5359 | Methods: |
| 5360 | |
| 5361 | - <code title="get /accounts/{account_id}/teamnet/routes/ip/{ip}">client.zeroTrust.networks.routes.ips.<a href="./src/resources/zero-trust/networks/routes/ips.ts">get</a>(ip, { ...params }) -> Teamnet</code> |
| 5362 | |
| 5363 | #### Networks |
| 5364 | |
| 5365 | Methods: |
| 5366 | |
| 5367 | - <code title="post /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}">client.zeroTrust.networks.routes.networks.<a href="./src/resources/zero-trust/networks/routes/networks.ts">create</a>(ipNetworkEncoded, { ...params }) -> Route</code> |
| 5368 | - <code title="delete /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}">client.zeroTrust.networks.routes.networks.<a href="./src/resources/zero-trust/networks/routes/networks.ts">delete</a>(ipNetworkEncoded, { ...params }) -> Route</code> |
| 5369 | - <code title="patch /accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}">client.zeroTrust.networks.routes.networks.<a href="./src/resources/zero-trust/networks/routes/networks.ts">edit</a>(ipNetworkEncoded, { ...params }) -> Route</code> |
| 5370 | |
| 5371 | ### VirtualNetworks |
| 5372 | |
| 5373 | Types: |
| 5374 | |
| 5375 | - <code><a href="./src/resources/zero-trust/networks/virtual-networks.ts">VirtualNetwork</a></code> |
| 5376 | - <code><a href="./src/resources/zero-trust/networks/virtual-networks.ts">VirtualNetworkCreateResponse</a></code> |
| 5377 | - <code><a href="./src/resources/zero-trust/networks/virtual-networks.ts">VirtualNetworkDeleteResponse</a></code> |
| 5378 | - <code><a href="./src/resources/zero-trust/networks/virtual-networks.ts">VirtualNetworkEditResponse</a></code> |
| 5379 | |
| 5380 | Methods: |
| 5381 | |
| 5382 | - <code title="post /accounts/{account_id}/teamnet/virtual_networks">client.zeroTrust.networks.virtualNetworks.<a href="./src/resources/zero-trust/networks/virtual-networks.ts">create</a>({ ...params }) -> VirtualNetworkCreateResponse</code> |
| 5383 | - <code title="get /accounts/{account_id}/teamnet/virtual_networks">client.zeroTrust.networks.virtualNetworks.<a href="./src/resources/zero-trust/networks/virtual-networks.ts">list</a>({ ...params }) -> VirtualNetworksSinglePage</code> |
| 5384 | - <code title="delete /accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}">client.zeroTrust.networks.virtualNetworks.<a href="./src/resources/zero-trust/networks/virtual-networks.ts">delete</a>(virtualNetworkId, { ...params }) -> VirtualNetworkDeleteResponse</code> |
| 5385 | - <code title="patch /accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}">client.zeroTrust.networks.virtualNetworks.<a href="./src/resources/zero-trust/networks/virtual-networks.ts">edit</a>(virtualNetworkId, { ...params }) -> VirtualNetworkEditResponse</code> |
| 5386 | |
| 5387 | ## RiskScoring |
| 5388 | |
| 5389 | Types: |
| 5390 | |
| 5391 | - <code><a href="./src/resources/zero-trust/risk-scoring/risk-scoring.ts">RiskScoringGetResponse</a></code> |
| 5392 | - <code><a href="./src/resources/zero-trust/risk-scoring/risk-scoring.ts">RiskScoringResetResponse</a></code> |
| 5393 | |
| 5394 | Methods: |
| 5395 | |
| 5396 | - <code title="get /accounts/{account_identifier}/zt_risk_scoring/{user_id}">client.zeroTrust.riskScoring.<a href="./src/resources/zero-trust/risk-scoring/risk-scoring.ts">get</a>(accountIdentifier, userId, { ...params }) -> RiskScoringGetResponse</code> |
| 5397 | - <code title="post /accounts/{account_identifier}/zt_risk_scoring/{user_id}/reset">client.zeroTrust.riskScoring.<a href="./src/resources/zero-trust/risk-scoring/risk-scoring.ts">reset</a>(accountIdentifier, userId) -> RiskScoringResetResponse</code> |
| 5398 | |
| 5399 | ### Behaviours |
| 5400 | |
| 5401 | Types: |
| 5402 | |
| 5403 | - <code><a href="./src/resources/zero-trust/risk-scoring/behaviours.ts">BehaviourUpdateResponse</a></code> |
| 5404 | - <code><a href="./src/resources/zero-trust/risk-scoring/behaviours.ts">BehaviourGetResponse</a></code> |
| 5405 | |
| 5406 | Methods: |
| 5407 | |
| 5408 | - <code title="put /accounts/{account_identifier}/zt_risk_scoring/behaviors">client.zeroTrust.riskScoring.behaviours.<a href="./src/resources/zero-trust/risk-scoring/behaviours.ts">update</a>(accountIdentifier, { ...params }) -> BehaviourUpdateResponse</code> |
| 5409 | - <code title="get /accounts/{account_identifier}/zt_risk_scoring/behaviors">client.zeroTrust.riskScoring.behaviours.<a href="./src/resources/zero-trust/risk-scoring/behaviours.ts">get</a>(accountIdentifier) -> BehaviourGetResponse</code> |
| 5410 | |
| 5411 | ### Summary |
| 5412 | |
| 5413 | Types: |
| 5414 | |
| 5415 | - <code><a href="./src/resources/zero-trust/risk-scoring/summary.ts">SummaryGetResponse</a></code> |
| 5416 | |
| 5417 | Methods: |
| 5418 | |
| 5419 | - <code title="get /accounts/{account_identifier}/zt_risk_scoring/summary">client.zeroTrust.riskScoring.summary.<a href="./src/resources/zero-trust/risk-scoring/summary.ts">get</a>(accountIdentifier, { ...params }) -> SummaryGetResponse</code> |
| 5420 | |
| 5421 | ### Integrations |
| 5422 | |
| 5423 | Types: |
| 5424 | |
| 5425 | - <code><a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">IntegrationCreateResponse</a></code> |
| 5426 | - <code><a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">IntegrationUpdateResponse</a></code> |
| 5427 | - <code><a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">IntegrationListResponse</a></code> |
| 5428 | - <code><a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">IntegrationDeleteResponse</a></code> |
| 5429 | - <code><a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">IntegrationGetResponse</a></code> |
| 5430 | |
| 5431 | Methods: |
| 5432 | |
| 5433 | - <code title="post /accounts/{account_id}/zt_risk_scoring/integrations">client.zeroTrust.riskScoring.integrations.<a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">create</a>({ ...params }) -> IntegrationCreateResponse</code> |
| 5434 | - <code title="put /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}">client.zeroTrust.riskScoring.integrations.<a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">update</a>(integrationId, { ...params }) -> IntegrationUpdateResponse</code> |
| 5435 | - <code title="get /accounts/{account_id}/zt_risk_scoring/integrations">client.zeroTrust.riskScoring.integrations.<a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">list</a>({ ...params }) -> IntegrationListResponsesSinglePage</code> |
| 5436 | - <code title="delete /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}">client.zeroTrust.riskScoring.integrations.<a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">delete</a>(integrationId, { ...params }) -> IntegrationDeleteResponse</code> |
| 5437 | - <code title="get /accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}">client.zeroTrust.riskScoring.integrations.<a href="./src/resources/zero-trust/risk-scoring/integrations/integrations.ts">get</a>(integrationId, { ...params }) -> IntegrationGetResponse</code> |
| 5438 | |
| 5439 | #### References |
| 5440 | |
| 5441 | Types: |
| 5442 | |
| 5443 | - <code><a href="./src/resources/zero-trust/risk-scoring/integrations/references.ts">ReferenceGetResponse</a></code> |
| 5444 | |
| 5445 | Methods: |
| 5446 | |
| 5447 | - <code title="get /accounts/{account_id}/zt_risk_scoring/integrations/reference_id/{reference_id}">client.zeroTrust.riskScoring.integrations.references.<a href="./src/resources/zero-trust/risk-scoring/integrations/references.ts">get</a>(referenceId, { ...params }) -> ReferenceGetResponse</code> |
| 5448 | |
| 5449 | # Challenges |
| 5450 | |
| 5451 | ## Widgets |
| 5452 | |
| 5453 | Types: |
| 5454 | |
| 5455 | - <code><a href="./src/resources/challenges/widgets.ts">Widget</a></code> |
| 5456 | - <code><a href="./src/resources/challenges/widgets.ts">WidgetDomain</a></code> |
| 5457 | - <code><a href="./src/resources/challenges/widgets.ts">WidgetListResponse</a></code> |
| 5458 | |
| 5459 | Methods: |
| 5460 | |
| 5461 | - <code title="post /accounts/{account_id}/challenges/widgets">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">create</a>({ ...params }) -> Widget</code> |
| 5462 | - <code title="put /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">update</a>(sitekey, { ...params }) -> Widget</code> |
| 5463 | - <code title="get /accounts/{account_id}/challenges/widgets">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">list</a>({ ...params }) -> WidgetListResponsesV4PagePaginationArray</code> |
| 5464 | - <code title="delete /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">delete</a>(sitekey, { ...params }) -> Widget</code> |
| 5465 | - <code title="get /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">get</a>(sitekey, { ...params }) -> Widget</code> |
| 5466 | - <code title="post /accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">rotateSecret</a>(sitekey, { ...params }) -> Widget</code> |
| 5467 | |
| 5468 | # Hyperdrive |
| 5469 | |
| 5470 | Types: |
| 5471 | |
| 5472 | - <code><a href="./src/resources/hyperdrive/hyperdrive.ts">Configuration</a></code> |
| 5473 | - <code><a href="./src/resources/hyperdrive/hyperdrive.ts">Hyperdrive</a></code> |
| 5474 | |
| 5475 | ## Configs |
| 5476 | |
| 5477 | Types: |
| 5478 | |
| 5479 | - <code><a href="./src/resources/hyperdrive/configs.ts">ConfigDeleteResponse</a></code> |
| 5480 | |
| 5481 | Methods: |
| 5482 | |
| 5483 | - <code title="post /accounts/{account_id}/hyperdrive/configs">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">create</a>({ ...params }) -> Hyperdrive | null</code> |
| 5484 | - <code title="put /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">update</a>(hyperdriveId, { ...params }) -> Hyperdrive | null</code> |
| 5485 | - <code title="get /accounts/{account_id}/hyperdrive/configs">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">list</a>({ ...params }) -> HyperdrivesSinglePage</code> |
| 5486 | - <code title="delete /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">delete</a>(hyperdriveId, { ...params }) -> ConfigDeleteResponse</code> |
| 5487 | - <code title="patch /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">edit</a>(hyperdriveId, { ...params }) -> Hyperdrive | null</code> |
| 5488 | - <code title="get /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">get</a>(hyperdriveId, { ...params }) -> Hyperdrive | null</code> |
| 5489 | |
| 5490 | # RUM |
| 5491 | |
| 5492 | ## SiteInfo |
| 5493 | |
| 5494 | Types: |
| 5495 | |
| 5496 | - <code><a href="./src/resources/rum/site-info.ts">Site</a></code> |
| 5497 | - <code><a href="./src/resources/rum/site-info.ts">SiteInfoDeleteResponse</a></code> |
| 5498 | |
| 5499 | Methods: |
| 5500 | |
| 5501 | - <code title="post /accounts/{account_id}/rum/site_info">client.rum.siteInfo.<a href="./src/resources/rum/site-info.ts">create</a>({ ...params }) -> Site</code> |
| 5502 | - <code title="put /accounts/{account_id}/rum/site_info/{site_id}">client.rum.siteInfo.<a href="./src/resources/rum/site-info.ts">update</a>(siteId, { ...params }) -> Site</code> |
| 5503 | - <code title="get /accounts/{account_id}/rum/site_info/list">client.rum.siteInfo.<a href="./src/resources/rum/site-info.ts">list</a>({ ...params }) -> SitesV4PagePaginationArray</code> |
| 5504 | - <code title="delete /accounts/{account_id}/rum/site_info/{site_id}">client.rum.siteInfo.<a href="./src/resources/rum/site-info.ts">delete</a>(siteId, { ...params }) -> SiteInfoDeleteResponse</code> |
| 5505 | - <code title="get /accounts/{account_id}/rum/site_info/{site_id}">client.rum.siteInfo.<a href="./src/resources/rum/site-info.ts">get</a>(siteId, { ...params }) -> Site</code> |
| 5506 | |
| 5507 | ## Rules |
| 5508 | |
| 5509 | Types: |
| 5510 | |
| 5511 | - <code><a href="./src/resources/rum/rules.ts">RUMRule</a></code> |
| 5512 | - <code><a href="./src/resources/rum/rules.ts">RuleListResponse</a></code> |
| 5513 | - <code><a href="./src/resources/rum/rules.ts">RuleDeleteResponse</a></code> |
| 5514 | |
| 5515 | Methods: |
| 5516 | |
| 5517 | - <code title="post /accounts/{account_id}/rum/v2/{ruleset_id}/rule">client.rum.rules.<a href="./src/resources/rum/rules.ts">create</a>(rulesetId, { ...params }) -> RUMRule</code> |
| 5518 | - <code title="put /accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}">client.rum.rules.<a href="./src/resources/rum/rules.ts">update</a>(rulesetId, ruleId, { ...params }) -> RUMRule</code> |
| 5519 | - <code title="get /accounts/{account_id}/rum/v2/{ruleset_id}/rules">client.rum.rules.<a href="./src/resources/rum/rules.ts">list</a>(rulesetId, { ...params }) -> RuleListResponse</code> |
| 5520 | - <code title="delete /accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}">client.rum.rules.<a href="./src/resources/rum/rules.ts">delete</a>(rulesetId, ruleId, { ...params }) -> RuleDeleteResponse</code> |
| 5521 | |
| 5522 | # Vectorize |
| 5523 | |
| 5524 | ## Indexes |
| 5525 | |
| 5526 | Types: |
| 5527 | |
| 5528 | - <code><a href="./src/resources/vectorize/indexes.ts">CreateIndex</a></code> |
| 5529 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexDeleteVectorsByID</a></code> |
| 5530 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexDimensionConfiguration</a></code> |
| 5531 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexInsert</a></code> |
| 5532 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexQuery</a></code> |
| 5533 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexUpsert</a></code> |
| 5534 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexDeleteResponse</a></code> |
| 5535 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexGetByIDsResponse</a></code> |
| 5536 | |
| 5537 | Methods: |
| 5538 | |
| 5539 | - <code title="post /accounts/{account_id}/vectorize/indexes">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">create</a>({ ...params }) -> CreateIndex | null</code> |
| 5540 | - <code title="put /accounts/{account_id}/vectorize/indexes/{index_name}">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">update</a>(indexName, { ...params }) -> CreateIndex | null</code> |
| 5541 | - <code title="get /accounts/{account_id}/vectorize/indexes">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">list</a>({ ...params }) -> CreateIndicesSinglePage</code> |
| 5542 | - <code title="delete /accounts/{account_id}/vectorize/indexes/{index_name}">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">delete</a>(indexName, { ...params }) -> IndexDeleteResponse</code> |
| 5543 | - <code title="post /accounts/{account_id}/vectorize/indexes/{index_name}/delete-by-ids">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">deleteByIds</a>(indexName, { ...params }) -> IndexDeleteVectorsByID | null</code> |
| 5544 | - <code title="get /accounts/{account_id}/vectorize/indexes/{index_name}">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">get</a>(indexName, { ...params }) -> CreateIndex | null</code> |
| 5545 | - <code title="post /accounts/{account_id}/vectorize/indexes/{index_name}/get-by-ids">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">getByIds</a>(indexName, { ...params }) -> IndexGetByIDsResponse | null</code> |
| 5546 | - <code title="post /accounts/{account_id}/vectorize/indexes/{index_name}/insert">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">insert</a>(indexName, { ...params }) -> IndexInsert | null</code> |
| 5547 | - <code title="post /accounts/{account_id}/vectorize/indexes/{index_name}/query">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">query</a>(indexName, { ...params }) -> IndexQuery | null</code> |
| 5548 | - <code title="post /accounts/{account_id}/vectorize/indexes/{index_name}/upsert">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">upsert</a>(indexName, { ...params }) -> IndexUpsert | null</code> |
| 5549 | |
| 5550 | # URLScanner |
| 5551 | |
| 5552 | Types: |
| 5553 | |
| 5554 | - <code><a href="./src/resources/url-scanner/url-scanner.ts">URLScannerScanResponse</a></code> |
| 5555 | |
| 5556 | Methods: |
| 5557 | |
| 5558 | - <code title="get /accounts/{accountId}/urlscanner/scan">client.urlScanner.<a href="./src/resources/url-scanner/url-scanner.ts">scan</a>(accountId, { ...params }) -> URLScannerScanResponse</code> |
| 5559 | |
| 5560 | ## Scans |
| 5561 | |
| 5562 | Types: |
| 5563 | |
| 5564 | - <code><a href="./src/resources/url-scanner/scans.ts">URLScannerDomain</a></code> |
| 5565 | - <code><a href="./src/resources/url-scanner/scans.ts">URLScannerTask</a></code> |
| 5566 | - <code><a href="./src/resources/url-scanner/scans.ts">ScanCreateResponse</a></code> |
| 5567 | - <code><a href="./src/resources/url-scanner/scans.ts">ScanGetResponse</a></code> |
| 5568 | - <code><a href="./src/resources/url-scanner/scans.ts">ScanHarResponse</a></code> |
| 5569 | |
| 5570 | Methods: |
| 5571 | |
| 5572 | - <code title="post /accounts/{accountId}/urlscanner/scan">client.urlScanner.scans.<a href="./src/resources/url-scanner/scans.ts">create</a>(accountId, { ...params }) -> ScanCreateResponse</code> |
| 5573 | - <code title="get /accounts/{accountId}/urlscanner/scan/{scanId}">client.urlScanner.scans.<a href="./src/resources/url-scanner/scans.ts">get</a>(accountId, scanId) -> ScanGetResponse</code> |
| 5574 | - <code title="get /accounts/{accountId}/urlscanner/scan/{scanId}/har">client.urlScanner.scans.<a href="./src/resources/url-scanner/scans.ts">har</a>(accountId, scanId) -> ScanHarResponse</code> |
| 5575 | - <code title="get /accounts/{accountId}/urlscanner/scan/{scanId}/screenshot">client.urlScanner.scans.<a href="./src/resources/url-scanner/scans.ts">screenshot</a>(accountId, scanId, { ...params }) -> Response</code> |
| 5576 | |
| 5577 | # Radar |
| 5578 | |
| 5579 | ## Annotations |
| 5580 | |
| 5581 | ### Outages |
| 5582 | |
| 5583 | Types: |
| 5584 | |
| 5585 | - <code><a href="./src/resources/radar/annotations/outages.ts">OutageGetResponse</a></code> |
| 5586 | - <code><a href="./src/resources/radar/annotations/outages.ts">OutageLocationsResponse</a></code> |
| 5587 | |
| 5588 | Methods: |
| 5589 | |
| 5590 | - <code title="get /radar/annotations/outages">client.radar.annotations.outages.<a href="./src/resources/radar/annotations/outages.ts">get</a>({ ...params }) -> OutageGetResponse</code> |
| 5591 | - <code title="get /radar/annotations/outages/locations">client.radar.annotations.outages.<a href="./src/resources/radar/annotations/outages.ts">locations</a>({ ...params }) -> OutageLocationsResponse</code> |
| 5592 | |
| 5593 | ## BGP |
| 5594 | |
| 5595 | Types: |
| 5596 | |
| 5597 | - <code><a href="./src/resources/radar/bgp/bgp.ts">BGPTimeseriesResponse</a></code> |
| 5598 | |
| 5599 | Methods: |
| 5600 | |
| 5601 | - <code title="get /radar/bgp/timeseries">client.radar.bgp.<a href="./src/resources/radar/bgp/bgp.ts">timeseries</a>({ ...params }) -> BGPTimeseriesResponse</code> |
| 5602 | |
| 5603 | ### Leaks |
| 5604 | |
| 5605 | #### Events |
| 5606 | |
| 5607 | Types: |
| 5608 | |
| 5609 | - <code><a href="./src/resources/radar/bgp/leaks/events.ts">EventListResponse</a></code> |
| 5610 | |
| 5611 | Methods: |
| 5612 | |
| 5613 | - <code title="get /radar/bgp/leaks/events">client.radar.bgp.leaks.events.<a href="./src/resources/radar/bgp/leaks/events.ts">list</a>({ ...params }) -> EventListResponsesV4PagePagination</code> |
| 5614 | |
| 5615 | ### Top |
| 5616 | |
| 5617 | Types: |
| 5618 | |
| 5619 | - <code><a href="./src/resources/radar/bgp/top/top.ts">TopPrefixesResponse</a></code> |
| 5620 | |
| 5621 | Methods: |
| 5622 | |
| 5623 | - <code title="get /radar/bgp/top/prefixes">client.radar.bgp.top.<a href="./src/resources/radar/bgp/top/top.ts">prefixes</a>({ ...params }) -> TopPrefixesResponse</code> |
| 5624 | |
| 5625 | #### Ases |
| 5626 | |
| 5627 | Types: |
| 5628 | |
| 5629 | - <code><a href="./src/resources/radar/bgp/top/ases.ts">AseGetResponse</a></code> |
| 5630 | - <code><a href="./src/resources/radar/bgp/top/ases.ts">AsePrefixesResponse</a></code> |
| 5631 | |
| 5632 | Methods: |
| 5633 | |
| 5634 | - <code title="get /radar/bgp/top/ases">client.radar.bgp.top.ases.<a href="./src/resources/radar/bgp/top/ases.ts">get</a>({ ...params }) -> AseGetResponse</code> |
| 5635 | - <code title="get /radar/bgp/top/ases/prefixes">client.radar.bgp.top.ases.<a href="./src/resources/radar/bgp/top/ases.ts">prefixes</a>({ ...params }) -> AsePrefixesResponse</code> |
| 5636 | |
| 5637 | ### Hijacks |
| 5638 | |
| 5639 | #### Events |
| 5640 | |
| 5641 | Types: |
| 5642 | |
| 5643 | - <code><a href="./src/resources/radar/bgp/hijacks/events.ts">EventListResponse</a></code> |
| 5644 | |
| 5645 | Methods: |
| 5646 | |
| 5647 | - <code title="get /radar/bgp/hijacks/events">client.radar.bgp.hijacks.events.<a href="./src/resources/radar/bgp/hijacks/events.ts">list</a>({ ...params }) -> EventListResponsesV4PagePagination</code> |
| 5648 | |
| 5649 | ### Routes |
| 5650 | |
| 5651 | Types: |
| 5652 | |
| 5653 | - <code><a href="./src/resources/radar/bgp/routes.ts">RouteAsesResponse</a></code> |
| 5654 | - <code><a href="./src/resources/radar/bgp/routes.ts">RouteMoasResponse</a></code> |
| 5655 | - <code><a href="./src/resources/radar/bgp/routes.ts">RoutePfx2asResponse</a></code> |
| 5656 | - <code><a href="./src/resources/radar/bgp/routes.ts">RouteStatsResponse</a></code> |
| 5657 | |
| 5658 | Methods: |
| 5659 | |
| 5660 | - <code title="get /radar/bgp/routes/ases">client.radar.bgp.routes.<a href="./src/resources/radar/bgp/routes.ts">ases</a>({ ...params }) -> RouteAsesResponse</code> |
| 5661 | - <code title="get /radar/bgp/routes/moas">client.radar.bgp.routes.<a href="./src/resources/radar/bgp/routes.ts">moas</a>({ ...params }) -> RouteMoasResponse</code> |
| 5662 | - <code title="get /radar/bgp/routes/pfx2as">client.radar.bgp.routes.<a href="./src/resources/radar/bgp/routes.ts">pfx2as</a>({ ...params }) -> RoutePfx2asResponse</code> |
| 5663 | - <code title="get /radar/bgp/routes/stats">client.radar.bgp.routes.<a href="./src/resources/radar/bgp/routes.ts">stats</a>({ ...params }) -> RouteStatsResponse</code> |
| 5664 | |
| 5665 | ### IPs |
| 5666 | |
| 5667 | Types: |
| 5668 | |
| 5669 | - <code><a href="./src/resources/radar/bgp/ips.ts">IPTimeseriesResponse</a></code> |
| 5670 | |
| 5671 | Methods: |
| 5672 | |
| 5673 | - <code title="get /radar/bgp/ips/timeseries">client.radar.bgp.ips.<a href="./src/resources/radar/bgp/ips.ts">timeseries</a>({ ...params }) -> IPTimeseriesResponse</code> |
| 5674 | |
| 5675 | ## Datasets |
| 5676 | |
| 5677 | Types: |
| 5678 | |
| 5679 | - <code><a href="./src/resources/radar/datasets.ts">DatasetListResponse</a></code> |
| 5680 | - <code><a href="./src/resources/radar/datasets.ts">DatasetDownloadResponse</a></code> |
| 5681 | - <code><a href="./src/resources/radar/datasets.ts">DatasetGetResponse</a></code> |
| 5682 | |
| 5683 | Methods: |
| 5684 | |
| 5685 | - <code title="get /radar/datasets">client.radar.datasets.<a href="./src/resources/radar/datasets.ts">list</a>({ ...params }) -> DatasetListResponse</code> |
| 5686 | - <code title="post /radar/datasets/download">client.radar.datasets.<a href="./src/resources/radar/datasets.ts">download</a>({ ...params }) -> DatasetDownloadResponse</code> |
| 5687 | - <code title="get /radar/datasets/{alias}">client.radar.datasets.<a href="./src/resources/radar/datasets.ts">get</a>(alias, { ...params }) -> string</code> |
| 5688 | |
| 5689 | ## DNS |
| 5690 | |
| 5691 | ### Top |
| 5692 | |
| 5693 | Types: |
| 5694 | |
| 5695 | - <code><a href="./src/resources/radar/dns/top.ts">TopAsesResponse</a></code> |
| 5696 | - <code><a href="./src/resources/radar/dns/top.ts">TopLocationsResponse</a></code> |
| 5697 | |
| 5698 | Methods: |
| 5699 | |
| 5700 | - <code title="get /radar/dns/top/ases">client.radar.dns.top.<a href="./src/resources/radar/dns/top.ts">ases</a>({ ...params }) -> TopAsesResponse</code> |
| 5701 | - <code title="get /radar/dns/top/locations">client.radar.dns.top.<a href="./src/resources/radar/dns/top.ts">locations</a>({ ...params }) -> TopLocationsResponse</code> |
| 5702 | |
| 5703 | ## Netflows |
| 5704 | |
| 5705 | Types: |
| 5706 | |
| 5707 | - <code><a href="./src/resources/radar/netflows/netflows.ts">NetflowTimeseriesResponse</a></code> |
| 5708 | |
| 5709 | Methods: |
| 5710 | |
| 5711 | - <code title="get /radar/netflows/timeseries">client.radar.netflows.<a href="./src/resources/radar/netflows/netflows.ts">timeseries</a>({ ...params }) -> NetflowTimeseriesResponse</code> |
| 5712 | |
| 5713 | ### Top |
| 5714 | |
| 5715 | Types: |
| 5716 | |
| 5717 | - <code><a href="./src/resources/radar/netflows/top.ts">TopAsesResponse</a></code> |
| 5718 | - <code><a href="./src/resources/radar/netflows/top.ts">TopLocationsResponse</a></code> |
| 5719 | |
| 5720 | Methods: |
| 5721 | |
| 5722 | - <code title="get /radar/netflows/top/ases">client.radar.netflows.top.<a href="./src/resources/radar/netflows/top.ts">ases</a>({ ...params }) -> TopAsesResponse</code> |
| 5723 | - <code title="get /radar/netflows/top/locations">client.radar.netflows.top.<a href="./src/resources/radar/netflows/top.ts">locations</a>({ ...params }) -> TopLocationsResponse</code> |
| 5724 | |
| 5725 | ## Search |
| 5726 | |
| 5727 | Types: |
| 5728 | |
| 5729 | - <code><a href="./src/resources/radar/search.ts">SearchGlobalResponse</a></code> |
| 5730 | |
| 5731 | Methods: |
| 5732 | |
| 5733 | - <code title="get /radar/search/global">client.radar.search.<a href="./src/resources/radar/search.ts">global</a>({ ...params }) -> SearchGlobalResponse</code> |
| 5734 | |
| 5735 | ## VerifiedBots |
| 5736 | |
| 5737 | ### Top |
| 5738 | |
| 5739 | Types: |
| 5740 | |
| 5741 | - <code><a href="./src/resources/radar/verified-bots/top.ts">TopBotsResponse</a></code> |
| 5742 | - <code><a href="./src/resources/radar/verified-bots/top.ts">TopCategoriesResponse</a></code> |
| 5743 | |
| 5744 | Methods: |
| 5745 | |
| 5746 | - <code title="get /radar/verified_bots/top/bots">client.radar.verifiedBots.top.<a href="./src/resources/radar/verified-bots/top.ts">bots</a>({ ...params }) -> TopBotsResponse</code> |
| 5747 | - <code title="get /radar/verified_bots/top/categories">client.radar.verifiedBots.top.<a href="./src/resources/radar/verified-bots/top.ts">categories</a>({ ...params }) -> TopCategoriesResponse</code> |
| 5748 | |
| 5749 | ## AS112 |
| 5750 | |
| 5751 | Types: |
| 5752 | |
| 5753 | - <code><a href="./src/resources/radar/as112/as112.ts">AS112TimeseriesResponse</a></code> |
| 5754 | |
| 5755 | Methods: |
| 5756 | |
| 5757 | - <code title="get /radar/as112/timeseries">client.radar.as112.<a href="./src/resources/radar/as112/as112.ts">timeseries</a>({ ...params }) -> AS112TimeseriesResponse</code> |
| 5758 | |
| 5759 | ### Summary |
| 5760 | |
| 5761 | Types: |
| 5762 | |
| 5763 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryDNSSECResponse</a></code> |
| 5764 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryEdnsResponse</a></code> |
| 5765 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryIPVersionResponse</a></code> |
| 5766 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryProtocolResponse</a></code> |
| 5767 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryQueryTypeResponse</a></code> |
| 5768 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryResponseCodesResponse</a></code> |
| 5769 | |
| 5770 | Methods: |
| 5771 | |
| 5772 | - <code title="get /radar/as112/summary/dnssec">client.radar.as112.summary.<a href="./src/resources/radar/as112/summary.ts">dnssec</a>({ ...params }) -> SummaryDNSSECResponse</code> |
| 5773 | - <code title="get /radar/as112/summary/edns">client.radar.as112.summary.<a href="./src/resources/radar/as112/summary.ts">edns</a>({ ...params }) -> SummaryEdnsResponse</code> |
| 5774 | - <code title="get /radar/as112/summary/ip_version">client.radar.as112.summary.<a href="./src/resources/radar/as112/summary.ts">ipVersion</a>({ ...params }) -> SummaryIPVersionResponse</code> |
| 5775 | - <code title="get /radar/as112/summary/protocol">client.radar.as112.summary.<a href="./src/resources/radar/as112/summary.ts">protocol</a>({ ...params }) -> SummaryProtocolResponse</code> |
| 5776 | - <code title="get /radar/as112/summary/query_type">client.radar.as112.summary.<a href="./src/resources/radar/as112/summary.ts">queryType</a>({ ...params }) -> SummaryQueryTypeResponse</code> |
| 5777 | - <code title="get /radar/as112/summary/response_codes">client.radar.as112.summary.<a href="./src/resources/radar/as112/summary.ts">responseCodes</a>({ ...params }) -> SummaryResponseCodesResponse</code> |
| 5778 | |
| 5779 | ### TimeseriesGroups |
| 5780 | |
| 5781 | Types: |
| 5782 | |
| 5783 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupDNSSECResponse</a></code> |
| 5784 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupEdnsResponse</a></code> |
| 5785 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 5786 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupProtocolResponse</a></code> |
| 5787 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupQueryTypeResponse</a></code> |
| 5788 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupResponseCodesResponse</a></code> |
| 5789 | |
| 5790 | Methods: |
| 5791 | |
| 5792 | - <code title="get /radar/as112/timeseries_groups/dnssec">client.radar.as112.timeseriesGroups.<a href="./src/resources/radar/as112/timeseries-groups.ts">dnssec</a>({ ...params }) -> TimeseriesGroupDNSSECResponse</code> |
| 5793 | - <code title="get /radar/as112/timeseries_groups/edns">client.radar.as112.timeseriesGroups.<a href="./src/resources/radar/as112/timeseries-groups.ts">edns</a>({ ...params }) -> TimeseriesGroupEdnsResponse</code> |
| 5794 | - <code title="get /radar/as112/timeseries_groups/ip_version">client.radar.as112.timeseriesGroups.<a href="./src/resources/radar/as112/timeseries-groups.ts">ipVersion</a>({ ...params }) -> TimeseriesGroupIPVersionResponse</code> |
| 5795 | - <code title="get /radar/as112/timeseries_groups/protocol">client.radar.as112.timeseriesGroups.<a href="./src/resources/radar/as112/timeseries-groups.ts">protocol</a>({ ...params }) -> TimeseriesGroupProtocolResponse</code> |
| 5796 | - <code title="get /radar/as112/timeseries_groups/query_type">client.radar.as112.timeseriesGroups.<a href="./src/resources/radar/as112/timeseries-groups.ts">queryType</a>({ ...params }) -> TimeseriesGroupQueryTypeResponse</code> |
| 5797 | - <code title="get /radar/as112/timeseries_groups/response_codes">client.radar.as112.timeseriesGroups.<a href="./src/resources/radar/as112/timeseries-groups.ts">responseCodes</a>({ ...params }) -> TimeseriesGroupResponseCodesResponse</code> |
| 5798 | |
| 5799 | ### Top |
| 5800 | |
| 5801 | Types: |
| 5802 | |
| 5803 | - <code><a href="./src/resources/radar/as112/top.ts">TopDNSSECResponse</a></code> |
| 5804 | - <code><a href="./src/resources/radar/as112/top.ts">TopEdnsResponse</a></code> |
| 5805 | - <code><a href="./src/resources/radar/as112/top.ts">TopIPVersionResponse</a></code> |
| 5806 | - <code><a href="./src/resources/radar/as112/top.ts">TopLocationsResponse</a></code> |
| 5807 | |
| 5808 | Methods: |
| 5809 | |
| 5810 | - <code title="get /radar/as112/top/locations/dnssec/{dnssec}">client.radar.as112.top.<a href="./src/resources/radar/as112/top.ts">dnssec</a>(dnssec, { ...params }) -> TopDNSSECResponse</code> |
| 5811 | - <code title="get /radar/as112/top/locations/edns/{edns}">client.radar.as112.top.<a href="./src/resources/radar/as112/top.ts">edns</a>(edns, { ...params }) -> TopEdnsResponse</code> |
| 5812 | - <code title="get /radar/as112/top/locations/ip_version/{ip_version}">client.radar.as112.top.<a href="./src/resources/radar/as112/top.ts">ipVersion</a>(ipVersion, { ...params }) -> TopIPVersionResponse</code> |
| 5813 | - <code title="get /radar/as112/top/locations">client.radar.as112.top.<a href="./src/resources/radar/as112/top.ts">locations</a>({ ...params }) -> TopLocationsResponse</code> |
| 5814 | |
| 5815 | ## ConnectionTampering |
| 5816 | |
| 5817 | Types: |
| 5818 | |
| 5819 | - <code><a href="./src/resources/radar/connection-tampering.ts">ConnectionTamperingSummaryResponse</a></code> |
| 5820 | - <code><a href="./src/resources/radar/connection-tampering.ts">ConnectionTamperingTimeseriesGroupsResponse</a></code> |
| 5821 | |
| 5822 | Methods: |
| 5823 | |
| 5824 | - <code title="get /radar/connection_tampering/summary">client.radar.connectionTampering.<a href="./src/resources/radar/connection-tampering.ts">summary</a>({ ...params }) -> ConnectionTamperingSummaryResponse</code> |
| 5825 | - <code title="get /radar/connection_tampering/timeseries_groups">client.radar.connectionTampering.<a href="./src/resources/radar/connection-tampering.ts">timeseriesGroups</a>({ ...params }) -> ConnectionTamperingTimeseriesGroupsResponse</code> |
| 5826 | |
| 5827 | ## Email |
| 5828 | |
| 5829 | Types: |
| 5830 | |
| 5831 | - <code><a href="./src/resources/radar/email/email.ts">RadarEmailSeries</a></code> |
| 5832 | - <code><a href="./src/resources/radar/email/email.ts">RadarEmailSummary</a></code> |
| 5833 | |
| 5834 | ### Routing |
| 5835 | |
| 5836 | #### Summary |
| 5837 | |
| 5838 | Types: |
| 5839 | |
| 5840 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryARCResponse</a></code> |
| 5841 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryDKIMResponse</a></code> |
| 5842 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryDMARCResponse</a></code> |
| 5843 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryEncryptedResponse</a></code> |
| 5844 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryIPVersionResponse</a></code> |
| 5845 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummarySPFResponse</a></code> |
| 5846 | |
| 5847 | Methods: |
| 5848 | |
| 5849 | - <code title="get /radar/email/routing/summary/arc">client.radar.email.routing.summary.<a href="./src/resources/radar/email/routing/summary.ts">arc</a>({ ...params }) -> SummaryARCResponse</code> |
| 5850 | - <code title="get /radar/email/routing/summary/dkim">client.radar.email.routing.summary.<a href="./src/resources/radar/email/routing/summary.ts">dkim</a>({ ...params }) -> SummaryDKIMResponse</code> |
| 5851 | - <code title="get /radar/email/routing/summary/dmarc">client.radar.email.routing.summary.<a href="./src/resources/radar/email/routing/summary.ts">dmarc</a>({ ...params }) -> SummaryDMARCResponse</code> |
| 5852 | - <code title="get /radar/email/routing/summary/encrypted">client.radar.email.routing.summary.<a href="./src/resources/radar/email/routing/summary.ts">encrypted</a>({ ...params }) -> SummaryEncryptedResponse</code> |
| 5853 | - <code title="get /radar/email/routing/summary/ip_version">client.radar.email.routing.summary.<a href="./src/resources/radar/email/routing/summary.ts">ipVersion</a>({ ...params }) -> SummaryIPVersionResponse</code> |
| 5854 | - <code title="get /radar/email/routing/summary/spf">client.radar.email.routing.summary.<a href="./src/resources/radar/email/routing/summary.ts">spf</a>({ ...params }) -> SummarySPFResponse</code> |
| 5855 | |
| 5856 | #### TimeseriesGroups |
| 5857 | |
| 5858 | Types: |
| 5859 | |
| 5860 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupARCResponse</a></code> |
| 5861 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupDKIMResponse</a></code> |
| 5862 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupDMARCResponse</a></code> |
| 5863 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupEncryptedResponse</a></code> |
| 5864 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 5865 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupSPFResponse</a></code> |
| 5866 | |
| 5867 | Methods: |
| 5868 | |
| 5869 | - <code title="get /radar/email/routing/timeseries_groups/arc">client.radar.email.routing.timeseriesGroups.<a href="./src/resources/radar/email/routing/timeseries-groups.ts">arc</a>({ ...params }) -> TimeseriesGroupARCResponse</code> |
| 5870 | - <code title="get /radar/email/routing/timeseries_groups/dkim">client.radar.email.routing.timeseriesGroups.<a href="./src/resources/radar/email/routing/timeseries-groups.ts">dkim</a>({ ...params }) -> TimeseriesGroupDKIMResponse</code> |
| 5871 | - <code title="get /radar/email/routing/timeseries_groups/dmarc">client.radar.email.routing.timeseriesGroups.<a href="./src/resources/radar/email/routing/timeseries-groups.ts">dmarc</a>({ ...params }) -> TimeseriesGroupDMARCResponse</code> |
| 5872 | - <code title="get /radar/email/routing/timeseries_groups/encrypted">client.radar.email.routing.timeseriesGroups.<a href="./src/resources/radar/email/routing/timeseries-groups.ts">encrypted</a>({ ...params }) -> TimeseriesGroupEncryptedResponse</code> |
| 5873 | - <code title="get /radar/email/routing/timeseries_groups/ip_version">client.radar.email.routing.timeseriesGroups.<a href="./src/resources/radar/email/routing/timeseries-groups.ts">ipVersion</a>({ ...params }) -> TimeseriesGroupIPVersionResponse</code> |
| 5874 | - <code title="get /radar/email/routing/timeseries_groups/spf">client.radar.email.routing.timeseriesGroups.<a href="./src/resources/radar/email/routing/timeseries-groups.ts">spf</a>({ ...params }) -> TimeseriesGroupSPFResponse</code> |
| 5875 | |
| 5876 | ### Security |
| 5877 | |
| 5878 | #### Top |
| 5879 | |
| 5880 | ##### Tlds |
| 5881 | |
| 5882 | Types: |
| 5883 | |
| 5884 | - <code><a href="./src/resources/radar/email/security/top/tlds/tlds.ts">TldGetResponse</a></code> |
| 5885 | |
| 5886 | Methods: |
| 5887 | |
| 5888 | - <code title="get /radar/email/security/top/tlds">client.radar.email.security.top.tlds.<a href="./src/resources/radar/email/security/top/tlds/tlds.ts">get</a>({ ...params }) -> TldGetResponse</code> |
| 5889 | |
| 5890 | ###### Malicious |
| 5891 | |
| 5892 | Types: |
| 5893 | |
| 5894 | - <code><a href="./src/resources/radar/email/security/top/tlds/malicious.ts">MaliciousGetResponse</a></code> |
| 5895 | |
| 5896 | Methods: |
| 5897 | |
| 5898 | - <code title="get /radar/email/security/top/tlds/malicious/{malicious}">client.radar.email.security.top.tlds.malicious.<a href="./src/resources/radar/email/security/top/tlds/malicious.ts">get</a>(malicious, { ...params }) -> MaliciousGetResponse</code> |
| 5899 | |
| 5900 | ###### Spam |
| 5901 | |
| 5902 | Types: |
| 5903 | |
| 5904 | - <code><a href="./src/resources/radar/email/security/top/tlds/spam.ts">SpamGetResponse</a></code> |
| 5905 | |
| 5906 | Methods: |
| 5907 | |
| 5908 | - <code title="get /radar/email/security/top/tlds/spam/{spam}">client.radar.email.security.top.tlds.spam.<a href="./src/resources/radar/email/security/top/tlds/spam.ts">get</a>(spam, { ...params }) -> SpamGetResponse</code> |
| 5909 | |
| 5910 | ###### Spoof |
| 5911 | |
| 5912 | Types: |
| 5913 | |
| 5914 | - <code><a href="./src/resources/radar/email/security/top/tlds/spoof.ts">SpoofGetResponse</a></code> |
| 5915 | |
| 5916 | Methods: |
| 5917 | |
| 5918 | - <code title="get /radar/email/security/top/tlds/spoof/{spoof}">client.radar.email.security.top.tlds.spoof.<a href="./src/resources/radar/email/security/top/tlds/spoof.ts">get</a>(spoof, { ...params }) -> SpoofGetResponse</code> |
| 5919 | |
| 5920 | #### Summary |
| 5921 | |
| 5922 | Types: |
| 5923 | |
| 5924 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryARCResponse</a></code> |
| 5925 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryDKIMResponse</a></code> |
| 5926 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryDMARCResponse</a></code> |
| 5927 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryMaliciousResponse</a></code> |
| 5928 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummarySpamResponse</a></code> |
| 5929 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummarySPFResponse</a></code> |
| 5930 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummarySpoofResponse</a></code> |
| 5931 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryThreatCategoryResponse</a></code> |
| 5932 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryTLSVersionResponse</a></code> |
| 5933 | |
| 5934 | Methods: |
| 5935 | |
| 5936 | - <code title="get /radar/email/security/summary/arc">client.radar.email.security.summary.<a href="./src/resources/radar/email/security/summary.ts">arc</a>({ ...params }) -> SummaryARCResponse</code> |
| 5937 | - <code title="get /radar/email/security/summary/dkim">client.radar.email.security.summary.<a href="./src/resources/radar/email/security/summary.ts">dkim</a>({ ...params }) -> SummaryDKIMResponse</code> |
| 5938 | - <code title="get /radar/email/security/summary/dmarc">client.radar.email.security.summary.<a href="./src/resources/radar/email/security/summary.ts">dmarc</a>({ ...params }) -> SummaryDMARCResponse</code> |
| 5939 | - <code title="get /radar/email/security/summary/malicious">client.radar.email.security.summary.<a href="./src/resources/radar/email/security/summary.ts">malicious</a>({ ...params }) -> SummaryMaliciousResponse</code> |
| 5940 | - <code title="get /radar/email/security/summary/spam">client.radar.email.security.summary.<a href="./src/resources/radar/email/security/summary.ts">spam</a>({ ...params }) -> SummarySpamResponse</code> |
| 5941 | - <code title="get /radar/email/security/summary/spf">client.radar.email.security.summary.<a href="./src/resources/radar/email/security/summary.ts">spf</a>({ ...params }) -> SummarySPFResponse</code> |
| 5942 | - <code title="get /radar/email/security/summary/spoof">client.radar.email.security.summary.<a href="./src/resources/radar/email/security/summary.ts">spoof</a>({ ...params }) -> SummarySpoofResponse</code> |
| 5943 | - <code title="get /radar/email/security/summary/threat_category">client.radar.email.security.summary.<a href="./src/resources/radar/email/security/summary.ts">threatCategory</a>({ ...params }) -> SummaryThreatCategoryResponse</code> |
| 5944 | - <code title="get /radar/email/security/summary/tls_version">client.radar.email.security.summary.<a href="./src/resources/radar/email/security/summary.ts">tlsVersion</a>({ ...params }) -> SummaryTLSVersionResponse</code> |
| 5945 | |
| 5946 | #### TimeseriesGroups |
| 5947 | |
| 5948 | Types: |
| 5949 | |
| 5950 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupARCResponse</a></code> |
| 5951 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupDKIMResponse</a></code> |
| 5952 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupDMARCResponse</a></code> |
| 5953 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupMaliciousResponse</a></code> |
| 5954 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupSpamResponse</a></code> |
| 5955 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupSPFResponse</a></code> |
| 5956 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupSpoofResponse</a></code> |
| 5957 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupThreatCategoryResponse</a></code> |
| 5958 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupTLSVersionResponse</a></code> |
| 5959 | |
| 5960 | Methods: |
| 5961 | |
| 5962 | - <code title="get /radar/email/security/timeseries_groups/arc">client.radar.email.security.timeseriesGroups.<a href="./src/resources/radar/email/security/timeseries-groups.ts">arc</a>({ ...params }) -> TimeseriesGroupARCResponse</code> |
| 5963 | - <code title="get /radar/email/security/timeseries_groups/dkim">client.radar.email.security.timeseriesGroups.<a href="./src/resources/radar/email/security/timeseries-groups.ts">dkim</a>({ ...params }) -> TimeseriesGroupDKIMResponse</code> |
| 5964 | - <code title="get /radar/email/security/timeseries_groups/dmarc">client.radar.email.security.timeseriesGroups.<a href="./src/resources/radar/email/security/timeseries-groups.ts">dmarc</a>({ ...params }) -> TimeseriesGroupDMARCResponse</code> |
| 5965 | - <code title="get /radar/email/security/timeseries_groups/malicious">client.radar.email.security.timeseriesGroups.<a href="./src/resources/radar/email/security/timeseries-groups.ts">malicious</a>({ ...params }) -> TimeseriesGroupMaliciousResponse</code> |
| 5966 | - <code title="get /radar/email/security/timeseries_groups/spam">client.radar.email.security.timeseriesGroups.<a href="./src/resources/radar/email/security/timeseries-groups.ts">spam</a>({ ...params }) -> TimeseriesGroupSpamResponse</code> |
| 5967 | - <code title="get /radar/email/security/timeseries_groups/spf">client.radar.email.security.timeseriesGroups.<a href="./src/resources/radar/email/security/timeseries-groups.ts">spf</a>({ ...params }) -> TimeseriesGroupSPFResponse</code> |
| 5968 | - <code title="get /radar/email/security/timeseries_groups/spoof">client.radar.email.security.timeseriesGroups.<a href="./src/resources/radar/email/security/timeseries-groups.ts">spoof</a>({ ...params }) -> TimeseriesGroupSpoofResponse</code> |
| 5969 | - <code title="get /radar/email/security/timeseries_groups/threat_category">client.radar.email.security.timeseriesGroups.<a href="./src/resources/radar/email/security/timeseries-groups.ts">threatCategory</a>({ ...params }) -> TimeseriesGroupThreatCategoryResponse</code> |
| 5970 | - <code title="get /radar/email/security/timeseries_groups/tls_version">client.radar.email.security.timeseriesGroups.<a href="./src/resources/radar/email/security/timeseries-groups.ts">tlsVersion</a>({ ...params }) -> TimeseriesGroupTLSVersionResponse</code> |
| 5971 | |
| 5972 | ## Attacks |
| 5973 | |
| 5974 | ### Layer3 |
| 5975 | |
| 5976 | Types: |
| 5977 | |
| 5978 | - <code><a href="./src/resources/radar/attacks/layer3/layer3.ts">Layer3TimeseriesResponse</a></code> |
| 5979 | |
| 5980 | Methods: |
| 5981 | |
| 5982 | - <code title="get /radar/attacks/layer3/timeseries">client.radar.attacks.layer3.<a href="./src/resources/radar/attacks/layer3/layer3.ts">timeseries</a>({ ...params }) -> Layer3TimeseriesResponse</code> |
| 5983 | |
| 5984 | #### Summary |
| 5985 | |
| 5986 | Types: |
| 5987 | |
| 5988 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryBitrateResponse</a></code> |
| 5989 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryDurationResponse</a></code> |
| 5990 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryGetResponse</a></code> |
| 5991 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryIPVersionResponse</a></code> |
| 5992 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryProtocolResponse</a></code> |
| 5993 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryVectorResponse</a></code> |
| 5994 | |
| 5995 | Methods: |
| 5996 | |
| 5997 | - <code title="get /radar/attacks/layer3/summary/bitrate">client.radar.attacks.layer3.summary.<a href="./src/resources/radar/attacks/layer3/summary.ts">bitrate</a>({ ...params }) -> SummaryBitrateResponse</code> |
| 5998 | - <code title="get /radar/attacks/layer3/summary/duration">client.radar.attacks.layer3.summary.<a href="./src/resources/radar/attacks/layer3/summary.ts">duration</a>({ ...params }) -> SummaryDurationResponse</code> |
| 5999 | - <code title="get /radar/attacks/layer3/summary">client.radar.attacks.layer3.summary.<a href="./src/resources/radar/attacks/layer3/summary.ts">get</a>({ ...params }) -> SummaryGetResponse</code> |
| 6000 | - <code title="get /radar/attacks/layer3/summary/ip_version">client.radar.attacks.layer3.summary.<a href="./src/resources/radar/attacks/layer3/summary.ts">ipVersion</a>({ ...params }) -> SummaryIPVersionResponse</code> |
| 6001 | - <code title="get /radar/attacks/layer3/summary/protocol">client.radar.attacks.layer3.summary.<a href="./src/resources/radar/attacks/layer3/summary.ts">protocol</a>({ ...params }) -> SummaryProtocolResponse</code> |
| 6002 | - <code title="get /radar/attacks/layer3/summary/vector">client.radar.attacks.layer3.summary.<a href="./src/resources/radar/attacks/layer3/summary.ts">vector</a>({ ...params }) -> SummaryVectorResponse</code> |
| 6003 | |
| 6004 | #### TimeseriesGroups |
| 6005 | |
| 6006 | Types: |
| 6007 | |
| 6008 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupBitrateResponse</a></code> |
| 6009 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupDurationResponse</a></code> |
| 6010 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupGetResponse</a></code> |
| 6011 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupIndustryResponse</a></code> |
| 6012 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 6013 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupProtocolResponse</a></code> |
| 6014 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupVectorResponse</a></code> |
| 6015 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupVerticalResponse</a></code> |
| 6016 | |
| 6017 | Methods: |
| 6018 | |
| 6019 | - <code title="get /radar/attacks/layer3/timeseries_groups/bitrate">client.radar.attacks.layer3.timeseriesGroups.<a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">bitrate</a>({ ...params }) -> TimeseriesGroupBitrateResponse</code> |
| 6020 | - <code title="get /radar/attacks/layer3/timeseries_groups/duration">client.radar.attacks.layer3.timeseriesGroups.<a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">duration</a>({ ...params }) -> TimeseriesGroupDurationResponse</code> |
| 6021 | - <code title="get /radar/attacks/layer3/timeseries_groups">client.radar.attacks.layer3.timeseriesGroups.<a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">get</a>({ ...params }) -> TimeseriesGroupGetResponse</code> |
| 6022 | - <code title="get /radar/attacks/layer3/timeseries_groups/industry">client.radar.attacks.layer3.timeseriesGroups.<a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">industry</a>({ ...params }) -> TimeseriesGroupIndustryResponse</code> |
| 6023 | - <code title="get /radar/attacks/layer3/timeseries_groups/ip_version">client.radar.attacks.layer3.timeseriesGroups.<a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">ipVersion</a>({ ...params }) -> TimeseriesGroupIPVersionResponse</code> |
| 6024 | - <code title="get /radar/attacks/layer3/timeseries_groups/protocol">client.radar.attacks.layer3.timeseriesGroups.<a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">protocol</a>({ ...params }) -> TimeseriesGroupProtocolResponse</code> |
| 6025 | - <code title="get /radar/attacks/layer3/timeseries_groups/vector">client.radar.attacks.layer3.timeseriesGroups.<a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">vector</a>({ ...params }) -> TimeseriesGroupVectorResponse</code> |
| 6026 | - <code title="get /radar/attacks/layer3/timeseries_groups/vertical">client.radar.attacks.layer3.timeseriesGroups.<a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">vertical</a>({ ...params }) -> TimeseriesGroupVerticalResponse</code> |
| 6027 | |
| 6028 | #### Top |
| 6029 | |
| 6030 | Types: |
| 6031 | |
| 6032 | - <code><a href="./src/resources/radar/attacks/layer3/top/top.ts">TopAttacksResponse</a></code> |
| 6033 | - <code><a href="./src/resources/radar/attacks/layer3/top/top.ts">TopIndustryResponse</a></code> |
| 6034 | - <code><a href="./src/resources/radar/attacks/layer3/top/top.ts">TopVerticalResponse</a></code> |
| 6035 | |
| 6036 | Methods: |
| 6037 | |
| 6038 | - <code title="get /radar/attacks/layer3/top/attacks">client.radar.attacks.layer3.top.<a href="./src/resources/radar/attacks/layer3/top/top.ts">attacks</a>({ ...params }) -> TopAttacksResponse</code> |
| 6039 | - <code title="get /radar/attacks/layer3/top/industry">client.radar.attacks.layer3.top.<a href="./src/resources/radar/attacks/layer3/top/top.ts">industry</a>({ ...params }) -> TopIndustryResponse</code> |
| 6040 | - <code title="get /radar/attacks/layer3/top/vertical">client.radar.attacks.layer3.top.<a href="./src/resources/radar/attacks/layer3/top/top.ts">vertical</a>({ ...params }) -> TopVerticalResponse</code> |
| 6041 | |
| 6042 | ##### Locations |
| 6043 | |
| 6044 | Types: |
| 6045 | |
| 6046 | - <code><a href="./src/resources/radar/attacks/layer3/top/locations.ts">LocationOriginResponse</a></code> |
| 6047 | - <code><a href="./src/resources/radar/attacks/layer3/top/locations.ts">LocationTargetResponse</a></code> |
| 6048 | |
| 6049 | Methods: |
| 6050 | |
| 6051 | - <code title="get /radar/attacks/layer3/top/locations/origin">client.radar.attacks.layer3.top.locations.<a href="./src/resources/radar/attacks/layer3/top/locations.ts">origin</a>({ ...params }) -> LocationOriginResponse</code> |
| 6052 | - <code title="get /radar/attacks/layer3/top/locations/target">client.radar.attacks.layer3.top.locations.<a href="./src/resources/radar/attacks/layer3/top/locations.ts">target</a>({ ...params }) -> LocationTargetResponse</code> |
| 6053 | |
| 6054 | ### Layer7 |
| 6055 | |
| 6056 | Types: |
| 6057 | |
| 6058 | - <code><a href="./src/resources/radar/attacks/layer7/layer7.ts">Layer7TimeseriesResponse</a></code> |
| 6059 | |
| 6060 | Methods: |
| 6061 | |
| 6062 | - <code title="get /radar/attacks/layer7/timeseries">client.radar.attacks.layer7.<a href="./src/resources/radar/attacks/layer7/layer7.ts">timeseries</a>({ ...params }) -> Layer7TimeseriesResponse</code> |
| 6063 | |
| 6064 | #### Summary |
| 6065 | |
| 6066 | Types: |
| 6067 | |
| 6068 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryGetResponse</a></code> |
| 6069 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryHTTPMethodResponse</a></code> |
| 6070 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryHTTPVersionResponse</a></code> |
| 6071 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryIPVersionResponse</a></code> |
| 6072 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryManagedRulesResponse</a></code> |
| 6073 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryMitigationProductResponse</a></code> |
| 6074 | |
| 6075 | Methods: |
| 6076 | |
| 6077 | - <code title="get /radar/attacks/layer7/summary">client.radar.attacks.layer7.summary.<a href="./src/resources/radar/attacks/layer7/summary.ts">get</a>({ ...params }) -> SummaryGetResponse</code> |
| 6078 | - <code title="get /radar/attacks/layer7/summary/http_method">client.radar.attacks.layer7.summary.<a href="./src/resources/radar/attacks/layer7/summary.ts">httpMethod</a>({ ...params }) -> SummaryHTTPMethodResponse</code> |
| 6079 | - <code title="get /radar/attacks/layer7/summary/http_version">client.radar.attacks.layer7.summary.<a href="./src/resources/radar/attacks/layer7/summary.ts">httpVersion</a>({ ...params }) -> SummaryHTTPVersionResponse</code> |
| 6080 | - <code title="get /radar/attacks/layer7/summary/ip_version">client.radar.attacks.layer7.summary.<a href="./src/resources/radar/attacks/layer7/summary.ts">ipVersion</a>({ ...params }) -> SummaryIPVersionResponse</code> |
| 6081 | - <code title="get /radar/attacks/layer7/summary/managed_rules">client.radar.attacks.layer7.summary.<a href="./src/resources/radar/attacks/layer7/summary.ts">managedRules</a>({ ...params }) -> SummaryManagedRulesResponse</code> |
| 6082 | - <code title="get /radar/attacks/layer7/summary/mitigation_product">client.radar.attacks.layer7.summary.<a href="./src/resources/radar/attacks/layer7/summary.ts">mitigationProduct</a>({ ...params }) -> SummaryMitigationProductResponse</code> |
| 6083 | |
| 6084 | #### TimeseriesGroups |
| 6085 | |
| 6086 | Types: |
| 6087 | |
| 6088 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupGetResponse</a></code> |
| 6089 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupHTTPMethodResponse</a></code> |
| 6090 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupHTTPVersionResponse</a></code> |
| 6091 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupIndustryResponse</a></code> |
| 6092 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 6093 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupManagedRulesResponse</a></code> |
| 6094 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupMitigationProductResponse</a></code> |
| 6095 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupVerticalResponse</a></code> |
| 6096 | |
| 6097 | Methods: |
| 6098 | |
| 6099 | - <code title="get /radar/attacks/layer7/timeseries_groups">client.radar.attacks.layer7.timeseriesGroups.<a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">get</a>({ ...params }) -> TimeseriesGroupGetResponse</code> |
| 6100 | - <code title="get /radar/attacks/layer7/timeseries_groups/http_method">client.radar.attacks.layer7.timeseriesGroups.<a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">httpMethod</a>({ ...params }) -> TimeseriesGroupHTTPMethodResponse</code> |
| 6101 | - <code title="get /radar/attacks/layer7/timeseries_groups/http_version">client.radar.attacks.layer7.timeseriesGroups.<a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">httpVersion</a>({ ...params }) -> TimeseriesGroupHTTPVersionResponse</code> |
| 6102 | - <code title="get /radar/attacks/layer7/timeseries_groups/industry">client.radar.attacks.layer7.timeseriesGroups.<a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">industry</a>({ ...params }) -> TimeseriesGroupIndustryResponse</code> |
| 6103 | - <code title="get /radar/attacks/layer7/timeseries_groups/ip_version">client.radar.attacks.layer7.timeseriesGroups.<a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">ipVersion</a>({ ...params }) -> TimeseriesGroupIPVersionResponse</code> |
| 6104 | - <code title="get /radar/attacks/layer7/timeseries_groups/managed_rules">client.radar.attacks.layer7.timeseriesGroups.<a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">managedRules</a>({ ...params }) -> TimeseriesGroupManagedRulesResponse</code> |
| 6105 | - <code title="get /radar/attacks/layer7/timeseries_groups/mitigation_product">client.radar.attacks.layer7.timeseriesGroups.<a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">mitigationProduct</a>({ ...params }) -> TimeseriesGroupMitigationProductResponse</code> |
| 6106 | - <code title="get /radar/attacks/layer7/timeseries_groups/vertical">client.radar.attacks.layer7.timeseriesGroups.<a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">vertical</a>({ ...params }) -> TimeseriesGroupVerticalResponse</code> |
| 6107 | |
| 6108 | #### Top |
| 6109 | |
| 6110 | Types: |
| 6111 | |
| 6112 | - <code><a href="./src/resources/radar/attacks/layer7/top/top.ts">TopAttacksResponse</a></code> |
| 6113 | - <code><a href="./src/resources/radar/attacks/layer7/top/top.ts">TopIndustryResponse</a></code> |
| 6114 | - <code><a href="./src/resources/radar/attacks/layer7/top/top.ts">TopVerticalResponse</a></code> |
| 6115 | |
| 6116 | Methods: |
| 6117 | |
| 6118 | - <code title="get /radar/attacks/layer7/top/attacks">client.radar.attacks.layer7.top.<a href="./src/resources/radar/attacks/layer7/top/top.ts">attacks</a>({ ...params }) -> TopAttacksResponse</code> |
| 6119 | - <code title="get /radar/attacks/layer7/top/industry">client.radar.attacks.layer7.top.<a href="./src/resources/radar/attacks/layer7/top/top.ts">industry</a>({ ...params }) -> TopIndustryResponse</code> |
| 6120 | - <code title="get /radar/attacks/layer7/top/vertical">client.radar.attacks.layer7.top.<a href="./src/resources/radar/attacks/layer7/top/top.ts">vertical</a>({ ...params }) -> TopVerticalResponse</code> |
| 6121 | |
| 6122 | ##### Locations |
| 6123 | |
| 6124 | Types: |
| 6125 | |
| 6126 | - <code><a href="./src/resources/radar/attacks/layer7/top/locations.ts">LocationOriginResponse</a></code> |
| 6127 | - <code><a href="./src/resources/radar/attacks/layer7/top/locations.ts">LocationTargetResponse</a></code> |
| 6128 | |
| 6129 | Methods: |
| 6130 | |
| 6131 | - <code title="get /radar/attacks/layer7/top/locations/origin">client.radar.attacks.layer7.top.locations.<a href="./src/resources/radar/attacks/layer7/top/locations.ts">origin</a>({ ...params }) -> LocationOriginResponse</code> |
| 6132 | - <code title="get /radar/attacks/layer7/top/locations/target">client.radar.attacks.layer7.top.locations.<a href="./src/resources/radar/attacks/layer7/top/locations.ts">target</a>({ ...params }) -> LocationTargetResponse</code> |
| 6133 | |
| 6134 | ##### Ases |
| 6135 | |
| 6136 | Types: |
| 6137 | |
| 6138 | - <code><a href="./src/resources/radar/attacks/layer7/top/ases.ts">AseOriginResponse</a></code> |
| 6139 | |
| 6140 | Methods: |
| 6141 | |
| 6142 | - <code title="get /radar/attacks/layer7/top/ases/origin">client.radar.attacks.layer7.top.ases.<a href="./src/resources/radar/attacks/layer7/top/ases.ts">origin</a>({ ...params }) -> AseOriginResponse</code> |
| 6143 | |
| 6144 | ## Entities |
| 6145 | |
| 6146 | Types: |
| 6147 | |
| 6148 | - <code><a href="./src/resources/radar/entities/entities.ts">EntityGetResponse</a></code> |
| 6149 | |
| 6150 | Methods: |
| 6151 | |
| 6152 | - <code title="get /radar/entities/ip">client.radar.entities.<a href="./src/resources/radar/entities/entities.ts">get</a>({ ...params }) -> EntityGetResponse</code> |
| 6153 | |
| 6154 | ### ASNs |
| 6155 | |
| 6156 | Types: |
| 6157 | |
| 6158 | - <code><a href="./src/resources/radar/entities/asns.ts">ASNListResponse</a></code> |
| 6159 | - <code><a href="./src/resources/radar/entities/asns.ts">ASNGetResponse</a></code> |
| 6160 | - <code><a href="./src/resources/radar/entities/asns.ts">ASNIPResponse</a></code> |
| 6161 | - <code><a href="./src/resources/radar/entities/asns.ts">ASNRelResponse</a></code> |
| 6162 | |
| 6163 | Methods: |
| 6164 | |
| 6165 | - <code title="get /radar/entities/asns">client.radar.entities.asns.<a href="./src/resources/radar/entities/asns.ts">list</a>({ ...params }) -> ASNListResponse</code> |
| 6166 | - <code title="get /radar/entities/asns/{asn}">client.radar.entities.asns.<a href="./src/resources/radar/entities/asns.ts">get</a>(asn, { ...params }) -> ASNGetResponse</code> |
| 6167 | - <code title="get /radar/entities/asns/ip">client.radar.entities.asns.<a href="./src/resources/radar/entities/asns.ts">ip</a>({ ...params }) -> ASNIPResponse</code> |
| 6168 | - <code title="get /radar/entities/asns/{asn}/rel">client.radar.entities.asns.<a href="./src/resources/radar/entities/asns.ts">rel</a>(asn, { ...params }) -> ASNRelResponse</code> |
| 6169 | |
| 6170 | ### Locations |
| 6171 | |
| 6172 | Types: |
| 6173 | |
| 6174 | - <code><a href="./src/resources/radar/entities/locations.ts">LocationListResponse</a></code> |
| 6175 | - <code><a href="./src/resources/radar/entities/locations.ts">LocationGetResponse</a></code> |
| 6176 | |
| 6177 | Methods: |
| 6178 | |
| 6179 | - <code title="get /radar/entities/locations">client.radar.entities.locations.<a href="./src/resources/radar/entities/locations.ts">list</a>({ ...params }) -> LocationListResponse</code> |
| 6180 | - <code title="get /radar/entities/locations/{location}">client.radar.entities.locations.<a href="./src/resources/radar/entities/locations.ts">get</a>(location, { ...params }) -> LocationGetResponse</code> |
| 6181 | |
| 6182 | ## HTTP |
| 6183 | |
| 6184 | Types: |
| 6185 | |
| 6186 | - <code><a href="./src/resources/radar/http/http.ts">HTTPTimeseriesResponse</a></code> |
| 6187 | |
| 6188 | Methods: |
| 6189 | |
| 6190 | - <code title="get /radar/http/timeseries">client.radar.http.<a href="./src/resources/radar/http/http.ts">timeseries</a>({ ...params }) -> HTTPTimeseriesResponse</code> |
| 6191 | |
| 6192 | ### Top |
| 6193 | |
| 6194 | Types: |
| 6195 | |
| 6196 | - <code><a href="./src/resources/radar/http/top.ts">Browser</a></code> |
| 6197 | - <code><a href="./src/resources/radar/http/top.ts">TopBrowserFamiliesResponse</a></code> |
| 6198 | - <code><a href="./src/resources/radar/http/top.ts">TopBrowsersResponse</a></code> |
| 6199 | |
| 6200 | Methods: |
| 6201 | |
| 6202 | - <code title="get /radar/http/top/browser_families">client.radar.http.top.<a href="./src/resources/radar/http/top.ts">browserFamilies</a>({ ...params }) -> TopBrowserFamiliesResponse</code> |
| 6203 | - <code title="get /radar/http/top/browsers">client.radar.http.top.<a href="./src/resources/radar/http/top.ts">browsers</a>({ ...params }) -> TopBrowsersResponse</code> |
| 6204 | |
| 6205 | ### Locations |
| 6206 | |
| 6207 | Types: |
| 6208 | |
| 6209 | - <code><a href="./src/resources/radar/http/locations/locations.ts">LocationGetResponse</a></code> |
| 6210 | |
| 6211 | Methods: |
| 6212 | |
| 6213 | - <code title="get /radar/http/top/locations">client.radar.http.locations.<a href="./src/resources/radar/http/locations/locations.ts">get</a>({ ...params }) -> LocationGetResponse</code> |
| 6214 | |
| 6215 | #### BotClass |
| 6216 | |
| 6217 | Types: |
| 6218 | |
| 6219 | - <code><a href="./src/resources/radar/http/locations/bot-class.ts">BotClassGetResponse</a></code> |
| 6220 | |
| 6221 | Methods: |
| 6222 | |
| 6223 | - <code title="get /radar/http/top/locations/bot_class/{bot_class}">client.radar.http.locations.botClass.<a href="./src/resources/radar/http/locations/bot-class.ts">get</a>(botClass, { ...params }) -> BotClassGetResponse</code> |
| 6224 | |
| 6225 | #### DeviceType |
| 6226 | |
| 6227 | Types: |
| 6228 | |
| 6229 | - <code><a href="./src/resources/radar/http/locations/device-type.ts">DeviceTypeGetResponse</a></code> |
| 6230 | |
| 6231 | Methods: |
| 6232 | |
| 6233 | - <code title="get /radar/http/top/locations/device_type/{device_type}">client.radar.http.locations.deviceType.<a href="./src/resources/radar/http/locations/device-type.ts">get</a>(deviceType, { ...params }) -> DeviceTypeGetResponse</code> |
| 6234 | |
| 6235 | #### HTTPProtocol |
| 6236 | |
| 6237 | Types: |
| 6238 | |
| 6239 | - <code><a href="./src/resources/radar/http/locations/http-protocol.ts">HTTPProtocolGetResponse</a></code> |
| 6240 | |
| 6241 | Methods: |
| 6242 | |
| 6243 | - <code title="get /radar/http/top/locations/http_protocol/{http_protocol}">client.radar.http.locations.httpProtocol.<a href="./src/resources/radar/http/locations/http-protocol.ts">get</a>(httpProtocol, { ...params }) -> HTTPProtocolGetResponse</code> |
| 6244 | |
| 6245 | #### HTTPMethod |
| 6246 | |
| 6247 | Types: |
| 6248 | |
| 6249 | - <code><a href="./src/resources/radar/http/locations/http-method.ts">HTTPMethodGetResponse</a></code> |
| 6250 | |
| 6251 | Methods: |
| 6252 | |
| 6253 | - <code title="get /radar/http/top/locations/http_version/{http_version}">client.radar.http.locations.httpMethod.<a href="./src/resources/radar/http/locations/http-method.ts">get</a>(httpVersion, { ...params }) -> HTTPMethodGetResponse</code> |
| 6254 | |
| 6255 | #### IPVersion |
| 6256 | |
| 6257 | Types: |
| 6258 | |
| 6259 | - <code><a href="./src/resources/radar/http/locations/ip-version.ts">IPVersionGetResponse</a></code> |
| 6260 | |
| 6261 | Methods: |
| 6262 | |
| 6263 | - <code title="get /radar/http/top/locations/ip_version/{ip_version}">client.radar.http.locations.ipVersion.<a href="./src/resources/radar/http/locations/ip-version.ts">get</a>(ipVersion, { ...params }) -> IPVersionGetResponse</code> |
| 6264 | |
| 6265 | #### OS |
| 6266 | |
| 6267 | Types: |
| 6268 | |
| 6269 | - <code><a href="./src/resources/radar/http/locations/os.ts">OSGetResponse</a></code> |
| 6270 | |
| 6271 | Methods: |
| 6272 | |
| 6273 | - <code title="get /radar/http/top/locations/os/{os}">client.radar.http.locations.os.<a href="./src/resources/radar/http/locations/os.ts">get</a>(os, { ...params }) -> OSGetResponse</code> |
| 6274 | |
| 6275 | #### TLSVersion |
| 6276 | |
| 6277 | Types: |
| 6278 | |
| 6279 | - <code><a href="./src/resources/radar/http/locations/tls-version.ts">TLSVersionGetResponse</a></code> |
| 6280 | |
| 6281 | Methods: |
| 6282 | |
| 6283 | - <code title="get /radar/http/top/locations/tls_version/{tls_version}">client.radar.http.locations.tlsVersion.<a href="./src/resources/radar/http/locations/tls-version.ts">get</a>(tlsVersion, { ...params }) -> TLSVersionGetResponse</code> |
| 6284 | |
| 6285 | #### BrowserFamily |
| 6286 | |
| 6287 | Types: |
| 6288 | |
| 6289 | - <code><a href="./src/resources/radar/http/locations/browser-family.ts">BrowserFamilyGetResponse</a></code> |
| 6290 | |
| 6291 | Methods: |
| 6292 | |
| 6293 | - <code title="get /radar/http/top/locations/browser_family/{browser_family}">client.radar.http.locations.browserFamily.<a href="./src/resources/radar/http/locations/browser-family.ts">get</a>(browserFamily, { ...params }) -> BrowserFamilyGetResponse</code> |
| 6294 | |
| 6295 | ### Ases |
| 6296 | |
| 6297 | Types: |
| 6298 | |
| 6299 | - <code><a href="./src/resources/radar/http/ases/ases.ts">AseGetResponse</a></code> |
| 6300 | |
| 6301 | Methods: |
| 6302 | |
| 6303 | - <code title="get /radar/http/top/ases">client.radar.http.ases.<a href="./src/resources/radar/http/ases/ases.ts">get</a>({ ...params }) -> AseGetResponse</code> |
| 6304 | |
| 6305 | #### BotClass |
| 6306 | |
| 6307 | Types: |
| 6308 | |
| 6309 | - <code><a href="./src/resources/radar/http/ases/bot-class.ts">BotClassGetResponse</a></code> |
| 6310 | |
| 6311 | Methods: |
| 6312 | |
| 6313 | - <code title="get /radar/http/top/ases/bot_class/{bot_class}">client.radar.http.ases.botClass.<a href="./src/resources/radar/http/ases/bot-class.ts">get</a>(botClass, { ...params }) -> BotClassGetResponse</code> |
| 6314 | |
| 6315 | #### DeviceType |
| 6316 | |
| 6317 | Types: |
| 6318 | |
| 6319 | - <code><a href="./src/resources/radar/http/ases/device-type.ts">DeviceTypeGetResponse</a></code> |
| 6320 | |
| 6321 | Methods: |
| 6322 | |
| 6323 | - <code title="get /radar/http/top/ases/device_type/{device_type}">client.radar.http.ases.deviceType.<a href="./src/resources/radar/http/ases/device-type.ts">get</a>(deviceType, { ...params }) -> DeviceTypeGetResponse</code> |
| 6324 | |
| 6325 | #### HTTPProtocol |
| 6326 | |
| 6327 | Types: |
| 6328 | |
| 6329 | - <code><a href="./src/resources/radar/http/ases/http-protocol.ts">HTTPProtocolGetResponse</a></code> |
| 6330 | |
| 6331 | Methods: |
| 6332 | |
| 6333 | - <code title="get /radar/http/top/ases/http_protocol/{http_protocol}">client.radar.http.ases.httpProtocol.<a href="./src/resources/radar/http/ases/http-protocol.ts">get</a>(httpProtocol, { ...params }) -> HTTPProtocolGetResponse</code> |
| 6334 | |
| 6335 | #### HTTPMethod |
| 6336 | |
| 6337 | Types: |
| 6338 | |
| 6339 | - <code><a href="./src/resources/radar/http/ases/http-method.ts">HTTPMethodGetResponse</a></code> |
| 6340 | |
| 6341 | Methods: |
| 6342 | |
| 6343 | - <code title="get /radar/http/top/ases/http_version/{http_version}">client.radar.http.ases.httpMethod.<a href="./src/resources/radar/http/ases/http-method.ts">get</a>(httpVersion, { ...params }) -> HTTPMethodGetResponse</code> |
| 6344 | |
| 6345 | #### IPVersion |
| 6346 | |
| 6347 | Types: |
| 6348 | |
| 6349 | - <code><a href="./src/resources/radar/http/ases/ip-version.ts">IPVersionGetResponse</a></code> |
| 6350 | |
| 6351 | Methods: |
| 6352 | |
| 6353 | - <code title="get /radar/http/top/ases/ip_version/{ip_version}">client.radar.http.ases.ipVersion.<a href="./src/resources/radar/http/ases/ip-version.ts">get</a>(ipVersion, { ...params }) -> IPVersionGetResponse</code> |
| 6354 | |
| 6355 | #### OS |
| 6356 | |
| 6357 | Types: |
| 6358 | |
| 6359 | - <code><a href="./src/resources/radar/http/ases/os.ts">OSGetResponse</a></code> |
| 6360 | |
| 6361 | Methods: |
| 6362 | |
| 6363 | - <code title="get /radar/http/top/ases/os/{os}">client.radar.http.ases.os.<a href="./src/resources/radar/http/ases/os.ts">get</a>(os, { ...params }) -> OSGetResponse</code> |
| 6364 | |
| 6365 | #### TLSVersion |
| 6366 | |
| 6367 | Types: |
| 6368 | |
| 6369 | - <code><a href="./src/resources/radar/http/ases/tls-version.ts">TLSVersionGetResponse</a></code> |
| 6370 | |
| 6371 | Methods: |
| 6372 | |
| 6373 | - <code title="get /radar/http/top/ases/tls_version/{tls_version}">client.radar.http.ases.tlsVersion.<a href="./src/resources/radar/http/ases/tls-version.ts">get</a>(tlsVersion, { ...params }) -> TLSVersionGetResponse</code> |
| 6374 | |
| 6375 | #### BrowserFamily |
| 6376 | |
| 6377 | Types: |
| 6378 | |
| 6379 | - <code><a href="./src/resources/radar/http/ases/browser-family.ts">BrowserFamilyGetResponse</a></code> |
| 6380 | |
| 6381 | Methods: |
| 6382 | |
| 6383 | - <code title="get /radar/http/top/ases/browser_family/{browser_family}">client.radar.http.ases.browserFamily.<a href="./src/resources/radar/http/ases/browser-family.ts">get</a>(browserFamily, { ...params }) -> BrowserFamilyGetResponse</code> |
| 6384 | |
| 6385 | ### Summary |
| 6386 | |
| 6387 | Types: |
| 6388 | |
| 6389 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryBotClassResponse</a></code> |
| 6390 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryDeviceTypeResponse</a></code> |
| 6391 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryHTTPProtocolResponse</a></code> |
| 6392 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryHTTPVersionResponse</a></code> |
| 6393 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryIPVersionResponse</a></code> |
| 6394 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryOSResponse</a></code> |
| 6395 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryPostQuantumResponse</a></code> |
| 6396 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryTLSVersionResponse</a></code> |
| 6397 | |
| 6398 | Methods: |
| 6399 | |
| 6400 | - <code title="get /radar/http/summary/bot_class">client.radar.http.summary.<a href="./src/resources/radar/http/summary.ts">botClass</a>({ ...params }) -> SummaryBotClassResponse</code> |
| 6401 | - <code title="get /radar/http/summary/device_type">client.radar.http.summary.<a href="./src/resources/radar/http/summary.ts">deviceType</a>({ ...params }) -> SummaryDeviceTypeResponse</code> |
| 6402 | - <code title="get /radar/http/summary/http_protocol">client.radar.http.summary.<a href="./src/resources/radar/http/summary.ts">httpProtocol</a>({ ...params }) -> SummaryHTTPProtocolResponse</code> |
| 6403 | - <code title="get /radar/http/summary/http_version">client.radar.http.summary.<a href="./src/resources/radar/http/summary.ts">httpVersion</a>({ ...params }) -> SummaryHTTPVersionResponse</code> |
| 6404 | - <code title="get /radar/http/summary/ip_version">client.radar.http.summary.<a href="./src/resources/radar/http/summary.ts">ipVersion</a>({ ...params }) -> SummaryIPVersionResponse</code> |
| 6405 | - <code title="get /radar/http/summary/os">client.radar.http.summary.<a href="./src/resources/radar/http/summary.ts">os</a>({ ...params }) -> SummaryOSResponse</code> |
| 6406 | - <code title="get /radar/http/summary/post_quantum">client.radar.http.summary.<a href="./src/resources/radar/http/summary.ts">postQuantum</a>({ ...params }) -> SummaryPostQuantumResponse</code> |
| 6407 | - <code title="get /radar/http/summary/tls_version">client.radar.http.summary.<a href="./src/resources/radar/http/summary.ts">tlsVersion</a>({ ...params }) -> SummaryTLSVersionResponse</code> |
| 6408 | |
| 6409 | ### TimeseriesGroups |
| 6410 | |
| 6411 | Types: |
| 6412 | |
| 6413 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupBotClassResponse</a></code> |
| 6414 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupBrowserResponse</a></code> |
| 6415 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupBrowserFamilyResponse</a></code> |
| 6416 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupDeviceTypeResponse</a></code> |
| 6417 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupHTTPProtocolResponse</a></code> |
| 6418 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupHTTPVersionResponse</a></code> |
| 6419 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 6420 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupOSResponse</a></code> |
| 6421 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupPostQuantumResponse</a></code> |
| 6422 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupTLSVersionResponse</a></code> |
| 6423 | |
| 6424 | Methods: |
| 6425 | |
| 6426 | - <code title="get /radar/http/timeseries_groups/bot_class">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">botClass</a>({ ...params }) -> TimeseriesGroupBotClassResponse</code> |
| 6427 | - <code title="get /radar/http/timeseries_groups/browser">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">browser</a>({ ...params }) -> TimeseriesGroupBrowserResponse</code> |
| 6428 | - <code title="get /radar/http/timeseries_groups/browser_family">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">browserFamily</a>({ ...params }) -> TimeseriesGroupBrowserFamilyResponse</code> |
| 6429 | - <code title="get /radar/http/timeseries_groups/device_type">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">deviceType</a>({ ...params }) -> TimeseriesGroupDeviceTypeResponse</code> |
| 6430 | - <code title="get /radar/http/timeseries_groups/http_protocol">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">httpProtocol</a>({ ...params }) -> TimeseriesGroupHTTPProtocolResponse</code> |
| 6431 | - <code title="get /radar/http/timeseries_groups/http_version">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">httpVersion</a>({ ...params }) -> TimeseriesGroupHTTPVersionResponse</code> |
| 6432 | - <code title="get /radar/http/timeseries_groups/ip_version">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">ipVersion</a>({ ...params }) -> TimeseriesGroupIPVersionResponse</code> |
| 6433 | - <code title="get /radar/http/timeseries_groups/os">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">os</a>({ ...params }) -> TimeseriesGroupOSResponse</code> |
| 6434 | - <code title="get /radar/http/timeseries_groups/post_quantum">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">postQuantum</a>({ ...params }) -> TimeseriesGroupPostQuantumResponse</code> |
| 6435 | - <code title="get /radar/http/timeseries_groups/tls_version">client.radar.http.timeseriesGroups.<a href="./src/resources/radar/http/timeseries-groups.ts">tlsVersion</a>({ ...params }) -> TimeseriesGroupTLSVersionResponse</code> |
| 6436 | |
| 6437 | ## Quality |
| 6438 | |
| 6439 | ### IQI |
| 6440 | |
| 6441 | Types: |
| 6442 | |
| 6443 | - <code><a href="./src/resources/radar/quality/iqi.ts">IQISummaryResponse</a></code> |
| 6444 | - <code><a href="./src/resources/radar/quality/iqi.ts">IQITimeseriesGroupsResponse</a></code> |
| 6445 | |
| 6446 | Methods: |
| 6447 | |
| 6448 | - <code title="get /radar/quality/iqi/summary">client.radar.quality.iqi.<a href="./src/resources/radar/quality/iqi.ts">summary</a>({ ...params }) -> IQISummaryResponse</code> |
| 6449 | - <code title="get /radar/quality/iqi/timeseries_groups">client.radar.quality.iqi.<a href="./src/resources/radar/quality/iqi.ts">timeseriesGroups</a>({ ...params }) -> IQITimeseriesGroupsResponse</code> |
| 6450 | |
| 6451 | ### Speed |
| 6452 | |
| 6453 | Types: |
| 6454 | |
| 6455 | - <code><a href="./src/resources/radar/quality/speed/speed.ts">SpeedHistogramResponse</a></code> |
| 6456 | - <code><a href="./src/resources/radar/quality/speed/speed.ts">SpeedSummaryResponse</a></code> |
| 6457 | |
| 6458 | Methods: |
| 6459 | |
| 6460 | - <code title="get /radar/quality/speed/histogram">client.radar.quality.speed.<a href="./src/resources/radar/quality/speed/speed.ts">histogram</a>({ ...params }) -> SpeedHistogramResponse</code> |
| 6461 | - <code title="get /radar/quality/speed/summary">client.radar.quality.speed.<a href="./src/resources/radar/quality/speed/speed.ts">summary</a>({ ...params }) -> SpeedSummaryResponse</code> |
| 6462 | |
| 6463 | #### Top |
| 6464 | |
| 6465 | Types: |
| 6466 | |
| 6467 | - <code><a href="./src/resources/radar/quality/speed/top.ts">TopAsesResponse</a></code> |
| 6468 | - <code><a href="./src/resources/radar/quality/speed/top.ts">TopLocationsResponse</a></code> |
| 6469 | |
| 6470 | Methods: |
| 6471 | |
| 6472 | - <code title="get /radar/quality/speed/top/ases">client.radar.quality.speed.top.<a href="./src/resources/radar/quality/speed/top.ts">ases</a>({ ...params }) -> TopAsesResponse</code> |
| 6473 | - <code title="get /radar/quality/speed/top/locations">client.radar.quality.speed.top.<a href="./src/resources/radar/quality/speed/top.ts">locations</a>({ ...params }) -> TopLocationsResponse</code> |
| 6474 | |
| 6475 | ## Ranking |
| 6476 | |
| 6477 | Types: |
| 6478 | |
| 6479 | - <code><a href="./src/resources/radar/ranking/ranking.ts">RankingTimeseriesGroupsResponse</a></code> |
| 6480 | - <code><a href="./src/resources/radar/ranking/ranking.ts">RankingTopResponse</a></code> |
| 6481 | |
| 6482 | Methods: |
| 6483 | |
| 6484 | - <code title="get /radar/ranking/timeseries_groups">client.radar.ranking.<a href="./src/resources/radar/ranking/ranking.ts">timeseriesGroups</a>({ ...params }) -> RankingTimeseriesGroupsResponse</code> |
| 6485 | - <code title="get /radar/ranking/top">client.radar.ranking.<a href="./src/resources/radar/ranking/ranking.ts">top</a>({ ...params }) -> RankingTopResponse</code> |
| 6486 | |
| 6487 | ### Domain |
| 6488 | |
| 6489 | Types: |
| 6490 | |
| 6491 | - <code><a href="./src/resources/radar/ranking/domain.ts">DomainGetResponse</a></code> |
| 6492 | |
| 6493 | Methods: |
| 6494 | |
| 6495 | - <code title="get /radar/ranking/domain/{domain}">client.radar.ranking.domain.<a href="./src/resources/radar/ranking/domain.ts">get</a>(domain, { ...params }) -> DomainGetResponse</code> |
| 6496 | |
| 6497 | ## TrafficAnomalies |
| 6498 | |
| 6499 | Types: |
| 6500 | |
| 6501 | - <code><a href="./src/resources/radar/traffic-anomalies/traffic-anomalies.ts">TrafficAnomalyGetResponse</a></code> |
| 6502 | |
| 6503 | Methods: |
| 6504 | |
| 6505 | - <code title="get /radar/traffic_anomalies">client.radar.trafficAnomalies.<a href="./src/resources/radar/traffic-anomalies/traffic-anomalies.ts">get</a>({ ...params }) -> TrafficAnomalyGetResponse</code> |
| 6506 | |
| 6507 | ### Locations |
| 6508 | |
| 6509 | Types: |
| 6510 | |
| 6511 | - <code><a href="./src/resources/radar/traffic-anomalies/locations.ts">LocationGetResponse</a></code> |
| 6512 | |
| 6513 | Methods: |
| 6514 | |
| 6515 | - <code title="get /radar/traffic_anomalies/locations">client.radar.trafficAnomalies.locations.<a href="./src/resources/radar/traffic-anomalies/locations.ts">get</a>({ ...params }) -> LocationGetResponse</code> |
| 6516 | |
| 6517 | # BotManagement |
| 6518 | |
| 6519 | Types: |
| 6520 | |
| 6521 | - <code><a href="./src/resources/bot-management.ts">BotFightModeConfiguration</a></code> |
| 6522 | - <code><a href="./src/resources/bot-management.ts">SubscriptionConfiguration</a></code> |
| 6523 | - <code><a href="./src/resources/bot-management.ts">SuperBotFightModeDefinitelyConfiguration</a></code> |
| 6524 | - <code><a href="./src/resources/bot-management.ts">SuperBotFightModeLikelyConfiguration</a></code> |
| 6525 | - <code><a href="./src/resources/bot-management.ts">BotManagementUpdateResponse</a></code> |
| 6526 | - <code><a href="./src/resources/bot-management.ts">BotManagementGetResponse</a></code> |
| 6527 | |
| 6528 | Methods: |
| 6529 | |
| 6530 | - <code title="put /zones/{zone_id}/bot_management">client.botManagement.<a href="./src/resources/bot-management.ts">update</a>({ ...params }) -> BotManagementUpdateResponse</code> |
| 6531 | - <code title="get /zones/{zone_id}/bot_management">client.botManagement.<a href="./src/resources/bot-management.ts">get</a>({ ...params }) -> BotManagementGetResponse</code> |
| 6532 | |
| 6533 | # OriginPostQuantumEncryption |
| 6534 | |
| 6535 | Types: |
| 6536 | |
| 6537 | - <code><a href="./src/resources/origin-post-quantum-encryption.ts">OriginPostQuantumEncryptionUpdateResponse</a></code> |
| 6538 | - <code><a href="./src/resources/origin-post-quantum-encryption.ts">OriginPostQuantumEncryptionGetResponse</a></code> |
| 6539 | |
| 6540 | Methods: |
| 6541 | |
| 6542 | - <code title="put /zones/{zone_id}/cache/origin_post_quantum_encryption">client.originPostQuantumEncryption.<a href="./src/resources/origin-post-quantum-encryption.ts">update</a>({ ...params }) -> OriginPostQuantumEncryptionUpdateResponse</code> |
| 6543 | - <code title="get /zones/{zone_id}/cache/origin_post_quantum_encryption">client.originPostQuantumEncryption.<a href="./src/resources/origin-post-quantum-encryption.ts">get</a>({ ...params }) -> OriginPostQuantumEncryptionGetResponse</code> |
| 6544 | |
| 6545 | # Speed |
| 6546 | |
| 6547 | Types: |
| 6548 | |
| 6549 | - <code><a href="./src/resources/speed/speed.ts">LabeledRegion</a></code> |
| 6550 | - <code><a href="./src/resources/speed/speed.ts">LighthouseReport</a></code> |
| 6551 | - <code><a href="./src/resources/speed/speed.ts">Trend</a></code> |
| 6552 | |
| 6553 | ## Schedule |
| 6554 | |
| 6555 | Types: |
| 6556 | |
| 6557 | - <code><a href="./src/resources/speed/schedule.ts">Schedule</a></code> |
| 6558 | - <code><a href="./src/resources/speed/schedule.ts">ScheduleCreateResponse</a></code> |
| 6559 | - <code><a href="./src/resources/speed/schedule.ts">ScheduleDeleteResponse</a></code> |
| 6560 | |
| 6561 | Methods: |
| 6562 | |
| 6563 | - <code title="post /zones/{zone_id}/speed_api/schedule/{url}">client.speed.schedule.<a href="./src/resources/speed/schedule.ts">create</a>(url, { ...params }) -> ScheduleCreateResponse</code> |
| 6564 | - <code title="delete /zones/{zone_id}/speed_api/schedule/{url}">client.speed.schedule.<a href="./src/resources/speed/schedule.ts">delete</a>(url, { ...params }) -> ScheduleDeleteResponse</code> |
| 6565 | - <code title="get /zones/{zone_id}/speed_api/schedule/{url}">client.speed.schedule.<a href="./src/resources/speed/schedule.ts">get</a>(url, { ...params }) -> Schedule</code> |
| 6566 | |
| 6567 | ## Availabilities |
| 6568 | |
| 6569 | Types: |
| 6570 | |
| 6571 | - <code><a href="./src/resources/speed/availabilities.ts">Availability</a></code> |
| 6572 | |
| 6573 | Methods: |
| 6574 | |
| 6575 | - <code title="get /zones/{zone_id}/speed_api/availabilities">client.speed.availabilities.<a href="./src/resources/speed/availabilities.ts">list</a>({ ...params }) -> Availability</code> |
| 6576 | |
| 6577 | ## Pages |
| 6578 | |
| 6579 | Types: |
| 6580 | |
| 6581 | - <code><a href="./src/resources/speed/pages/pages.ts">PageListResponse</a></code> |
| 6582 | |
| 6583 | Methods: |
| 6584 | |
| 6585 | - <code title="get /zones/{zone_id}/speed_api/pages">client.speed.pages.<a href="./src/resources/speed/pages/pages.ts">list</a>({ ...params }) -> PageListResponsesSinglePage</code> |
| 6586 | - <code title="get /zones/{zone_id}/speed_api/pages/{url}/trend">client.speed.pages.<a href="./src/resources/speed/pages/pages.ts">trend</a>(url, { ...params }) -> Trend</code> |
| 6587 | |
| 6588 | ### Tests |
| 6589 | |
| 6590 | Types: |
| 6591 | |
| 6592 | - <code><a href="./src/resources/speed/pages/tests.ts">Test</a></code> |
| 6593 | - <code><a href="./src/resources/speed/pages/tests.ts">TestListResponse</a></code> |
| 6594 | - <code><a href="./src/resources/speed/pages/tests.ts">TestDeleteResponse</a></code> |
| 6595 | |
| 6596 | Methods: |
| 6597 | |
| 6598 | - <code title="post /zones/{zone_id}/speed_api/pages/{url}/tests">client.speed.pages.tests.<a href="./src/resources/speed/pages/tests.ts">create</a>(url, { ...params }) -> Test</code> |
| 6599 | - <code title="get /zones/{zone_id}/speed_api/pages/{url}/tests">client.speed.pages.tests.<a href="./src/resources/speed/pages/tests.ts">list</a>(url, { ...params }) -> TestListResponse</code> |
| 6600 | - <code title="delete /zones/{zone_id}/speed_api/pages/{url}/tests">client.speed.pages.tests.<a href="./src/resources/speed/pages/tests.ts">delete</a>(url, { ...params }) -> TestDeleteResponse</code> |
| 6601 | - <code title="get /zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}">client.speed.pages.tests.<a href="./src/resources/speed/pages/tests.ts">get</a>(url, testId, { ...params }) -> Test</code> |
| 6602 | |
| 6603 | # DCVDelegation |
| 6604 | |
| 6605 | Types: |
| 6606 | |
| 6607 | - <code><a href="./src/resources/dcv-delegation.ts">DCVDelegationUUID</a></code> |
| 6608 | |
| 6609 | Methods: |
| 6610 | |
| 6611 | - <code title="get /zones/{zone_id}/dcv_delegation/uuid">client.dcvDelegation.<a href="./src/resources/dcv-delegation.ts">get</a>({ ...params }) -> DCVDelegationUUID</code> |
| 6612 | |
| 6613 | # Hostnames |
| 6614 | |
| 6615 | ## Settings |
| 6616 | |
| 6617 | ### TLS |
| 6618 | |
| 6619 | Types: |
| 6620 | |
| 6621 | - <code><a href="./src/resources/hostnames/settings/tls.ts">Setting</a></code> |
| 6622 | - <code><a href="./src/resources/hostnames/settings/tls.ts">SettingValue</a></code> |
| 6623 | - <code><a href="./src/resources/hostnames/settings/tls.ts">TLSDeleteResponse</a></code> |
| 6624 | - <code><a href="./src/resources/hostnames/settings/tls.ts">TLSGetResponse</a></code> |
| 6625 | |
| 6626 | Methods: |
| 6627 | |
| 6628 | - <code title="put /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}">client.hostnames.settings.tls.<a href="./src/resources/hostnames/settings/tls.ts">update</a>(settingId, hostname, { ...params }) -> Setting</code> |
| 6629 | - <code title="delete /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}">client.hostnames.settings.tls.<a href="./src/resources/hostnames/settings/tls.ts">delete</a>(settingId, hostname, { ...params }) -> TLSDeleteResponse</code> |
| 6630 | - <code title="get /zones/{zone_id}/hostnames/settings/{setting_id}">client.hostnames.settings.tls.<a href="./src/resources/hostnames/settings/tls.ts">get</a>(settingId, { ...params }) -> TLSGetResponse | null</code> |
| 6631 | |
| 6632 | # Snippets |
| 6633 | |
| 6634 | Types: |
| 6635 | |
| 6636 | - <code><a href="./src/resources/snippets/snippets.ts">Snippet</a></code> |
| 6637 | - <code><a href="./src/resources/snippets/snippets.ts">SnippetDeleteResponse</a></code> |
| 6638 | |
| 6639 | Methods: |
| 6640 | |
| 6641 | - <code title="put /zones/{zone_id}/snippets/{snippet_name}">client.snippets.<a href="./src/resources/snippets/snippets.ts">update</a>(snippetName, { ...params }) -> Snippet</code> |
| 6642 | - <code title="get /zones/{zone_id}/snippets">client.snippets.<a href="./src/resources/snippets/snippets.ts">list</a>({ ...params }) -> SnippetsSinglePage</code> |
| 6643 | - <code title="delete /zones/{zone_id}/snippets/{snippet_name}">client.snippets.<a href="./src/resources/snippets/snippets.ts">delete</a>(snippetName, { ...params }) -> SnippetDeleteResponse</code> |
| 6644 | - <code title="get /zones/{zone_id}/snippets/{snippet_name}">client.snippets.<a href="./src/resources/snippets/snippets.ts">get</a>(snippetName, { ...params }) -> Snippet</code> |
| 6645 | |
| 6646 | ## Content |
| 6647 | |
| 6648 | Methods: |
| 6649 | |
| 6650 | - <code title="get /zones/{zone_id}/snippets/{snippet_name}/content">client.snippets.content.<a href="./src/resources/snippets/content.ts">get</a>(snippetName, { ...params }) -> Response</code> |
| 6651 | |
| 6652 | ## Rules |
| 6653 | |
| 6654 | Types: |
| 6655 | |
| 6656 | - <code><a href="./src/resources/snippets/rules.ts">RuleUpdateResponse</a></code> |
| 6657 | - <code><a href="./src/resources/snippets/rules.ts">RuleListResponse</a></code> |
| 6658 | |
| 6659 | Methods: |
| 6660 | |
| 6661 | - <code title="put /zones/{zone_id}/snippets/snippet_rules">client.snippets.rules.<a href="./src/resources/snippets/rules.ts">update</a>({ ...params }) -> RuleUpdateResponse</code> |
| 6662 | - <code title="get /zones/{zone_id}/snippets/snippet_rules">client.snippets.rules.<a href="./src/resources/snippets/rules.ts">list</a>({ ...params }) -> RuleListResponsesSinglePage</code> |
| 6663 | |
| 6664 | # Calls |
| 6665 | |
| 6666 | Types: |
| 6667 | |
| 6668 | - <code><a href="./src/resources/calls/calls.ts">CallsApp</a></code> |
| 6669 | - <code><a href="./src/resources/calls/calls.ts">CallsAppWithSecret</a></code> |
| 6670 | - <code><a href="./src/resources/calls/calls.ts">CallListResponse</a></code> |
| 6671 | |
| 6672 | Methods: |
| 6673 | |
| 6674 | - <code title="post /accounts/{account_id}/calls/apps">client.calls.<a href="./src/resources/calls/calls.ts">create</a>({ ...params }) -> CallsAppWithSecret</code> |
| 6675 | - <code title="put /accounts/{account_id}/calls/apps/{app_id}">client.calls.<a href="./src/resources/calls/calls.ts">update</a>(appId, { ...params }) -> CallsApp</code> |
| 6676 | - <code title="get /accounts/{account_id}/calls/apps">client.calls.<a href="./src/resources/calls/calls.ts">list</a>({ ...params }) -> CallListResponsesSinglePage</code> |
| 6677 | - <code title="delete /accounts/{account_id}/calls/apps/{app_id}">client.calls.<a href="./src/resources/calls/calls.ts">delete</a>(appId, { ...params }) -> CallsApp</code> |
| 6678 | - <code title="get /accounts/{account_id}/calls/apps/{app_id}">client.calls.<a href="./src/resources/calls/calls.ts">get</a>(appId, { ...params }) -> CallsApp</code> |
| 6679 | |
| 6680 | ## TURN |
| 6681 | |
| 6682 | ### Keys |
| 6683 | |
| 6684 | Types: |
| 6685 | |
| 6686 | - <code><a href="./src/resources/calls/turn/keys.ts">KeyCreateResponse</a></code> |
| 6687 | - <code><a href="./src/resources/calls/turn/keys.ts">KeyUpdateResponse</a></code> |
| 6688 | - <code><a href="./src/resources/calls/turn/keys.ts">KeyListResponse</a></code> |
| 6689 | - <code><a href="./src/resources/calls/turn/keys.ts">KeyDeleteResponse</a></code> |
| 6690 | - <code><a href="./src/resources/calls/turn/keys.ts">KeyGetResponse</a></code> |
| 6691 | |
| 6692 | Methods: |
| 6693 | |
| 6694 | - <code title="post /accounts/{account_id}/calls/turn_keys">client.calls.turn.keys.<a href="./src/resources/calls/turn/keys.ts">create</a>({ ...params }) -> KeyCreateResponse</code> |
| 6695 | - <code title="put /accounts/{account_id}/calls/turn_keys/{key_id}">client.calls.turn.keys.<a href="./src/resources/calls/turn/keys.ts">update</a>(keyId, { ...params }) -> KeyUpdateResponse</code> |
| 6696 | - <code title="get /accounts/{account_id}/calls/turn_keys">client.calls.turn.keys.<a href="./src/resources/calls/turn/keys.ts">list</a>({ ...params }) -> KeyListResponsesSinglePage</code> |
| 6697 | - <code title="delete /accounts/{account_id}/calls/turn_keys/{key_id}">client.calls.turn.keys.<a href="./src/resources/calls/turn/keys.ts">delete</a>(keyId, { ...params }) -> KeyDeleteResponse</code> |
| 6698 | - <code title="get /accounts/{account_id}/calls/turn_keys/{key_id}">client.calls.turn.keys.<a href="./src/resources/calls/turn/keys.ts">get</a>(keyId, { ...params }) -> KeyGetResponse</code> |
| 6699 | |
| 6700 | # CloudforceOne |
| 6701 | |
| 6702 | ## Requests |
| 6703 | |
| 6704 | Types: |
| 6705 | |
| 6706 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">Item</a></code> |
| 6707 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">ListItem</a></code> |
| 6708 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">Quota</a></code> |
| 6709 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">RequestConstants</a></code> |
| 6710 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">RequestTypes</a></code> |
| 6711 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">RequestDeleteResponse</a></code> |
| 6712 | |
| 6713 | Methods: |
| 6714 | |
| 6715 | - <code title="post /accounts/{account_identifier}/cloudforce-one/requests/new">client.cloudforceOne.requests.<a href="./src/resources/cloudforce-one/requests/requests.ts">create</a>(accountIdentifier, { ...params }) -> Item</code> |
| 6716 | - <code title="put /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}">client.cloudforceOne.requests.<a href="./src/resources/cloudforce-one/requests/requests.ts">update</a>(accountIdentifier, requestIdentifier, { ...params }) -> Item</code> |
| 6717 | - <code title="post /accounts/{account_identifier}/cloudforce-one/requests">client.cloudforceOne.requests.<a href="./src/resources/cloudforce-one/requests/requests.ts">list</a>(accountIdentifier, { ...params }) -> ListItemsV4PagePaginationArray</code> |
| 6718 | - <code title="delete /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}">client.cloudforceOne.requests.<a href="./src/resources/cloudforce-one/requests/requests.ts">delete</a>(accountIdentifier, requestIdentifier) -> RequestDeleteResponse</code> |
| 6719 | - <code title="get /accounts/{account_identifier}/cloudforce-one/requests/constants">client.cloudforceOne.requests.<a href="./src/resources/cloudforce-one/requests/requests.ts">constants</a>(accountIdentifier) -> RequestConstants</code> |
| 6720 | - <code title="get /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}">client.cloudforceOne.requests.<a href="./src/resources/cloudforce-one/requests/requests.ts">get</a>(accountIdentifier, requestIdentifier) -> Item</code> |
| 6721 | - <code title="get /accounts/{account_identifier}/cloudforce-one/requests/quota">client.cloudforceOne.requests.<a href="./src/resources/cloudforce-one/requests/requests.ts">quota</a>(accountIdentifier) -> Quota</code> |
| 6722 | - <code title="get /accounts/{account_identifier}/cloudforce-one/requests/types">client.cloudforceOne.requests.<a href="./src/resources/cloudforce-one/requests/requests.ts">types</a>(accountIdentifier) -> RequestTypes</code> |
| 6723 | |
| 6724 | ### Message |
| 6725 | |
| 6726 | Types: |
| 6727 | |
| 6728 | - <code><a href="./src/resources/cloudforce-one/requests/message.ts">Message</a></code> |
| 6729 | - <code><a href="./src/resources/cloudforce-one/requests/message.ts">MessageDeleteResponse</a></code> |
| 6730 | - <code><a href="./src/resources/cloudforce-one/requests/message.ts">MessageGetResponse</a></code> |
| 6731 | |
| 6732 | Methods: |
| 6733 | |
| 6734 | - <code title="post /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/new">client.cloudforceOne.requests.message.<a href="./src/resources/cloudforce-one/requests/message.ts">create</a>(accountIdentifier, requestIdentifier, { ...params }) -> Message</code> |
| 6735 | - <code title="put /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}">client.cloudforceOne.requests.message.<a href="./src/resources/cloudforce-one/requests/message.ts">update</a>(accountIdentifier, requestIdentifier, messageIdentifer, { ...params }) -> Message</code> |
| 6736 | - <code title="delete /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message/{message_identifer}">client.cloudforceOne.requests.message.<a href="./src/resources/cloudforce-one/requests/message.ts">delete</a>(accountIdentifier, requestIdentifier, messageIdentifer) -> MessageDeleteResponse</code> |
| 6737 | - <code title="post /accounts/{account_identifier}/cloudforce-one/requests/{request_identifier}/message">client.cloudforceOne.requests.message.<a href="./src/resources/cloudforce-one/requests/message.ts">get</a>(accountIdentifier, requestIdentifier, { ...params }) -> MessageGetResponse</code> |
| 6738 | |
| 6739 | ### Priority |
| 6740 | |
| 6741 | Types: |
| 6742 | |
| 6743 | - <code><a href="./src/resources/cloudforce-one/requests/priority.ts">Label</a></code> |
| 6744 | - <code><a href="./src/resources/cloudforce-one/requests/priority.ts">Priority</a></code> |
| 6745 | - <code><a href="./src/resources/cloudforce-one/requests/priority.ts">PriorityEdit</a></code> |
| 6746 | - <code><a href="./src/resources/cloudforce-one/requests/priority.ts">PriorityDeleteResponse</a></code> |
| 6747 | |
| 6748 | Methods: |
| 6749 | |
| 6750 | - <code title="post /accounts/{account_identifier}/cloudforce-one/requests/priority/new">client.cloudforceOne.requests.priority.<a href="./src/resources/cloudforce-one/requests/priority.ts">create</a>(accountIdentifier, { ...params }) -> Priority</code> |
| 6751 | - <code title="put /accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}">client.cloudforceOne.requests.priority.<a href="./src/resources/cloudforce-one/requests/priority.ts">update</a>(accountIdentifier, priorityIdentifer, { ...params }) -> Item</code> |
| 6752 | - <code title="delete /accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}">client.cloudforceOne.requests.priority.<a href="./src/resources/cloudforce-one/requests/priority.ts">delete</a>(accountIdentifier, priorityIdentifer) -> PriorityDeleteResponse</code> |
| 6753 | - <code title="get /accounts/{account_identifier}/cloudforce-one/requests/priority/{priority_identifer}">client.cloudforceOne.requests.priority.<a href="./src/resources/cloudforce-one/requests/priority.ts">get</a>(accountIdentifier, priorityIdentifer) -> Item</code> |
| 6754 | - <code title="get /accounts/{account_identifier}/cloudforce-one/requests/priority/quota">client.cloudforceOne.requests.priority.<a href="./src/resources/cloudforce-one/requests/priority.ts">quota</a>(accountIdentifier) -> Quota</code> |
| 6755 | |
| 6756 | # EventNotifications |
| 6757 | |
| 6758 | ## R2 |
| 6759 | |
| 6760 | ### Configuration |
| 6761 | |
| 6762 | Types: |
| 6763 | |
| 6764 | - <code><a href="./src/resources/event-notifications/r2/configuration/configuration.ts">ConfigurationGetResponse</a></code> |
| 6765 | |
| 6766 | Methods: |
| 6767 | |
| 6768 | - <code title="get /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration">client.eventNotifications.r2.configuration.<a href="./src/resources/event-notifications/r2/configuration/configuration.ts">get</a>(bucketName, { ...params }) -> ConfigurationGetResponse</code> |
| 6769 | |
| 6770 | #### Queues |
| 6771 | |
| 6772 | Types: |
| 6773 | |
| 6774 | - <code><a href="./src/resources/event-notifications/r2/configuration/queues.ts">QueueUpdateResponse</a></code> |
| 6775 | - <code><a href="./src/resources/event-notifications/r2/configuration/queues.ts">QueueDeleteResponse</a></code> |
| 6776 | |
| 6777 | Methods: |
| 6778 | |
| 6779 | - <code title="put /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}">client.eventNotifications.r2.configuration.queues.<a href="./src/resources/event-notifications/r2/configuration/queues.ts">update</a>(bucketName, queueId, { ...params }) -> QueueUpdateResponse</code> |
| 6780 | - <code title="delete /accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}">client.eventNotifications.r2.configuration.queues.<a href="./src/resources/event-notifications/r2/configuration/queues.ts">delete</a>(bucketName, queueId, { ...params }) -> QueueDeleteResponse</code> |
| 6781 | |
| 6782 | # AIGateway |
| 6783 | |
| 6784 | Types: |
| 6785 | |
| 6786 | - <code><a href="./src/resources/ai-gateway/ai-gateway.ts">AIGatewayCreateResponse</a></code> |
| 6787 | - <code><a href="./src/resources/ai-gateway/ai-gateway.ts">AIGatewayUpdateResponse</a></code> |
| 6788 | - <code><a href="./src/resources/ai-gateway/ai-gateway.ts">AIGatewayListResponse</a></code> |
| 6789 | - <code><a href="./src/resources/ai-gateway/ai-gateway.ts">AIGatewayDeleteResponse</a></code> |
| 6790 | - <code><a href="./src/resources/ai-gateway/ai-gateway.ts">AIGatewayGetResponse</a></code> |
| 6791 | |
| 6792 | Methods: |
| 6793 | |
| 6794 | - <code title="post /accounts/{account_id}/ai-gateway/gateways">client.aiGateway.<a href="./src/resources/ai-gateway/ai-gateway.ts">create</a>({ ...params }) -> AIGatewayCreateResponse</code> |
| 6795 | - <code title="put /accounts/{account_id}/ai-gateway/gateways/{id}">client.aiGateway.<a href="./src/resources/ai-gateway/ai-gateway.ts">update</a>(id, { ...params }) -> AIGatewayUpdateResponse</code> |
| 6796 | - <code title="get /accounts/{account_id}/ai-gateway/gateways">client.aiGateway.<a href="./src/resources/ai-gateway/ai-gateway.ts">list</a>({ ...params }) -> AIGatewayListResponsesV4PagePaginationArray</code> |
| 6797 | - <code title="delete /accounts/{account_id}/ai-gateway/gateways/{id}">client.aiGateway.<a href="./src/resources/ai-gateway/ai-gateway.ts">delete</a>(id, { ...params }) -> AIGatewayDeleteResponse</code> |
| 6798 | - <code title="get /accounts/{account_id}/ai-gateway/gateways/{id}">client.aiGateway.<a href="./src/resources/ai-gateway/ai-gateway.ts">get</a>(id, { ...params }) -> AIGatewayGetResponse</code> |
| 6799 | |
| 6800 | ## Logs |
| 6801 | |
| 6802 | Types: |
| 6803 | |
| 6804 | - <code><a href="./src/resources/ai-gateway/logs.ts">LogGetResponse</a></code> |
| 6805 | |
| 6806 | Methods: |
| 6807 | |
| 6808 | - <code title="get /accounts/{account_id}/ai-gateway/gateways/{id}/logs">client.aiGateway.logs.<a href="./src/resources/ai-gateway/logs.ts">get</a>(id, { ...params }) -> LogGetResponse</code> |
| 6809 | |
| 6810 | # IAM |
| 6811 | |
| 6812 | ## PermissionGroups |
| 6813 | |
| 6814 | Types: |
| 6815 | |
| 6816 | - <code><a href="./src/resources/iam/permission-groups.ts">PermissionGroupListResponse</a></code> |
| 6817 | - <code><a href="./src/resources/iam/permission-groups.ts">PermissionGroupGetResponse</a></code> |
| 6818 | |
| 6819 | Methods: |
| 6820 | |
| 6821 | - <code title="get /accounts/{account_id}/iam/permission_groups">client.iam.permissionGroups.<a href="./src/resources/iam/permission-groups.ts">list</a>({ ...params }) -> PermissionGroupListResponsesV4PagePaginationArray</code> |
| 6822 | - <code title="get /accounts/{account_id}/iam/permission_groups/{permission_group_id}">client.iam.permissionGroups.<a href="./src/resources/iam/permission-groups.ts">get</a>(permissionGroupId, { ...params }) -> PermissionGroupGetResponse</code> |
| 6823 | |
| 6824 | ## ResourceGroups |
| 6825 | |
| 6826 | Types: |
| 6827 | |
| 6828 | - <code><a href="./src/resources/iam/resource-groups.ts">ResourceGroupCreateResponse</a></code> |
| 6829 | - <code><a href="./src/resources/iam/resource-groups.ts">ResourceGroupUpdateResponse</a></code> |
| 6830 | - <code><a href="./src/resources/iam/resource-groups.ts">ResourceGroupListResponse</a></code> |
| 6831 | - <code><a href="./src/resources/iam/resource-groups.ts">ResourceGroupDeleteResponse</a></code> |
| 6832 | - <code><a href="./src/resources/iam/resource-groups.ts">ResourceGroupGetResponse</a></code> |
| 6833 | |
| 6834 | Methods: |
| 6835 | |
| 6836 | - <code title="post /accounts/{account_id}/iam/resource_groups">client.iam.resourceGroups.<a href="./src/resources/iam/resource-groups.ts">create</a>({ ...params }) -> ResourceGroupCreateResponse</code> |
| 6837 | - <code title="put /accounts/{account_id}/iam/resource_groups/{resource_group_id}">client.iam.resourceGroups.<a href="./src/resources/iam/resource-groups.ts">update</a>(resourceGroupId, { ...params }) -> ResourceGroupUpdateResponse</code> |
| 6838 | - <code title="get /accounts/{account_id}/iam/resource_groups">client.iam.resourceGroups.<a href="./src/resources/iam/resource-groups.ts">list</a>({ ...params }) -> ResourceGroupListResponsesV4PagePaginationArray</code> |
| 6839 | - <code title="delete /accounts/{account_id}/iam/resource_groups/{resource_group_id}">client.iam.resourceGroups.<a href="./src/resources/iam/resource-groups.ts">delete</a>(resourceGroupId, { ...params }) -> ResourceGroupDeleteResponse | null</code> |
| 6840 | - <code title="get /accounts/{account_id}/iam/resource_groups/{resource_group_id}">client.iam.resourceGroups.<a href="./src/resources/iam/resource-groups.ts">get</a>(resourceGroupId, { ...params }) -> ResourceGroupGetResponse</code> |