cloudflare/cloudflare-typescript
Publicmirrored from https://github.com/cloudflare/cloudflare-typescriptAvailable
api.md
6241lines · modecode
| 1 | # Accounts |
| 2 | |
| 3 | Types: |
| 4 | |
| 5 | - <code><a href="./src/resources/accounts/accounts.ts">Account</a></code> |
| 6 | - <code><a href="./src/resources/accounts/accounts.ts">AccountUpdateResponse</a></code> |
| 7 | - <code><a href="./src/resources/accounts/accounts.ts">AccountListResponse</a></code> |
| 8 | - <code><a href="./src/resources/accounts/accounts.ts">AccountGetResponse</a></code> |
| 9 | |
| 10 | Methods: |
| 11 | |
| 12 | - <code title="put /accounts/{account_id}">client.accounts.<a href="./src/resources/accounts/accounts.ts">update</a>({ ...params }) -> AccountUpdateResponse</code> |
| 13 | - <code title="get /accounts">client.accounts.<a href="./src/resources/accounts/accounts.ts">list</a>({ ...params }) -> AccountListResponsesV4PagePaginationArray</code> |
| 14 | - <code title="get /accounts/{account_id}">client.accounts.<a href="./src/resources/accounts/accounts.ts">get</a>({ ...params }) -> AccountGetResponse</code> |
| 15 | |
| 16 | ## Members |
| 17 | |
| 18 | Types: |
| 19 | |
| 20 | - <code><a href="./src/resources/accounts/members.ts">AccountMember</a></code> |
| 21 | - <code><a href="./src/resources/accounts/members.ts">AccountMemberWithID</a></code> |
| 22 | - <code><a href="./src/resources/accounts/members.ts">MemberListResponse</a></code> |
| 23 | - <code><a href="./src/resources/accounts/members.ts">MemberDeleteResponse</a></code> |
| 24 | |
| 25 | Methods: |
| 26 | |
| 27 | - <code title="post /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">create</a>({ ...params }) -> AccountMemberWithID</code> |
| 28 | - <code title="put /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">update</a>(memberId, { ...params }) -> AccountMember</code> |
| 29 | - <code title="get /accounts/{account_id}/members">client.accounts.members.<a href="./src/resources/accounts/members.ts">list</a>({ ...params }) -> MemberListResponsesV4PagePaginationArray</code> |
| 30 | - <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> |
| 31 | - <code title="get /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/resources/accounts/members.ts">get</a>(memberId, { ...params }) -> AccountMember</code> |
| 32 | |
| 33 | ## Roles |
| 34 | |
| 35 | Types: |
| 36 | |
| 37 | - <code><a href="./src/resources/accounts/roles.ts">IamSchemasRole</a></code> |
| 38 | - <code><a href="./src/resources/accounts/roles.ts">RoleListResponse</a></code> |
| 39 | - <code><a href="./src/resources/accounts/roles.ts">RoleGetResponse</a></code> |
| 40 | |
| 41 | Methods: |
| 42 | |
| 43 | - <code title="get /accounts/{account_id}/roles">client.accounts.roles.<a href="./src/resources/accounts/roles.ts">list</a>({ ...params }) -> RoleListResponse | null</code> |
| 44 | - <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> |
| 45 | |
| 46 | # OriginCACertificates |
| 47 | |
| 48 | Types: |
| 49 | |
| 50 | - <code><a href="./src/resources/origin-ca-certificates.ts">OriginCACertificate</a></code> |
| 51 | - <code><a href="./src/resources/origin-ca-certificates.ts">OriginCACertificateCreateResponse</a></code> |
| 52 | - <code><a href="./src/resources/origin-ca-certificates.ts">OriginCACertificateListResponse</a></code> |
| 53 | - <code><a href="./src/resources/origin-ca-certificates.ts">OriginCACertificateDeleteResponse</a></code> |
| 54 | - <code><a href="./src/resources/origin-ca-certificates.ts">OriginCACertificateGetResponse</a></code> |
| 55 | |
| 56 | Methods: |
| 57 | |
| 58 | - <code title="post /certificates">client.originCACertificates.<a href="./src/resources/origin-ca-certificates.ts">create</a>({ ...params }) -> OriginCACertificateCreateResponse</code> |
| 59 | - <code title="get /certificates">client.originCACertificates.<a href="./src/resources/origin-ca-certificates.ts">list</a>() -> OriginCACertificateListResponse | null</code> |
| 60 | - <code title="delete /certificates/{certificate_id}">client.originCACertificates.<a href="./src/resources/origin-ca-certificates.ts">delete</a>(certificateId) -> OriginCACertificateDeleteResponse</code> |
| 61 | - <code title="get /certificates/{certificate_id}">client.originCACertificates.<a href="./src/resources/origin-ca-certificates.ts">get</a>(certificateId) -> OriginCACertificateGetResponse</code> |
| 62 | |
| 63 | # IPs |
| 64 | |
| 65 | Types: |
| 66 | |
| 67 | - <code><a href="./src/resources/ips.ts">IPs</a></code> |
| 68 | - <code><a href="./src/resources/ips.ts">JDCloudIPs</a></code> |
| 69 | - <code><a href="./src/resources/ips.ts">IPListResponse</a></code> |
| 70 | |
| 71 | Methods: |
| 72 | |
| 73 | - <code title="get /ips">client.ips.<a href="./src/resources/ips.ts">list</a>({ ...params }) -> IPListResponse</code> |
| 74 | |
| 75 | # Memberships |
| 76 | |
| 77 | Types: |
| 78 | |
| 79 | - <code><a href="./src/resources/memberships.ts">Membership</a></code> |
| 80 | - <code><a href="./src/resources/memberships.ts">MembershipUpdateResponse</a></code> |
| 81 | - <code><a href="./src/resources/memberships.ts">MembershipDeleteResponse</a></code> |
| 82 | - <code><a href="./src/resources/memberships.ts">MembershipGetResponse</a></code> |
| 83 | |
| 84 | Methods: |
| 85 | |
| 86 | - <code title="put /memberships/{membership_id}">client.memberships.<a href="./src/resources/memberships.ts">update</a>(membershipId, { ...params }) -> MembershipUpdateResponse</code> |
| 87 | - <code title="get /memberships">client.memberships.<a href="./src/resources/memberships.ts">list</a>({ ...params }) -> MembershipsV4PagePaginationArray</code> |
| 88 | - <code title="delete /memberships/{membership_id}">client.memberships.<a href="./src/resources/memberships.ts">delete</a>(membershipId) -> MembershipDeleteResponse</code> |
| 89 | - <code title="get /memberships/{membership_id}">client.memberships.<a href="./src/resources/memberships.ts">get</a>(membershipId) -> MembershipGetResponse</code> |
| 90 | |
| 91 | # User |
| 92 | |
| 93 | Types: |
| 94 | |
| 95 | - <code><a href="./src/resources/user/user.ts">User</a></code> |
| 96 | - <code><a href="./src/resources/user/user.ts">UserEditResponse</a></code> |
| 97 | - <code><a href="./src/resources/user/user.ts">UserGetResponse</a></code> |
| 98 | |
| 99 | Methods: |
| 100 | |
| 101 | - <code title="patch /user">client.user.<a href="./src/resources/user/user.ts">edit</a>({ ...params }) -> UserEditResponse</code> |
| 102 | - <code title="get /user">client.user.<a href="./src/resources/user/user.ts">get</a>() -> UserGetResponse</code> |
| 103 | |
| 104 | ## AuditLogs |
| 105 | |
| 106 | Types: |
| 107 | |
| 108 | - <code><a href="./src/resources/user/audit-logs.ts">AuditLogListResponse</a></code> |
| 109 | |
| 110 | Methods: |
| 111 | |
| 112 | - <code title="get /user/audit_logs">client.user.auditLogs.<a href="./src/resources/user/audit-logs.ts">list</a>({ ...params }) -> AuditLogListResponsesV4PagePaginationArray</code> |
| 113 | |
| 114 | ## Billing |
| 115 | |
| 116 | ### History |
| 117 | |
| 118 | Types: |
| 119 | |
| 120 | - <code><a href="./src/resources/user/billing/history.ts">BillSubsAPIBillingHistory</a></code> |
| 121 | - <code><a href="./src/resources/user/billing/history.ts">HistoryGetResponse</a></code> |
| 122 | |
| 123 | Methods: |
| 124 | |
| 125 | - <code title="get /user/billing/history">client.user.billing.history.<a href="./src/resources/user/billing/history.ts">get</a>({ ...params }) -> HistoryGetResponse | null</code> |
| 126 | |
| 127 | ### Profile |
| 128 | |
| 129 | Types: |
| 130 | |
| 131 | - <code><a href="./src/resources/user/billing/profile.ts">ProfileGetResponse</a></code> |
| 132 | |
| 133 | Methods: |
| 134 | |
| 135 | - <code title="get /user/billing/profile">client.user.billing.profile.<a href="./src/resources/user/billing/profile.ts">get</a>() -> ProfileGetResponse</code> |
| 136 | |
| 137 | ## Firewall |
| 138 | |
| 139 | ### AccessRules |
| 140 | |
| 141 | Types: |
| 142 | |
| 143 | - <code><a href="./src/resources/user/firewall/access-rules.ts">LegacyJhsRule</a></code> |
| 144 | - <code><a href="./src/resources/user/firewall/access-rules.ts">AccessRuleDeleteResponse</a></code> |
| 145 | |
| 146 | Methods: |
| 147 | |
| 148 | - <code title="post /user/firewall/access_rules/rules">client.user.firewall.accessRules.<a href="./src/resources/user/firewall/access-rules.ts">create</a>({ ...params }) -> LegacyJhsRule | null</code> |
| 149 | - <code title="get /user/firewall/access_rules/rules">client.user.firewall.accessRules.<a href="./src/resources/user/firewall/access-rules.ts">list</a>({ ...params }) -> LegacyJhsRulesV4PagePaginationArray</code> |
| 150 | - <code title="delete /user/firewall/access_rules/rules/{identifier}">client.user.firewall.accessRules.<a href="./src/resources/user/firewall/access-rules.ts">delete</a>(identifier) -> AccessRuleDeleteResponse | null</code> |
| 151 | - <code title="patch /user/firewall/access_rules/rules/{identifier}">client.user.firewall.accessRules.<a href="./src/resources/user/firewall/access-rules.ts">edit</a>(identifier, { ...params }) -> LegacyJhsRule | null</code> |
| 152 | |
| 153 | ## Invites |
| 154 | |
| 155 | Types: |
| 156 | |
| 157 | - <code><a href="./src/resources/user/invites.ts">IamSchemasInvite</a></code> |
| 158 | - <code><a href="./src/resources/user/invites.ts">InviteListResponse</a></code> |
| 159 | - <code><a href="./src/resources/user/invites.ts">InviteEditResponse</a></code> |
| 160 | - <code><a href="./src/resources/user/invites.ts">InviteGetResponse</a></code> |
| 161 | |
| 162 | Methods: |
| 163 | |
| 164 | - <code title="get /user/invites">client.user.invites.<a href="./src/resources/user/invites.ts">list</a>() -> InviteListResponse | null</code> |
| 165 | - <code title="patch /user/invites/{invite_id}">client.user.invites.<a href="./src/resources/user/invites.ts">edit</a>(inviteId, { ...params }) -> InviteEditResponse</code> |
| 166 | - <code title="get /user/invites/{invite_id}">client.user.invites.<a href="./src/resources/user/invites.ts">get</a>(inviteId) -> InviteGetResponse</code> |
| 167 | |
| 168 | ## LoadBalancers |
| 169 | |
| 170 | ### Monitors |
| 171 | |
| 172 | Types: |
| 173 | |
| 174 | - <code><a href="./src/resources/user/load-balancers/monitors.ts">LoadBalancingMonitor</a></code> |
| 175 | - <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorListResponse</a></code> |
| 176 | - <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorDeleteResponse</a></code> |
| 177 | - <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorPreviewResponse</a></code> |
| 178 | - <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorReferencesResponse</a></code> |
| 179 | |
| 180 | Methods: |
| 181 | |
| 182 | - <code title="post /user/load_balancers/monitors">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">create</a>({ ...params }) -> LoadBalancingMonitor</code> |
| 183 | - <code title="put /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">update</a>(monitorId, { ...params }) -> LoadBalancingMonitor</code> |
| 184 | - <code title="get /user/load_balancers/monitors">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">list</a>() -> MonitorListResponse | null</code> |
| 185 | - <code title="delete /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">delete</a>(monitorId) -> MonitorDeleteResponse</code> |
| 186 | - <code title="patch /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">edit</a>(monitorId, { ...params }) -> LoadBalancingMonitor</code> |
| 187 | - <code title="get /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">get</a>(monitorId) -> LoadBalancingMonitor</code> |
| 188 | - <code title="post /user/load_balancers/monitors/{monitor_id}/preview">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">preview</a>(monitorId, { ...params }) -> MonitorPreviewResponse</code> |
| 189 | - <code title="get /user/load_balancers/monitors/{monitor_id}/references">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">references</a>(monitorId) -> MonitorReferencesResponse | null</code> |
| 190 | |
| 191 | ### Pools |
| 192 | |
| 193 | Types: |
| 194 | |
| 195 | - <code><a href="./src/resources/user/load-balancers/pools.ts">LoadBalancingPool</a></code> |
| 196 | - <code><a href="./src/resources/user/load-balancers/pools.ts">PoolListResponse</a></code> |
| 197 | - <code><a href="./src/resources/user/load-balancers/pools.ts">PoolDeleteResponse</a></code> |
| 198 | - <code><a href="./src/resources/user/load-balancers/pools.ts">PoolHealthResponse</a></code> |
| 199 | - <code><a href="./src/resources/user/load-balancers/pools.ts">PoolPreviewResponse</a></code> |
| 200 | - <code><a href="./src/resources/user/load-balancers/pools.ts">PoolReferencesResponse</a></code> |
| 201 | |
| 202 | Methods: |
| 203 | |
| 204 | - <code title="post /user/load_balancers/pools">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">create</a>({ ...params }) -> LoadBalancingPool</code> |
| 205 | - <code title="put /user/load_balancers/pools/{pool_id}">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">update</a>(poolId, { ...params }) -> LoadBalancingPool</code> |
| 206 | - <code title="get /user/load_balancers/pools">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">list</a>({ ...params }) -> PoolListResponse | null</code> |
| 207 | - <code title="delete /user/load_balancers/pools/{pool_id}">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">delete</a>(poolId) -> PoolDeleteResponse</code> |
| 208 | - <code title="patch /user/load_balancers/pools/{pool_id}">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">edit</a>(poolId, { ...params }) -> LoadBalancingPool</code> |
| 209 | - <code title="get /user/load_balancers/pools/{pool_id}">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">get</a>(poolId) -> LoadBalancingPool</code> |
| 210 | - <code title="get /user/load_balancers/pools/{pool_id}/health">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">health</a>(poolId) -> PoolHealthResponse</code> |
| 211 | - <code title="post /user/load_balancers/pools/{pool_id}/preview">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">preview</a>(poolId, { ...params }) -> PoolPreviewResponse</code> |
| 212 | - <code title="get /user/load_balancers/pools/{pool_id}/references">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">references</a>(poolId) -> PoolReferencesResponse | null</code> |
| 213 | |
| 214 | ### Preview |
| 215 | |
| 216 | Types: |
| 217 | |
| 218 | - <code><a href="./src/resources/user/load-balancers/preview.ts">LoadBalancingPreviewResult</a></code> |
| 219 | |
| 220 | Methods: |
| 221 | |
| 222 | - <code title="get /user/load_balancers/preview/{preview_id}">client.user.loadBalancers.preview.<a href="./src/resources/user/load-balancers/preview.ts">get</a>(previewId) -> LoadBalancingPreviewResult</code> |
| 223 | |
| 224 | ### Analytics |
| 225 | |
| 226 | #### Events |
| 227 | |
| 228 | Types: |
| 229 | |
| 230 | - <code><a href="./src/resources/user/load-balancers/analytics/events.ts">LoadBalancingAnalytics</a></code> |
| 231 | - <code><a href="./src/resources/user/load-balancers/analytics/events.ts">EventListResponse</a></code> |
| 232 | |
| 233 | Methods: |
| 234 | |
| 235 | - <code title="get /user/load_balancing_analytics/events">client.user.loadBalancers.analytics.events.<a href="./src/resources/user/load-balancers/analytics/events.ts">list</a>({ ...params }) -> EventListResponse | null</code> |
| 236 | |
| 237 | ## Organizations |
| 238 | |
| 239 | Types: |
| 240 | |
| 241 | - <code><a href="./src/resources/user/organizations.ts">IamOrganization</a></code> |
| 242 | - <code><a href="./src/resources/user/organizations.ts">OrganizationDeleteResponse</a></code> |
| 243 | - <code><a href="./src/resources/user/organizations.ts">OrganizationGetResponse</a></code> |
| 244 | |
| 245 | Methods: |
| 246 | |
| 247 | - <code title="get /user/organizations">client.user.organizations.<a href="./src/resources/user/organizations.ts">list</a>({ ...params }) -> IamOrganizationsV4PagePaginationArray</code> |
| 248 | - <code title="delete /user/organizations/{organization_id}">client.user.organizations.<a href="./src/resources/user/organizations.ts">delete</a>(organizationId) -> OrganizationDeleteResponse</code> |
| 249 | - <code title="get /user/organizations/{organization_id}">client.user.organizations.<a href="./src/resources/user/organizations.ts">get</a>(organizationId) -> OrganizationGetResponse</code> |
| 250 | |
| 251 | ## Subscriptions |
| 252 | |
| 253 | Types: |
| 254 | |
| 255 | - <code><a href="./src/resources/user/subscriptions.ts">BillSubsAPISubscription</a></code> |
| 256 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionUpdateResponse</a></code> |
| 257 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionDeleteResponse</a></code> |
| 258 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionEditResponse</a></code> |
| 259 | - <code><a href="./src/resources/user/subscriptions.ts">SubscriptionGetResponse</a></code> |
| 260 | |
| 261 | Methods: |
| 262 | |
| 263 | - <code title="put /user/subscriptions/{identifier}">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">update</a>(identifier, { ...params }) -> SubscriptionUpdateResponse</code> |
| 264 | - <code title="delete /user/subscriptions/{identifier}">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">delete</a>(identifier) -> SubscriptionDeleteResponse</code> |
| 265 | - <code title="put /zones/{identifier}/subscription">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">edit</a>(identifier, { ...params }) -> SubscriptionEditResponse</code> |
| 266 | - <code title="get /user/subscriptions">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">get</a>() -> SubscriptionGetResponse | null</code> |
| 267 | |
| 268 | ## Tokens |
| 269 | |
| 270 | Types: |
| 271 | |
| 272 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenCreateResponse</a></code> |
| 273 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenUpdateResponse</a></code> |
| 274 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenListResponse</a></code> |
| 275 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenDeleteResponse</a></code> |
| 276 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenGetResponse</a></code> |
| 277 | - <code><a href="./src/resources/user/tokens/tokens.ts">TokenVerifyResponse</a></code> |
| 278 | |
| 279 | Methods: |
| 280 | |
| 281 | - <code title="post /user/tokens">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">create</a>({ ...params }) -> TokenCreateResponse</code> |
| 282 | - <code title="put /user/tokens/{token_id}">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">update</a>(tokenId, { ...params }) -> TokenUpdateResponse</code> |
| 283 | - <code title="get /user/tokens">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">list</a>({ ...params }) -> TokenListResponsesV4PagePaginationArray</code> |
| 284 | - <code title="delete /user/tokens/{token_id}">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">delete</a>(tokenId) -> TokenDeleteResponse | null</code> |
| 285 | - <code title="get /user/tokens/{token_id}">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">get</a>(tokenId) -> TokenGetResponse</code> |
| 286 | - <code title="get /user/tokens/verify">client.user.tokens.<a href="./src/resources/user/tokens/tokens.ts">verify</a>() -> TokenVerifyResponse</code> |
| 287 | |
| 288 | ### PermissionGroups |
| 289 | |
| 290 | Types: |
| 291 | |
| 292 | - <code><a href="./src/resources/user/tokens/permission-groups.ts">PermissionGroupListResponse</a></code> |
| 293 | |
| 294 | Methods: |
| 295 | |
| 296 | - <code title="get /user/tokens/permission_groups">client.user.tokens.permissionGroups.<a href="./src/resources/user/tokens/permission-groups.ts">list</a>() -> PermissionGroupListResponse | null</code> |
| 297 | |
| 298 | ### Value |
| 299 | |
| 300 | Types: |
| 301 | |
| 302 | - <code><a href="./src/resources/user/tokens/value.ts">IamValue</a></code> |
| 303 | |
| 304 | Methods: |
| 305 | |
| 306 | - <code title="put /user/tokens/{token_id}/value">client.user.tokens.value.<a href="./src/resources/user/tokens/value.ts">update</a>(tokenId, { ...params }) -> IamValue</code> |
| 307 | |
| 308 | # Zones |
| 309 | |
| 310 | Types: |
| 311 | |
| 312 | - <code><a href="./src/resources/zones/zones.ts">Zone</a></code> |
| 313 | - <code><a href="./src/resources/zones/zones.ts">ZoneCreateResponse</a></code> |
| 314 | - <code><a href="./src/resources/zones/zones.ts">ZoneListResponse</a></code> |
| 315 | - <code><a href="./src/resources/zones/zones.ts">ZoneDeleteResponse</a></code> |
| 316 | - <code><a href="./src/resources/zones/zones.ts">ZoneEditResponse</a></code> |
| 317 | - <code><a href="./src/resources/zones/zones.ts">ZoneGetResponse</a></code> |
| 318 | |
| 319 | Methods: |
| 320 | |
| 321 | - <code title="post /zones">client.zones.<a href="./src/resources/zones/zones.ts">create</a>({ ...params }) -> ZoneCreateResponse</code> |
| 322 | - <code title="get /zones">client.zones.<a href="./src/resources/zones/zones.ts">list</a>({ ...params }) -> ZoneListResponsesV4PagePaginationArray</code> |
| 323 | - <code title="delete /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">delete</a>({ ...params }) -> ZoneDeleteResponse | null</code> |
| 324 | - <code title="patch /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">edit</a>({ ...params }) -> ZoneEditResponse</code> |
| 325 | - <code title="get /zones/{zone_id}">client.zones.<a href="./src/resources/zones/zones.ts">get</a>({ ...params }) -> ZoneGetResponse</code> |
| 326 | |
| 327 | ## ActivationCheck |
| 328 | |
| 329 | Types: |
| 330 | |
| 331 | - <code><a href="./src/resources/zones/activation-check.ts">ActivationCheckTriggerResponse</a></code> |
| 332 | |
| 333 | Methods: |
| 334 | |
| 335 | - <code title="put /zones/{zone_id}/activation_check">client.zones.activationCheck.<a href="./src/resources/zones/activation-check.ts">trigger</a>({ ...params }) -> ActivationCheckTriggerResponse</code> |
| 336 | |
| 337 | ## Settings |
| 338 | |
| 339 | Types: |
| 340 | |
| 341 | - <code><a href="./src/resources/zones/settings/settings.ts">SettingEditResponse</a></code> |
| 342 | - <code><a href="./src/resources/zones/settings/settings.ts">SettingGetResponse</a></code> |
| 343 | |
| 344 | Methods: |
| 345 | |
| 346 | - <code title="patch /zones/{zone_id}/settings">client.zones.settings.<a href="./src/resources/zones/settings/settings.ts">edit</a>({ ...params }) -> SettingEditResponse</code> |
| 347 | - <code title="get /zones/{zone_id}/settings">client.zones.settings.<a href="./src/resources/zones/settings/settings.ts">get</a>({ ...params }) -> SettingGetResponse</code> |
| 348 | |
| 349 | ### ZeroRTT |
| 350 | |
| 351 | Types: |
| 352 | |
| 353 | - <code><a href="./src/resources/zones/settings/zero-rtt.ts">Zones0rtt</a></code> |
| 354 | |
| 355 | Methods: |
| 356 | |
| 357 | - <code title="patch /zones/{zone_id}/settings/0rtt">client.zones.settings.zeroRTT.<a href="./src/resources/zones/settings/zero-rtt.ts">edit</a>({ ...params }) -> Zones0rtt</code> |
| 358 | - <code title="get /zones/{zone_id}/settings/0rtt">client.zones.settings.zeroRTT.<a href="./src/resources/zones/settings/zero-rtt.ts">get</a>({ ...params }) -> Zones0rtt</code> |
| 359 | |
| 360 | ### AdvancedDDOS |
| 361 | |
| 362 | Types: |
| 363 | |
| 364 | - <code><a href="./src/resources/zones/settings/advanced-ddos.ts">ZonesAdvancedDDOS</a></code> |
| 365 | |
| 366 | Methods: |
| 367 | |
| 368 | - <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 }) -> ZonesAdvancedDDOS</code> |
| 369 | |
| 370 | ### AlwaysOnline |
| 371 | |
| 372 | Types: |
| 373 | |
| 374 | - <code><a href="./src/resources/zones/settings/always-online.ts">ZonesAlwaysOnline</a></code> |
| 375 | |
| 376 | Methods: |
| 377 | |
| 378 | - <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 }) -> ZonesAlwaysOnline</code> |
| 379 | - <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 }) -> ZonesAlwaysOnline</code> |
| 380 | |
| 381 | ### AlwaysUseHTTPS |
| 382 | |
| 383 | Types: |
| 384 | |
| 385 | - <code><a href="./src/resources/zones/settings/always-use-https.ts">ZonesAlwaysUseHTTPS</a></code> |
| 386 | |
| 387 | Methods: |
| 388 | |
| 389 | - <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 }) -> ZonesAlwaysUseHTTPS</code> |
| 390 | - <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 }) -> ZonesAlwaysUseHTTPS</code> |
| 391 | |
| 392 | ### AutomaticHTTPSRewrites |
| 393 | |
| 394 | Types: |
| 395 | |
| 396 | - <code><a href="./src/resources/zones/settings/automatic-https-rewrites.ts">ZonesAutomaticHTTPSRewrites</a></code> |
| 397 | |
| 398 | Methods: |
| 399 | |
| 400 | - <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 }) -> ZonesAutomaticHTTPSRewrites</code> |
| 401 | - <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 }) -> ZonesAutomaticHTTPSRewrites</code> |
| 402 | |
| 403 | ### AutomaticPlatformOptimization |
| 404 | |
| 405 | Types: |
| 406 | |
| 407 | - <code><a href="./src/resources/zones/settings/automatic-platform-optimization.ts">ZonesAutomaticPlatformOptimization</a></code> |
| 408 | |
| 409 | Methods: |
| 410 | |
| 411 | - <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 }) -> ZonesAutomaticPlatformOptimization</code> |
| 412 | - <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 }) -> ZonesAutomaticPlatformOptimization</code> |
| 413 | |
| 414 | ### Brotli |
| 415 | |
| 416 | Types: |
| 417 | |
| 418 | - <code><a href="./src/resources/zones/settings/brotli.ts">ZonesBrotli</a></code> |
| 419 | |
| 420 | Methods: |
| 421 | |
| 422 | - <code title="patch /zones/{zone_id}/settings/brotli">client.zones.settings.brotli.<a href="./src/resources/zones/settings/brotli.ts">edit</a>({ ...params }) -> ZonesBrotli</code> |
| 423 | - <code title="get /zones/{zone_id}/settings/brotli">client.zones.settings.brotli.<a href="./src/resources/zones/settings/brotli.ts">get</a>({ ...params }) -> ZonesBrotli</code> |
| 424 | |
| 425 | ### BrowserCacheTTL |
| 426 | |
| 427 | Types: |
| 428 | |
| 429 | - <code><a href="./src/resources/zones/settings/browser-cache-ttl.ts">ZonesBrowserCacheTTL</a></code> |
| 430 | |
| 431 | Methods: |
| 432 | |
| 433 | - <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 }) -> ZonesBrowserCacheTTL</code> |
| 434 | - <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 }) -> ZonesBrowserCacheTTL</code> |
| 435 | |
| 436 | ### BrowserCheck |
| 437 | |
| 438 | Types: |
| 439 | |
| 440 | - <code><a href="./src/resources/zones/settings/browser-check.ts">ZonesBrowserCheck</a></code> |
| 441 | |
| 442 | Methods: |
| 443 | |
| 444 | - <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 }) -> ZonesBrowserCheck</code> |
| 445 | - <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 }) -> ZonesBrowserCheck</code> |
| 446 | |
| 447 | ### CacheLevel |
| 448 | |
| 449 | Types: |
| 450 | |
| 451 | - <code><a href="./src/resources/zones/settings/cache-level.ts">ZonesCacheLevel</a></code> |
| 452 | |
| 453 | Methods: |
| 454 | |
| 455 | - <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 }) -> ZonesCacheLevel</code> |
| 456 | - <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 }) -> ZonesCacheLevel</code> |
| 457 | |
| 458 | ### ChallengeTTL |
| 459 | |
| 460 | Types: |
| 461 | |
| 462 | - <code><a href="./src/resources/zones/settings/challenge-ttl.ts">ZonesChallengeTTL</a></code> |
| 463 | |
| 464 | Methods: |
| 465 | |
| 466 | - <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 }) -> ZonesChallengeTTL</code> |
| 467 | - <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 }) -> ZonesChallengeTTL</code> |
| 468 | |
| 469 | ### Ciphers |
| 470 | |
| 471 | Types: |
| 472 | |
| 473 | - <code><a href="./src/resources/zones/settings/ciphers.ts">ZonesCiphers</a></code> |
| 474 | |
| 475 | Methods: |
| 476 | |
| 477 | - <code title="patch /zones/{zone_id}/settings/ciphers">client.zones.settings.ciphers.<a href="./src/resources/zones/settings/ciphers.ts">edit</a>({ ...params }) -> ZonesCiphers</code> |
| 478 | - <code title="get /zones/{zone_id}/settings/ciphers">client.zones.settings.ciphers.<a href="./src/resources/zones/settings/ciphers.ts">get</a>({ ...params }) -> ZonesCiphers</code> |
| 479 | |
| 480 | ### DevelopmentMode |
| 481 | |
| 482 | Types: |
| 483 | |
| 484 | - <code><a href="./src/resources/zones/settings/development-mode.ts">ZonesDevelopmentMode</a></code> |
| 485 | |
| 486 | Methods: |
| 487 | |
| 488 | - <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 }) -> ZonesDevelopmentMode</code> |
| 489 | - <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 }) -> ZonesDevelopmentMode</code> |
| 490 | |
| 491 | ### EarlyHints |
| 492 | |
| 493 | Types: |
| 494 | |
| 495 | - <code><a href="./src/resources/zones/settings/early-hints.ts">ZonesEarlyHints</a></code> |
| 496 | |
| 497 | Methods: |
| 498 | |
| 499 | - <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 }) -> ZonesEarlyHints</code> |
| 500 | - <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 }) -> ZonesEarlyHints</code> |
| 501 | |
| 502 | ### EmailObfuscation |
| 503 | |
| 504 | Types: |
| 505 | |
| 506 | - <code><a href="./src/resources/zones/settings/email-obfuscation.ts">ZonesEmailObfuscation</a></code> |
| 507 | |
| 508 | Methods: |
| 509 | |
| 510 | - <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 }) -> ZonesEmailObfuscation</code> |
| 511 | - <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 }) -> ZonesEmailObfuscation</code> |
| 512 | |
| 513 | ### H2Prioritization |
| 514 | |
| 515 | Types: |
| 516 | |
| 517 | - <code><a href="./src/resources/zones/settings/h2-prioritization.ts">ZonesH2Prioritization</a></code> |
| 518 | |
| 519 | Methods: |
| 520 | |
| 521 | - <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 }) -> ZonesH2Prioritization</code> |
| 522 | - <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 }) -> ZonesH2Prioritization</code> |
| 523 | |
| 524 | ### HotlinkProtection |
| 525 | |
| 526 | Types: |
| 527 | |
| 528 | - <code><a href="./src/resources/zones/settings/hotlink-protection.ts">ZonesHotlinkProtection</a></code> |
| 529 | |
| 530 | Methods: |
| 531 | |
| 532 | - <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 }) -> ZonesHotlinkProtection</code> |
| 533 | - <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 }) -> ZonesHotlinkProtection</code> |
| 534 | |
| 535 | ### HTTP2 |
| 536 | |
| 537 | Types: |
| 538 | |
| 539 | - <code><a href="./src/resources/zones/settings/http2.ts">ZonesHTTP2</a></code> |
| 540 | |
| 541 | Methods: |
| 542 | |
| 543 | - <code title="patch /zones/{zone_id}/settings/http2">client.zones.settings.http2.<a href="./src/resources/zones/settings/http2.ts">edit</a>({ ...params }) -> ZonesHTTP2</code> |
| 544 | - <code title="get /zones/{zone_id}/settings/http2">client.zones.settings.http2.<a href="./src/resources/zones/settings/http2.ts">get</a>({ ...params }) -> ZonesHTTP2</code> |
| 545 | |
| 546 | ### HTTP3 |
| 547 | |
| 548 | Types: |
| 549 | |
| 550 | - <code><a href="./src/resources/zones/settings/http3.ts">ZonesHTTP3</a></code> |
| 551 | |
| 552 | Methods: |
| 553 | |
| 554 | - <code title="patch /zones/{zone_id}/settings/http3">client.zones.settings.http3.<a href="./src/resources/zones/settings/http3.ts">edit</a>({ ...params }) -> ZonesHTTP3</code> |
| 555 | - <code title="get /zones/{zone_id}/settings/http3">client.zones.settings.http3.<a href="./src/resources/zones/settings/http3.ts">get</a>({ ...params }) -> ZonesHTTP3</code> |
| 556 | |
| 557 | ### ImageResizing |
| 558 | |
| 559 | Types: |
| 560 | |
| 561 | - <code><a href="./src/resources/zones/settings/image-resizing.ts">ZonesImageResizing</a></code> |
| 562 | |
| 563 | Methods: |
| 564 | |
| 565 | - <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 }) -> ZonesImageResizing</code> |
| 566 | - <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 }) -> ZonesImageResizing</code> |
| 567 | |
| 568 | ### IPGeolocation |
| 569 | |
| 570 | Types: |
| 571 | |
| 572 | - <code><a href="./src/resources/zones/settings/ip-geolocation.ts">ZonesIPGeolocation</a></code> |
| 573 | |
| 574 | Methods: |
| 575 | |
| 576 | - <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 }) -> ZonesIPGeolocation</code> |
| 577 | - <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 }) -> ZonesIPGeolocation</code> |
| 578 | |
| 579 | ### IPV6 |
| 580 | |
| 581 | Types: |
| 582 | |
| 583 | - <code><a href="./src/resources/zones/settings/ipv6.ts">ZonesIPV6</a></code> |
| 584 | |
| 585 | Methods: |
| 586 | |
| 587 | - <code title="patch /zones/{zone_id}/settings/ipv6">client.zones.settings.ipv6.<a href="./src/resources/zones/settings/ipv6.ts">edit</a>({ ...params }) -> ZonesIPV6</code> |
| 588 | - <code title="get /zones/{zone_id}/settings/ipv6">client.zones.settings.ipv6.<a href="./src/resources/zones/settings/ipv6.ts">get</a>({ ...params }) -> ZonesIPV6</code> |
| 589 | |
| 590 | ### MinTLSVersion |
| 591 | |
| 592 | Types: |
| 593 | |
| 594 | - <code><a href="./src/resources/zones/settings/min-tls-version.ts">ZonesMinTLSVersion</a></code> |
| 595 | |
| 596 | Methods: |
| 597 | |
| 598 | - <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 }) -> ZonesMinTLSVersion</code> |
| 599 | - <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 }) -> ZonesMinTLSVersion</code> |
| 600 | |
| 601 | ### Minify |
| 602 | |
| 603 | Types: |
| 604 | |
| 605 | - <code><a href="./src/resources/zones/settings/minify.ts">ZonesMinify</a></code> |
| 606 | |
| 607 | Methods: |
| 608 | |
| 609 | - <code title="patch /zones/{zone_id}/settings/minify">client.zones.settings.minify.<a href="./src/resources/zones/settings/minify.ts">edit</a>({ ...params }) -> ZonesMinify</code> |
| 610 | - <code title="get /zones/{zone_id}/settings/minify">client.zones.settings.minify.<a href="./src/resources/zones/settings/minify.ts">get</a>({ ...params }) -> ZonesMinify</code> |
| 611 | |
| 612 | ### Mirage |
| 613 | |
| 614 | Types: |
| 615 | |
| 616 | - <code><a href="./src/resources/zones/settings/mirage.ts">ZonesMirage</a></code> |
| 617 | |
| 618 | Methods: |
| 619 | |
| 620 | - <code title="patch /zones/{zone_id}/settings/mirage">client.zones.settings.mirage.<a href="./src/resources/zones/settings/mirage.ts">edit</a>({ ...params }) -> ZonesMirage</code> |
| 621 | - <code title="get /zones/{zone_id}/settings/mirage">client.zones.settings.mirage.<a href="./src/resources/zones/settings/mirage.ts">get</a>({ ...params }) -> ZonesMirage</code> |
| 622 | |
| 623 | ### MobileRedirect |
| 624 | |
| 625 | Types: |
| 626 | |
| 627 | - <code><a href="./src/resources/zones/settings/mobile-redirect.ts">ZonesMobileRedirect</a></code> |
| 628 | |
| 629 | Methods: |
| 630 | |
| 631 | - <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 }) -> ZonesMobileRedirect</code> |
| 632 | - <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 }) -> ZonesMobileRedirect</code> |
| 633 | |
| 634 | ### NEL |
| 635 | |
| 636 | Types: |
| 637 | |
| 638 | - <code><a href="./src/resources/zones/settings/nel.ts">ZonesNEL</a></code> |
| 639 | |
| 640 | Methods: |
| 641 | |
| 642 | - <code title="patch /zones/{zone_id}/settings/nel">client.zones.settings.nel.<a href="./src/resources/zones/settings/nel.ts">edit</a>({ ...params }) -> ZonesNEL</code> |
| 643 | - <code title="get /zones/{zone_id}/settings/nel">client.zones.settings.nel.<a href="./src/resources/zones/settings/nel.ts">get</a>({ ...params }) -> ZonesNEL</code> |
| 644 | |
| 645 | ### OpportunisticEncryption |
| 646 | |
| 647 | Types: |
| 648 | |
| 649 | - <code><a href="./src/resources/zones/settings/opportunistic-encryption.ts">ZonesOpportunisticEncryption</a></code> |
| 650 | |
| 651 | Methods: |
| 652 | |
| 653 | - <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 }) -> ZonesOpportunisticEncryption</code> |
| 654 | - <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 }) -> ZonesOpportunisticEncryption</code> |
| 655 | |
| 656 | ### OpportunisticOnion |
| 657 | |
| 658 | Types: |
| 659 | |
| 660 | - <code><a href="./src/resources/zones/settings/opportunistic-onion.ts">ZonesOpportunisticOnion</a></code> |
| 661 | |
| 662 | Methods: |
| 663 | |
| 664 | - <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 }) -> ZonesOpportunisticOnion</code> |
| 665 | - <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 }) -> ZonesOpportunisticOnion</code> |
| 666 | |
| 667 | ### OrangeToOrange |
| 668 | |
| 669 | Types: |
| 670 | |
| 671 | - <code><a href="./src/resources/zones/settings/orange-to-orange.ts">ZonesOrangeToOrange</a></code> |
| 672 | |
| 673 | Methods: |
| 674 | |
| 675 | - <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 }) -> ZonesOrangeToOrange</code> |
| 676 | - <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 }) -> ZonesOrangeToOrange</code> |
| 677 | |
| 678 | ### OriginErrorPagePassThru |
| 679 | |
| 680 | Types: |
| 681 | |
| 682 | - <code><a href="./src/resources/zones/settings/origin-error-page-pass-thru.ts">ZonesOriginErrorPagePassThru</a></code> |
| 683 | |
| 684 | Methods: |
| 685 | |
| 686 | - <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 }) -> ZonesOriginErrorPagePassThru</code> |
| 687 | - <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 }) -> ZonesOriginErrorPagePassThru</code> |
| 688 | |
| 689 | ### OriginMaxHTTPVersion |
| 690 | |
| 691 | Types: |
| 692 | |
| 693 | - <code><a href="./src/resources/zones/settings/origin-max-http-version.ts">OriginMaxHTTPVersionEditResponse</a></code> |
| 694 | - <code><a href="./src/resources/zones/settings/origin-max-http-version.ts">OriginMaxHTTPVersionGetResponse</a></code> |
| 695 | |
| 696 | Methods: |
| 697 | |
| 698 | - <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> |
| 699 | - <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> |
| 700 | |
| 701 | ### Polish |
| 702 | |
| 703 | Types: |
| 704 | |
| 705 | - <code><a href="./src/resources/zones/settings/polish.ts">ZonesPolish</a></code> |
| 706 | |
| 707 | Methods: |
| 708 | |
| 709 | - <code title="patch /zones/{zone_id}/settings/polish">client.zones.settings.polish.<a href="./src/resources/zones/settings/polish.ts">edit</a>({ ...params }) -> ZonesPolish</code> |
| 710 | - <code title="get /zones/{zone_id}/settings/polish">client.zones.settings.polish.<a href="./src/resources/zones/settings/polish.ts">get</a>({ ...params }) -> ZonesPolish</code> |
| 711 | |
| 712 | ### PrefetchPreload |
| 713 | |
| 714 | Types: |
| 715 | |
| 716 | - <code><a href="./src/resources/zones/settings/prefetch-preload.ts">ZonesPrefetchPreload</a></code> |
| 717 | |
| 718 | Methods: |
| 719 | |
| 720 | - <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 }) -> ZonesPrefetchPreload</code> |
| 721 | - <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 }) -> ZonesPrefetchPreload</code> |
| 722 | |
| 723 | ### ProxyReadTimeout |
| 724 | |
| 725 | Types: |
| 726 | |
| 727 | - <code><a href="./src/resources/zones/settings/proxy-read-timeout.ts">ZonesProxyReadTimeout</a></code> |
| 728 | |
| 729 | Methods: |
| 730 | |
| 731 | - <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 }) -> ZonesProxyReadTimeout</code> |
| 732 | - <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 }) -> ZonesProxyReadTimeout</code> |
| 733 | |
| 734 | ### PseudoIPV4 |
| 735 | |
| 736 | Types: |
| 737 | |
| 738 | - <code><a href="./src/resources/zones/settings/pseudo-ipv4.ts">ZonesPseudoIPV4</a></code> |
| 739 | |
| 740 | Methods: |
| 741 | |
| 742 | - <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 }) -> ZonesPseudoIPV4</code> |
| 743 | - <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 }) -> ZonesPseudoIPV4</code> |
| 744 | |
| 745 | ### ResponseBuffering |
| 746 | |
| 747 | Types: |
| 748 | |
| 749 | - <code><a href="./src/resources/zones/settings/response-buffering.ts">ZonesBuffering</a></code> |
| 750 | |
| 751 | Methods: |
| 752 | |
| 753 | - <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 }) -> ZonesBuffering</code> |
| 754 | - <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 }) -> ZonesBuffering</code> |
| 755 | |
| 756 | ### RocketLoader |
| 757 | |
| 758 | Types: |
| 759 | |
| 760 | - <code><a href="./src/resources/zones/settings/rocket-loader.ts">ZonesRocketLoader</a></code> |
| 761 | |
| 762 | Methods: |
| 763 | |
| 764 | - <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 }) -> ZonesRocketLoader</code> |
| 765 | - <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 }) -> ZonesRocketLoader</code> |
| 766 | |
| 767 | ### SecurityHeaders |
| 768 | |
| 769 | Types: |
| 770 | |
| 771 | - <code><a href="./src/resources/zones/settings/security-headers.ts">ZonesSecurityHeader</a></code> |
| 772 | |
| 773 | Methods: |
| 774 | |
| 775 | - <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 }) -> ZonesSecurityHeader</code> |
| 776 | - <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 }) -> ZonesSecurityHeader</code> |
| 777 | |
| 778 | ### SecurityLevel |
| 779 | |
| 780 | Types: |
| 781 | |
| 782 | - <code><a href="./src/resources/zones/settings/security-level.ts">ZonesSecurityLevel</a></code> |
| 783 | |
| 784 | Methods: |
| 785 | |
| 786 | - <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 }) -> ZonesSecurityLevel</code> |
| 787 | - <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 }) -> ZonesSecurityLevel</code> |
| 788 | |
| 789 | ### ServerSideExcludes |
| 790 | |
| 791 | Types: |
| 792 | |
| 793 | - <code><a href="./src/resources/zones/settings/server-side-excludes.ts">ZonesServerSideExclude</a></code> |
| 794 | |
| 795 | Methods: |
| 796 | |
| 797 | - <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 }) -> ZonesServerSideExclude</code> |
| 798 | - <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 }) -> ZonesServerSideExclude</code> |
| 799 | |
| 800 | ### SortQueryStringForCache |
| 801 | |
| 802 | Types: |
| 803 | |
| 804 | - <code><a href="./src/resources/zones/settings/sort-query-string-for-cache.ts">ZonesSortQueryStringForCache</a></code> |
| 805 | |
| 806 | Methods: |
| 807 | |
| 808 | - <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 }) -> ZonesSortQueryStringForCache</code> |
| 809 | - <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 }) -> ZonesSortQueryStringForCache</code> |
| 810 | |
| 811 | ### SSL |
| 812 | |
| 813 | Types: |
| 814 | |
| 815 | - <code><a href="./src/resources/zones/settings/ssl.ts">ZonesSSL</a></code> |
| 816 | |
| 817 | Methods: |
| 818 | |
| 819 | - <code title="patch /zones/{zone_id}/settings/ssl">client.zones.settings.ssl.<a href="./src/resources/zones/settings/ssl.ts">edit</a>({ ...params }) -> ZonesSSL</code> |
| 820 | - <code title="get /zones/{zone_id}/settings/ssl">client.zones.settings.ssl.<a href="./src/resources/zones/settings/ssl.ts">get</a>({ ...params }) -> ZonesSSL</code> |
| 821 | |
| 822 | ### SSLRecommender |
| 823 | |
| 824 | Types: |
| 825 | |
| 826 | - <code><a href="./src/resources/zones/settings/ssl-recommender.ts">ZonesSSLRecommender</a></code> |
| 827 | |
| 828 | Methods: |
| 829 | |
| 830 | - <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 }) -> ZonesSSLRecommender</code> |
| 831 | - <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 }) -> ZonesSSLRecommender</code> |
| 832 | |
| 833 | ### TLS1_3 |
| 834 | |
| 835 | Types: |
| 836 | |
| 837 | - <code><a href="./src/resources/zones/settings/tls-1-3.ts">ZonesTLS1_3</a></code> |
| 838 | |
| 839 | Methods: |
| 840 | |
| 841 | - <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 }) -> ZonesTLS1_3</code> |
| 842 | - <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 }) -> ZonesTLS1_3</code> |
| 843 | |
| 844 | ### TLSClientAuth |
| 845 | |
| 846 | Types: |
| 847 | |
| 848 | - <code><a href="./src/resources/zones/settings/tls-client-auth.ts">ZonesTLSClientAuth</a></code> |
| 849 | |
| 850 | Methods: |
| 851 | |
| 852 | - <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 }) -> ZonesTLSClientAuth</code> |
| 853 | - <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 }) -> ZonesTLSClientAuth</code> |
| 854 | |
| 855 | ### TrueClientIPHeader |
| 856 | |
| 857 | Types: |
| 858 | |
| 859 | - <code><a href="./src/resources/zones/settings/true-client-ip-header.ts">ZonesTrueClientIPHeader</a></code> |
| 860 | |
| 861 | Methods: |
| 862 | |
| 863 | - <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 }) -> ZonesTrueClientIPHeader</code> |
| 864 | - <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 }) -> ZonesTrueClientIPHeader</code> |
| 865 | |
| 866 | ### WAF |
| 867 | |
| 868 | Types: |
| 869 | |
| 870 | - <code><a href="./src/resources/zones/settings/waf.ts">ZonesWAF</a></code> |
| 871 | |
| 872 | Methods: |
| 873 | |
| 874 | - <code title="patch /zones/{zone_id}/settings/waf">client.zones.settings.waf.<a href="./src/resources/zones/settings/waf.ts">edit</a>({ ...params }) -> ZonesWAF</code> |
| 875 | - <code title="get /zones/{zone_id}/settings/waf">client.zones.settings.waf.<a href="./src/resources/zones/settings/waf.ts">get</a>({ ...params }) -> ZonesWAF</code> |
| 876 | |
| 877 | ### Webp |
| 878 | |
| 879 | Types: |
| 880 | |
| 881 | - <code><a href="./src/resources/zones/settings/webp.ts">ZonesWebp</a></code> |
| 882 | |
| 883 | Methods: |
| 884 | |
| 885 | - <code title="patch /zones/{zone_id}/settings/webp">client.zones.settings.webp.<a href="./src/resources/zones/settings/webp.ts">edit</a>({ ...params }) -> ZonesWebp</code> |
| 886 | - <code title="get /zones/{zone_id}/settings/webp">client.zones.settings.webp.<a href="./src/resources/zones/settings/webp.ts">get</a>({ ...params }) -> ZonesWebp</code> |
| 887 | |
| 888 | ### Websocket |
| 889 | |
| 890 | Types: |
| 891 | |
| 892 | - <code><a href="./src/resources/zones/settings/websocket.ts">ZonesWebsockets</a></code> |
| 893 | |
| 894 | Methods: |
| 895 | |
| 896 | - <code title="patch /zones/{zone_id}/settings/websockets">client.zones.settings.websocket.<a href="./src/resources/zones/settings/websocket.ts">edit</a>({ ...params }) -> ZonesWebsockets</code> |
| 897 | - <code title="get /zones/{zone_id}/settings/websockets">client.zones.settings.websocket.<a href="./src/resources/zones/settings/websocket.ts">get</a>({ ...params }) -> ZonesWebsockets</code> |
| 898 | |
| 899 | ### FontSettings |
| 900 | |
| 901 | Types: |
| 902 | |
| 903 | - <code><a href="./src/resources/zones/settings/font-settings.ts">SpeedCloudflareFonts</a></code> |
| 904 | |
| 905 | Methods: |
| 906 | |
| 907 | - <code title="patch /zones/{zone_id}/settings/fonts">client.zones.settings.fontSettings.<a href="./src/resources/zones/settings/font-settings.ts">edit</a>({ ...params }) -> SpeedCloudflareFonts</code> |
| 908 | - <code title="get /zones/{zone_id}/settings/fonts">client.zones.settings.fontSettings.<a href="./src/resources/zones/settings/font-settings.ts">get</a>({ ...params }) -> SpeedCloudflareFonts</code> |
| 909 | |
| 910 | ## CustomNameservers |
| 911 | |
| 912 | Types: |
| 913 | |
| 914 | - <code><a href="./src/resources/zones/custom-nameservers.ts">CustomNameserverUpdateResponse</a></code> |
| 915 | - <code><a href="./src/resources/zones/custom-nameservers.ts">CustomNameserverGetResponse</a></code> |
| 916 | |
| 917 | Methods: |
| 918 | |
| 919 | - <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> |
| 920 | - <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> |
| 921 | |
| 922 | ## Holds |
| 923 | |
| 924 | Types: |
| 925 | |
| 926 | - <code><a href="./src/resources/zones/holds.ts">HoldCreateResponse</a></code> |
| 927 | - <code><a href="./src/resources/zones/holds.ts">HoldDeleteResponse</a></code> |
| 928 | - <code><a href="./src/resources/zones/holds.ts">HoldGetResponse</a></code> |
| 929 | |
| 930 | Methods: |
| 931 | |
| 932 | - <code title="post /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">create</a>({ ...params }) -> HoldCreateResponse</code> |
| 933 | - <code title="delete /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">delete</a>({ ...params }) -> HoldDeleteResponse</code> |
| 934 | - <code title="get /zones/{zone_id}/hold">client.zones.holds.<a href="./src/resources/zones/holds.ts">get</a>({ ...params }) -> HoldGetResponse</code> |
| 935 | |
| 936 | ## Workers |
| 937 | |
| 938 | ### Script |
| 939 | |
| 940 | Types: |
| 941 | |
| 942 | - <code><a href="./src/resources/zones/workers/script.ts">ScriptUpdateResponse</a></code> |
| 943 | |
| 944 | Methods: |
| 945 | |
| 946 | - <code title="put /zones/{zone_id}/workers/script">client.zones.workers.script.<a href="./src/resources/zones/workers/script.ts">update</a>({ ...params }) -> ScriptUpdateResponse</code> |
| 947 | - <code title="delete /zones/{zone_id}/workers/script">client.zones.workers.script.<a href="./src/resources/zones/workers/script.ts">delete</a>({ ...params }) -> void</code> |
| 948 | - <code title="get /zones/{zone_id}/workers/script">client.zones.workers.script.<a href="./src/resources/zones/workers/script.ts">get</a>({ ...params }) -> Response</code> |
| 949 | |
| 950 | ## Subscriptions |
| 951 | |
| 952 | Types: |
| 953 | |
| 954 | - <code><a href="./src/resources/zones/subscriptions.ts">SubscriptionCreateResponse</a></code> |
| 955 | - <code><a href="./src/resources/zones/subscriptions.ts">SubscriptionListResponse</a></code> |
| 956 | - <code><a href="./src/resources/zones/subscriptions.ts">SubscriptionGetResponse</a></code> |
| 957 | |
| 958 | Methods: |
| 959 | |
| 960 | - <code title="post /zones/{identifier}/subscription">client.zones.subscriptions.<a href="./src/resources/zones/subscriptions.ts">create</a>(identifier, { ...params }) -> SubscriptionCreateResponse</code> |
| 961 | - <code title="get /accounts/{account_identifier}/subscriptions">client.zones.subscriptions.<a href="./src/resources/zones/subscriptions.ts">list</a>(accountIdentifier) -> SubscriptionListResponse | null</code> |
| 962 | - <code title="get /zones/{identifier}/subscription">client.zones.subscriptions.<a href="./src/resources/zones/subscriptions.ts">get</a>(identifier) -> SubscriptionGetResponse</code> |
| 963 | |
| 964 | # LoadBalancers |
| 965 | |
| 966 | Types: |
| 967 | |
| 968 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">LoadBalancer</a></code> |
| 969 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">LoadBalancerListResponse</a></code> |
| 970 | - <code><a href="./src/resources/load-balancers/load-balancers.ts">LoadBalancerDeleteResponse</a></code> |
| 971 | |
| 972 | Methods: |
| 973 | |
| 974 | - <code title="post /zones/{zone_id}/load_balancers">client.loadBalancers.<a href="./src/resources/load-balancers/load-balancers.ts">create</a>({ ...params }) -> LoadBalancer</code> |
| 975 | - <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> |
| 976 | - <code title="get /zones/{zone_id}/load_balancers">client.loadBalancers.<a href="./src/resources/load-balancers/load-balancers.ts">list</a>({ ...params }) -> LoadBalancerListResponse | null</code> |
| 977 | - <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> |
| 978 | - <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> |
| 979 | - <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> |
| 980 | |
| 981 | ## Monitors |
| 982 | |
| 983 | Types: |
| 984 | |
| 985 | - <code><a href="./src/resources/load-balancers/monitors/monitors.ts">MonitorListResponse</a></code> |
| 986 | - <code><a href="./src/resources/load-balancers/monitors/monitors.ts">MonitorDeleteResponse</a></code> |
| 987 | |
| 988 | Methods: |
| 989 | |
| 990 | - <code title="post /accounts/{account_id}/load_balancers/monitors">client.loadBalancers.monitors.<a href="./src/resources/load-balancers/monitors/monitors.ts">create</a>({ ...params }) -> LoadBalancingMonitor</code> |
| 991 | - <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 }) -> LoadBalancingMonitor</code> |
| 992 | - <code title="get /accounts/{account_id}/load_balancers/monitors">client.loadBalancers.monitors.<a href="./src/resources/load-balancers/monitors/monitors.ts">list</a>({ ...params }) -> MonitorListResponse | null</code> |
| 993 | - <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> |
| 994 | - <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 }) -> LoadBalancingMonitor</code> |
| 995 | - <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 }) -> LoadBalancingMonitor</code> |
| 996 | |
| 997 | ### Previews |
| 998 | |
| 999 | Types: |
| 1000 | |
| 1001 | - <code><a href="./src/resources/load-balancers/monitors/previews.ts">PreviewCreateResponse</a></code> |
| 1002 | |
| 1003 | Methods: |
| 1004 | |
| 1005 | - <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> |
| 1006 | |
| 1007 | ### References |
| 1008 | |
| 1009 | Types: |
| 1010 | |
| 1011 | - <code><a href="./src/resources/load-balancers/monitors/references.ts">ReferenceGetResponse</a></code> |
| 1012 | |
| 1013 | Methods: |
| 1014 | |
| 1015 | - <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> |
| 1016 | |
| 1017 | ## Pools |
| 1018 | |
| 1019 | Types: |
| 1020 | |
| 1021 | - <code><a href="./src/resources/load-balancers/pools/pools.ts">PoolListResponse</a></code> |
| 1022 | - <code><a href="./src/resources/load-balancers/pools/pools.ts">PoolDeleteResponse</a></code> |
| 1023 | |
| 1024 | Methods: |
| 1025 | |
| 1026 | - <code title="post /accounts/{account_id}/load_balancers/pools">client.loadBalancers.pools.<a href="./src/resources/load-balancers/pools/pools.ts">create</a>({ ...params }) -> LoadBalancingPool</code> |
| 1027 | - <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 }) -> LoadBalancingPool</code> |
| 1028 | - <code title="get /accounts/{account_id}/load_balancers/pools">client.loadBalancers.pools.<a href="./src/resources/load-balancers/pools/pools.ts">list</a>({ ...params }) -> PoolListResponse | null</code> |
| 1029 | - <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> |
| 1030 | - <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 }) -> LoadBalancingPool</code> |
| 1031 | - <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 }) -> LoadBalancingPool</code> |
| 1032 | |
| 1033 | ### Health |
| 1034 | |
| 1035 | Types: |
| 1036 | |
| 1037 | - <code><a href="./src/resources/load-balancers/pools/health.ts">HealthCreateResponse</a></code> |
| 1038 | - <code><a href="./src/resources/load-balancers/pools/health.ts">HealthGetResponse</a></code> |
| 1039 | |
| 1040 | Methods: |
| 1041 | |
| 1042 | - <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> |
| 1043 | - <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> |
| 1044 | |
| 1045 | ### References |
| 1046 | |
| 1047 | Types: |
| 1048 | |
| 1049 | - <code><a href="./src/resources/load-balancers/pools/references.ts">ReferenceGetResponse</a></code> |
| 1050 | |
| 1051 | Methods: |
| 1052 | |
| 1053 | - <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> |
| 1054 | |
| 1055 | ## Previews |
| 1056 | |
| 1057 | Methods: |
| 1058 | |
| 1059 | - <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 }) -> LoadBalancingPreviewResult</code> |
| 1060 | |
| 1061 | ## Regions |
| 1062 | |
| 1063 | Types: |
| 1064 | |
| 1065 | - <code><a href="./src/resources/load-balancers/regions.ts">RegionListResponse</a></code> |
| 1066 | - <code><a href="./src/resources/load-balancers/regions.ts">RegionGetResponse</a></code> |
| 1067 | |
| 1068 | Methods: |
| 1069 | |
| 1070 | - <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> |
| 1071 | - <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> |
| 1072 | |
| 1073 | ## Searches |
| 1074 | |
| 1075 | Types: |
| 1076 | |
| 1077 | - <code><a href="./src/resources/load-balancers/searches.ts">SearchGetResponse</a></code> |
| 1078 | |
| 1079 | Methods: |
| 1080 | |
| 1081 | - <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> |
| 1082 | |
| 1083 | # Cache |
| 1084 | |
| 1085 | Types: |
| 1086 | |
| 1087 | - <code><a href="./src/resources/cache/cache.ts">CachePurgeResponse</a></code> |
| 1088 | |
| 1089 | Methods: |
| 1090 | |
| 1091 | - <code title="post /zones/{zone_id}/purge_cache">client.cache.<a href="./src/resources/cache/cache.ts">purge</a>({ ...params }) -> CachePurgeResponse | null</code> |
| 1092 | |
| 1093 | ## CacheReserve |
| 1094 | |
| 1095 | Types: |
| 1096 | |
| 1097 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveClearResponse</a></code> |
| 1098 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveEditResponse</a></code> |
| 1099 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveGetResponse</a></code> |
| 1100 | - <code><a href="./src/resources/cache/cache-reserve.ts">CacheReserveStatusResponse</a></code> |
| 1101 | |
| 1102 | Methods: |
| 1103 | |
| 1104 | - <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> |
| 1105 | - <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> |
| 1106 | - <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> |
| 1107 | - <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> |
| 1108 | |
| 1109 | ## SmartTieredCache |
| 1110 | |
| 1111 | Types: |
| 1112 | |
| 1113 | - <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheDeleteResponse</a></code> |
| 1114 | - <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheEditResponse</a></code> |
| 1115 | - <code><a href="./src/resources/cache/smart-tiered-cache.ts">SmartTieredCacheGetResponse</a></code> |
| 1116 | |
| 1117 | Methods: |
| 1118 | |
| 1119 | - <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> |
| 1120 | - <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> |
| 1121 | - <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> |
| 1122 | |
| 1123 | ## Variants |
| 1124 | |
| 1125 | Types: |
| 1126 | |
| 1127 | - <code><a href="./src/resources/cache/variants.ts">CacheVariants</a></code> |
| 1128 | - <code><a href="./src/resources/cache/variants.ts">VariantEditResponse</a></code> |
| 1129 | - <code><a href="./src/resources/cache/variants.ts">VariantGetResponse</a></code> |
| 1130 | |
| 1131 | Methods: |
| 1132 | |
| 1133 | - <code title="delete /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">delete</a>({ ...params }) -> CacheVariants</code> |
| 1134 | - <code title="patch /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">edit</a>({ ...params }) -> VariantEditResponse</code> |
| 1135 | - <code title="get /zones/{zone_id}/cache/variants">client.cache.variants.<a href="./src/resources/cache/variants.ts">get</a>({ ...params }) -> VariantGetResponse</code> |
| 1136 | |
| 1137 | ## RegionalTieredCache |
| 1138 | |
| 1139 | Types: |
| 1140 | |
| 1141 | - <code><a href="./src/resources/cache/regional-tiered-cache.ts">RegionalTieredCacheEditResponse</a></code> |
| 1142 | - <code><a href="./src/resources/cache/regional-tiered-cache.ts">RegionalTieredCacheGetResponse</a></code> |
| 1143 | |
| 1144 | Methods: |
| 1145 | |
| 1146 | - <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> |
| 1147 | - <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> |
| 1148 | |
| 1149 | # SSL |
| 1150 | |
| 1151 | ## Analyze |
| 1152 | |
| 1153 | Types: |
| 1154 | |
| 1155 | - <code><a href="./src/resources/ssl/analyze.ts">AnalyzeCreateResponse</a></code> |
| 1156 | |
| 1157 | Methods: |
| 1158 | |
| 1159 | - <code title="post /zones/{zone_id}/ssl/analyze">client.ssl.analyze.<a href="./src/resources/ssl/analyze.ts">create</a>({ ...params }) -> AnalyzeCreateResponse</code> |
| 1160 | |
| 1161 | ## CertificatePacks |
| 1162 | |
| 1163 | Types: |
| 1164 | |
| 1165 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">CertificatePackListResponse</a></code> |
| 1166 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">CertificatePackDeleteResponse</a></code> |
| 1167 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">CertificatePackEditResponse</a></code> |
| 1168 | - <code><a href="./src/resources/ssl/certificate-packs/certificate-packs.ts">CertificatePackGetResponse</a></code> |
| 1169 | |
| 1170 | Methods: |
| 1171 | |
| 1172 | - <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 }) -> CertificatePackListResponse | null</code> |
| 1173 | - <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> |
| 1174 | - <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> |
| 1175 | - <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> |
| 1176 | |
| 1177 | ### Order |
| 1178 | |
| 1179 | Types: |
| 1180 | |
| 1181 | - <code><a href="./src/resources/ssl/certificate-packs/order.ts">OrderCreateResponse</a></code> |
| 1182 | |
| 1183 | Methods: |
| 1184 | |
| 1185 | - <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> |
| 1186 | |
| 1187 | ### Quota |
| 1188 | |
| 1189 | Types: |
| 1190 | |
| 1191 | - <code><a href="./src/resources/ssl/certificate-packs/quota.ts">QuotaGetResponse</a></code> |
| 1192 | |
| 1193 | Methods: |
| 1194 | |
| 1195 | - <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> |
| 1196 | |
| 1197 | ## Recommendations |
| 1198 | |
| 1199 | Types: |
| 1200 | |
| 1201 | - <code><a href="./src/resources/ssl/recommendations.ts">RecommendationGetResponse</a></code> |
| 1202 | |
| 1203 | Methods: |
| 1204 | |
| 1205 | - <code title="get /zones/{zone_identifier}/ssl/recommendation">client.ssl.recommendations.<a href="./src/resources/ssl/recommendations.ts">get</a>(zoneIdentifier) -> RecommendationGetResponse | null</code> |
| 1206 | |
| 1207 | ## Universal |
| 1208 | |
| 1209 | ### Settings |
| 1210 | |
| 1211 | Types: |
| 1212 | |
| 1213 | - <code><a href="./src/resources/ssl/universal/settings.ts">TLSCertificatesAndHostnamesUniversal</a></code> |
| 1214 | |
| 1215 | Methods: |
| 1216 | |
| 1217 | - <code title="patch /zones/{zone_id}/ssl/universal/settings">client.ssl.universal.settings.<a href="./src/resources/ssl/universal/settings.ts">edit</a>({ ...params }) -> TLSCertificatesAndHostnamesUniversal</code> |
| 1218 | - <code title="get /zones/{zone_id}/ssl/universal/settings">client.ssl.universal.settings.<a href="./src/resources/ssl/universal/settings.ts">get</a>({ ...params }) -> TLSCertificatesAndHostnamesUniversal</code> |
| 1219 | |
| 1220 | ## Verification |
| 1221 | |
| 1222 | Types: |
| 1223 | |
| 1224 | - <code><a href="./src/resources/ssl/verification.ts">TLSCertificatesAndHostnamesVerification</a></code> |
| 1225 | - <code><a href="./src/resources/ssl/verification.ts">VerificationEditResponse</a></code> |
| 1226 | - <code><a href="./src/resources/ssl/verification.ts">VerificationGetResponse</a></code> |
| 1227 | |
| 1228 | Methods: |
| 1229 | |
| 1230 | - <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> |
| 1231 | - <code title="get /zones/{zone_id}/ssl/verification">client.ssl.verification.<a href="./src/resources/ssl/verification.ts">get</a>({ ...params }) -> VerificationGetResponse</code> |
| 1232 | |
| 1233 | # Subscriptions |
| 1234 | |
| 1235 | Types: |
| 1236 | |
| 1237 | - <code><a href="./src/resources/subscriptions.ts">SubscriptionCreateResponse</a></code> |
| 1238 | - <code><a href="./src/resources/subscriptions.ts">SubscriptionUpdateResponse</a></code> |
| 1239 | - <code><a href="./src/resources/subscriptions.ts">SubscriptionListResponse</a></code> |
| 1240 | - <code><a href="./src/resources/subscriptions.ts">SubscriptionDeleteResponse</a></code> |
| 1241 | - <code><a href="./src/resources/subscriptions.ts">SubscriptionGetResponse</a></code> |
| 1242 | |
| 1243 | Methods: |
| 1244 | |
| 1245 | - <code title="post /zones/{identifier}/subscription">client.subscriptions.<a href="./src/resources/subscriptions.ts">create</a>(identifier, { ...params }) -> SubscriptionCreateResponse</code> |
| 1246 | - <code title="put /accounts/{account_identifier}/subscriptions/{subscription_identifier}">client.subscriptions.<a href="./src/resources/subscriptions.ts">update</a>(accountIdentifier, subscriptionIdentifier, { ...params }) -> SubscriptionUpdateResponse</code> |
| 1247 | - <code title="get /accounts/{account_identifier}/subscriptions">client.subscriptions.<a href="./src/resources/subscriptions.ts">list</a>(accountIdentifier) -> SubscriptionListResponse | null</code> |
| 1248 | - <code title="delete /accounts/{account_identifier}/subscriptions/{subscription_identifier}">client.subscriptions.<a href="./src/resources/subscriptions.ts">delete</a>(accountIdentifier, subscriptionIdentifier) -> SubscriptionDeleteResponse</code> |
| 1249 | - <code title="get /zones/{identifier}/subscription">client.subscriptions.<a href="./src/resources/subscriptions.ts">get</a>(identifier) -> SubscriptionGetResponse</code> |
| 1250 | |
| 1251 | # ACM |
| 1252 | |
| 1253 | ## TotalTLS |
| 1254 | |
| 1255 | Types: |
| 1256 | |
| 1257 | - <code><a href="./src/resources/acm/total-tls.ts">TotalTLSCreateResponse</a></code> |
| 1258 | - <code><a href="./src/resources/acm/total-tls.ts">TotalTLSGetResponse</a></code> |
| 1259 | |
| 1260 | Methods: |
| 1261 | |
| 1262 | - <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> |
| 1263 | - <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> |
| 1264 | |
| 1265 | # Argo |
| 1266 | |
| 1267 | ## SmartRouting |
| 1268 | |
| 1269 | Types: |
| 1270 | |
| 1271 | - <code><a href="./src/resources/argo/smart-routing.ts">SmartRoutingEditResponse</a></code> |
| 1272 | - <code><a href="./src/resources/argo/smart-routing.ts">SmartRoutingGetResponse</a></code> |
| 1273 | |
| 1274 | Methods: |
| 1275 | |
| 1276 | - <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> |
| 1277 | - <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> |
| 1278 | |
| 1279 | ## TieredCaching |
| 1280 | |
| 1281 | Types: |
| 1282 | |
| 1283 | - <code><a href="./src/resources/argo/tiered-caching.ts">TieredCachingEditResponse</a></code> |
| 1284 | - <code><a href="./src/resources/argo/tiered-caching.ts">TieredCachingGetResponse</a></code> |
| 1285 | |
| 1286 | Methods: |
| 1287 | |
| 1288 | - <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> |
| 1289 | - <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> |
| 1290 | |
| 1291 | # AvailablePlans |
| 1292 | |
| 1293 | Types: |
| 1294 | |
| 1295 | - <code><a href="./src/resources/available-plans.ts">BillSubsAPIAvailableRatePlan</a></code> |
| 1296 | - <code><a href="./src/resources/available-plans.ts">AvailablePlanListResponse</a></code> |
| 1297 | |
| 1298 | Methods: |
| 1299 | |
| 1300 | - <code title="get /zones/{zone_identifier}/available_plans">client.availablePlans.<a href="./src/resources/available-plans.ts">list</a>(zoneIdentifier) -> AvailablePlanListResponse | null</code> |
| 1301 | - <code title="get /zones/{zone_identifier}/available_plans/{plan_identifier}">client.availablePlans.<a href="./src/resources/available-plans.ts">get</a>(zoneIdentifier, planIdentifier) -> BillSubsAPIAvailableRatePlan</code> |
| 1302 | |
| 1303 | # AvailableRatePlans |
| 1304 | |
| 1305 | Types: |
| 1306 | |
| 1307 | - <code><a href="./src/resources/available-rate-plans.ts">BillSubsRatePlan</a></code> |
| 1308 | - <code><a href="./src/resources/available-rate-plans.ts">AvailableRatePlanGetResponse</a></code> |
| 1309 | |
| 1310 | Methods: |
| 1311 | |
| 1312 | - <code title="get /zones/{zone_identifier}/available_rate_plans">client.availableRatePlans.<a href="./src/resources/available-rate-plans.ts">get</a>(zoneIdentifier) -> AvailableRatePlanGetResponse | null</code> |
| 1313 | |
| 1314 | # CertificateAuthorities |
| 1315 | |
| 1316 | ## HostnameAssociations |
| 1317 | |
| 1318 | Types: |
| 1319 | |
| 1320 | - <code><a href="./src/resources/certificate-authorities/hostname-associations.ts">TLSCertificatesAndHostnamesHostnameAssociation</a></code> |
| 1321 | |
| 1322 | Methods: |
| 1323 | |
| 1324 | - <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 }) -> TLSCertificatesAndHostnamesHostnameAssociation</code> |
| 1325 | - <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 }) -> TLSCertificatesAndHostnamesHostnameAssociation</code> |
| 1326 | |
| 1327 | # ClientCertificates |
| 1328 | |
| 1329 | Types: |
| 1330 | |
| 1331 | - <code><a href="./src/resources/client-certificates.ts">TLSCertificatesAndHostnamesClientCertificate</a></code> |
| 1332 | |
| 1333 | Methods: |
| 1334 | |
| 1335 | - <code title="post /zones/{zone_id}/client_certificates">client.clientCertificates.<a href="./src/resources/client-certificates.ts">create</a>({ ...params }) -> TLSCertificatesAndHostnamesClientCertificate</code> |
| 1336 | - <code title="get /zones/{zone_id}/client_certificates">client.clientCertificates.<a href="./src/resources/client-certificates.ts">list</a>({ ...params }) -> TLSCertificatesAndHostnamesClientCertificatesV4PagePaginationArray</code> |
| 1337 | - <code title="delete /zones/{zone_id}/client_certificates/{client_certificate_id}">client.clientCertificates.<a href="./src/resources/client-certificates.ts">delete</a>(clientCertificateId, { ...params }) -> TLSCertificatesAndHostnamesClientCertificate</code> |
| 1338 | - <code title="patch /zones/{zone_id}/client_certificates/{client_certificate_id}">client.clientCertificates.<a href="./src/resources/client-certificates.ts">edit</a>(clientCertificateId, { ...params }) -> TLSCertificatesAndHostnamesClientCertificate</code> |
| 1339 | - <code title="get /zones/{zone_id}/client_certificates/{client_certificate_id}">client.clientCertificates.<a href="./src/resources/client-certificates.ts">get</a>(clientCertificateId, { ...params }) -> TLSCertificatesAndHostnamesClientCertificate</code> |
| 1340 | |
| 1341 | # CustomCertificates |
| 1342 | |
| 1343 | Types: |
| 1344 | |
| 1345 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">TLSCertificatesAndHostnamesCustomCertificate</a></code> |
| 1346 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">CustomCertificateCreateResponse</a></code> |
| 1347 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">CustomCertificateDeleteResponse</a></code> |
| 1348 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">CustomCertificateEditResponse</a></code> |
| 1349 | - <code><a href="./src/resources/custom-certificates/custom-certificates.ts">CustomCertificateGetResponse</a></code> |
| 1350 | |
| 1351 | Methods: |
| 1352 | |
| 1353 | - <code title="post /zones/{zone_id}/custom_certificates">client.customCertificates.<a href="./src/resources/custom-certificates/custom-certificates.ts">create</a>({ ...params }) -> CustomCertificateCreateResponse</code> |
| 1354 | - <code title="get /zones/{zone_id}/custom_certificates">client.customCertificates.<a href="./src/resources/custom-certificates/custom-certificates.ts">list</a>({ ...params }) -> TLSCertificatesAndHostnamesCustomCertificatesV4PagePaginationArray</code> |
| 1355 | - <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> |
| 1356 | - <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> |
| 1357 | - <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> |
| 1358 | |
| 1359 | ## Prioritize |
| 1360 | |
| 1361 | Types: |
| 1362 | |
| 1363 | - <code><a href="./src/resources/custom-certificates/prioritize.ts">PrioritizeUpdateResponse</a></code> |
| 1364 | |
| 1365 | Methods: |
| 1366 | |
| 1367 | - <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> |
| 1368 | |
| 1369 | # CustomHostnames |
| 1370 | |
| 1371 | Types: |
| 1372 | |
| 1373 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">TLSCertificatesAndHostnamesCustomHostname</a></code> |
| 1374 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameCreateResponse</a></code> |
| 1375 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameListResponse</a></code> |
| 1376 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameDeleteResponse</a></code> |
| 1377 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameEditResponse</a></code> |
| 1378 | - <code><a href="./src/resources/custom-hostnames/custom-hostnames.ts">CustomHostnameGetResponse</a></code> |
| 1379 | |
| 1380 | Methods: |
| 1381 | |
| 1382 | - <code title="post /zones/{zone_id}/custom_hostnames">client.customHostnames.<a href="./src/resources/custom-hostnames/custom-hostnames.ts">create</a>({ ...params }) -> CustomHostnameCreateResponse</code> |
| 1383 | - <code title="get /zones/{zone_id}/custom_hostnames">client.customHostnames.<a href="./src/resources/custom-hostnames/custom-hostnames.ts">list</a>({ ...params }) -> CustomHostnameListResponsesV4PagePaginationArray</code> |
| 1384 | - <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> |
| 1385 | - <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> |
| 1386 | - <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> |
| 1387 | |
| 1388 | ## FallbackOrigin |
| 1389 | |
| 1390 | Types: |
| 1391 | |
| 1392 | - <code><a href="./src/resources/custom-hostnames/fallback-origin.ts">FallbackOriginUpdateResponse</a></code> |
| 1393 | - <code><a href="./src/resources/custom-hostnames/fallback-origin.ts">FallbackOriginDeleteResponse</a></code> |
| 1394 | - <code><a href="./src/resources/custom-hostnames/fallback-origin.ts">FallbackOriginGetResponse</a></code> |
| 1395 | |
| 1396 | Methods: |
| 1397 | |
| 1398 | - <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> |
| 1399 | - <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> |
| 1400 | - <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> |
| 1401 | |
| 1402 | # CustomNameservers |
| 1403 | |
| 1404 | Types: |
| 1405 | |
| 1406 | - <code><a href="./src/resources/custom-nameservers.ts">DNSCustomNameserversCustomNS</a></code> |
| 1407 | - <code><a href="./src/resources/custom-nameservers.ts">CustomNameserverDeleteResponse</a></code> |
| 1408 | - <code><a href="./src/resources/custom-nameservers.ts">CustomNameserverAvailabiltyResponse</a></code> |
| 1409 | - <code><a href="./src/resources/custom-nameservers.ts">CustomNameserverGetResponse</a></code> |
| 1410 | - <code><a href="./src/resources/custom-nameservers.ts">CustomNameserverVerifyResponse</a></code> |
| 1411 | |
| 1412 | Methods: |
| 1413 | |
| 1414 | - <code title="post /accounts/{account_id}/custom_ns">client.customNameservers.<a href="./src/resources/custom-nameservers.ts">create</a>({ ...params }) -> DNSCustomNameserversCustomNS</code> |
| 1415 | - <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> |
| 1416 | - <code title="get /accounts/{account_id}/custom_ns/availability">client.customNameservers.<a href="./src/resources/custom-nameservers.ts">availabilty</a>({ ...params }) -> CustomNameserverAvailabiltyResponse | null</code> |
| 1417 | - <code title="get /accounts/{account_id}/custom_ns">client.customNameservers.<a href="./src/resources/custom-nameservers.ts">get</a>({ ...params }) -> CustomNameserverGetResponse | null</code> |
| 1418 | - <code title="post /accounts/{account_id}/custom_ns/verify">client.customNameservers.<a href="./src/resources/custom-nameservers.ts">verify</a>({ ...params }) -> CustomNameserverVerifyResponse | null</code> |
| 1419 | |
| 1420 | # DNS |
| 1421 | |
| 1422 | ## Records |
| 1423 | |
| 1424 | Types: |
| 1425 | |
| 1426 | - <code><a href="./src/resources/dns/records.ts">DNSRecord</a></code> |
| 1427 | - <code><a href="./src/resources/dns/records.ts">RecordCreateResponse</a></code> |
| 1428 | - <code><a href="./src/resources/dns/records.ts">RecordUpdateResponse</a></code> |
| 1429 | - <code><a href="./src/resources/dns/records.ts">RecordListResponse</a></code> |
| 1430 | - <code><a href="./src/resources/dns/records.ts">RecordDeleteResponse</a></code> |
| 1431 | - <code><a href="./src/resources/dns/records.ts">RecordEditResponse</a></code> |
| 1432 | - <code><a href="./src/resources/dns/records.ts">RecordExportResponse</a></code> |
| 1433 | - <code><a href="./src/resources/dns/records.ts">RecordGetResponse</a></code> |
| 1434 | - <code><a href="./src/resources/dns/records.ts">RecordImportResponse</a></code> |
| 1435 | - <code><a href="./src/resources/dns/records.ts">RecordScanResponse</a></code> |
| 1436 | |
| 1437 | Methods: |
| 1438 | |
| 1439 | - <code title="post /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/resources/dns/records.ts">create</a>({ ...params }) -> RecordCreateResponse</code> |
| 1440 | - <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 }) -> RecordUpdateResponse</code> |
| 1441 | - <code title="get /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/resources/dns/records.ts">list</a>({ ...params }) -> RecordListResponsesV4PagePaginationArray</code> |
| 1442 | - <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> |
| 1443 | - <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 }) -> RecordEditResponse</code> |
| 1444 | - <code title="get /zones/{zone_id}/dns_records/export">client.dns.records.<a href="./src/resources/dns/records.ts">export</a>({ ...params }) -> string</code> |
| 1445 | - <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 }) -> RecordGetResponse</code> |
| 1446 | - <code title="post /zones/{zone_id}/dns_records/import">client.dns.records.<a href="./src/resources/dns/records.ts">import</a>({ ...params }) -> RecordImportResponse</code> |
| 1447 | - <code title="post /zones/{zone_id}/dns_records/scan">client.dns.records.<a href="./src/resources/dns/records.ts">scan</a>({ ...params }) -> RecordScanResponse</code> |
| 1448 | |
| 1449 | ## Analytics |
| 1450 | |
| 1451 | ### Reports |
| 1452 | |
| 1453 | Types: |
| 1454 | |
| 1455 | - <code><a href="./src/resources/dns/analytics/reports/reports.ts">DNSDNSAnalyticsAPIReport</a></code> |
| 1456 | |
| 1457 | Methods: |
| 1458 | |
| 1459 | - <code title="get /zones/{identifier}/dns_analytics/report">client.dns.analytics.reports.<a href="./src/resources/dns/analytics/reports/reports.ts">get</a>(identifier, { ...params }) -> DNSDNSAnalyticsAPIReport</code> |
| 1460 | |
| 1461 | #### Bytimes |
| 1462 | |
| 1463 | Types: |
| 1464 | |
| 1465 | - <code><a href="./src/resources/dns/analytics/reports/bytimes.ts">DNSDNSAnalyticsAPIReportBytime</a></code> |
| 1466 | |
| 1467 | Methods: |
| 1468 | |
| 1469 | - <code title="get /zones/{identifier}/dns_analytics/report/bytime">client.dns.analytics.reports.bytimes.<a href="./src/resources/dns/analytics/reports/bytimes.ts">get</a>(identifier, { ...params }) -> DNSDNSAnalyticsAPIReportBytime</code> |
| 1470 | |
| 1471 | ## Firewall |
| 1472 | |
| 1473 | Types: |
| 1474 | |
| 1475 | - <code><a href="./src/resources/dns/firewall/firewall.ts">DNSFirewallDNSFirewall</a></code> |
| 1476 | - <code><a href="./src/resources/dns/firewall/firewall.ts">FirewallDeleteResponse</a></code> |
| 1477 | |
| 1478 | Methods: |
| 1479 | |
| 1480 | - <code title="post /accounts/{account_id}/dns_firewall">client.dns.firewall.<a href="./src/resources/dns/firewall/firewall.ts">create</a>({ ...params }) -> DNSFirewallDNSFirewall</code> |
| 1481 | - <code title="get /accounts/{account_id}/dns_firewall">client.dns.firewall.<a href="./src/resources/dns/firewall/firewall.ts">list</a>({ ...params }) -> DNSFirewallDNSFirewallsV4PagePaginationArray</code> |
| 1482 | - <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> |
| 1483 | - <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 }) -> DNSFirewallDNSFirewall</code> |
| 1484 | - <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 }) -> DNSFirewallDNSFirewall</code> |
| 1485 | |
| 1486 | ### Analytics |
| 1487 | |
| 1488 | #### Reports |
| 1489 | |
| 1490 | Methods: |
| 1491 | |
| 1492 | - <code title="get /accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report">client.dns.firewall.analytics.reports.<a href="./src/resources/dns/firewall/analytics/reports/reports.ts">get</a>(accountIdentifier, identifier, { ...params }) -> DNSDNSAnalyticsAPIReport</code> |
| 1493 | |
| 1494 | ##### Bytimes |
| 1495 | |
| 1496 | Methods: |
| 1497 | |
| 1498 | - <code title="get /accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report/bytime">client.dns.firewall.analytics.reports.bytimes.<a href="./src/resources/dns/firewall/analytics/reports/bytimes.ts">get</a>(accountIdentifier, identifier, { ...params }) -> DNSDNSAnalyticsAPIReportBytime</code> |
| 1499 | |
| 1500 | # DNSSEC |
| 1501 | |
| 1502 | Types: |
| 1503 | |
| 1504 | - <code><a href="./src/resources/dnssec.ts">DNSSECDNSSEC</a></code> |
| 1505 | - <code><a href="./src/resources/dnssec.ts">DNSSECDeleteResponse</a></code> |
| 1506 | |
| 1507 | Methods: |
| 1508 | |
| 1509 | - <code title="delete /zones/{zone_id}/dnssec">client.dnssec.<a href="./src/resources/dnssec.ts">delete</a>({ ...params }) -> DNSSECDeleteResponse</code> |
| 1510 | - <code title="patch /zones/{zone_id}/dnssec">client.dnssec.<a href="./src/resources/dnssec.ts">edit</a>({ ...params }) -> DNSSECDNSSEC</code> |
| 1511 | - <code title="get /zones/{zone_id}/dnssec">client.dnssec.<a href="./src/resources/dnssec.ts">get</a>({ ...params }) -> DNSSECDNSSEC</code> |
| 1512 | |
| 1513 | # EmailRouting |
| 1514 | |
| 1515 | ## Routing |
| 1516 | |
| 1517 | Types: |
| 1518 | |
| 1519 | - <code><a href="./src/resources/email-routing/routing/routing.ts">EmailSettings</a></code> |
| 1520 | - <code><a href="./src/resources/email-routing/routing/routing.ts">RoutingDisableResponse</a></code> |
| 1521 | - <code><a href="./src/resources/email-routing/routing/routing.ts">RoutingEnableResponse</a></code> |
| 1522 | - <code><a href="./src/resources/email-routing/routing/routing.ts">RoutingGetResponse</a></code> |
| 1523 | |
| 1524 | Methods: |
| 1525 | |
| 1526 | - <code title="post /zones/{zone_identifier}/email/routing/disable">client.emailRouting.routing.<a href="./src/resources/email-routing/routing/routing.ts">disable</a>(zoneIdentifier) -> RoutingDisableResponse</code> |
| 1527 | - <code title="post /zones/{zone_identifier}/email/routing/enable">client.emailRouting.routing.<a href="./src/resources/email-routing/routing/routing.ts">enable</a>(zoneIdentifier) -> RoutingEnableResponse</code> |
| 1528 | - <code title="get /zones/{zone_identifier}/email/routing">client.emailRouting.routing.<a href="./src/resources/email-routing/routing/routing.ts">get</a>(zoneIdentifier) -> RoutingGetResponse</code> |
| 1529 | |
| 1530 | ### DNS |
| 1531 | |
| 1532 | Types: |
| 1533 | |
| 1534 | - <code><a href="./src/resources/email-routing/routing/dns.ts">EmailDNSRecord</a></code> |
| 1535 | - <code><a href="./src/resources/email-routing/routing/dns.ts">DNSGetResponse</a></code> |
| 1536 | |
| 1537 | Methods: |
| 1538 | |
| 1539 | - <code title="get /zones/{zone_identifier}/email/routing/dns">client.emailRouting.routing.dns.<a href="./src/resources/email-routing/routing/dns.ts">get</a>(zoneIdentifier) -> DNSGetResponse | null</code> |
| 1540 | |
| 1541 | ### Rules |
| 1542 | |
| 1543 | Types: |
| 1544 | |
| 1545 | - <code><a href="./src/resources/email-routing/routing/rules/rules.ts">EmailRules</a></code> |
| 1546 | - <code><a href="./src/resources/email-routing/routing/rules/rules.ts">RuleCreateResponse</a></code> |
| 1547 | - <code><a href="./src/resources/email-routing/routing/rules/rules.ts">RuleUpdateResponse</a></code> |
| 1548 | - <code><a href="./src/resources/email-routing/routing/rules/rules.ts">RuleListResponse</a></code> |
| 1549 | - <code><a href="./src/resources/email-routing/routing/rules/rules.ts">RuleDeleteResponse</a></code> |
| 1550 | - <code><a href="./src/resources/email-routing/routing/rules/rules.ts">RuleGetResponse</a></code> |
| 1551 | |
| 1552 | Methods: |
| 1553 | |
| 1554 | - <code title="post /zones/{zone_identifier}/email/routing/rules">client.emailRouting.routing.rules.<a href="./src/resources/email-routing/routing/rules/rules.ts">create</a>(zoneIdentifier, { ...params }) -> RuleCreateResponse</code> |
| 1555 | - <code title="put /zones/{zone_identifier}/email/routing/rules/{rule_identifier}">client.emailRouting.routing.rules.<a href="./src/resources/email-routing/routing/rules/rules.ts">update</a>(zoneIdentifier, ruleIdentifier, { ...params }) -> RuleUpdateResponse</code> |
| 1556 | - <code title="get /zones/{zone_identifier}/email/routing/rules">client.emailRouting.routing.rules.<a href="./src/resources/email-routing/routing/rules/rules.ts">list</a>(zoneIdentifier, { ...params }) -> RuleListResponsesV4PagePaginationArray</code> |
| 1557 | - <code title="delete /zones/{zone_identifier}/email/routing/rules/{rule_identifier}">client.emailRouting.routing.rules.<a href="./src/resources/email-routing/routing/rules/rules.ts">delete</a>(zoneIdentifier, ruleIdentifier) -> RuleDeleteResponse</code> |
| 1558 | - <code title="get /zones/{zone_identifier}/email/routing/rules/{rule_identifier}">client.emailRouting.routing.rules.<a href="./src/resources/email-routing/routing/rules/rules.ts">get</a>(zoneIdentifier, ruleIdentifier) -> RuleGetResponse</code> |
| 1559 | |
| 1560 | #### CatchAlls |
| 1561 | |
| 1562 | Types: |
| 1563 | |
| 1564 | - <code><a href="./src/resources/email-routing/routing/rules/catch-alls.ts">EmailCatchAllRule</a></code> |
| 1565 | |
| 1566 | Methods: |
| 1567 | |
| 1568 | - <code title="put /zones/{zone_identifier}/email/routing/rules/catch_all">client.emailRouting.routing.rules.catchAlls.<a href="./src/resources/email-routing/routing/rules/catch-alls.ts">update</a>(zoneIdentifier, { ...params }) -> EmailCatchAllRule</code> |
| 1569 | - <code title="get /zones/{zone_identifier}/email/routing/rules/catch_all">client.emailRouting.routing.rules.catchAlls.<a href="./src/resources/email-routing/routing/rules/catch-alls.ts">get</a>(zoneIdentifier) -> EmailCatchAllRule</code> |
| 1570 | |
| 1571 | ### Addresses |
| 1572 | |
| 1573 | Types: |
| 1574 | |
| 1575 | - <code><a href="./src/resources/email-routing/routing/addresses.ts">EmailAddresses</a></code> |
| 1576 | - <code><a href="./src/resources/email-routing/routing/addresses.ts">AddressCreateResponse</a></code> |
| 1577 | - <code><a href="./src/resources/email-routing/routing/addresses.ts">AddressListResponse</a></code> |
| 1578 | - <code><a href="./src/resources/email-routing/routing/addresses.ts">AddressDeleteResponse</a></code> |
| 1579 | - <code><a href="./src/resources/email-routing/routing/addresses.ts">AddressGetResponse</a></code> |
| 1580 | |
| 1581 | Methods: |
| 1582 | |
| 1583 | - <code title="post /accounts/{account_identifier}/email/routing/addresses">client.emailRouting.routing.addresses.<a href="./src/resources/email-routing/routing/addresses.ts">create</a>(accountIdentifier, { ...params }) -> AddressCreateResponse</code> |
| 1584 | - <code title="get /accounts/{account_identifier}/email/routing/addresses">client.emailRouting.routing.addresses.<a href="./src/resources/email-routing/routing/addresses.ts">list</a>(accountIdentifier, { ...params }) -> AddressListResponsesV4PagePaginationArray</code> |
| 1585 | - <code title="delete /accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}">client.emailRouting.routing.addresses.<a href="./src/resources/email-routing/routing/addresses.ts">delete</a>(accountIdentifier, destinationAddressIdentifier) -> AddressDeleteResponse</code> |
| 1586 | - <code title="get /accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}">client.emailRouting.routing.addresses.<a href="./src/resources/email-routing/routing/addresses.ts">get</a>(accountIdentifier, destinationAddressIdentifier) -> AddressGetResponse</code> |
| 1587 | |
| 1588 | # Filters |
| 1589 | |
| 1590 | Types: |
| 1591 | |
| 1592 | - <code><a href="./src/resources/filters.ts">LegacyJhsFilter</a></code> |
| 1593 | - <code><a href="./src/resources/filters.ts">FilterCreateResponse</a></code> |
| 1594 | |
| 1595 | Methods: |
| 1596 | |
| 1597 | - <code title="post /zones/{zone_identifier}/filters">client.filters.<a href="./src/resources/filters.ts">create</a>(zoneIdentifier, { ...params }) -> FilterCreateResponse | null</code> |
| 1598 | - <code title="put /zones/{zone_identifier}/filters/{id}">client.filters.<a href="./src/resources/filters.ts">update</a>(zoneIdentifier, id, { ...params }) -> LegacyJhsFilter | null</code> |
| 1599 | - <code title="get /zones/{zone_identifier}/filters">client.filters.<a href="./src/resources/filters.ts">list</a>(zoneIdentifier, { ...params }) -> LegacyJhsFiltersV4PagePaginationArray</code> |
| 1600 | - <code title="delete /zones/{zone_identifier}/filters/{id}">client.filters.<a href="./src/resources/filters.ts">delete</a>(zoneIdentifier, id) -> LegacyJhsFilter | null</code> |
| 1601 | - <code title="get /zones/{zone_identifier}/filters/{id}">client.filters.<a href="./src/resources/filters.ts">get</a>(zoneIdentifier, id) -> LegacyJhsFilter | null</code> |
| 1602 | |
| 1603 | # Firewall |
| 1604 | |
| 1605 | ## Lockdowns |
| 1606 | |
| 1607 | Types: |
| 1608 | |
| 1609 | - <code><a href="./src/resources/firewall/lockdowns.ts">LegacyJhsZonelockdown</a></code> |
| 1610 | - <code><a href="./src/resources/firewall/lockdowns.ts">LockdownDeleteResponse</a></code> |
| 1611 | |
| 1612 | Methods: |
| 1613 | |
| 1614 | - <code title="post /zones/{zone_identifier}/firewall/lockdowns">client.firewall.lockdowns.<a href="./src/resources/firewall/lockdowns.ts">create</a>(zoneIdentifier, { ...params }) -> LegacyJhsZonelockdown | null</code> |
| 1615 | - <code title="put /zones/{zone_identifier}/firewall/lockdowns/{id}">client.firewall.lockdowns.<a href="./src/resources/firewall/lockdowns.ts">update</a>(zoneIdentifier, id, { ...params }) -> LegacyJhsZonelockdown | null</code> |
| 1616 | - <code title="get /zones/{zone_identifier}/firewall/lockdowns">client.firewall.lockdowns.<a href="./src/resources/firewall/lockdowns.ts">list</a>(zoneIdentifier, { ...params }) -> LegacyJhsZonelockdownsV4PagePaginationArray</code> |
| 1617 | - <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> |
| 1618 | - <code title="get /zones/{zone_identifier}/firewall/lockdowns/{id}">client.firewall.lockdowns.<a href="./src/resources/firewall/lockdowns.ts">get</a>(zoneIdentifier, id) -> LegacyJhsZonelockdown | null</code> |
| 1619 | |
| 1620 | ## Rules |
| 1621 | |
| 1622 | Types: |
| 1623 | |
| 1624 | - <code><a href="./src/resources/firewall/rules.ts">LegacyJhsFilterRule</a></code> |
| 1625 | - <code><a href="./src/resources/firewall/rules.ts">RuleCreateResponse</a></code> |
| 1626 | - <code><a href="./src/resources/firewall/rules.ts">RuleEditResponse</a></code> |
| 1627 | |
| 1628 | Methods: |
| 1629 | |
| 1630 | - <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> |
| 1631 | - <code title="put /zones/{zone_identifier}/firewall/rules/{id}">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">update</a>(zoneIdentifier, id, { ...params }) -> LegacyJhsFilterRule | null</code> |
| 1632 | - <code title="get /zones/{zone_identifier}/firewall/rules">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">list</a>(zoneIdentifier, { ...params }) -> LegacyJhsFilterRulesV4PagePaginationArray</code> |
| 1633 | - <code title="delete /zones/{zone_identifier}/firewall/rules/{id}">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">delete</a>(zoneIdentifier, id, { ...params }) -> LegacyJhsFilterRule | null</code> |
| 1634 | - <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> |
| 1635 | - <code title="get /zones/{zone_identifier}/firewall/rules/{id}">client.firewall.rules.<a href="./src/resources/firewall/rules.ts">get</a>(zoneIdentifier, id) -> LegacyJhsFilterRule | null</code> |
| 1636 | |
| 1637 | ## AccessRules |
| 1638 | |
| 1639 | Types: |
| 1640 | |
| 1641 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleCreateResponse</a></code> |
| 1642 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleListResponse</a></code> |
| 1643 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleDeleteResponse</a></code> |
| 1644 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleEditResponse</a></code> |
| 1645 | - <code><a href="./src/resources/firewall/access-rules.ts">AccessRuleGetResponse</a></code> |
| 1646 | |
| 1647 | Methods: |
| 1648 | |
| 1649 | - <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 | null</code> |
| 1650 | - <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> |
| 1651 | - <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> |
| 1652 | - <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 | null</code> |
| 1653 | - <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 | null</code> |
| 1654 | |
| 1655 | ## UARules |
| 1656 | |
| 1657 | Types: |
| 1658 | |
| 1659 | - <code><a href="./src/resources/firewall/ua-rules.ts">LegacyJhsUARules</a></code> |
| 1660 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleCreateResponse</a></code> |
| 1661 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleUpdateResponse</a></code> |
| 1662 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleListResponse</a></code> |
| 1663 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleDeleteResponse</a></code> |
| 1664 | - <code><a href="./src/resources/firewall/ua-rules.ts">UARuleGetResponse</a></code> |
| 1665 | |
| 1666 | Methods: |
| 1667 | |
| 1668 | - <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 | null</code> |
| 1669 | - <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 | null</code> |
| 1670 | - <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> |
| 1671 | - <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 | null</code> |
| 1672 | - <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 | null</code> |
| 1673 | |
| 1674 | ## WAF |
| 1675 | |
| 1676 | ### Overrides |
| 1677 | |
| 1678 | Types: |
| 1679 | |
| 1680 | - <code><a href="./src/resources/firewall/waf/overrides.ts">LegacyJhsOverride</a></code> |
| 1681 | - <code><a href="./src/resources/firewall/waf/overrides.ts">OverrideDeleteResponse</a></code> |
| 1682 | |
| 1683 | Methods: |
| 1684 | |
| 1685 | - <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 }) -> LegacyJhsOverride | null</code> |
| 1686 | - <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 }) -> LegacyJhsOverride | null</code> |
| 1687 | - <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 }) -> LegacyJhsOverridesV4PagePaginationArray</code> |
| 1688 | - <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> |
| 1689 | - <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) -> LegacyJhsOverride | null</code> |
| 1690 | |
| 1691 | ### Packages |
| 1692 | |
| 1693 | Types: |
| 1694 | |
| 1695 | - <code><a href="./src/resources/firewall/waf/packages/packages.ts">PackageListResponse</a></code> |
| 1696 | - <code><a href="./src/resources/firewall/waf/packages/packages.ts">PackageGetResponse</a></code> |
| 1697 | |
| 1698 | Methods: |
| 1699 | |
| 1700 | - <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> |
| 1701 | - <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> |
| 1702 | |
| 1703 | #### Groups |
| 1704 | |
| 1705 | Types: |
| 1706 | |
| 1707 | - <code><a href="./src/resources/firewall/waf/packages/groups.ts">WAFManagedRulesSchemasGroup</a></code> |
| 1708 | - <code><a href="./src/resources/firewall/waf/packages/groups.ts">GroupEditResponse</a></code> |
| 1709 | - <code><a href="./src/resources/firewall/waf/packages/groups.ts">GroupGetResponse</a></code> |
| 1710 | |
| 1711 | Methods: |
| 1712 | |
| 1713 | - <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 }) -> WAFManagedRulesSchemasGroupsV4PagePaginationArray</code> |
| 1714 | - <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> |
| 1715 | - <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> |
| 1716 | |
| 1717 | #### Rules |
| 1718 | |
| 1719 | Types: |
| 1720 | |
| 1721 | - <code><a href="./src/resources/firewall/waf/packages/rules.ts">WAFManagedRulesRule</a></code> |
| 1722 | - <code><a href="./src/resources/firewall/waf/packages/rules.ts">RuleEditResponse</a></code> |
| 1723 | - <code><a href="./src/resources/firewall/waf/packages/rules.ts">RuleGetResponse</a></code> |
| 1724 | |
| 1725 | Methods: |
| 1726 | |
| 1727 | - <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 }) -> WAFManagedRulesRulesV4PagePaginationArray</code> |
| 1728 | - <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> |
| 1729 | - <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> |
| 1730 | |
| 1731 | # Healthchecks |
| 1732 | |
| 1733 | Types: |
| 1734 | |
| 1735 | - <code><a href="./src/resources/healthchecks/healthchecks.ts">HealthchecksHealthchecks</a></code> |
| 1736 | - <code><a href="./src/resources/healthchecks/healthchecks.ts">HealthcheckListResponse</a></code> |
| 1737 | - <code><a href="./src/resources/healthchecks/healthchecks.ts">HealthcheckDeleteResponse</a></code> |
| 1738 | |
| 1739 | Methods: |
| 1740 | |
| 1741 | - <code title="post /zones/{zone_identifier}/healthchecks">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">create</a>(zoneIdentifier, { ...params }) -> HealthchecksHealthchecks</code> |
| 1742 | - <code title="put /zones/{zone_identifier}/healthchecks/{identifier}">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">update</a>(zoneIdentifier, identifier, { ...params }) -> HealthchecksHealthchecks</code> |
| 1743 | - <code title="get /zones/{zone_identifier}/healthchecks">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">list</a>(zoneIdentifier) -> HealthcheckListResponse | null</code> |
| 1744 | - <code title="delete /zones/{zone_identifier}/healthchecks/{identifier}">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">delete</a>(zoneIdentifier, identifier) -> HealthcheckDeleteResponse</code> |
| 1745 | - <code title="patch /zones/{zone_identifier}/healthchecks/{identifier}">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">edit</a>(zoneIdentifier, identifier, { ...params }) -> HealthchecksHealthchecks</code> |
| 1746 | - <code title="get /zones/{zone_identifier}/healthchecks/{identifier}">client.healthchecks.<a href="./src/resources/healthchecks/healthchecks.ts">get</a>(zoneIdentifier, identifier) -> HealthchecksHealthchecks</code> |
| 1747 | |
| 1748 | ## Previews |
| 1749 | |
| 1750 | Types: |
| 1751 | |
| 1752 | - <code><a href="./src/resources/healthchecks/previews.ts">PreviewDeleteResponse</a></code> |
| 1753 | |
| 1754 | Methods: |
| 1755 | |
| 1756 | - <code title="post /zones/{zone_identifier}/healthchecks/preview">client.healthchecks.previews.<a href="./src/resources/healthchecks/previews.ts">create</a>(zoneIdentifier, { ...params }) -> HealthchecksHealthchecks</code> |
| 1757 | - <code title="delete /zones/{zone_identifier}/healthchecks/preview/{identifier}">client.healthchecks.previews.<a href="./src/resources/healthchecks/previews.ts">delete</a>(zoneIdentifier, identifier) -> PreviewDeleteResponse</code> |
| 1758 | - <code title="get /zones/{zone_identifier}/healthchecks/preview/{identifier}">client.healthchecks.previews.<a href="./src/resources/healthchecks/previews.ts">get</a>(zoneIdentifier, identifier) -> HealthchecksHealthchecks</code> |
| 1759 | |
| 1760 | # KeylessCertificates |
| 1761 | |
| 1762 | Types: |
| 1763 | |
| 1764 | - <code><a href="./src/resources/keyless-certificates.ts">TLSCertificatesAndHostnamesBase</a></code> |
| 1765 | - <code><a href="./src/resources/keyless-certificates.ts">TLSCertificatesAndHostnamesKeylessCertificate</a></code> |
| 1766 | - <code><a href="./src/resources/keyless-certificates.ts">KeylessCertificateListResponse</a></code> |
| 1767 | - <code><a href="./src/resources/keyless-certificates.ts">KeylessCertificateDeleteResponse</a></code> |
| 1768 | |
| 1769 | Methods: |
| 1770 | |
| 1771 | - <code title="post /zones/{zone_id}/keyless_certificates">client.keylessCertificates.<a href="./src/resources/keyless-certificates.ts">create</a>({ ...params }) -> TLSCertificatesAndHostnamesBase</code> |
| 1772 | - <code title="get /zones/{zone_id}/keyless_certificates">client.keylessCertificates.<a href="./src/resources/keyless-certificates.ts">list</a>({ ...params }) -> KeylessCertificateListResponse | null</code> |
| 1773 | - <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> |
| 1774 | - <code title="patch /zones/{zone_id}/keyless_certificates/{keyless_certificate_id}">client.keylessCertificates.<a href="./src/resources/keyless-certificates.ts">edit</a>(keylessCertificateId, { ...params }) -> TLSCertificatesAndHostnamesBase</code> |
| 1775 | - <code title="get /zones/{zone_id}/keyless_certificates/{keyless_certificate_id}">client.keylessCertificates.<a href="./src/resources/keyless-certificates.ts">get</a>(keylessCertificateId, { ...params }) -> TLSCertificatesAndHostnamesBase</code> |
| 1776 | |
| 1777 | # Logpush |
| 1778 | |
| 1779 | ## Datasets |
| 1780 | |
| 1781 | ### Fields |
| 1782 | |
| 1783 | Types: |
| 1784 | |
| 1785 | - <code><a href="./src/resources/logpush/datasets/fields.ts">FieldGetResponse</a></code> |
| 1786 | |
| 1787 | Methods: |
| 1788 | |
| 1789 | - <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> |
| 1790 | |
| 1791 | ### Jobs |
| 1792 | |
| 1793 | Types: |
| 1794 | |
| 1795 | - <code><a href="./src/resources/logpush/datasets/jobs.ts">LogpushLogpushJob</a></code> |
| 1796 | - <code><a href="./src/resources/logpush/datasets/jobs.ts">JobGetResponse</a></code> |
| 1797 | |
| 1798 | Methods: |
| 1799 | |
| 1800 | - <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> |
| 1801 | |
| 1802 | ## Edge |
| 1803 | |
| 1804 | Types: |
| 1805 | |
| 1806 | - <code><a href="./src/resources/logpush/edge.ts">LogpushInstantLogsJob</a></code> |
| 1807 | - <code><a href="./src/resources/logpush/edge.ts">EdgeGetResponse</a></code> |
| 1808 | |
| 1809 | Methods: |
| 1810 | |
| 1811 | - <code title="post /zones/{zone_id}/logpush/edge">client.logpush.edge.<a href="./src/resources/logpush/edge.ts">create</a>({ ...params }) -> LogpushInstantLogsJob | null</code> |
| 1812 | - <code title="get /zones/{zone_id}/logpush/edge">client.logpush.edge.<a href="./src/resources/logpush/edge.ts">get</a>({ ...params }) -> EdgeGetResponse</code> |
| 1813 | |
| 1814 | ## Jobs |
| 1815 | |
| 1816 | Types: |
| 1817 | |
| 1818 | - <code><a href="./src/resources/logpush/jobs.ts">JobListResponse</a></code> |
| 1819 | - <code><a href="./src/resources/logpush/jobs.ts">JobDeleteResponse</a></code> |
| 1820 | |
| 1821 | Methods: |
| 1822 | |
| 1823 | - <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 }) -> LogpushLogpushJob | null</code> |
| 1824 | - <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 }) -> LogpushLogpushJob | null</code> |
| 1825 | - <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 }) -> JobListResponse</code> |
| 1826 | - <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> |
| 1827 | - <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 }) -> LogpushLogpushJob | null</code> |
| 1828 | |
| 1829 | ## Ownership |
| 1830 | |
| 1831 | Types: |
| 1832 | |
| 1833 | - <code><a href="./src/resources/logpush/ownership.ts">OwnershipCreateResponse</a></code> |
| 1834 | - <code><a href="./src/resources/logpush/ownership.ts">OwnershipValidateResponse</a></code> |
| 1835 | |
| 1836 | Methods: |
| 1837 | |
| 1838 | - <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> |
| 1839 | - <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 }) -> OwnershipValidateResponse | null</code> |
| 1840 | |
| 1841 | ## Validate |
| 1842 | |
| 1843 | Types: |
| 1844 | |
| 1845 | - <code><a href="./src/resources/logpush/validate.ts">ValidateDestinationResponse</a></code> |
| 1846 | - <code><a href="./src/resources/logpush/validate.ts">ValidateOriginResponse</a></code> |
| 1847 | |
| 1848 | Methods: |
| 1849 | |
| 1850 | - <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> |
| 1851 | - <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> |
| 1852 | |
| 1853 | # Logs |
| 1854 | |
| 1855 | ## Control |
| 1856 | |
| 1857 | ### Retention |
| 1858 | |
| 1859 | #### Flag |
| 1860 | |
| 1861 | Types: |
| 1862 | |
| 1863 | - <code><a href="./src/resources/logs/control/retention/flag.ts">FlagCreateResponse</a></code> |
| 1864 | - <code><a href="./src/resources/logs/control/retention/flag.ts">FlagGetResponse</a></code> |
| 1865 | |
| 1866 | Methods: |
| 1867 | |
| 1868 | - <code title="post /zones/{zone_identifier}/logs/control/retention/flag">client.logs.control.retention.flag.<a href="./src/resources/logs/control/retention/flag.ts">create</a>(zoneIdentifier, { ...params }) -> FlagCreateResponse</code> |
| 1869 | - <code title="get /zones/{zone_identifier}/logs/control/retention/flag">client.logs.control.retention.flag.<a href="./src/resources/logs/control/retention/flag.ts">get</a>(zoneIdentifier) -> FlagGetResponse</code> |
| 1870 | |
| 1871 | ### Cmb |
| 1872 | |
| 1873 | #### Config |
| 1874 | |
| 1875 | Types: |
| 1876 | |
| 1877 | - <code><a href="./src/resources/logs/control/cmb/config.ts">LogcontrolCmbConfig</a></code> |
| 1878 | - <code><a href="./src/resources/logs/control/cmb/config.ts">ConfigDeleteResponse</a></code> |
| 1879 | |
| 1880 | Methods: |
| 1881 | |
| 1882 | - <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 }) -> LogcontrolCmbConfig | null</code> |
| 1883 | - <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> |
| 1884 | - <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 }) -> LogcontrolCmbConfig | null</code> |
| 1885 | |
| 1886 | ## Rayid |
| 1887 | |
| 1888 | Types: |
| 1889 | |
| 1890 | - <code><a href="./src/resources/logs/rayid.ts">RayidGetResponse</a></code> |
| 1891 | |
| 1892 | Methods: |
| 1893 | |
| 1894 | - <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> |
| 1895 | |
| 1896 | ## Received |
| 1897 | |
| 1898 | Types: |
| 1899 | |
| 1900 | - <code><a href="./src/resources/logs/received/received.ts">ReceivedGetResponse</a></code> |
| 1901 | |
| 1902 | Methods: |
| 1903 | |
| 1904 | - <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> |
| 1905 | |
| 1906 | ### Fields |
| 1907 | |
| 1908 | Types: |
| 1909 | |
| 1910 | - <code><a href="./src/resources/logs/received/fields.ts">FieldGetResponse</a></code> |
| 1911 | |
| 1912 | Methods: |
| 1913 | |
| 1914 | - <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> |
| 1915 | |
| 1916 | # OriginTLSClientAuth |
| 1917 | |
| 1918 | Types: |
| 1919 | |
| 1920 | - <code><a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">TLSCertificatesAndHostnamesZoneAuthenticatedOriginPull</a></code> |
| 1921 | - <code><a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">OriginTLSClientAuthCreateResponse</a></code> |
| 1922 | - <code><a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">OriginTLSClientAuthListResponse</a></code> |
| 1923 | - <code><a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">OriginTLSClientAuthDeleteResponse</a></code> |
| 1924 | - <code><a href="./src/resources/origin-tls-client-auth/origin-tls-client-auth.ts">OriginTLSClientAuthGetResponse</a></code> |
| 1925 | |
| 1926 | Methods: |
| 1927 | |
| 1928 | - <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> |
| 1929 | - <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 }) -> OriginTLSClientAuthListResponse | null</code> |
| 1930 | - <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> |
| 1931 | - <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> |
| 1932 | |
| 1933 | ## Hostnames |
| 1934 | |
| 1935 | Types: |
| 1936 | |
| 1937 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/hostnames.ts">TLSCertificatesAndHostnamesHostnameAuthenticatedOriginPull</a></code> |
| 1938 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/hostnames.ts">TLSCertificatesAndHostnamesHostnameCertidObject</a></code> |
| 1939 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/hostnames.ts">HostnameUpdateResponse</a></code> |
| 1940 | |
| 1941 | Methods: |
| 1942 | |
| 1943 | - <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> |
| 1944 | - <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 }) -> TLSCertificatesAndHostnamesHostnameCertidObject</code> |
| 1945 | |
| 1946 | ### Certificates |
| 1947 | |
| 1948 | Types: |
| 1949 | |
| 1950 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">TLSCertificatesAndHostnamesSchemasCertificateObject</a></code> |
| 1951 | - <code><a href="./src/resources/origin-tls-client-auth/hostnames/certificates.ts">CertificateListResponse</a></code> |
| 1952 | |
| 1953 | Methods: |
| 1954 | |
| 1955 | - <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 }) -> TLSCertificatesAndHostnamesSchemasCertificateObject</code> |
| 1956 | - <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 }) -> CertificateListResponse | null</code> |
| 1957 | - <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 }) -> TLSCertificatesAndHostnamesSchemasCertificateObject</code> |
| 1958 | - <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 }) -> TLSCertificatesAndHostnamesSchemasCertificateObject</code> |
| 1959 | |
| 1960 | ## Settings |
| 1961 | |
| 1962 | Types: |
| 1963 | |
| 1964 | - <code><a href="./src/resources/origin-tls-client-auth/settings.ts">SettingUpdateResponse</a></code> |
| 1965 | - <code><a href="./src/resources/origin-tls-client-auth/settings.ts">SettingGetResponse</a></code> |
| 1966 | |
| 1967 | Methods: |
| 1968 | |
| 1969 | - <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> |
| 1970 | - <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> |
| 1971 | |
| 1972 | # Pagerules |
| 1973 | |
| 1974 | Types: |
| 1975 | |
| 1976 | - <code><a href="./src/resources/pagerules/pagerules.ts">ZonesPageRule</a></code> |
| 1977 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleCreateResponse</a></code> |
| 1978 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleUpdateResponse</a></code> |
| 1979 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleListResponse</a></code> |
| 1980 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleDeleteResponse</a></code> |
| 1981 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleEditResponse</a></code> |
| 1982 | - <code><a href="./src/resources/pagerules/pagerules.ts">PageruleGetResponse</a></code> |
| 1983 | |
| 1984 | Methods: |
| 1985 | |
| 1986 | - <code title="post /zones/{zone_id}/pagerules">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">create</a>({ ...params }) -> PageruleCreateResponse</code> |
| 1987 | - <code title="put /zones/{zone_id}/pagerules/{pagerule_id}">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">update</a>(pageruleId, { ...params }) -> PageruleUpdateResponse</code> |
| 1988 | - <code title="get /zones/{zone_id}/pagerules">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">list</a>({ ...params }) -> PageruleListResponse</code> |
| 1989 | - <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> |
| 1990 | - <code title="patch /zones/{zone_id}/pagerules/{pagerule_id}">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">edit</a>(pageruleId, { ...params }) -> PageruleEditResponse</code> |
| 1991 | - <code title="get /zones/{zone_id}/pagerules/{pagerule_id}">client.pagerules.<a href="./src/resources/pagerules/pagerules.ts">get</a>(pageruleId, { ...params }) -> PageruleGetResponse</code> |
| 1992 | |
| 1993 | ## Settings |
| 1994 | |
| 1995 | Types: |
| 1996 | |
| 1997 | - <code><a href="./src/resources/pagerules/settings.ts">ZonesSettings</a></code> |
| 1998 | |
| 1999 | Methods: |
| 2000 | |
| 2001 | - <code title="get /zones/{zone_id}/pagerules/settings">client.pagerules.settings.<a href="./src/resources/pagerules/settings.ts">list</a>({ ...params }) -> ZonesSettings</code> |
| 2002 | |
| 2003 | # RateLimits |
| 2004 | |
| 2005 | Types: |
| 2006 | |
| 2007 | - <code><a href="./src/resources/rate-limits.ts">LegacyJhsRateLimits</a></code> |
| 2008 | - <code><a href="./src/resources/rate-limits.ts">RateLimitCreateResponse</a></code> |
| 2009 | - <code><a href="./src/resources/rate-limits.ts">RateLimitListResponse</a></code> |
| 2010 | - <code><a href="./src/resources/rate-limits.ts">RateLimitDeleteResponse</a></code> |
| 2011 | - <code><a href="./src/resources/rate-limits.ts">RateLimitEditResponse</a></code> |
| 2012 | - <code><a href="./src/resources/rate-limits.ts">RateLimitGetResponse</a></code> |
| 2013 | |
| 2014 | Methods: |
| 2015 | |
| 2016 | - <code title="post /zones/{zone_identifier}/rate_limits">client.rateLimits.<a href="./src/resources/rate-limits.ts">create</a>(zoneIdentifier, { ...params }) -> RateLimitCreateResponse | null</code> |
| 2017 | - <code title="get /zones/{zone_identifier}/rate_limits">client.rateLimits.<a href="./src/resources/rate-limits.ts">list</a>(zoneIdentifier, { ...params }) -> RateLimitListResponsesV4PagePaginationArray</code> |
| 2018 | - <code title="delete /zones/{zone_identifier}/rate_limits/{id}">client.rateLimits.<a href="./src/resources/rate-limits.ts">delete</a>(zoneIdentifier, id) -> RateLimitDeleteResponse | null</code> |
| 2019 | - <code title="put /zones/{zone_identifier}/rate_limits/{id}">client.rateLimits.<a href="./src/resources/rate-limits.ts">edit</a>(zoneIdentifier, id, { ...params }) -> RateLimitEditResponse | null</code> |
| 2020 | - <code title="get /zones/{zone_identifier}/rate_limits/{id}">client.rateLimits.<a href="./src/resources/rate-limits.ts">get</a>(zoneIdentifier, id) -> RateLimitGetResponse | null</code> |
| 2021 | |
| 2022 | # SecondaryDNS |
| 2023 | |
| 2024 | ## ForceAXFR |
| 2025 | |
| 2026 | Types: |
| 2027 | |
| 2028 | - <code><a href="./src/resources/secondary-dns/force-axfr.ts">SecondaryDNSForceResult</a></code> |
| 2029 | |
| 2030 | Methods: |
| 2031 | |
| 2032 | - <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 }) -> SecondaryDNSForceResult</code> |
| 2033 | |
| 2034 | ## Incoming |
| 2035 | |
| 2036 | Types: |
| 2037 | |
| 2038 | - <code><a href="./src/resources/secondary-dns/incoming.ts">IncomingCreateResponse</a></code> |
| 2039 | - <code><a href="./src/resources/secondary-dns/incoming.ts">IncomingUpdateResponse</a></code> |
| 2040 | - <code><a href="./src/resources/secondary-dns/incoming.ts">IncomingDeleteResponse</a></code> |
| 2041 | - <code><a href="./src/resources/secondary-dns/incoming.ts">IncomingGetResponse</a></code> |
| 2042 | |
| 2043 | Methods: |
| 2044 | |
| 2045 | - <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> |
| 2046 | - <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> |
| 2047 | - <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> |
| 2048 | - <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> |
| 2049 | |
| 2050 | ## Outgoing |
| 2051 | |
| 2052 | Types: |
| 2053 | |
| 2054 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">SecondaryDNSDisableTransferResult</a></code> |
| 2055 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">SecondaryDNSEnableTransferResult</a></code> |
| 2056 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">SecondaryDNSSchemasForceResult</a></code> |
| 2057 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingCreateResponse</a></code> |
| 2058 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingUpdateResponse</a></code> |
| 2059 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingDeleteResponse</a></code> |
| 2060 | - <code><a href="./src/resources/secondary-dns/outgoing/outgoing.ts">OutgoingGetResponse</a></code> |
| 2061 | |
| 2062 | Methods: |
| 2063 | |
| 2064 | - <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> |
| 2065 | - <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> |
| 2066 | - <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> |
| 2067 | - <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 }) -> SecondaryDNSDisableTransferResult</code> |
| 2068 | - <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 }) -> SecondaryDNSEnableTransferResult</code> |
| 2069 | - <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 }) -> SecondaryDNSSchemasForceResult</code> |
| 2070 | - <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> |
| 2071 | |
| 2072 | ### Status |
| 2073 | |
| 2074 | Methods: |
| 2075 | |
| 2076 | - <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 }) -> SecondaryDNSEnableTransferResult</code> |
| 2077 | |
| 2078 | ## ACLs |
| 2079 | |
| 2080 | Types: |
| 2081 | |
| 2082 | - <code><a href="./src/resources/secondary-dns/acls.ts">SecondaryDNSACL</a></code> |
| 2083 | - <code><a href="./src/resources/secondary-dns/acls.ts">ACLListResponse</a></code> |
| 2084 | - <code><a href="./src/resources/secondary-dns/acls.ts">ACLDeleteResponse</a></code> |
| 2085 | |
| 2086 | Methods: |
| 2087 | |
| 2088 | - <code title="post /accounts/{account_id}/secondary_dns/acls">client.secondaryDNS.acls.<a href="./src/resources/secondary-dns/acls.ts">create</a>({ ...params }) -> SecondaryDNSACL</code> |
| 2089 | - <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 }) -> SecondaryDNSACL</code> |
| 2090 | - <code title="get /accounts/{account_id}/secondary_dns/acls">client.secondaryDNS.acls.<a href="./src/resources/secondary-dns/acls.ts">list</a>({ ...params }) -> ACLListResponse | null</code> |
| 2091 | - <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> |
| 2092 | - <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 }) -> SecondaryDNSACL</code> |
| 2093 | |
| 2094 | ## Peers |
| 2095 | |
| 2096 | Types: |
| 2097 | |
| 2098 | - <code><a href="./src/resources/secondary-dns/peers.ts">SecondaryDNSPeer</a></code> |
| 2099 | - <code><a href="./src/resources/secondary-dns/peers.ts">PeerListResponse</a></code> |
| 2100 | - <code><a href="./src/resources/secondary-dns/peers.ts">PeerDeleteResponse</a></code> |
| 2101 | |
| 2102 | Methods: |
| 2103 | |
| 2104 | - <code title="post /accounts/{account_id}/secondary_dns/peers">client.secondaryDNS.peers.<a href="./src/resources/secondary-dns/peers.ts">create</a>({ ...params }) -> SecondaryDNSPeer</code> |
| 2105 | - <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 }) -> SecondaryDNSPeer</code> |
| 2106 | - <code title="get /accounts/{account_id}/secondary_dns/peers">client.secondaryDNS.peers.<a href="./src/resources/secondary-dns/peers.ts">list</a>({ ...params }) -> PeerListResponse | null</code> |
| 2107 | - <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> |
| 2108 | - <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 }) -> SecondaryDNSPeer</code> |
| 2109 | |
| 2110 | ## TSIGs |
| 2111 | |
| 2112 | Types: |
| 2113 | |
| 2114 | - <code><a href="./src/resources/secondary-dns/tsigs.ts">SecondaryDNSTSIG</a></code> |
| 2115 | - <code><a href="./src/resources/secondary-dns/tsigs.ts">TSIGListResponse</a></code> |
| 2116 | - <code><a href="./src/resources/secondary-dns/tsigs.ts">TSIGDeleteResponse</a></code> |
| 2117 | |
| 2118 | Methods: |
| 2119 | |
| 2120 | - <code title="post /accounts/{account_id}/secondary_dns/tsigs">client.secondaryDNS.tsigs.<a href="./src/resources/secondary-dns/tsigs.ts">create</a>({ ...params }) -> SecondaryDNSTSIG</code> |
| 2121 | - <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 }) -> SecondaryDNSTSIG</code> |
| 2122 | - <code title="get /accounts/{account_id}/secondary_dns/tsigs">client.secondaryDNS.tsigs.<a href="./src/resources/secondary-dns/tsigs.ts">list</a>({ ...params }) -> TSIGListResponse | null</code> |
| 2123 | - <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> |
| 2124 | - <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 }) -> SecondaryDNSTSIG</code> |
| 2125 | |
| 2126 | # WaitingRooms |
| 2127 | |
| 2128 | Types: |
| 2129 | |
| 2130 | - <code><a href="./src/resources/waiting-rooms/waiting-rooms.ts">WaitingroomWaitingroom</a></code> |
| 2131 | - <code><a href="./src/resources/waiting-rooms/waiting-rooms.ts">WaitingRoomListResponse</a></code> |
| 2132 | - <code><a href="./src/resources/waiting-rooms/waiting-rooms.ts">WaitingRoomDeleteResponse</a></code> |
| 2133 | |
| 2134 | Methods: |
| 2135 | |
| 2136 | - <code title="post /zones/{zone_identifier}/waiting_rooms">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">create</a>(zoneIdentifier, { ...params }) -> WaitingroomWaitingroom</code> |
| 2137 | - <code title="put /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">update</a>(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingroomWaitingroom</code> |
| 2138 | - <code title="get /zones/{zone_identifier}/waiting_rooms">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">list</a>(zoneIdentifier) -> WaitingRoomListResponse | null</code> |
| 2139 | - <code title="delete /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">delete</a>(zoneIdentifier, waitingRoomId) -> WaitingRoomDeleteResponse</code> |
| 2140 | - <code title="patch /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">edit</a>(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingroomWaitingroom</code> |
| 2141 | - <code title="get /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}">client.waitingRooms.<a href="./src/resources/waiting-rooms/waiting-rooms.ts">get</a>(zoneIdentifier, waitingRoomId) -> WaitingroomWaitingroom</code> |
| 2142 | |
| 2143 | ## Page |
| 2144 | |
| 2145 | Types: |
| 2146 | |
| 2147 | - <code><a href="./src/resources/waiting-rooms/page.ts">PagePreviewResponse</a></code> |
| 2148 | |
| 2149 | Methods: |
| 2150 | |
| 2151 | - <code title="post /zones/{zone_identifier}/waiting_rooms/preview">client.waitingRooms.page.<a href="./src/resources/waiting-rooms/page.ts">preview</a>(zoneIdentifier, { ...params }) -> PagePreviewResponse</code> |
| 2152 | |
| 2153 | ## Events |
| 2154 | |
| 2155 | Types: |
| 2156 | |
| 2157 | - <code><a href="./src/resources/waiting-rooms/events/events.ts">WaitingroomEventResult</a></code> |
| 2158 | - <code><a href="./src/resources/waiting-rooms/events/events.ts">EventListResponse</a></code> |
| 2159 | - <code><a href="./src/resources/waiting-rooms/events/events.ts">EventDeleteResponse</a></code> |
| 2160 | |
| 2161 | Methods: |
| 2162 | |
| 2163 | - <code title="post /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">create</a>(zoneIdentifier, waitingRoomId, { ...params }) -> WaitingroomEventResult</code> |
| 2164 | - <code title="put /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">update</a>(zoneIdentifier, waitingRoomId, eventId, { ...params }) -> WaitingroomEventResult</code> |
| 2165 | - <code title="get /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">list</a>(zoneIdentifier, waitingRoomId) -> EventListResponse | null</code> |
| 2166 | - <code title="delete /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">delete</a>(zoneIdentifier, waitingRoomId, eventId) -> EventDeleteResponse</code> |
| 2167 | - <code title="patch /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">edit</a>(zoneIdentifier, waitingRoomId, eventId, { ...params }) -> WaitingroomEventResult</code> |
| 2168 | - <code title="get /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}">client.waitingRooms.events.<a href="./src/resources/waiting-rooms/events/events.ts">get</a>(zoneIdentifier, waitingRoomId, eventId) -> WaitingroomEventResult</code> |
| 2169 | |
| 2170 | ### Details |
| 2171 | |
| 2172 | Types: |
| 2173 | |
| 2174 | - <code><a href="./src/resources/waiting-rooms/events/details.ts">WaitingroomEventDetailsResult</a></code> |
| 2175 | |
| 2176 | Methods: |
| 2177 | |
| 2178 | - <code title="get /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}/details">client.waitingRooms.events.details.<a href="./src/resources/waiting-rooms/events/details.ts">get</a>(zoneIdentifier, waitingRoomId, eventId) -> WaitingroomEventDetailsResult</code> |
| 2179 | |
| 2180 | ## Rules |
| 2181 | |
| 2182 | Types: |
| 2183 | |
| 2184 | - <code><a href="./src/resources/waiting-rooms/rules.ts">WaitingroomRuleResult</a></code> |
| 2185 | - <code><a href="./src/resources/waiting-rooms/rules.ts">RuleCreateResponse</a></code> |
| 2186 | - <code><a href="./src/resources/waiting-rooms/rules.ts">RuleUpdateResponse</a></code> |
| 2187 | - <code><a href="./src/resources/waiting-rooms/rules.ts">RuleListResponse</a></code> |
| 2188 | - <code><a href="./src/resources/waiting-rooms/rules.ts">RuleDeleteResponse</a></code> |
| 2189 | - <code><a href="./src/resources/waiting-rooms/rules.ts">RuleEditResponse</a></code> |
| 2190 | |
| 2191 | Methods: |
| 2192 | |
| 2193 | - <code title="post /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">create</a>(zoneIdentifier, waitingRoomId, { ...params }) -> RuleCreateResponse | null</code> |
| 2194 | - <code title="put /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">update</a>(zoneIdentifier, waitingRoomId, [ ...body ]) -> RuleUpdateResponse | null</code> |
| 2195 | - <code title="get /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">list</a>(zoneIdentifier, waitingRoomId) -> RuleListResponse | null</code> |
| 2196 | - <code title="delete /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">delete</a>(zoneIdentifier, waitingRoomId, ruleId) -> RuleDeleteResponse | null</code> |
| 2197 | - <code title="patch /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}">client.waitingRooms.rules.<a href="./src/resources/waiting-rooms/rules.ts">edit</a>(zoneIdentifier, waitingRoomId, ruleId, { ...params }) -> RuleEditResponse | null</code> |
| 2198 | |
| 2199 | ## Statuses |
| 2200 | |
| 2201 | Types: |
| 2202 | |
| 2203 | - <code><a href="./src/resources/waiting-rooms/statuses.ts">StatusGetResponse</a></code> |
| 2204 | |
| 2205 | Methods: |
| 2206 | |
| 2207 | - <code title="get /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status">client.waitingRooms.statuses.<a href="./src/resources/waiting-rooms/statuses.ts">get</a>(zoneIdentifier, waitingRoomId) -> StatusGetResponse</code> |
| 2208 | |
| 2209 | ## Settings |
| 2210 | |
| 2211 | Types: |
| 2212 | |
| 2213 | - <code><a href="./src/resources/waiting-rooms/settings.ts">SettingUpdateResponse</a></code> |
| 2214 | - <code><a href="./src/resources/waiting-rooms/settings.ts">SettingEditResponse</a></code> |
| 2215 | - <code><a href="./src/resources/waiting-rooms/settings.ts">SettingGetResponse</a></code> |
| 2216 | |
| 2217 | Methods: |
| 2218 | |
| 2219 | - <code title="put /zones/{zone_identifier}/waiting_rooms/settings">client.waitingRooms.settings.<a href="./src/resources/waiting-rooms/settings.ts">update</a>(zoneIdentifier, { ...params }) -> SettingUpdateResponse</code> |
| 2220 | - <code title="patch /zones/{zone_identifier}/waiting_rooms/settings">client.waitingRooms.settings.<a href="./src/resources/waiting-rooms/settings.ts">edit</a>(zoneIdentifier, { ...params }) -> SettingEditResponse</code> |
| 2221 | - <code title="get /zones/{zone_identifier}/waiting_rooms/settings">client.waitingRooms.settings.<a href="./src/resources/waiting-rooms/settings.ts">get</a>(zoneIdentifier) -> SettingGetResponse</code> |
| 2222 | |
| 2223 | # Web3 |
| 2224 | |
| 2225 | ## Hostnames |
| 2226 | |
| 2227 | Types: |
| 2228 | |
| 2229 | - <code><a href="./src/resources/web3/hostnames/hostnames.ts">DwebConfigWeb3Hostname</a></code> |
| 2230 | - <code><a href="./src/resources/web3/hostnames/hostnames.ts">HostnameListResponse</a></code> |
| 2231 | - <code><a href="./src/resources/web3/hostnames/hostnames.ts">HostnameDeleteResponse</a></code> |
| 2232 | |
| 2233 | Methods: |
| 2234 | |
| 2235 | - <code title="post /zones/{zone_identifier}/web3/hostnames">client.web3.hostnames.<a href="./src/resources/web3/hostnames/hostnames.ts">create</a>(zoneIdentifier, { ...params }) -> DwebConfigWeb3Hostname</code> |
| 2236 | - <code title="get /zones/{zone_identifier}/web3/hostnames">client.web3.hostnames.<a href="./src/resources/web3/hostnames/hostnames.ts">list</a>(zoneIdentifier) -> HostnameListResponse | null</code> |
| 2237 | - <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> |
| 2238 | - <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 }) -> DwebConfigWeb3Hostname</code> |
| 2239 | - <code title="get /zones/{zone_identifier}/web3/hostnames/{identifier}">client.web3.hostnames.<a href="./src/resources/web3/hostnames/hostnames.ts">get</a>(zoneIdentifier, identifier) -> DwebConfigWeb3Hostname</code> |
| 2240 | |
| 2241 | ### IPFSUniversalPaths |
| 2242 | |
| 2243 | #### ContentLists |
| 2244 | |
| 2245 | Types: |
| 2246 | |
| 2247 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/content-lists.ts">DwebConfigContentListDetails</a></code> |
| 2248 | |
| 2249 | Methods: |
| 2250 | |
| 2251 | - <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 }) -> DwebConfigContentListDetails</code> |
| 2252 | - <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) -> DwebConfigContentListDetails</code> |
| 2253 | |
| 2254 | ##### Entries |
| 2255 | |
| 2256 | Types: |
| 2257 | |
| 2258 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">DwebConfigContentListEntry</a></code> |
| 2259 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">EntryListResponse</a></code> |
| 2260 | - <code><a href="./src/resources/web3/hostnames/ipfs-universal-paths/content-lists/entries.ts">EntryDeleteResponse</a></code> |
| 2261 | |
| 2262 | Methods: |
| 2263 | |
| 2264 | - <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 }) -> DwebConfigContentListEntry</code> |
| 2265 | - <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 }) -> DwebConfigContentListEntry</code> |
| 2266 | - <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> |
| 2267 | - <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> |
| 2268 | - <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) -> DwebConfigContentListEntry</code> |
| 2269 | |
| 2270 | # Workers |
| 2271 | |
| 2272 | ## AI |
| 2273 | |
| 2274 | Types: |
| 2275 | |
| 2276 | - <code><a href="./src/resources/workers/ai.ts">AIRunResponse</a></code> |
| 2277 | |
| 2278 | Methods: |
| 2279 | |
| 2280 | - <code title="post /accounts/{account_id}/ai/run/{model_name}">client.workers.ai.<a href="./src/resources/workers/ai.ts">run</a>(modelName, { ...params }) -> AIRunResponse</code> |
| 2281 | |
| 2282 | ## Scripts |
| 2283 | |
| 2284 | Types: |
| 2285 | |
| 2286 | - <code><a href="./src/resources/workers/scripts/scripts.ts">WorkersScript</a></code> |
| 2287 | - <code><a href="./src/resources/workers/scripts/scripts.ts">ScriptListResponse</a></code> |
| 2288 | |
| 2289 | Methods: |
| 2290 | |
| 2291 | - <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 }) -> WorkersScript</code> |
| 2292 | - <code title="get /accounts/{account_id}/workers/scripts">client.workers.scripts.<a href="./src/resources/workers/scripts/scripts.ts">list</a>({ ...params }) -> ScriptListResponse</code> |
| 2293 | - <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> |
| 2294 | - <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> |
| 2295 | |
| 2296 | ### Bindings |
| 2297 | |
| 2298 | Types: |
| 2299 | |
| 2300 | - <code><a href="./src/resources/workers/scripts/bindings.ts">WorkersSchemasBinding</a></code> |
| 2301 | - <code><a href="./src/resources/workers/scripts/bindings.ts">BindingGetResponse</a></code> |
| 2302 | |
| 2303 | Methods: |
| 2304 | |
| 2305 | - <code title="get /zones/{zone_id}/workers/script/bindings">client.workers.scripts.bindings.<a href="./src/resources/workers/scripts/bindings.ts">get</a>({ ...params }) -> BindingGetResponse</code> |
| 2306 | |
| 2307 | ### Schedules |
| 2308 | |
| 2309 | Types: |
| 2310 | |
| 2311 | - <code><a href="./src/resources/workers/scripts/schedules.ts">ScheduleUpdateResponse</a></code> |
| 2312 | - <code><a href="./src/resources/workers/scripts/schedules.ts">ScheduleGetResponse</a></code> |
| 2313 | |
| 2314 | Methods: |
| 2315 | |
| 2316 | - <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> |
| 2317 | - <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> |
| 2318 | |
| 2319 | ### Tail |
| 2320 | |
| 2321 | Types: |
| 2322 | |
| 2323 | - <code><a href="./src/resources/workers/scripts/tail.ts">TailCreateResponse</a></code> |
| 2324 | - <code><a href="./src/resources/workers/scripts/tail.ts">TailDeleteResponse</a></code> |
| 2325 | - <code><a href="./src/resources/workers/scripts/tail.ts">TailGetResponse</a></code> |
| 2326 | |
| 2327 | Methods: |
| 2328 | |
| 2329 | - <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> |
| 2330 | - <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> |
| 2331 | - <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> |
| 2332 | |
| 2333 | ### UsageModel |
| 2334 | |
| 2335 | Types: |
| 2336 | |
| 2337 | - <code><a href="./src/resources/workers/scripts/usage-model.ts">UsageModelUpdateResponse</a></code> |
| 2338 | - <code><a href="./src/resources/workers/scripts/usage-model.ts">UsageModelGetResponse</a></code> |
| 2339 | |
| 2340 | Methods: |
| 2341 | |
| 2342 | - <code title="put /accounts/{account_id}/workers/scripts/{script_name}/usage-model">client.workers.scripts.usageModel.<a href="./src/resources/workers/scripts/usage-model.ts">update</a>(scriptName, { ...params }) -> UsageModelUpdateResponse</code> |
| 2343 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/usage-model">client.workers.scripts.usageModel.<a href="./src/resources/workers/scripts/usage-model.ts">get</a>(scriptName, { ...params }) -> UsageModelGetResponse</code> |
| 2344 | |
| 2345 | ### Content |
| 2346 | |
| 2347 | Methods: |
| 2348 | |
| 2349 | - <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 }) -> WorkersScript</code> |
| 2350 | |
| 2351 | ### ContentV2 |
| 2352 | |
| 2353 | Methods: |
| 2354 | |
| 2355 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/content/v2">client.workers.scripts.contentV2.<a href="./src/resources/workers/scripts/content-v2.ts">get</a>(scriptName, { ...params }) -> Response</code> |
| 2356 | |
| 2357 | ### Settings |
| 2358 | |
| 2359 | Types: |
| 2360 | |
| 2361 | - <code><a href="./src/resources/workers/scripts/settings.ts">SettingEditResponse</a></code> |
| 2362 | - <code><a href="./src/resources/workers/scripts/settings.ts">SettingGetResponse</a></code> |
| 2363 | |
| 2364 | Methods: |
| 2365 | |
| 2366 | - <code title="patch /accounts/{account_id}/workers/scripts/{script_name}/settings">client.workers.scripts.settings.<a href="./src/resources/workers/scripts/settings.ts">edit</a>(scriptName, { ...params }) -> SettingEditResponse</code> |
| 2367 | - <code title="get /accounts/{account_id}/workers/scripts/{script_name}/settings">client.workers.scripts.settings.<a href="./src/resources/workers/scripts/settings.ts">get</a>(scriptName, { ...params }) -> SettingGetResponse</code> |
| 2368 | |
| 2369 | ## Filters |
| 2370 | |
| 2371 | Types: |
| 2372 | |
| 2373 | - <code><a href="./src/resources/workers/filters.ts">WorkersFilters</a></code> |
| 2374 | - <code><a href="./src/resources/workers/filters.ts">FilterCreateResponse</a></code> |
| 2375 | - <code><a href="./src/resources/workers/filters.ts">FilterListResponse</a></code> |
| 2376 | - <code><a href="./src/resources/workers/filters.ts">FilterDeleteResponse</a></code> |
| 2377 | |
| 2378 | Methods: |
| 2379 | |
| 2380 | - <code title="post /zones/{zone_id}/workers/filters">client.workers.filters.<a href="./src/resources/workers/filters.ts">create</a>({ ...params }) -> FilterCreateResponse | null</code> |
| 2381 | - <code title="put /zones/{zone_id}/workers/filters/{filter_id}">client.workers.filters.<a href="./src/resources/workers/filters.ts">update</a>(filterId, { ...params }) -> WorkersFilters</code> |
| 2382 | - <code title="get /zones/{zone_id}/workers/filters">client.workers.filters.<a href="./src/resources/workers/filters.ts">list</a>({ ...params }) -> FilterListResponse</code> |
| 2383 | - <code title="delete /zones/{zone_id}/workers/filters/{filter_id}">client.workers.filters.<a href="./src/resources/workers/filters.ts">delete</a>(filterId, { ...params }) -> FilterDeleteResponse | null</code> |
| 2384 | |
| 2385 | ## Routes |
| 2386 | |
| 2387 | Types: |
| 2388 | |
| 2389 | - <code><a href="./src/resources/workers/routes.ts">WorkersRoutes</a></code> |
| 2390 | - <code><a href="./src/resources/workers/routes.ts">RouteCreateResponse</a></code> |
| 2391 | - <code><a href="./src/resources/workers/routes.ts">RouteListResponse</a></code> |
| 2392 | - <code><a href="./src/resources/workers/routes.ts">RouteDeleteResponse</a></code> |
| 2393 | |
| 2394 | Methods: |
| 2395 | |
| 2396 | - <code title="post /zones/{zone_id}/workers/routes">client.workers.routes.<a href="./src/resources/workers/routes.ts">create</a>({ ...params }) -> RouteCreateResponse</code> |
| 2397 | - <code title="put /zones/{zone_id}/workers/routes/{route_id}">client.workers.routes.<a href="./src/resources/workers/routes.ts">update</a>(routeId, { ...params }) -> WorkersRoutes</code> |
| 2398 | - <code title="get /zones/{zone_id}/workers/routes">client.workers.routes.<a href="./src/resources/workers/routes.ts">list</a>({ ...params }) -> RouteListResponse</code> |
| 2399 | - <code title="delete /zones/{zone_id}/workers/routes/{route_id}">client.workers.routes.<a href="./src/resources/workers/routes.ts">delete</a>(routeId, { ...params }) -> RouteDeleteResponse</code> |
| 2400 | - <code title="get /zones/{zone_id}/workers/routes/{route_id}">client.workers.routes.<a href="./src/resources/workers/routes.ts">get</a>(routeId, { ...params }) -> WorkersRoutes</code> |
| 2401 | |
| 2402 | ## AccountSettings |
| 2403 | |
| 2404 | Types: |
| 2405 | |
| 2406 | - <code><a href="./src/resources/workers/account-settings.ts">AccountSettingUpdateResponse</a></code> |
| 2407 | - <code><a href="./src/resources/workers/account-settings.ts">AccountSettingGetResponse</a></code> |
| 2408 | |
| 2409 | Methods: |
| 2410 | |
| 2411 | - <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> |
| 2412 | - <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> |
| 2413 | |
| 2414 | ## Deployments |
| 2415 | |
| 2416 | ### ByScripts |
| 2417 | |
| 2418 | Types: |
| 2419 | |
| 2420 | - <code><a href="./src/resources/workers/deployments/by-scripts/by-scripts.ts">ByScriptGetResponse</a></code> |
| 2421 | |
| 2422 | Methods: |
| 2423 | |
| 2424 | - <code title="get /accounts/{account_id}/workers/deployments/by-script/{script_id}">client.workers.deployments.byScripts.<a href="./src/resources/workers/deployments/by-scripts/by-scripts.ts">get</a>(scriptId, { ...params }) -> ByScriptGetResponse</code> |
| 2425 | |
| 2426 | #### Details |
| 2427 | |
| 2428 | Types: |
| 2429 | |
| 2430 | - <code><a href="./src/resources/workers/deployments/by-scripts/details.ts">DetailGetResponse</a></code> |
| 2431 | |
| 2432 | Methods: |
| 2433 | |
| 2434 | - <code title="get /accounts/{account_id}/workers/deployments/by-script/{script_id}/detail/{deployment_id}">client.workers.deployments.byScripts.details.<a href="./src/resources/workers/deployments/by-scripts/details.ts">get</a>(scriptId, deploymentId, { ...params }) -> DetailGetResponse</code> |
| 2435 | |
| 2436 | ## Domains |
| 2437 | |
| 2438 | Types: |
| 2439 | |
| 2440 | - <code><a href="./src/resources/workers/domains.ts">WorkersDomain</a></code> |
| 2441 | - <code><a href="./src/resources/workers/domains.ts">DomainListResponse</a></code> |
| 2442 | |
| 2443 | Methods: |
| 2444 | |
| 2445 | - <code title="put /accounts/{account_id}/workers/domains">client.workers.domains.<a href="./src/resources/workers/domains.ts">update</a>({ ...params }) -> WorkersDomain</code> |
| 2446 | - <code title="get /accounts/{account_id}/workers/domains">client.workers.domains.<a href="./src/resources/workers/domains.ts">list</a>({ ...params }) -> DomainListResponse</code> |
| 2447 | - <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> |
| 2448 | - <code title="get /accounts/{account_id}/workers/domains/{domain_id}">client.workers.domains.<a href="./src/resources/workers/domains.ts">get</a>(domainId, { ...params }) -> WorkersDomain</code> |
| 2449 | |
| 2450 | ## Subdomains |
| 2451 | |
| 2452 | Types: |
| 2453 | |
| 2454 | - <code><a href="./src/resources/workers/subdomains.ts">SubdomainUpdateResponse</a></code> |
| 2455 | - <code><a href="./src/resources/workers/subdomains.ts">SubdomainGetResponse</a></code> |
| 2456 | |
| 2457 | Methods: |
| 2458 | |
| 2459 | - <code title="put /accounts/{account_id}/workers/subdomain">client.workers.subdomains.<a href="./src/resources/workers/subdomains.ts">update</a>({ ...params }) -> SubdomainUpdateResponse</code> |
| 2460 | - <code title="get /accounts/{account_id}/workers/subdomain">client.workers.subdomains.<a href="./src/resources/workers/subdomains.ts">get</a>({ ...params }) -> SubdomainGetResponse</code> |
| 2461 | |
| 2462 | ## Services |
| 2463 | |
| 2464 | ### Environments |
| 2465 | |
| 2466 | #### Content |
| 2467 | |
| 2468 | Methods: |
| 2469 | |
| 2470 | - <code title="put /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content">client.workers.services.environments.content.<a href="./src/resources/workers/services/environments/content.ts">update</a>(serviceName, environmentName, { ...params }) -> WorkersScript</code> |
| 2471 | - <code title="get /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content">client.workers.services.environments.content.<a href="./src/resources/workers/services/environments/content.ts">get</a>(serviceName, environmentName, { ...params }) -> Response</code> |
| 2472 | |
| 2473 | #### Settings |
| 2474 | |
| 2475 | Types: |
| 2476 | |
| 2477 | - <code><a href="./src/resources/workers/services/environments/settings.ts">SettingEditResponse</a></code> |
| 2478 | - <code><a href="./src/resources/workers/services/environments/settings.ts">SettingGetResponse</a></code> |
| 2479 | |
| 2480 | Methods: |
| 2481 | |
| 2482 | - <code title="patch /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings">client.workers.services.environments.settings.<a href="./src/resources/workers/services/environments/settings.ts">edit</a>(serviceName, environmentName, { ...params }) -> SettingEditResponse</code> |
| 2483 | - <code title="get /accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings">client.workers.services.environments.settings.<a href="./src/resources/workers/services/environments/settings.ts">get</a>(serviceName, environmentName, { ...params }) -> SettingGetResponse</code> |
| 2484 | |
| 2485 | # KV |
| 2486 | |
| 2487 | ## Namespaces |
| 2488 | |
| 2489 | Types: |
| 2490 | |
| 2491 | - <code><a href="./src/resources/kv/namespaces/namespaces.ts">WorkersKVNamespace</a></code> |
| 2492 | - <code><a href="./src/resources/kv/namespaces/namespaces.ts">NamespaceUpdateResponse</a></code> |
| 2493 | - <code><a href="./src/resources/kv/namespaces/namespaces.ts">NamespaceDeleteResponse</a></code> |
| 2494 | |
| 2495 | Methods: |
| 2496 | |
| 2497 | - <code title="post /accounts/{account_id}/storage/kv/namespaces">client.kv.namespaces.<a href="./src/resources/kv/namespaces/namespaces.ts">create</a>({ ...params }) -> WorkersKVNamespace</code> |
| 2498 | - <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</code> |
| 2499 | - <code title="get /accounts/{account_id}/storage/kv/namespaces">client.kv.namespaces.<a href="./src/resources/kv/namespaces/namespaces.ts">list</a>({ ...params }) -> WorkersKVNamespacesV4PagePaginationArray</code> |
| 2500 | - <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</code> |
| 2501 | |
| 2502 | ### Bulk |
| 2503 | |
| 2504 | Types: |
| 2505 | |
| 2506 | - <code><a href="./src/resources/kv/namespaces/bulk.ts">BulkUpdateResponse</a></code> |
| 2507 | - <code><a href="./src/resources/kv/namespaces/bulk.ts">BulkDeleteResponse</a></code> |
| 2508 | |
| 2509 | Methods: |
| 2510 | |
| 2511 | - <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</code> |
| 2512 | - <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, [ ...body ]) -> BulkDeleteResponse</code> |
| 2513 | |
| 2514 | ### Keys |
| 2515 | |
| 2516 | Types: |
| 2517 | |
| 2518 | - <code><a href="./src/resources/kv/namespaces/keys.ts">WorkersKVKey</a></code> |
| 2519 | |
| 2520 | Methods: |
| 2521 | |
| 2522 | - <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 }) -> WorkersKVKeysCursorLimitPagination</code> |
| 2523 | |
| 2524 | ### Metadata |
| 2525 | |
| 2526 | Types: |
| 2527 | |
| 2528 | - <code><a href="./src/resources/kv/namespaces/metadata.ts">MetadataGetResponse</a></code> |
| 2529 | |
| 2530 | Methods: |
| 2531 | |
| 2532 | - <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> |
| 2533 | |
| 2534 | ### Values |
| 2535 | |
| 2536 | Types: |
| 2537 | |
| 2538 | - <code><a href="./src/resources/kv/namespaces/values.ts">ValueUpdateResponse</a></code> |
| 2539 | - <code><a href="./src/resources/kv/namespaces/values.ts">ValueDeleteResponse</a></code> |
| 2540 | - <code><a href="./src/resources/kv/namespaces/values.ts">ValueGetResponse</a></code> |
| 2541 | |
| 2542 | Methods: |
| 2543 | |
| 2544 | - <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</code> |
| 2545 | - <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</code> |
| 2546 | - <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 }) -> string</code> |
| 2547 | |
| 2548 | # DurableObjects |
| 2549 | |
| 2550 | ## Namespaces |
| 2551 | |
| 2552 | Types: |
| 2553 | |
| 2554 | - <code><a href="./src/resources/durable-objects/namespaces/namespaces.ts">WorkersNamespace</a></code> |
| 2555 | - <code><a href="./src/resources/durable-objects/namespaces/namespaces.ts">NamespaceListResponse</a></code> |
| 2556 | |
| 2557 | Methods: |
| 2558 | |
| 2559 | - <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 }) -> NamespaceListResponse | null</code> |
| 2560 | |
| 2561 | ### Objects |
| 2562 | |
| 2563 | Types: |
| 2564 | |
| 2565 | - <code><a href="./src/resources/durable-objects/namespaces/objects.ts">WorkersObject</a></code> |
| 2566 | |
| 2567 | Methods: |
| 2568 | |
| 2569 | - <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 }) -> WorkersObjectsCursorLimitPagination</code> |
| 2570 | |
| 2571 | # Queues |
| 2572 | |
| 2573 | Types: |
| 2574 | |
| 2575 | - <code><a href="./src/resources/queues/queues.ts">WorkersQueue</a></code> |
| 2576 | - <code><a href="./src/resources/queues/queues.ts">WorkersQueueCreated</a></code> |
| 2577 | - <code><a href="./src/resources/queues/queues.ts">WorkersQueueUpdated</a></code> |
| 2578 | - <code><a href="./src/resources/queues/queues.ts">QueueListResponse</a></code> |
| 2579 | - <code><a href="./src/resources/queues/queues.ts">QueueDeleteResponse</a></code> |
| 2580 | |
| 2581 | Methods: |
| 2582 | |
| 2583 | - <code title="post /accounts/{account_id}/workers/queues">client.queues.<a href="./src/resources/queues/queues.ts">create</a>({ ...params }) -> WorkersQueueCreated | null</code> |
| 2584 | - <code title="put /accounts/{account_id}/workers/queues/{name}">client.queues.<a href="./src/resources/queues/queues.ts">update</a>(name, { ...params }) -> WorkersQueueUpdated | null</code> |
| 2585 | - <code title="get /accounts/{account_id}/workers/queues">client.queues.<a href="./src/resources/queues/queues.ts">list</a>({ ...params }) -> QueueListResponse | null</code> |
| 2586 | - <code title="delete /accounts/{account_id}/workers/queues/{name}">client.queues.<a href="./src/resources/queues/queues.ts">delete</a>(name, { ...params }) -> QueueDeleteResponse | null</code> |
| 2587 | - <code title="get /accounts/{account_id}/workers/queues/{name}">client.queues.<a href="./src/resources/queues/queues.ts">get</a>(name, { ...params }) -> WorkersQueue | null</code> |
| 2588 | |
| 2589 | ## Consumers |
| 2590 | |
| 2591 | Types: |
| 2592 | |
| 2593 | - <code><a href="./src/resources/queues/consumers.ts">WorkersConsumer</a></code> |
| 2594 | - <code><a href="./src/resources/queues/consumers.ts">WorkersConsumerCreated</a></code> |
| 2595 | - <code><a href="./src/resources/queues/consumers.ts">WorkersConsumerUpdated</a></code> |
| 2596 | - <code><a href="./src/resources/queues/consumers.ts">ConsumerDeleteResponse</a></code> |
| 2597 | - <code><a href="./src/resources/queues/consumers.ts">ConsumerGetResponse</a></code> |
| 2598 | |
| 2599 | Methods: |
| 2600 | |
| 2601 | - <code title="post /accounts/{account_id}/workers/queues/{name}/consumers">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">create</a>(name, { ...params }) -> WorkersConsumerCreated | null</code> |
| 2602 | - <code title="put /accounts/{account_id}/workers/queues/{name}/consumers/{consumer_name}">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">update</a>(name, consumerName, { ...params }) -> WorkersConsumerUpdated | null</code> |
| 2603 | - <code title="delete /accounts/{account_id}/workers/queues/{name}/consumers/{consumer_name}">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">delete</a>(name, consumerName, { ...params }) -> ConsumerDeleteResponse | null</code> |
| 2604 | - <code title="get /accounts/{account_id}/workers/queues/{name}/consumers">client.queues.consumers.<a href="./src/resources/queues/consumers.ts">get</a>(name, { ...params }) -> ConsumerGetResponse | null</code> |
| 2605 | |
| 2606 | # ManagedHeaders |
| 2607 | |
| 2608 | Types: |
| 2609 | |
| 2610 | - <code><a href="./src/resources/managed-headers.ts">ManagedHeaderListResponse</a></code> |
| 2611 | - <code><a href="./src/resources/managed-headers.ts">ManagedHeaderEditResponse</a></code> |
| 2612 | |
| 2613 | Methods: |
| 2614 | |
| 2615 | - <code title="get /zones/{zone_id}/managed_headers">client.managedHeaders.<a href="./src/resources/managed-headers.ts">list</a>({ ...params }) -> ManagedHeaderListResponse</code> |
| 2616 | - <code title="patch /zones/{zone_id}/managed_headers">client.managedHeaders.<a href="./src/resources/managed-headers.ts">edit</a>({ ...params }) -> ManagedHeaderEditResponse</code> |
| 2617 | |
| 2618 | # PageShield |
| 2619 | |
| 2620 | Types: |
| 2621 | |
| 2622 | - <code><a href="./src/resources/page-shield/page-shield.ts">PageShieldGetZoneSettings</a></code> |
| 2623 | - <code><a href="./src/resources/page-shield/page-shield.ts">PageShieldUpdateZoneSettings</a></code> |
| 2624 | |
| 2625 | Methods: |
| 2626 | |
| 2627 | - <code title="put /zones/{zone_id}/page_shield">client.pageShield.<a href="./src/resources/page-shield/page-shield.ts">update</a>({ ...params }) -> PageShieldUpdateZoneSettings</code> |
| 2628 | - <code title="get /zones/{zone_id}/page_shield">client.pageShield.<a href="./src/resources/page-shield/page-shield.ts">get</a>({ ...params }) -> PageShieldGetZoneSettings</code> |
| 2629 | |
| 2630 | ## Policies |
| 2631 | |
| 2632 | Types: |
| 2633 | |
| 2634 | - <code><a href="./src/resources/page-shield/policies.ts">PageShieldPageshieldPolicy</a></code> |
| 2635 | - <code><a href="./src/resources/page-shield/policies.ts">PolicyListResponse</a></code> |
| 2636 | |
| 2637 | Methods: |
| 2638 | |
| 2639 | - <code title="post /zones/{zone_id}/page_shield/policies">client.pageShield.policies.<a href="./src/resources/page-shield/policies.ts">create</a>({ ...params }) -> PageShieldPageshieldPolicy</code> |
| 2640 | - <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 }) -> PageShieldPageshieldPolicy</code> |
| 2641 | - <code title="get /zones/{zone_id}/page_shield/policies">client.pageShield.policies.<a href="./src/resources/page-shield/policies.ts">list</a>({ ...params }) -> PolicyListResponse | null</code> |
| 2642 | - <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> |
| 2643 | - <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 }) -> PageShieldPageshieldPolicy</code> |
| 2644 | |
| 2645 | ## Connections |
| 2646 | |
| 2647 | Types: |
| 2648 | |
| 2649 | - <code><a href="./src/resources/page-shield/connections.ts">PageShieldConnection</a></code> |
| 2650 | - <code><a href="./src/resources/page-shield/connections.ts">ConnectionListResponse</a></code> |
| 2651 | |
| 2652 | Methods: |
| 2653 | |
| 2654 | - <code title="get /zones/{zone_id}/page_shield/connections">client.pageShield.connections.<a href="./src/resources/page-shield/connections.ts">list</a>({ ...params }) -> ConnectionListResponse | null</code> |
| 2655 | - <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 }) -> PageShieldConnection</code> |
| 2656 | |
| 2657 | ## Scripts |
| 2658 | |
| 2659 | Types: |
| 2660 | |
| 2661 | - <code><a href="./src/resources/page-shield/scripts.ts">PageShieldScript</a></code> |
| 2662 | - <code><a href="./src/resources/page-shield/scripts.ts">ScriptListResponse</a></code> |
| 2663 | - <code><a href="./src/resources/page-shield/scripts.ts">ScriptGetResponse</a></code> |
| 2664 | |
| 2665 | Methods: |
| 2666 | |
| 2667 | - <code title="get /zones/{zone_id}/page_shield/scripts">client.pageShield.scripts.<a href="./src/resources/page-shield/scripts.ts">list</a>({ ...params }) -> ScriptListResponse | null</code> |
| 2668 | - <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</code> |
| 2669 | |
| 2670 | # Rulesets |
| 2671 | |
| 2672 | Types: |
| 2673 | |
| 2674 | - <code><a href="./src/resources/rulesets/rulesets.ts">RulesetsRulesetResponse</a></code> |
| 2675 | - <code><a href="./src/resources/rulesets/rulesets.ts">RulesetsRulesetsResponse</a></code> |
| 2676 | |
| 2677 | Methods: |
| 2678 | |
| 2679 | - <code title="post /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">create</a>({ ...params }) -> RulesetsRulesetResponse</code> |
| 2680 | - <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 }) -> RulesetsRulesetResponse</code> |
| 2681 | - <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">list</a>({ ...params }) -> RulesetsRulesetsResponse</code> |
| 2682 | - <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> |
| 2683 | - <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 }) -> RulesetsRulesetResponse</code> |
| 2684 | |
| 2685 | ## Phases |
| 2686 | |
| 2687 | Methods: |
| 2688 | |
| 2689 | - <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 }) -> RulesetsRulesetResponse</code> |
| 2690 | - <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 }) -> RulesetsRulesetResponse</code> |
| 2691 | |
| 2692 | ### Versions |
| 2693 | |
| 2694 | Methods: |
| 2695 | |
| 2696 | - <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 }) -> RulesetsRulesetsResponse</code> |
| 2697 | - <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 }) -> RulesetsRulesetResponse</code> |
| 2698 | |
| 2699 | ## Rules |
| 2700 | |
| 2701 | Methods: |
| 2702 | |
| 2703 | - <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 }) -> RulesetsRulesetResponse</code> |
| 2704 | - <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 }) -> RulesetsRulesetResponse</code> |
| 2705 | - <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 }) -> RulesetsRulesetResponse</code> |
| 2706 | |
| 2707 | ## Versions |
| 2708 | |
| 2709 | Methods: |
| 2710 | |
| 2711 | - <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 }) -> RulesetsRulesetsResponse</code> |
| 2712 | - <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> |
| 2713 | - <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 }) -> RulesetsRulesetResponse</code> |
| 2714 | |
| 2715 | ### ByTags |
| 2716 | |
| 2717 | Methods: |
| 2718 | |
| 2719 | - <code title="get /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}">client.rulesets.versions.byTags.<a href="./src/resources/rulesets/versions/by-tags.ts">get</a>(rulesetId, rulesetVersion, ruleTag, { ...params }) -> RulesetsRulesetResponse</code> |
| 2720 | |
| 2721 | # URLNormalization |
| 2722 | |
| 2723 | Types: |
| 2724 | |
| 2725 | - <code><a href="./src/resources/url-normalization.ts">URLNormalizationUpdateResponse</a></code> |
| 2726 | - <code><a href="./src/resources/url-normalization.ts">URLNormalizationGetResponse</a></code> |
| 2727 | |
| 2728 | Methods: |
| 2729 | |
| 2730 | - <code title="put /zones/{zone_id}/url_normalization">client.urlNormalization.<a href="./src/resources/url-normalization.ts">update</a>({ ...params }) -> URLNormalizationUpdateResponse</code> |
| 2731 | - <code title="get /zones/{zone_id}/url_normalization">client.urlNormalization.<a href="./src/resources/url-normalization.ts">get</a>({ ...params }) -> URLNormalizationGetResponse</code> |
| 2732 | |
| 2733 | # Spectrum |
| 2734 | |
| 2735 | ## Analytics |
| 2736 | |
| 2737 | ### Aggregates |
| 2738 | |
| 2739 | #### Currents |
| 2740 | |
| 2741 | Types: |
| 2742 | |
| 2743 | - <code><a href="./src/resources/spectrum/analytics/aggregates/currents.ts">CurrentGetResponse</a></code> |
| 2744 | |
| 2745 | Methods: |
| 2746 | |
| 2747 | - <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> |
| 2748 | |
| 2749 | ### Events |
| 2750 | |
| 2751 | #### Bytimes |
| 2752 | |
| 2753 | Types: |
| 2754 | |
| 2755 | - <code><a href="./src/resources/spectrum/analytics/events/bytimes.ts">BytimeGetResponse</a></code> |
| 2756 | |
| 2757 | Methods: |
| 2758 | |
| 2759 | - <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> |
| 2760 | |
| 2761 | #### Summaries |
| 2762 | |
| 2763 | Types: |
| 2764 | |
| 2765 | - <code><a href="./src/resources/spectrum/analytics/events/summaries.ts">SummaryGetResponse</a></code> |
| 2766 | |
| 2767 | Methods: |
| 2768 | |
| 2769 | - <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> |
| 2770 | |
| 2771 | ## Apps |
| 2772 | |
| 2773 | Types: |
| 2774 | |
| 2775 | - <code><a href="./src/resources/spectrum/apps.ts">AppCreateResponse</a></code> |
| 2776 | - <code><a href="./src/resources/spectrum/apps.ts">AppUpdateResponse</a></code> |
| 2777 | - <code><a href="./src/resources/spectrum/apps.ts">AppListResponse</a></code> |
| 2778 | - <code><a href="./src/resources/spectrum/apps.ts">AppDeleteResponse</a></code> |
| 2779 | - <code><a href="./src/resources/spectrum/apps.ts">AppGetResponse</a></code> |
| 2780 | |
| 2781 | Methods: |
| 2782 | |
| 2783 | - <code title="post /zones/{zone}/spectrum/apps">client.spectrum.apps.<a href="./src/resources/spectrum/apps.ts">create</a>(zone, { ...params }) -> AppCreateResponse | null</code> |
| 2784 | - <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> |
| 2785 | - <code title="get /zones/{zone}/spectrum/apps">client.spectrum.apps.<a href="./src/resources/spectrum/apps.ts">list</a>(zone, { ...params }) -> AppListResponsesV4PagePaginationArray</code> |
| 2786 | - <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> |
| 2787 | - <code title="get /zones/{zone}/spectrum/apps/{app_id}">client.spectrum.apps.<a href="./src/resources/spectrum/apps.ts">get</a>(zone, appId) -> AppGetResponse | null</code> |
| 2788 | |
| 2789 | # Addressing |
| 2790 | |
| 2791 | ## Services |
| 2792 | |
| 2793 | Types: |
| 2794 | |
| 2795 | - <code><a href="./src/resources/addressing/services.ts">ServiceListResponse</a></code> |
| 2796 | |
| 2797 | Methods: |
| 2798 | |
| 2799 | - <code title="get /accounts/{account_id}/addressing/services">client.addressing.services.<a href="./src/resources/addressing/services.ts">list</a>({ ...params }) -> ServiceListResponse</code> |
| 2800 | |
| 2801 | ## AddressMaps |
| 2802 | |
| 2803 | Types: |
| 2804 | |
| 2805 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">AddressingAddressMaps</a></code> |
| 2806 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">AddressMapCreateResponse</a></code> |
| 2807 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">AddressMapListResponse</a></code> |
| 2808 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">AddressMapDeleteResponse</a></code> |
| 2809 | - <code><a href="./src/resources/addressing/address-maps/address-maps.ts">AddressMapGetResponse</a></code> |
| 2810 | |
| 2811 | Methods: |
| 2812 | |
| 2813 | - <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> |
| 2814 | - <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 }) -> AddressMapListResponse | null</code> |
| 2815 | - <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> |
| 2816 | - <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 }) -> AddressingAddressMaps</code> |
| 2817 | - <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> |
| 2818 | |
| 2819 | ### Accounts |
| 2820 | |
| 2821 | Types: |
| 2822 | |
| 2823 | - <code><a href="./src/resources/addressing/address-maps/accounts.ts">AccountUpdateResponse</a></code> |
| 2824 | - <code><a href="./src/resources/addressing/address-maps/accounts.ts">AccountDeleteResponse</a></code> |
| 2825 | |
| 2826 | Methods: |
| 2827 | |
| 2828 | - <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> |
| 2829 | - <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> |
| 2830 | |
| 2831 | ### IPs |
| 2832 | |
| 2833 | Types: |
| 2834 | |
| 2835 | - <code><a href="./src/resources/addressing/address-maps/ips.ts">IPUpdateResponse</a></code> |
| 2836 | - <code><a href="./src/resources/addressing/address-maps/ips.ts">IPDeleteResponse</a></code> |
| 2837 | |
| 2838 | Methods: |
| 2839 | |
| 2840 | - <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> |
| 2841 | - <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> |
| 2842 | |
| 2843 | ### Zones |
| 2844 | |
| 2845 | Types: |
| 2846 | |
| 2847 | - <code><a href="./src/resources/addressing/address-maps/zones.ts">ZoneUpdateResponse</a></code> |
| 2848 | - <code><a href="./src/resources/addressing/address-maps/zones.ts">ZoneDeleteResponse</a></code> |
| 2849 | |
| 2850 | Methods: |
| 2851 | |
| 2852 | - <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> |
| 2853 | - <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> |
| 2854 | |
| 2855 | ## LOADocuments |
| 2856 | |
| 2857 | Types: |
| 2858 | |
| 2859 | - <code><a href="./src/resources/addressing/loa-documents/loa-documents.ts">LOADocumentCreateResponse</a></code> |
| 2860 | |
| 2861 | Methods: |
| 2862 | |
| 2863 | - <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> |
| 2864 | |
| 2865 | ### Downloads |
| 2866 | |
| 2867 | Types: |
| 2868 | |
| 2869 | - <code><a href="./src/resources/addressing/loa-documents/downloads.ts">DownloadGetResponse</a></code> |
| 2870 | |
| 2871 | Methods: |
| 2872 | |
| 2873 | - <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 }) -> unknown</code> |
| 2874 | |
| 2875 | ## Prefixes |
| 2876 | |
| 2877 | Types: |
| 2878 | |
| 2879 | - <code><a href="./src/resources/addressing/prefixes/prefixes.ts">AddressingIpamPrefixes</a></code> |
| 2880 | - <code><a href="./src/resources/addressing/prefixes/prefixes.ts">PrefixListResponse</a></code> |
| 2881 | - <code><a href="./src/resources/addressing/prefixes/prefixes.ts">PrefixDeleteResponse</a></code> |
| 2882 | |
| 2883 | Methods: |
| 2884 | |
| 2885 | - <code title="post /accounts/{account_id}/addressing/prefixes">client.addressing.prefixes.<a href="./src/resources/addressing/prefixes/prefixes.ts">create</a>({ ...params }) -> AddressingIpamPrefixes</code> |
| 2886 | - <code title="get /accounts/{account_id}/addressing/prefixes">client.addressing.prefixes.<a href="./src/resources/addressing/prefixes/prefixes.ts">list</a>({ ...params }) -> PrefixListResponse | null</code> |
| 2887 | - <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> |
| 2888 | - <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 }) -> AddressingIpamPrefixes</code> |
| 2889 | - <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 }) -> AddressingIpamPrefixes</code> |
| 2890 | |
| 2891 | ### BGP |
| 2892 | |
| 2893 | #### Bindings |
| 2894 | |
| 2895 | Types: |
| 2896 | |
| 2897 | - <code><a href="./src/resources/addressing/prefixes/bgp/bindings.ts">AddressingServiceBinding</a></code> |
| 2898 | - <code><a href="./src/resources/addressing/prefixes/bgp/bindings.ts">BindingListResponse</a></code> |
| 2899 | - <code><a href="./src/resources/addressing/prefixes/bgp/bindings.ts">BindingDeleteResponse</a></code> |
| 2900 | |
| 2901 | Methods: |
| 2902 | |
| 2903 | - <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 }) -> AddressingServiceBinding</code> |
| 2904 | - <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 }) -> BindingListResponse</code> |
| 2905 | - <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> |
| 2906 | - <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 }) -> AddressingServiceBinding</code> |
| 2907 | |
| 2908 | #### Prefixes |
| 2909 | |
| 2910 | Types: |
| 2911 | |
| 2912 | - <code><a href="./src/resources/addressing/prefixes/bgp/prefixes.ts">AddressingIpamBGPPrefixes</a></code> |
| 2913 | - <code><a href="./src/resources/addressing/prefixes/bgp/prefixes.ts">PrefixListResponse</a></code> |
| 2914 | |
| 2915 | Methods: |
| 2916 | |
| 2917 | - <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 }) -> PrefixListResponse | null</code> |
| 2918 | - <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 }) -> AddressingIpamBGPPrefixes</code> |
| 2919 | - <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 }) -> AddressingIpamBGPPrefixes</code> |
| 2920 | |
| 2921 | #### Statuses |
| 2922 | |
| 2923 | Types: |
| 2924 | |
| 2925 | - <code><a href="./src/resources/addressing/prefixes/bgp/statuses.ts">StatusEditResponse</a></code> |
| 2926 | - <code><a href="./src/resources/addressing/prefixes/bgp/statuses.ts">StatusGetResponse</a></code> |
| 2927 | |
| 2928 | Methods: |
| 2929 | |
| 2930 | - <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> |
| 2931 | - <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> |
| 2932 | |
| 2933 | ### Delegations |
| 2934 | |
| 2935 | Types: |
| 2936 | |
| 2937 | - <code><a href="./src/resources/addressing/prefixes/delegations.ts">AddressingIpamDelegations</a></code> |
| 2938 | - <code><a href="./src/resources/addressing/prefixes/delegations.ts">DelegationListResponse</a></code> |
| 2939 | - <code><a href="./src/resources/addressing/prefixes/delegations.ts">DelegationDeleteResponse</a></code> |
| 2940 | |
| 2941 | Methods: |
| 2942 | |
| 2943 | - <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 }) -> AddressingIpamDelegations</code> |
| 2944 | - <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 }) -> DelegationListResponse | null</code> |
| 2945 | - <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> |
| 2946 | |
| 2947 | # AuditLogs |
| 2948 | |
| 2949 | Types: |
| 2950 | |
| 2951 | - <code><a href="./src/resources/audit-logs.ts">AuditLogListResponse</a></code> |
| 2952 | |
| 2953 | Methods: |
| 2954 | |
| 2955 | - <code title="get /accounts/{account_id}/audit_logs">client.auditLogs.<a href="./src/resources/audit-logs.ts">list</a>({ ...params }) -> AuditLogListResponsesV4PagePaginationArray</code> |
| 2956 | |
| 2957 | # Billing |
| 2958 | |
| 2959 | ## Profiles |
| 2960 | |
| 2961 | Types: |
| 2962 | |
| 2963 | - <code><a href="./src/resources/billing/profiles.ts">ProfileGetResponse</a></code> |
| 2964 | |
| 2965 | Methods: |
| 2966 | |
| 2967 | - <code title="get /accounts/{account_identifier}/billing/profile">client.billing.profiles.<a href="./src/resources/billing/profiles.ts">get</a>(accountIdentifier) -> ProfileGetResponse</code> |
| 2968 | |
| 2969 | # BrandProtection |
| 2970 | |
| 2971 | Types: |
| 2972 | |
| 2973 | - <code><a href="./src/resources/brand-protection.ts">IntelPhishingURLInfo</a></code> |
| 2974 | - <code><a href="./src/resources/brand-protection.ts">IntelPhishingURLSubmit</a></code> |
| 2975 | |
| 2976 | Methods: |
| 2977 | |
| 2978 | - <code title="post /accounts/{account_id}/brand-protection/submit">client.brandProtection.<a href="./src/resources/brand-protection.ts">submit</a>({ ...params }) -> IntelPhishingURLSubmit</code> |
| 2979 | - <code title="get /accounts/{account_id}/brand-protection/url-info">client.brandProtection.<a href="./src/resources/brand-protection.ts">urlInfo</a>({ ...params }) -> IntelPhishingURLInfo</code> |
| 2980 | |
| 2981 | # Diagnostics |
| 2982 | |
| 2983 | ## Traceroutes |
| 2984 | |
| 2985 | Types: |
| 2986 | |
| 2987 | - <code><a href="./src/resources/diagnostics/traceroutes.ts">MagicTransitTargetResult</a></code> |
| 2988 | - <code><a href="./src/resources/diagnostics/traceroutes.ts">TracerouteCreateResponse</a></code> |
| 2989 | |
| 2990 | Methods: |
| 2991 | |
| 2992 | - <code title="post /accounts/{account_id}/diagnostics/traceroute">client.diagnostics.traceroutes.<a href="./src/resources/diagnostics/traceroutes.ts">create</a>({ ...params }) -> TracerouteCreateResponse | null</code> |
| 2993 | |
| 2994 | # Images |
| 2995 | |
| 2996 | ## V1 |
| 2997 | |
| 2998 | Types: |
| 2999 | |
| 3000 | - <code><a href="./src/resources/images/v1/v1.ts">ImagesImage</a></code> |
| 3001 | - <code><a href="./src/resources/images/v1/v1.ts">V1ListResponse</a></code> |
| 3002 | - <code><a href="./src/resources/images/v1/v1.ts">V1DeleteResponse</a></code> |
| 3003 | |
| 3004 | Methods: |
| 3005 | |
| 3006 | - <code title="post /accounts/{account_id}/images/v1">client.images.v1.<a href="./src/resources/images/v1/v1.ts">create</a>({ ...params }) -> ImagesImage</code> |
| 3007 | - <code title="get /accounts/{account_id}/images/v1">client.images.v1.<a href="./src/resources/images/v1/v1.ts">list</a>({ ...params }) -> V1ListResponsesV4PagePagination</code> |
| 3008 | - <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> |
| 3009 | - <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 }) -> ImagesImage</code> |
| 3010 | - <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 }) -> ImagesImage</code> |
| 3011 | |
| 3012 | ### Keys |
| 3013 | |
| 3014 | Types: |
| 3015 | |
| 3016 | - <code><a href="./src/resources/images/v1/keys.ts">ImagesImageKeys</a></code> |
| 3017 | |
| 3018 | Methods: |
| 3019 | |
| 3020 | - <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 }) -> ImagesImageKeys</code> |
| 3021 | - <code title="get /accounts/{account_id}/images/v1/keys">client.images.v1.keys.<a href="./src/resources/images/v1/keys.ts">list</a>({ ...params }) -> ImagesImageKeys</code> |
| 3022 | - <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 }) -> ImagesImageKeys</code> |
| 3023 | |
| 3024 | ### Stats |
| 3025 | |
| 3026 | Types: |
| 3027 | |
| 3028 | - <code><a href="./src/resources/images/v1/stats.ts">ImagesImagesStats</a></code> |
| 3029 | |
| 3030 | Methods: |
| 3031 | |
| 3032 | - <code title="get /accounts/{account_id}/images/v1/stats">client.images.v1.stats.<a href="./src/resources/images/v1/stats.ts">get</a>({ ...params }) -> ImagesImagesStats</code> |
| 3033 | |
| 3034 | ### Variants |
| 3035 | |
| 3036 | Types: |
| 3037 | |
| 3038 | - <code><a href="./src/resources/images/v1/variants.ts">ImageVariant</a></code> |
| 3039 | - <code><a href="./src/resources/images/v1/variants.ts">ImageVariants</a></code> |
| 3040 | - <code><a href="./src/resources/images/v1/variants.ts">VariantDeleteResponse</a></code> |
| 3041 | |
| 3042 | Methods: |
| 3043 | |
| 3044 | - <code title="post /accounts/{account_id}/images/v1/variants">client.images.v1.variants.<a href="./src/resources/images/v1/variants.ts">create</a>({ ...params }) -> ImageVariant</code> |
| 3045 | - <code title="get /accounts/{account_id}/images/v1/variants">client.images.v1.variants.<a href="./src/resources/images/v1/variants.ts">list</a>({ ...params }) -> ImageVariants</code> |
| 3046 | - <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> |
| 3047 | - <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 }) -> ImageVariant</code> |
| 3048 | - <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 }) -> ImageVariant</code> |
| 3049 | |
| 3050 | ### Blobs |
| 3051 | |
| 3052 | Methods: |
| 3053 | |
| 3054 | - <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> |
| 3055 | |
| 3056 | ## V2 |
| 3057 | |
| 3058 | Types: |
| 3059 | |
| 3060 | - <code><a href="./src/resources/images/v2/v2.ts">V2ListResponse</a></code> |
| 3061 | |
| 3062 | Methods: |
| 3063 | |
| 3064 | - <code title="get /accounts/{account_id}/images/v2">client.images.v2.<a href="./src/resources/images/v2/v2.ts">list</a>({ ...params }) -> V2ListResponse</code> |
| 3065 | |
| 3066 | ### DirectUploads |
| 3067 | |
| 3068 | Types: |
| 3069 | |
| 3070 | - <code><a href="./src/resources/images/v2/direct-uploads.ts">DirectUploadCreateResponse</a></code> |
| 3071 | |
| 3072 | Methods: |
| 3073 | |
| 3074 | - <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> |
| 3075 | |
| 3076 | # Intel |
| 3077 | |
| 3078 | ## ASN |
| 3079 | |
| 3080 | Types: |
| 3081 | |
| 3082 | - <code><a href="./src/resources/intel/asn/asn.ts">IntelASN</a></code> |
| 3083 | |
| 3084 | Methods: |
| 3085 | |
| 3086 | - <code title="get /accounts/{account_id}/intel/asn/{asn}">client.intel.asn.<a href="./src/resources/intel/asn/asn.ts">get</a>(asn, { ...params }) -> IntelASN</code> |
| 3087 | |
| 3088 | ### Subnets |
| 3089 | |
| 3090 | Types: |
| 3091 | |
| 3092 | - <code><a href="./src/resources/intel/asn/subnets.ts">SubnetGetResponse</a></code> |
| 3093 | |
| 3094 | Methods: |
| 3095 | |
| 3096 | - <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> |
| 3097 | |
| 3098 | ## DNS |
| 3099 | |
| 3100 | Types: |
| 3101 | |
| 3102 | - <code><a href="./src/resources/intel/dns.ts">IntelPassiveDNSByIP</a></code> |
| 3103 | |
| 3104 | Methods: |
| 3105 | |
| 3106 | - <code title="get /accounts/{account_id}/intel/dns">client.intel.dns.<a href="./src/resources/intel/dns.ts">get</a>({ ...params }) -> IntelPassiveDNSByIP</code> |
| 3107 | |
| 3108 | ## Domains |
| 3109 | |
| 3110 | Types: |
| 3111 | |
| 3112 | - <code><a href="./src/resources/intel/domains/domains.ts">IntelDomain</a></code> |
| 3113 | |
| 3114 | Methods: |
| 3115 | |
| 3116 | - <code title="get /accounts/{account_id}/intel/domain">client.intel.domains.<a href="./src/resources/intel/domains/domains.ts">get</a>({ ...params }) -> IntelDomain</code> |
| 3117 | |
| 3118 | ### Bulks |
| 3119 | |
| 3120 | Types: |
| 3121 | |
| 3122 | - <code><a href="./src/resources/intel/domains/bulks.ts">BulkGetResponse</a></code> |
| 3123 | |
| 3124 | Methods: |
| 3125 | |
| 3126 | - <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> |
| 3127 | |
| 3128 | ## DomainHistory |
| 3129 | |
| 3130 | Types: |
| 3131 | |
| 3132 | - <code><a href="./src/resources/intel/domain-history.ts">IntelDomainHistory</a></code> |
| 3133 | - <code><a href="./src/resources/intel/domain-history.ts">DomainHistoryGetResponse</a></code> |
| 3134 | |
| 3135 | Methods: |
| 3136 | |
| 3137 | - <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> |
| 3138 | |
| 3139 | ## IPs |
| 3140 | |
| 3141 | Types: |
| 3142 | |
| 3143 | - <code><a href="./src/resources/intel/ips.ts">IntelSchemasIP</a></code> |
| 3144 | - <code><a href="./src/resources/intel/ips.ts">IPGetResponse</a></code> |
| 3145 | |
| 3146 | Methods: |
| 3147 | |
| 3148 | - <code title="get /accounts/{account_id}/intel/ip">client.intel.ips.<a href="./src/resources/intel/ips.ts">get</a>({ ...params }) -> IPGetResponse | null</code> |
| 3149 | |
| 3150 | ## IPLists |
| 3151 | |
| 3152 | Types: |
| 3153 | |
| 3154 | - <code><a href="./src/resources/intel/ip-lists.ts">IntelIPList</a></code> |
| 3155 | - <code><a href="./src/resources/intel/ip-lists.ts">IPListGetResponse</a></code> |
| 3156 | |
| 3157 | Methods: |
| 3158 | |
| 3159 | - <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> |
| 3160 | |
| 3161 | ## Miscategorizations |
| 3162 | |
| 3163 | Types: |
| 3164 | |
| 3165 | - <code><a href="./src/resources/intel/miscategorizations.ts">MiscategorizationCreateResponse</a></code> |
| 3166 | |
| 3167 | Methods: |
| 3168 | |
| 3169 | - <code title="post /accounts/{account_id}/intel/miscategorization">client.intel.miscategorizations.<a href="./src/resources/intel/miscategorizations.ts">create</a>({ ...params }) -> MiscategorizationCreateResponse</code> |
| 3170 | |
| 3171 | ## Whois |
| 3172 | |
| 3173 | Types: |
| 3174 | |
| 3175 | - <code><a href="./src/resources/intel/whois.ts">IntelWhois</a></code> |
| 3176 | |
| 3177 | Methods: |
| 3178 | |
| 3179 | - <code title="get /accounts/{account_id}/intel/whois">client.intel.whois.<a href="./src/resources/intel/whois.ts">get</a>({ ...params }) -> IntelWhois</code> |
| 3180 | |
| 3181 | ## IndicatorFeeds |
| 3182 | |
| 3183 | Types: |
| 3184 | |
| 3185 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IntelIndicatorFeedItem</a></code> |
| 3186 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IntelIndicatorFeedMetadata</a></code> |
| 3187 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IntelUpdateFeed</a></code> |
| 3188 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedListResponse</a></code> |
| 3189 | - <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedDataResponse</a></code> |
| 3190 | |
| 3191 | Methods: |
| 3192 | |
| 3193 | - <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 }) -> IntelIndicatorFeedItem</code> |
| 3194 | - <code title="put /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">update</a>(feedId, { ...params }) -> IntelUpdateFeed</code> |
| 3195 | - <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 }) -> IndicatorFeedListResponse</code> |
| 3196 | - <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> |
| 3197 | - <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 }) -> IntelIndicatorFeedMetadata</code> |
| 3198 | |
| 3199 | ### Permissions |
| 3200 | |
| 3201 | Types: |
| 3202 | |
| 3203 | - <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">IntelPermissionListItem</a></code> |
| 3204 | - <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">IntelPermissionsUpdate</a></code> |
| 3205 | - <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionListResponse</a></code> |
| 3206 | |
| 3207 | Methods: |
| 3208 | |
| 3209 | - <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 }) -> IntelPermissionsUpdate</code> |
| 3210 | - <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> |
| 3211 | - <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 }) -> IntelPermissionsUpdate</code> |
| 3212 | |
| 3213 | ## Sinkholes |
| 3214 | |
| 3215 | Types: |
| 3216 | |
| 3217 | - <code><a href="./src/resources/intel/sinkholes.ts">IntelSinkholesSinkholeItem</a></code> |
| 3218 | - <code><a href="./src/resources/intel/sinkholes.ts">SinkholeListResponse</a></code> |
| 3219 | |
| 3220 | Methods: |
| 3221 | |
| 3222 | - <code title="get /accounts/{account_id}/intel/sinkholes">client.intel.sinkholes.<a href="./src/resources/intel/sinkholes.ts">list</a>({ ...params }) -> SinkholeListResponse</code> |
| 3223 | |
| 3224 | ## AttackSurfaceReport |
| 3225 | |
| 3226 | ### IssueTypes |
| 3227 | |
| 3228 | Types: |
| 3229 | |
| 3230 | - <code><a href="./src/resources/intel/attack-surface-report/issue-types.ts">IssueTypeGetResponse</a></code> |
| 3231 | |
| 3232 | Methods: |
| 3233 | |
| 3234 | - <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> |
| 3235 | |
| 3236 | ### Issues |
| 3237 | |
| 3238 | Types: |
| 3239 | |
| 3240 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueListResponse</a></code> |
| 3241 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueClassResponse</a></code> |
| 3242 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueDismissResponse</a></code> |
| 3243 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueSeverityResponse</a></code> |
| 3244 | - <code><a href="./src/resources/intel/attack-surface-report/issues.ts">IssueTypeResponse</a></code> |
| 3245 | |
| 3246 | Methods: |
| 3247 | |
| 3248 | - <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> |
| 3249 | - <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> |
| 3250 | - <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> |
| 3251 | - <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> |
| 3252 | - <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> |
| 3253 | |
| 3254 | # MagicTransit |
| 3255 | |
| 3256 | ## CfInterconnects |
| 3257 | |
| 3258 | Types: |
| 3259 | |
| 3260 | - <code><a href="./src/resources/magic-transit/cf-interconnects.ts">CfInterconnectUpdateResponse</a></code> |
| 3261 | - <code><a href="./src/resources/magic-transit/cf-interconnects.ts">CfInterconnectListResponse</a></code> |
| 3262 | - <code><a href="./src/resources/magic-transit/cf-interconnects.ts">CfInterconnectGetResponse</a></code> |
| 3263 | |
| 3264 | Methods: |
| 3265 | |
| 3266 | - <code title="put /accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}">client.magicTransit.cfInterconnects.<a href="./src/resources/magic-transit/cf-interconnects.ts">update</a>(accountIdentifier, tunnelIdentifier, { ...params }) -> CfInterconnectUpdateResponse</code> |
| 3267 | - <code title="get /accounts/{account_identifier}/magic/cf_interconnects">client.magicTransit.cfInterconnects.<a href="./src/resources/magic-transit/cf-interconnects.ts">list</a>(accountIdentifier) -> CfInterconnectListResponse</code> |
| 3268 | - <code title="get /accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}">client.magicTransit.cfInterconnects.<a href="./src/resources/magic-transit/cf-interconnects.ts">get</a>(accountIdentifier, tunnelIdentifier) -> CfInterconnectGetResponse</code> |
| 3269 | |
| 3270 | ## GRETunnels |
| 3271 | |
| 3272 | Types: |
| 3273 | |
| 3274 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelCreateResponse</a></code> |
| 3275 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelUpdateResponse</a></code> |
| 3276 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelListResponse</a></code> |
| 3277 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelDeleteResponse</a></code> |
| 3278 | - <code><a href="./src/resources/magic-transit/gre-tunnels.ts">GRETunnelGetResponse</a></code> |
| 3279 | |
| 3280 | Methods: |
| 3281 | |
| 3282 | - <code title="post /accounts/{account_identifier}/magic/gre_tunnels">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">create</a>(accountIdentifier, { ...params }) -> GRETunnelCreateResponse</code> |
| 3283 | - <code title="put /accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">update</a>(accountIdentifier, tunnelIdentifier, { ...params }) -> GRETunnelUpdateResponse</code> |
| 3284 | - <code title="get /accounts/{account_identifier}/magic/gre_tunnels">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">list</a>(accountIdentifier) -> GRETunnelListResponse</code> |
| 3285 | - <code title="delete /accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">delete</a>(accountIdentifier, tunnelIdentifier) -> GRETunnelDeleteResponse</code> |
| 3286 | - <code title="get /accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}">client.magicTransit.greTunnels.<a href="./src/resources/magic-transit/gre-tunnels.ts">get</a>(accountIdentifier, tunnelIdentifier) -> GRETunnelGetResponse</code> |
| 3287 | |
| 3288 | ## IPSECTunnels |
| 3289 | |
| 3290 | Types: |
| 3291 | |
| 3292 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelCreateResponse</a></code> |
| 3293 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelUpdateResponse</a></code> |
| 3294 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelListResponse</a></code> |
| 3295 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelDeleteResponse</a></code> |
| 3296 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelGetResponse</a></code> |
| 3297 | - <code><a href="./src/resources/magic-transit/ipsec-tunnels.ts">IPSECTunnelPSKGenerateResponse</a></code> |
| 3298 | |
| 3299 | Methods: |
| 3300 | |
| 3301 | - <code title="post /accounts/{account_identifier}/magic/ipsec_tunnels">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">create</a>(accountIdentifier, { ...params }) -> IPSECTunnelCreateResponse</code> |
| 3302 | - <code title="put /accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">update</a>(accountIdentifier, tunnelIdentifier, { ...params }) -> IPSECTunnelUpdateResponse</code> |
| 3303 | - <code title="get /accounts/{account_identifier}/magic/ipsec_tunnels">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">list</a>(accountIdentifier) -> IPSECTunnelListResponse</code> |
| 3304 | - <code title="delete /accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">delete</a>(accountIdentifier, tunnelIdentifier) -> IPSECTunnelDeleteResponse</code> |
| 3305 | - <code title="get /accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">get</a>(accountIdentifier, tunnelIdentifier) -> IPSECTunnelGetResponse</code> |
| 3306 | - <code title="post /accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate">client.magicTransit.ipsecTunnels.<a href="./src/resources/magic-transit/ipsec-tunnels.ts">pskGenerate</a>(accountIdentifier, tunnelIdentifier) -> IPSECTunnelPSKGenerateResponse</code> |
| 3307 | |
| 3308 | ## Routes |
| 3309 | |
| 3310 | Types: |
| 3311 | |
| 3312 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteCreateResponse</a></code> |
| 3313 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteUpdateResponse</a></code> |
| 3314 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteListResponse</a></code> |
| 3315 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteDeleteResponse</a></code> |
| 3316 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteEmptyResponse</a></code> |
| 3317 | - <code><a href="./src/resources/magic-transit/routes.ts">RouteGetResponse</a></code> |
| 3318 | |
| 3319 | Methods: |
| 3320 | |
| 3321 | - <code title="post /accounts/{account_identifier}/magic/routes">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">create</a>(accountIdentifier, { ...params }) -> RouteCreateResponse</code> |
| 3322 | - <code title="put /accounts/{account_identifier}/magic/routes/{route_identifier}">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">update</a>(accountIdentifier, routeIdentifier, { ...params }) -> RouteUpdateResponse</code> |
| 3323 | - <code title="get /accounts/{account_identifier}/magic/routes">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">list</a>(accountIdentifier) -> RouteListResponse</code> |
| 3324 | - <code title="delete /accounts/{account_identifier}/magic/routes/{route_identifier}">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">delete</a>(accountIdentifier, routeIdentifier) -> RouteDeleteResponse</code> |
| 3325 | - <code title="delete /accounts/{account_identifier}/magic/routes">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">empty</a>(accountIdentifier, { ...params }) -> RouteEmptyResponse</code> |
| 3326 | - <code title="get /accounts/{account_identifier}/magic/routes/{route_identifier}">client.magicTransit.routes.<a href="./src/resources/magic-transit/routes.ts">get</a>(accountIdentifier, routeIdentifier) -> RouteGetResponse</code> |
| 3327 | |
| 3328 | ## Sites |
| 3329 | |
| 3330 | Types: |
| 3331 | |
| 3332 | - <code><a href="./src/resources/magic-transit/sites/sites.ts">SiteCreateResponse</a></code> |
| 3333 | - <code><a href="./src/resources/magic-transit/sites/sites.ts">SiteUpdateResponse</a></code> |
| 3334 | - <code><a href="./src/resources/magic-transit/sites/sites.ts">SiteListResponse</a></code> |
| 3335 | - <code><a href="./src/resources/magic-transit/sites/sites.ts">SiteDeleteResponse</a></code> |
| 3336 | - <code><a href="./src/resources/magic-transit/sites/sites.ts">SiteGetResponse</a></code> |
| 3337 | |
| 3338 | Methods: |
| 3339 | |
| 3340 | - <code title="post /accounts/{account_identifier}/magic/sites">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">create</a>(accountIdentifier, { ...params }) -> SiteCreateResponse</code> |
| 3341 | - <code title="put /accounts/{account_identifier}/magic/sites/{site_identifier}">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">update</a>(accountIdentifier, siteIdentifier, { ...params }) -> SiteUpdateResponse</code> |
| 3342 | - <code title="get /accounts/{account_identifier}/magic/sites">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">list</a>(accountIdentifier) -> SiteListResponse</code> |
| 3343 | - <code title="delete /accounts/{account_identifier}/magic/sites/{site_identifier}">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">delete</a>(accountIdentifier, siteIdentifier) -> SiteDeleteResponse</code> |
| 3344 | - <code title="get /accounts/{account_identifier}/magic/sites/{site_identifier}">client.magicTransit.sites.<a href="./src/resources/magic-transit/sites/sites.ts">get</a>(accountIdentifier, siteIdentifier) -> SiteGetResponse</code> |
| 3345 | |
| 3346 | ### ACLs |
| 3347 | |
| 3348 | Types: |
| 3349 | |
| 3350 | - <code><a href="./src/resources/magic-transit/sites/acls.ts">ACLCreateResponse</a></code> |
| 3351 | - <code><a href="./src/resources/magic-transit/sites/acls.ts">ACLUpdateResponse</a></code> |
| 3352 | - <code><a href="./src/resources/magic-transit/sites/acls.ts">ACLListResponse</a></code> |
| 3353 | - <code><a href="./src/resources/magic-transit/sites/acls.ts">ACLDeleteResponse</a></code> |
| 3354 | - <code><a href="./src/resources/magic-transit/sites/acls.ts">ACLGetResponse</a></code> |
| 3355 | |
| 3356 | Methods: |
| 3357 | |
| 3358 | - <code title="post /accounts/{account_identifier}/magic/sites/{site_identifier}/acls">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">create</a>(accountIdentifier, siteIdentifier, { ...params }) -> ACLCreateResponse</code> |
| 3359 | - <code title="put /accounts/{account_identifier}/magic/sites/{site_identifier}/acls/{acl_identifier}">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">update</a>(accountIdentifier, siteIdentifier, aclIdentifier, { ...params }) -> ACLUpdateResponse</code> |
| 3360 | - <code title="get /accounts/{account_identifier}/magic/sites/{site_identifier}/acls">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">list</a>(accountIdentifier, siteIdentifier) -> ACLListResponse</code> |
| 3361 | - <code title="delete /accounts/{account_identifier}/magic/sites/{site_identifier}/acls/{acl_identifier}">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">delete</a>(accountIdentifier, siteIdentifier, aclIdentifier) -> ACLDeleteResponse</code> |
| 3362 | - <code title="get /accounts/{account_identifier}/magic/sites/{site_identifier}/acls/{acl_identifier}">client.magicTransit.sites.acls.<a href="./src/resources/magic-transit/sites/acls.ts">get</a>(accountIdentifier, siteIdentifier, aclIdentifier) -> ACLGetResponse</code> |
| 3363 | |
| 3364 | ### Lans |
| 3365 | |
| 3366 | Types: |
| 3367 | |
| 3368 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">LanCreateResponse</a></code> |
| 3369 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">LanUpdateResponse</a></code> |
| 3370 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">LanListResponse</a></code> |
| 3371 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">LanDeleteResponse</a></code> |
| 3372 | - <code><a href="./src/resources/magic-transit/sites/lans.ts">LanGetResponse</a></code> |
| 3373 | |
| 3374 | Methods: |
| 3375 | |
| 3376 | - <code title="post /accounts/{account_identifier}/magic/sites/{site_identifier}/lans">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">create</a>(accountIdentifier, siteIdentifier, { ...params }) -> LanCreateResponse</code> |
| 3377 | - <code title="put /accounts/{account_identifier}/magic/sites/{site_identifier}/lans/{lan_identifier}">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">update</a>(accountIdentifier, siteIdentifier, lanIdentifier, { ...params }) -> LanUpdateResponse</code> |
| 3378 | - <code title="get /accounts/{account_identifier}/magic/sites/{site_identifier}/lans">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">list</a>(accountIdentifier, siteIdentifier) -> LanListResponse</code> |
| 3379 | - <code title="delete /accounts/{account_identifier}/magic/sites/{site_identifier}/lans/{lan_identifier}">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">delete</a>(accountIdentifier, siteIdentifier, lanIdentifier) -> LanDeleteResponse</code> |
| 3380 | - <code title="get /accounts/{account_identifier}/magic/sites/{site_identifier}/lans/{lan_identifier}">client.magicTransit.sites.lans.<a href="./src/resources/magic-transit/sites/lans.ts">get</a>(accountIdentifier, siteIdentifier, lanIdentifier) -> LanGetResponse</code> |
| 3381 | |
| 3382 | ### Wans |
| 3383 | |
| 3384 | Types: |
| 3385 | |
| 3386 | - <code><a href="./src/resources/magic-transit/sites/wans.ts">WanCreateResponse</a></code> |
| 3387 | - <code><a href="./src/resources/magic-transit/sites/wans.ts">WanUpdateResponse</a></code> |
| 3388 | - <code><a href="./src/resources/magic-transit/sites/wans.ts">WanListResponse</a></code> |
| 3389 | - <code><a href="./src/resources/magic-transit/sites/wans.ts">WanDeleteResponse</a></code> |
| 3390 | - <code><a href="./src/resources/magic-transit/sites/wans.ts">WanGetResponse</a></code> |
| 3391 | |
| 3392 | Methods: |
| 3393 | |
| 3394 | - <code title="post /accounts/{account_identifier}/magic/sites/{site_identifier}/wans">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">create</a>(accountIdentifier, siteIdentifier, { ...params }) -> WanCreateResponse</code> |
| 3395 | - <code title="put /accounts/{account_identifier}/magic/sites/{site_identifier}/wans/{wan_identifier}">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">update</a>(accountIdentifier, siteIdentifier, wanIdentifier, { ...params }) -> WanUpdateResponse</code> |
| 3396 | - <code title="get /accounts/{account_identifier}/magic/sites/{site_identifier}/wans">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">list</a>(accountIdentifier, siteIdentifier) -> WanListResponse</code> |
| 3397 | - <code title="delete /accounts/{account_identifier}/magic/sites/{site_identifier}/wans/{wan_identifier}">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">delete</a>(accountIdentifier, siteIdentifier, wanIdentifier) -> WanDeleteResponse</code> |
| 3398 | - <code title="get /accounts/{account_identifier}/magic/sites/{site_identifier}/wans/{wan_identifier}">client.magicTransit.sites.wans.<a href="./src/resources/magic-transit/sites/wans.ts">get</a>(accountIdentifier, siteIdentifier, wanIdentifier) -> WanGetResponse</code> |
| 3399 | |
| 3400 | # MagicNetworkMonitoring |
| 3401 | |
| 3402 | ## Configs |
| 3403 | |
| 3404 | Types: |
| 3405 | |
| 3406 | - <code><a href="./src/resources/magic-network-monitoring/configs/configs.ts">MagicVisibilityMNMConfig</a></code> |
| 3407 | |
| 3408 | Methods: |
| 3409 | |
| 3410 | - <code title="post /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">create</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code> |
| 3411 | - <code title="put /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">update</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code> |
| 3412 | - <code title="delete /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">delete</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code> |
| 3413 | - <code title="patch /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">edit</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code> |
| 3414 | - <code title="get /accounts/{account_identifier}/mnm/config">client.magicNetworkMonitoring.configs.<a href="./src/resources/magic-network-monitoring/configs/configs.ts">get</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code> |
| 3415 | |
| 3416 | ### Full |
| 3417 | |
| 3418 | Methods: |
| 3419 | |
| 3420 | - <code title="get /accounts/{account_identifier}/mnm/config/full">client.magicNetworkMonitoring.configs.full.<a href="./src/resources/magic-network-monitoring/configs/full.ts">get</a>(accountIdentifier) -> MagicVisibilityMNMConfig</code> |
| 3421 | |
| 3422 | ## Rules |
| 3423 | |
| 3424 | Types: |
| 3425 | |
| 3426 | - <code><a href="./src/resources/magic-network-monitoring/rules/rules.ts">MagicVisibilityMNMRule</a></code> |
| 3427 | - <code><a href="./src/resources/magic-network-monitoring/rules/rules.ts">RuleListResponse</a></code> |
| 3428 | |
| 3429 | Methods: |
| 3430 | |
| 3431 | - <code title="post /accounts/{account_identifier}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">create</a>(accountIdentifier) -> MagicVisibilityMNMRule | null</code> |
| 3432 | - <code title="put /accounts/{account_identifier}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">update</a>(accountIdentifier) -> MagicVisibilityMNMRule | null</code> |
| 3433 | - <code title="get /accounts/{account_identifier}/mnm/rules">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">list</a>(accountIdentifier) -> RuleListResponse | null</code> |
| 3434 | - <code title="delete /accounts/{account_identifier}/mnm/rules/{rule_identifier}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">delete</a>(accountIdentifier, ruleIdentifier) -> MagicVisibilityMNMRule | null</code> |
| 3435 | - <code title="patch /accounts/{account_identifier}/mnm/rules/{rule_identifier}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">edit</a>(accountIdentifier, ruleIdentifier) -> MagicVisibilityMNMRule | null</code> |
| 3436 | - <code title="get /accounts/{account_identifier}/mnm/rules/{rule_identifier}">client.magicNetworkMonitoring.rules.<a href="./src/resources/magic-network-monitoring/rules/rules.ts">get</a>(accountIdentifier, ruleIdentifier) -> MagicVisibilityMNMRule | null</code> |
| 3437 | |
| 3438 | ### Advertisements |
| 3439 | |
| 3440 | Types: |
| 3441 | |
| 3442 | - <code><a href="./src/resources/magic-network-monitoring/rules/advertisements.ts">MagicVisibilityMNMRuleAdvertisable</a></code> |
| 3443 | |
| 3444 | Methods: |
| 3445 | |
| 3446 | - <code title="patch /accounts/{account_identifier}/mnm/rules/{rule_identifier}/advertisement">client.magicNetworkMonitoring.rules.advertisements.<a href="./src/resources/magic-network-monitoring/rules/advertisements.ts">edit</a>(accountIdentifier, ruleIdentifier) -> MagicVisibilityMNMRuleAdvertisable | null</code> |
| 3447 | |
| 3448 | # MTLSCertificates |
| 3449 | |
| 3450 | Types: |
| 3451 | |
| 3452 | - <code><a href="./src/resources/mtls-certificates/mtls-certificates.ts">TLSCertificatesAndHostnamesCertificateObjectPost</a></code> |
| 3453 | - <code><a href="./src/resources/mtls-certificates/mtls-certificates.ts">TLSCertificatesAndHostnamesComponentsSchemasCertificateObject</a></code> |
| 3454 | - <code><a href="./src/resources/mtls-certificates/mtls-certificates.ts">MTLSCertificateListResponse</a></code> |
| 3455 | |
| 3456 | Methods: |
| 3457 | |
| 3458 | - <code title="post /accounts/{account_id}/mtls_certificates">client.mtlsCertificates.<a href="./src/resources/mtls-certificates/mtls-certificates.ts">create</a>({ ...params }) -> TLSCertificatesAndHostnamesCertificateObjectPost</code> |
| 3459 | - <code title="get /accounts/{account_id}/mtls_certificates">client.mtlsCertificates.<a href="./src/resources/mtls-certificates/mtls-certificates.ts">list</a>({ ...params }) -> MTLSCertificateListResponse | null</code> |
| 3460 | - <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 }) -> TLSCertificatesAndHostnamesComponentsSchemasCertificateObject</code> |
| 3461 | - <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 }) -> TLSCertificatesAndHostnamesComponentsSchemasCertificateObject</code> |
| 3462 | |
| 3463 | ## Associations |
| 3464 | |
| 3465 | Types: |
| 3466 | |
| 3467 | - <code><a href="./src/resources/mtls-certificates/associations.ts">TLSCertificatesAndHostnamesAssociationObject</a></code> |
| 3468 | - <code><a href="./src/resources/mtls-certificates/associations.ts">AssociationGetResponse</a></code> |
| 3469 | |
| 3470 | Methods: |
| 3471 | |
| 3472 | - <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> |
| 3473 | |
| 3474 | # Pages |
| 3475 | |
| 3476 | ## Projects |
| 3477 | |
| 3478 | Types: |
| 3479 | |
| 3480 | - <code><a href="./src/resources/pages/projects/projects.ts">PagesDeployments</a></code> |
| 3481 | - <code><a href="./src/resources/pages/projects/projects.ts">PagesProjects</a></code> |
| 3482 | - <code><a href="./src/resources/pages/projects/projects.ts">ProjectCreateResponse</a></code> |
| 3483 | - <code><a href="./src/resources/pages/projects/projects.ts">ProjectListResponse</a></code> |
| 3484 | - <code><a href="./src/resources/pages/projects/projects.ts">ProjectDeleteResponse</a></code> |
| 3485 | - <code><a href="./src/resources/pages/projects/projects.ts">ProjectEditResponse</a></code> |
| 3486 | - <code><a href="./src/resources/pages/projects/projects.ts">ProjectPurgeBuildCacheResponse</a></code> |
| 3487 | |
| 3488 | Methods: |
| 3489 | |
| 3490 | - <code title="post /accounts/{account_id}/pages/projects">client.pages.projects.<a href="./src/resources/pages/projects/projects.ts">create</a>({ ...params }) -> ProjectCreateResponse</code> |
| 3491 | - <code title="get /accounts/{account_id}/pages/projects">client.pages.projects.<a href="./src/resources/pages/projects/projects.ts">list</a>({ ...params }) -> ProjectListResponse</code> |
| 3492 | - <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> |
| 3493 | - <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> |
| 3494 | - <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 }) -> PagesProjects</code> |
| 3495 | - <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> |
| 3496 | |
| 3497 | ### Deployments |
| 3498 | |
| 3499 | Types: |
| 3500 | |
| 3501 | - <code><a href="./src/resources/pages/projects/deployments/deployments.ts">DeploymentListResponse</a></code> |
| 3502 | - <code><a href="./src/resources/pages/projects/deployments/deployments.ts">DeploymentDeleteResponse</a></code> |
| 3503 | |
| 3504 | Methods: |
| 3505 | |
| 3506 | - <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 }) -> PagesDeployments</code> |
| 3507 | - <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 }) -> DeploymentListResponse</code> |
| 3508 | - <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> |
| 3509 | - <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 }) -> PagesDeployments</code> |
| 3510 | - <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 }) -> PagesDeployments</code> |
| 3511 | - <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 }) -> PagesDeployments</code> |
| 3512 | |
| 3513 | #### History |
| 3514 | |
| 3515 | ##### Logs |
| 3516 | |
| 3517 | Types: |
| 3518 | |
| 3519 | - <code><a href="./src/resources/pages/projects/deployments/history/logs.ts">LogGetResponse</a></code> |
| 3520 | |
| 3521 | Methods: |
| 3522 | |
| 3523 | - <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> |
| 3524 | |
| 3525 | ### Domains |
| 3526 | |
| 3527 | Types: |
| 3528 | |
| 3529 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainCreateResponse</a></code> |
| 3530 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainListResponse</a></code> |
| 3531 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainDeleteResponse</a></code> |
| 3532 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainEditResponse</a></code> |
| 3533 | - <code><a href="./src/resources/pages/projects/domains.ts">DomainGetResponse</a></code> |
| 3534 | |
| 3535 | Methods: |
| 3536 | |
| 3537 | - <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> |
| 3538 | - <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 }) -> DomainListResponse</code> |
| 3539 | - <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> |
| 3540 | - <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> |
| 3541 | - <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> |
| 3542 | |
| 3543 | # PCAPs |
| 3544 | |
| 3545 | Types: |
| 3546 | |
| 3547 | - <code><a href="./src/resources/pcaps/pcaps.ts">PCAPCreateResponse</a></code> |
| 3548 | - <code><a href="./src/resources/pcaps/pcaps.ts">PCAPListResponse</a></code> |
| 3549 | - <code><a href="./src/resources/pcaps/pcaps.ts">PCAPGetResponse</a></code> |
| 3550 | |
| 3551 | Methods: |
| 3552 | |
| 3553 | - <code title="post /accounts/{account_id}/pcaps">client.pcaps.<a href="./src/resources/pcaps/pcaps.ts">create</a>({ ...params }) -> PCAPCreateResponse</code> |
| 3554 | - <code title="get /accounts/{account_id}/pcaps">client.pcaps.<a href="./src/resources/pcaps/pcaps.ts">list</a>({ ...params }) -> PCAPListResponse | null</code> |
| 3555 | - <code title="get /accounts/{account_id}/pcaps/{pcap_id}">client.pcaps.<a href="./src/resources/pcaps/pcaps.ts">get</a>(pcapId, { ...params }) -> PCAPGetResponse</code> |
| 3556 | |
| 3557 | ## Ownerships |
| 3558 | |
| 3559 | Types: |
| 3560 | |
| 3561 | - <code><a href="./src/resources/pcaps/ownerships.ts">MagicVisibilityPCAPsOwnership</a></code> |
| 3562 | - <code><a href="./src/resources/pcaps/ownerships.ts">OwnershipGetResponse</a></code> |
| 3563 | |
| 3564 | Methods: |
| 3565 | |
| 3566 | - <code title="post /accounts/{account_id}/pcaps/ownership">client.pcaps.ownerships.<a href="./src/resources/pcaps/ownerships.ts">create</a>({ ...params }) -> MagicVisibilityPCAPsOwnership</code> |
| 3567 | - <code title="delete /accounts/{account_id}/pcaps/ownership/{ownership_id}">client.pcaps.ownerships.<a href="./src/resources/pcaps/ownerships.ts">delete</a>(ownershipId, { ...params }) -> void</code> |
| 3568 | - <code title="get /accounts/{account_id}/pcaps/ownership">client.pcaps.ownerships.<a href="./src/resources/pcaps/ownerships.ts">get</a>({ ...params }) -> OwnershipGetResponse | null</code> |
| 3569 | - <code title="post /accounts/{account_id}/pcaps/ownership/validate">client.pcaps.ownerships.<a href="./src/resources/pcaps/ownerships.ts">validate</a>({ ...params }) -> MagicVisibilityPCAPsOwnership</code> |
| 3570 | |
| 3571 | ## Downloads |
| 3572 | |
| 3573 | Methods: |
| 3574 | |
| 3575 | - <code title="get /accounts/{account_id}/pcaps/{pcap_id}/download">client.pcaps.downloads.<a href="./src/resources/pcaps/downloads.ts">get</a>(pcapId, { ...params }) -> Response</code> |
| 3576 | |
| 3577 | # Registrar |
| 3578 | |
| 3579 | ## Domains |
| 3580 | |
| 3581 | Types: |
| 3582 | |
| 3583 | - <code><a href="./src/resources/registrar/domains.ts">RegistrarAPIDomains</a></code> |
| 3584 | - <code><a href="./src/resources/registrar/domains.ts">DomainUpdateResponse</a></code> |
| 3585 | - <code><a href="./src/resources/registrar/domains.ts">DomainListResponse</a></code> |
| 3586 | - <code><a href="./src/resources/registrar/domains.ts">DomainGetResponse</a></code> |
| 3587 | |
| 3588 | Methods: |
| 3589 | |
| 3590 | - <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> |
| 3591 | - <code title="get /accounts/{account_id}/registrar/domains">client.registrar.domains.<a href="./src/resources/registrar/domains.ts">list</a>({ ...params }) -> DomainListResponse | null</code> |
| 3592 | - <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> |
| 3593 | |
| 3594 | # RequestTracers |
| 3595 | |
| 3596 | ## Traces |
| 3597 | |
| 3598 | Types: |
| 3599 | |
| 3600 | - <code><a href="./src/resources/request-tracers/traces.ts">RequestTracerTrace</a></code> |
| 3601 | - <code><a href="./src/resources/request-tracers/traces.ts">TraceCreateResponse</a></code> |
| 3602 | |
| 3603 | Methods: |
| 3604 | |
| 3605 | - <code title="post /accounts/{account_identifier}/request-tracer/trace">client.requestTracers.traces.<a href="./src/resources/request-tracers/traces.ts">create</a>(accountIdentifier, { ...params }) -> TraceCreateResponse</code> |
| 3606 | |
| 3607 | # Rules |
| 3608 | |
| 3609 | ## Lists |
| 3610 | |
| 3611 | Types: |
| 3612 | |
| 3613 | - <code><a href="./src/resources/rules/lists/lists.ts">ListsList</a></code> |
| 3614 | - <code><a href="./src/resources/rules/lists/lists.ts">ListListResponse</a></code> |
| 3615 | - <code><a href="./src/resources/rules/lists/lists.ts">ListDeleteResponse</a></code> |
| 3616 | |
| 3617 | Methods: |
| 3618 | |
| 3619 | - <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> |
| 3620 | - <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> |
| 3621 | - <code title="get /accounts/{account_id}/rules/lists">client.rules.lists.<a href="./src/resources/rules/lists/lists.ts">list</a>({ ...params }) -> ListListResponse | null</code> |
| 3622 | - <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> |
| 3623 | - <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> |
| 3624 | |
| 3625 | ### BulkOperations |
| 3626 | |
| 3627 | Types: |
| 3628 | |
| 3629 | - <code><a href="./src/resources/rules/lists/bulk-operations.ts">BulkOperationGetResponse</a></code> |
| 3630 | |
| 3631 | Methods: |
| 3632 | |
| 3633 | - <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> |
| 3634 | |
| 3635 | ### Items |
| 3636 | |
| 3637 | Types: |
| 3638 | |
| 3639 | - <code><a href="./src/resources/rules/lists/items.ts">ItemCreateResponse</a></code> |
| 3640 | - <code><a href="./src/resources/rules/lists/items.ts">ItemUpdateResponse</a></code> |
| 3641 | - <code><a href="./src/resources/rules/lists/items.ts">ItemListResponse</a></code> |
| 3642 | - <code><a href="./src/resources/rules/lists/items.ts">ItemDeleteResponse</a></code> |
| 3643 | - <code><a href="./src/resources/rules/lists/items.ts">ItemGetResponse</a></code> |
| 3644 | |
| 3645 | Methods: |
| 3646 | |
| 3647 | - <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> |
| 3648 | - <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> |
| 3649 | - <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> |
| 3650 | - <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> |
| 3651 | - <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> |
| 3652 | |
| 3653 | # Storage |
| 3654 | |
| 3655 | ## Analytics |
| 3656 | |
| 3657 | Types: |
| 3658 | |
| 3659 | - <code><a href="./src/resources/storage/analytics.ts">WorkersKVComponentsSchemasResult</a></code> |
| 3660 | - <code><a href="./src/resources/storage/analytics.ts">WorkersKVSchemasResult</a></code> |
| 3661 | |
| 3662 | Methods: |
| 3663 | |
| 3664 | - <code title="get /accounts/{account_id}/storage/analytics">client.storage.analytics.<a href="./src/resources/storage/analytics.ts">list</a>({ ...params }) -> WorkersKVSchemasResult</code> |
| 3665 | - <code title="get /accounts/{account_id}/storage/analytics/stored">client.storage.analytics.<a href="./src/resources/storage/analytics.ts">stored</a>({ ...params }) -> WorkersKVComponentsSchemasResult</code> |
| 3666 | |
| 3667 | # Stream |
| 3668 | |
| 3669 | Types: |
| 3670 | |
| 3671 | - <code><a href="./src/resources/stream/stream.ts">StreamVideos</a></code> |
| 3672 | - <code><a href="./src/resources/stream/stream.ts">StreamListResponse</a></code> |
| 3673 | |
| 3674 | Methods: |
| 3675 | |
| 3676 | - <code title="post /accounts/{account_id}/stream">client.stream.<a href="./src/resources/stream/stream.ts">create</a>({ ...params }) -> void</code> |
| 3677 | - <code title="get /accounts/{account_id}/stream">client.stream.<a href="./src/resources/stream/stream.ts">list</a>({ ...params }) -> StreamListResponse</code> |
| 3678 | - <code title="delete /accounts/{account_id}/stream/{identifier}">client.stream.<a href="./src/resources/stream/stream.ts">delete</a>(identifier, { ...params }) -> void</code> |
| 3679 | - <code title="get /accounts/{account_id}/stream/{identifier}">client.stream.<a href="./src/resources/stream/stream.ts">get</a>(identifier, { ...params }) -> StreamVideos</code> |
| 3680 | |
| 3681 | ## AudioTracks |
| 3682 | |
| 3683 | Types: |
| 3684 | |
| 3685 | - <code><a href="./src/resources/stream/audio-tracks.ts">StreamAdditionalAudio</a></code> |
| 3686 | - <code><a href="./src/resources/stream/audio-tracks.ts">AudioTrackDeleteResponse</a></code> |
| 3687 | - <code><a href="./src/resources/stream/audio-tracks.ts">AudioTrackGetResponse</a></code> |
| 3688 | |
| 3689 | Methods: |
| 3690 | |
| 3691 | - <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> |
| 3692 | - <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 }) -> StreamAdditionalAudio</code> |
| 3693 | - <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 }) -> StreamAdditionalAudio</code> |
| 3694 | - <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> |
| 3695 | |
| 3696 | ## Videos |
| 3697 | |
| 3698 | Types: |
| 3699 | |
| 3700 | - <code><a href="./src/resources/stream/videos.ts">VideoStorageUsageResponse</a></code> |
| 3701 | |
| 3702 | Methods: |
| 3703 | |
| 3704 | - <code title="get /accounts/{account_id}/stream/storage-usage">client.stream.videos.<a href="./src/resources/stream/videos.ts">storageUsage</a>({ ...params }) -> VideoStorageUsageResponse</code> |
| 3705 | |
| 3706 | ## Clips |
| 3707 | |
| 3708 | Types: |
| 3709 | |
| 3710 | - <code><a href="./src/resources/stream/clips.ts">StreamClipping</a></code> |
| 3711 | |
| 3712 | Methods: |
| 3713 | |
| 3714 | - <code title="post /accounts/{account_id}/stream/clip">client.stream.clips.<a href="./src/resources/stream/clips.ts">create</a>({ ...params }) -> StreamClipping</code> |
| 3715 | |
| 3716 | ## Copies |
| 3717 | |
| 3718 | Methods: |
| 3719 | |
| 3720 | - <code title="post /accounts/{account_id}/stream/copy">client.stream.copies.<a href="./src/resources/stream/copies.ts">create</a>({ ...params }) -> StreamVideos</code> |
| 3721 | |
| 3722 | ## DirectUploads |
| 3723 | |
| 3724 | Types: |
| 3725 | |
| 3726 | - <code><a href="./src/resources/stream/direct-uploads.ts">DirectUploadCreateResponse</a></code> |
| 3727 | |
| 3728 | Methods: |
| 3729 | |
| 3730 | - <code title="post /accounts/{account_id}/stream/direct_upload">client.stream.directUploads.<a href="./src/resources/stream/direct-uploads.ts">create</a>({ ...params }) -> DirectUploadCreateResponse</code> |
| 3731 | |
| 3732 | ## Keys |
| 3733 | |
| 3734 | Types: |
| 3735 | |
| 3736 | - <code><a href="./src/resources/stream/keys.ts">StreamKeys</a></code> |
| 3737 | - <code><a href="./src/resources/stream/keys.ts">KeyDeleteResponse</a></code> |
| 3738 | - <code><a href="./src/resources/stream/keys.ts">KeyGetResponse</a></code> |
| 3739 | |
| 3740 | Methods: |
| 3741 | |
| 3742 | - <code title="post /accounts/{account_id}/stream/keys">client.stream.keys.<a href="./src/resources/stream/keys.ts">create</a>({ ...params }) -> StreamKeys</code> |
| 3743 | - <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> |
| 3744 | - <code title="get /accounts/{account_id}/stream/keys">client.stream.keys.<a href="./src/resources/stream/keys.ts">get</a>({ ...params }) -> KeyGetResponse</code> |
| 3745 | |
| 3746 | ## LiveInputs |
| 3747 | |
| 3748 | Types: |
| 3749 | |
| 3750 | - <code><a href="./src/resources/stream/live-inputs/live-inputs.ts">StreamLiveInput</a></code> |
| 3751 | - <code><a href="./src/resources/stream/live-inputs/live-inputs.ts">LiveInputListResponse</a></code> |
| 3752 | |
| 3753 | Methods: |
| 3754 | |
| 3755 | - <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 }) -> StreamLiveInput</code> |
| 3756 | - <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 }) -> StreamLiveInput</code> |
| 3757 | - <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> |
| 3758 | - <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> |
| 3759 | - <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 }) -> StreamLiveInput</code> |
| 3760 | |
| 3761 | ### Outputs |
| 3762 | |
| 3763 | Types: |
| 3764 | |
| 3765 | - <code><a href="./src/resources/stream/live-inputs/outputs.ts">StreamOutput</a></code> |
| 3766 | - <code><a href="./src/resources/stream/live-inputs/outputs.ts">OutputListResponse</a></code> |
| 3767 | |
| 3768 | Methods: |
| 3769 | |
| 3770 | - <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 }) -> StreamOutput</code> |
| 3771 | - <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 }) -> StreamOutput</code> |
| 3772 | - <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 }) -> OutputListResponse</code> |
| 3773 | - <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> |
| 3774 | |
| 3775 | ## Watermarks |
| 3776 | |
| 3777 | Types: |
| 3778 | |
| 3779 | - <code><a href="./src/resources/stream/watermarks.ts">StreamWatermarks</a></code> |
| 3780 | - <code><a href="./src/resources/stream/watermarks.ts">WatermarkCreateResponse</a></code> |
| 3781 | - <code><a href="./src/resources/stream/watermarks.ts">WatermarkListResponse</a></code> |
| 3782 | - <code><a href="./src/resources/stream/watermarks.ts">WatermarkDeleteResponse</a></code> |
| 3783 | - <code><a href="./src/resources/stream/watermarks.ts">WatermarkGetResponse</a></code> |
| 3784 | |
| 3785 | Methods: |
| 3786 | |
| 3787 | - <code title="post /accounts/{account_id}/stream/watermarks">client.stream.watermarks.<a href="./src/resources/stream/watermarks.ts">create</a>({ ...params }) -> WatermarkCreateResponse</code> |
| 3788 | - <code title="get /accounts/{account_id}/stream/watermarks">client.stream.watermarks.<a href="./src/resources/stream/watermarks.ts">list</a>({ ...params }) -> WatermarkListResponse</code> |
| 3789 | - <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> |
| 3790 | - <code title="get /accounts/{account_id}/stream/watermarks/{identifier}">client.stream.watermarks.<a href="./src/resources/stream/watermarks.ts">get</a>(identifier, { ...params }) -> WatermarkGetResponse</code> |
| 3791 | |
| 3792 | ## Webhooks |
| 3793 | |
| 3794 | Types: |
| 3795 | |
| 3796 | - <code><a href="./src/resources/stream/webhooks.ts">WebhookUpdateResponse</a></code> |
| 3797 | - <code><a href="./src/resources/stream/webhooks.ts">WebhookDeleteResponse</a></code> |
| 3798 | - <code><a href="./src/resources/stream/webhooks.ts">WebhookGetResponse</a></code> |
| 3799 | |
| 3800 | Methods: |
| 3801 | |
| 3802 | - <code title="put /accounts/{account_id}/stream/webhook">client.stream.webhooks.<a href="./src/resources/stream/webhooks.ts">update</a>({ ...params }) -> WebhookUpdateResponse</code> |
| 3803 | - <code title="delete /accounts/{account_id}/stream/webhook">client.stream.webhooks.<a href="./src/resources/stream/webhooks.ts">delete</a>({ ...params }) -> WebhookDeleteResponse</code> |
| 3804 | - <code title="get /accounts/{account_id}/stream/webhook">client.stream.webhooks.<a href="./src/resources/stream/webhooks.ts">get</a>({ ...params }) -> WebhookGetResponse</code> |
| 3805 | |
| 3806 | ## Captions |
| 3807 | |
| 3808 | Types: |
| 3809 | |
| 3810 | - <code><a href="./src/resources/stream/captions.ts">StreamCaptions</a></code> |
| 3811 | - <code><a href="./src/resources/stream/captions.ts">CaptionUpdateResponse</a></code> |
| 3812 | - <code><a href="./src/resources/stream/captions.ts">CaptionDeleteResponse</a></code> |
| 3813 | - <code><a href="./src/resources/stream/captions.ts">CaptionGetResponse</a></code> |
| 3814 | |
| 3815 | Methods: |
| 3816 | |
| 3817 | - <code title="put /accounts/{account_id}/stream/{identifier}/captions/{language}">client.stream.captions.<a href="./src/resources/stream/captions.ts">update</a>(identifier, language, { ...params }) -> CaptionUpdateResponse</code> |
| 3818 | - <code title="delete /accounts/{account_id}/stream/{identifier}/captions/{language}">client.stream.captions.<a href="./src/resources/stream/captions.ts">delete</a>(identifier, language, { ...params }) -> CaptionDeleteResponse</code> |
| 3819 | - <code title="get /accounts/{account_id}/stream/{identifier}/captions">client.stream.captions.<a href="./src/resources/stream/captions.ts">get</a>(identifier, { ...params }) -> CaptionGetResponse</code> |
| 3820 | |
| 3821 | ## Downloads |
| 3822 | |
| 3823 | Types: |
| 3824 | |
| 3825 | - <code><a href="./src/resources/stream/downloads.ts">DownloadCreateResponse</a></code> |
| 3826 | - <code><a href="./src/resources/stream/downloads.ts">DownloadDeleteResponse</a></code> |
| 3827 | - <code><a href="./src/resources/stream/downloads.ts">DownloadGetResponse</a></code> |
| 3828 | |
| 3829 | Methods: |
| 3830 | |
| 3831 | - <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> |
| 3832 | - <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> |
| 3833 | - <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> |
| 3834 | |
| 3835 | ## Embeds |
| 3836 | |
| 3837 | Types: |
| 3838 | |
| 3839 | - <code><a href="./src/resources/stream/embeds.ts">EmbedGetResponse</a></code> |
| 3840 | |
| 3841 | Methods: |
| 3842 | |
| 3843 | - <code title="get /accounts/{account_id}/stream/{identifier}/embed">client.stream.embeds.<a href="./src/resources/stream/embeds.ts">get</a>(identifier, { ...params }) -> unknown</code> |
| 3844 | |
| 3845 | ## Tokens |
| 3846 | |
| 3847 | Types: |
| 3848 | |
| 3849 | - <code><a href="./src/resources/stream/tokens.ts">TokenCreateResponse</a></code> |
| 3850 | |
| 3851 | Methods: |
| 3852 | |
| 3853 | - <code title="post /accounts/{account_id}/stream/{identifier}/token">client.stream.tokens.<a href="./src/resources/stream/tokens.ts">create</a>(identifier, { ...params }) -> TokenCreateResponse</code> |
| 3854 | |
| 3855 | # Alerting |
| 3856 | |
| 3857 | ## V3 |
| 3858 | |
| 3859 | Types: |
| 3860 | |
| 3861 | - <code><a href="./src/resources/alerting/v3/v3.ts">V3ListResponse</a></code> |
| 3862 | |
| 3863 | Methods: |
| 3864 | |
| 3865 | - <code title="get /accounts/{account_id}/alerting/v3/available_alerts">client.alerting.v3.<a href="./src/resources/alerting/v3/v3.ts">list</a>({ ...params }) -> V3ListResponse | null</code> |
| 3866 | |
| 3867 | ### Destinations |
| 3868 | |
| 3869 | #### Eligible |
| 3870 | |
| 3871 | Types: |
| 3872 | |
| 3873 | - <code><a href="./src/resources/alerting/v3/destinations/eligible.ts">EligibleGetResponse</a></code> |
| 3874 | |
| 3875 | Methods: |
| 3876 | |
| 3877 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/eligible">client.alerting.v3.destinations.eligible.<a href="./src/resources/alerting/v3/destinations/eligible.ts">get</a>({ ...params }) -> EligibleGetResponse | null</code> |
| 3878 | |
| 3879 | #### Pagerduty |
| 3880 | |
| 3881 | Types: |
| 3882 | |
| 3883 | - <code><a href="./src/resources/alerting/v3/destinations/pagerduty.ts">AaaPagerduty</a></code> |
| 3884 | - <code><a href="./src/resources/alerting/v3/destinations/pagerduty.ts">PagerdutyCreateResponse</a></code> |
| 3885 | - <code><a href="./src/resources/alerting/v3/destinations/pagerduty.ts">PagerdutyDeleteResponse</a></code> |
| 3886 | - <code><a href="./src/resources/alerting/v3/destinations/pagerduty.ts">PagerdutyGetResponse</a></code> |
| 3887 | - <code><a href="./src/resources/alerting/v3/destinations/pagerduty.ts">PagerdutyLinkResponse</a></code> |
| 3888 | |
| 3889 | Methods: |
| 3890 | |
| 3891 | - <code title="post /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect">client.alerting.v3.destinations.pagerduty.<a href="./src/resources/alerting/v3/destinations/pagerduty.ts">create</a>({ ...params }) -> PagerdutyCreateResponse</code> |
| 3892 | - <code title="delete /accounts/{account_id}/alerting/v3/destinations/pagerduty">client.alerting.v3.destinations.pagerduty.<a href="./src/resources/alerting/v3/destinations/pagerduty.ts">delete</a>({ ...params }) -> PagerdutyDeleteResponse | null</code> |
| 3893 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/pagerduty">client.alerting.v3.destinations.pagerduty.<a href="./src/resources/alerting/v3/destinations/pagerduty.ts">get</a>({ ...params }) -> PagerdutyGetResponse | null</code> |
| 3894 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}">client.alerting.v3.destinations.pagerduty.<a href="./src/resources/alerting/v3/destinations/pagerduty.ts">link</a>(tokenId, { ...params }) -> PagerdutyLinkResponse</code> |
| 3895 | |
| 3896 | #### Webhooks |
| 3897 | |
| 3898 | Types: |
| 3899 | |
| 3900 | - <code><a href="./src/resources/alerting/v3/destinations/webhooks.ts">AaaWebhooks</a></code> |
| 3901 | - <code><a href="./src/resources/alerting/v3/destinations/webhooks.ts">WebhookCreateResponse</a></code> |
| 3902 | - <code><a href="./src/resources/alerting/v3/destinations/webhooks.ts">WebhookUpdateResponse</a></code> |
| 3903 | - <code><a href="./src/resources/alerting/v3/destinations/webhooks.ts">WebhookListResponse</a></code> |
| 3904 | - <code><a href="./src/resources/alerting/v3/destinations/webhooks.ts">WebhookDeleteResponse</a></code> |
| 3905 | |
| 3906 | Methods: |
| 3907 | |
| 3908 | - <code title="post /accounts/{account_id}/alerting/v3/destinations/webhooks">client.alerting.v3.destinations.webhooks.<a href="./src/resources/alerting/v3/destinations/webhooks.ts">create</a>({ ...params }) -> WebhookCreateResponse</code> |
| 3909 | - <code title="put /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}">client.alerting.v3.destinations.webhooks.<a href="./src/resources/alerting/v3/destinations/webhooks.ts">update</a>(webhookId, { ...params }) -> WebhookUpdateResponse</code> |
| 3910 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/webhooks">client.alerting.v3.destinations.webhooks.<a href="./src/resources/alerting/v3/destinations/webhooks.ts">list</a>({ ...params }) -> WebhookListResponse | null</code> |
| 3911 | - <code title="delete /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}">client.alerting.v3.destinations.webhooks.<a href="./src/resources/alerting/v3/destinations/webhooks.ts">delete</a>(webhookId, { ...params }) -> WebhookDeleteResponse | null</code> |
| 3912 | - <code title="get /accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}">client.alerting.v3.destinations.webhooks.<a href="./src/resources/alerting/v3/destinations/webhooks.ts">get</a>(webhookId, { ...params }) -> AaaWebhooks</code> |
| 3913 | |
| 3914 | ### Histories |
| 3915 | |
| 3916 | Types: |
| 3917 | |
| 3918 | - <code><a href="./src/resources/alerting/v3/histories.ts">AaaHistory</a></code> |
| 3919 | |
| 3920 | Methods: |
| 3921 | |
| 3922 | - <code title="get /accounts/{account_id}/alerting/v3/history">client.alerting.v3.histories.<a href="./src/resources/alerting/v3/histories.ts">list</a>({ ...params }) -> AaaHistoriesV4PagePaginationArray</code> |
| 3923 | |
| 3924 | ### Policies |
| 3925 | |
| 3926 | Types: |
| 3927 | |
| 3928 | - <code><a href="./src/resources/alerting/v3/policies.ts">AaaPolicies</a></code> |
| 3929 | - <code><a href="./src/resources/alerting/v3/policies.ts">PolicyCreateResponse</a></code> |
| 3930 | - <code><a href="./src/resources/alerting/v3/policies.ts">PolicyUpdateResponse</a></code> |
| 3931 | - <code><a href="./src/resources/alerting/v3/policies.ts">PolicyListResponse</a></code> |
| 3932 | - <code><a href="./src/resources/alerting/v3/policies.ts">PolicyDeleteResponse</a></code> |
| 3933 | |
| 3934 | Methods: |
| 3935 | |
| 3936 | - <code title="post /accounts/{account_id}/alerting/v3/policies">client.alerting.v3.policies.<a href="./src/resources/alerting/v3/policies.ts">create</a>({ ...params }) -> PolicyCreateResponse</code> |
| 3937 | - <code title="put /accounts/{account_id}/alerting/v3/policies/{policy_id}">client.alerting.v3.policies.<a href="./src/resources/alerting/v3/policies.ts">update</a>(policyId, { ...params }) -> PolicyUpdateResponse</code> |
| 3938 | - <code title="get /accounts/{account_id}/alerting/v3/policies">client.alerting.v3.policies.<a href="./src/resources/alerting/v3/policies.ts">list</a>({ ...params }) -> PolicyListResponse | null</code> |
| 3939 | - <code title="delete /accounts/{account_id}/alerting/v3/policies/{policy_id}">client.alerting.v3.policies.<a href="./src/resources/alerting/v3/policies.ts">delete</a>(policyId, { ...params }) -> PolicyDeleteResponse | null</code> |
| 3940 | - <code title="get /accounts/{account_id}/alerting/v3/policies/{policy_id}">client.alerting.v3.policies.<a href="./src/resources/alerting/v3/policies.ts">get</a>(policyId, { ...params }) -> AaaPolicies</code> |
| 3941 | |
| 3942 | # D1 |
| 3943 | |
| 3944 | ## Database |
| 3945 | |
| 3946 | Types: |
| 3947 | |
| 3948 | - <code><a href="./src/resources/d1/database.ts">D1CreateDatabase</a></code> |
| 3949 | - <code><a href="./src/resources/d1/database.ts">D1DatabaseDetails</a></code> |
| 3950 | - <code><a href="./src/resources/d1/database.ts">D1QueryResult</a></code> |
| 3951 | - <code><a href="./src/resources/d1/database.ts">DatabaseDeleteResponse</a></code> |
| 3952 | - <code><a href="./src/resources/d1/database.ts">DatabaseQueryResponse</a></code> |
| 3953 | |
| 3954 | Methods: |
| 3955 | |
| 3956 | - <code title="post /accounts/{account_id}/d1/database">client.d1.database.<a href="./src/resources/d1/database.ts">create</a>({ ...params }) -> D1CreateDatabase</code> |
| 3957 | - <code title="get /accounts/{account_id}/d1/database">client.d1.database.<a href="./src/resources/d1/database.ts">list</a>({ ...params }) -> D1CreateDatabasesV4PagePaginationArray</code> |
| 3958 | - <code title="delete /accounts/{account_identifier}/d1/database/{database_identifier}">client.d1.database.<a href="./src/resources/d1/database.ts">delete</a>(accountIdentifier, databaseIdentifier) -> DatabaseDeleteResponse | null</code> |
| 3959 | - <code title="get /accounts/{account_identifier}/d1/database/{database_identifier}">client.d1.database.<a href="./src/resources/d1/database.ts">get</a>(accountIdentifier, databaseIdentifier) -> D1DatabaseDetails</code> |
| 3960 | - <code title="post /accounts/{account_identifier}/d1/database/{database_identifier}/query">client.d1.database.<a href="./src/resources/d1/database.ts">query</a>(accountIdentifier, databaseIdentifier, { ...params }) -> DatabaseQueryResponse</code> |
| 3961 | |
| 3962 | # R2 |
| 3963 | |
| 3964 | ## Buckets |
| 3965 | |
| 3966 | Types: |
| 3967 | |
| 3968 | - <code><a href="./src/resources/r2/buckets.ts">R2Bucket</a></code> |
| 3969 | - <code><a href="./src/resources/r2/buckets.ts">BucketDeleteResponse</a></code> |
| 3970 | |
| 3971 | Methods: |
| 3972 | |
| 3973 | - <code title="post /accounts/{account_id}/r2/buckets">client.r2.buckets.<a href="./src/resources/r2/buckets.ts">create</a>({ ...params }) -> R2Bucket</code> |
| 3974 | - <code title="get /accounts/{account_id}/r2/buckets">client.r2.buckets.<a href="./src/resources/r2/buckets.ts">list</a>({ ...params }) -> R2BucketsCursorPagination</code> |
| 3975 | - <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> |
| 3976 | - <code title="get /accounts/{account_id}/r2/buckets/{bucket_name}">client.r2.buckets.<a href="./src/resources/r2/buckets.ts">get</a>(bucketName, { ...params }) -> R2Bucket</code> |
| 3977 | |
| 3978 | ## Sippy |
| 3979 | |
| 3980 | Types: |
| 3981 | |
| 3982 | - <code><a href="./src/resources/r2/sippy.ts">R2Sippy</a></code> |
| 3983 | - <code><a href="./src/resources/r2/sippy.ts">SippyDeleteResponse</a></code> |
| 3984 | |
| 3985 | Methods: |
| 3986 | |
| 3987 | - <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 }) -> R2Sippy</code> |
| 3988 | - <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> |
| 3989 | - <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 }) -> R2Sippy</code> |
| 3990 | |
| 3991 | # WARPConnector |
| 3992 | |
| 3993 | Types: |
| 3994 | |
| 3995 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorCreateResponse</a></code> |
| 3996 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorListResponse</a></code> |
| 3997 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorDeleteResponse</a></code> |
| 3998 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorEditResponse</a></code> |
| 3999 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorGetResponse</a></code> |
| 4000 | - <code><a href="./src/resources/warp-connector.ts">WARPConnectorTokenResponse</a></code> |
| 4001 | |
| 4002 | Methods: |
| 4003 | |
| 4004 | - <code title="post /accounts/{account_id}/warp_connector">client.warpConnector.<a href="./src/resources/warp-connector.ts">create</a>({ ...params }) -> WARPConnectorCreateResponse</code> |
| 4005 | - <code title="get /accounts/{account_id}/warp_connector">client.warpConnector.<a href="./src/resources/warp-connector.ts">list</a>({ ...params }) -> WARPConnectorListResponsesV4PagePaginationArray</code> |
| 4006 | - <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> |
| 4007 | - <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> |
| 4008 | - <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> |
| 4009 | - <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> |
| 4010 | |
| 4011 | # WorkersForPlatforms |
| 4012 | |
| 4013 | ## Dispatch |
| 4014 | |
| 4015 | ### Namespaces |
| 4016 | |
| 4017 | Types: |
| 4018 | |
| 4019 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">NamespaceCreateResponse</a></code> |
| 4020 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">NamespaceListResponse</a></code> |
| 4021 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">NamespaceDeleteResponse</a></code> |
| 4022 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/namespaces.ts">NamespaceGetResponse</a></code> |
| 4023 | |
| 4024 | Methods: |
| 4025 | |
| 4026 | - <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> |
| 4027 | - <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 }) -> NamespaceListResponse</code> |
| 4028 | - <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> |
| 4029 | - <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> |
| 4030 | |
| 4031 | #### Scripts |
| 4032 | |
| 4033 | Types: |
| 4034 | |
| 4035 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/scripts.ts">WorkersNamespaceScript</a></code> |
| 4036 | |
| 4037 | Methods: |
| 4038 | |
| 4039 | - <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 }) -> WorkersScript</code> |
| 4040 | - <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> |
| 4041 | - <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 }) -> WorkersNamespaceScript</code> |
| 4042 | |
| 4043 | ##### Content |
| 4044 | |
| 4045 | ###### Scripts |
| 4046 | |
| 4047 | Methods: |
| 4048 | |
| 4049 | - <code title="put /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content">client.workersForPlatforms.dispatch.namespaces.scripts.content.scripts.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content/scripts.ts">update</a>(dispatchNamespace, scriptName, { ...params }) -> WorkersScript</code> |
| 4050 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content">client.workersForPlatforms.dispatch.namespaces.scripts.content.scripts.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content/scripts.ts">get</a>(dispatchNamespace, scriptName, { ...params }) -> Response</code> |
| 4051 | |
| 4052 | ###### Settings |
| 4053 | |
| 4054 | Types: |
| 4055 | |
| 4056 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content/settings.ts">SettingEditResponse</a></code> |
| 4057 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content/settings.ts">SettingGetResponse</a></code> |
| 4058 | |
| 4059 | Methods: |
| 4060 | |
| 4061 | - <code title="patch /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings">client.workersForPlatforms.dispatch.namespaces.scripts.content.settings.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content/settings.ts">edit</a>(dispatchNamespace, scriptName, { ...params }) -> SettingEditResponse</code> |
| 4062 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings">client.workersForPlatforms.dispatch.namespaces.scripts.content.settings.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content/settings.ts">get</a>(dispatchNamespace, scriptName, { ...params }) -> SettingGetResponse</code> |
| 4063 | |
| 4064 | ###### Bindings |
| 4065 | |
| 4066 | Types: |
| 4067 | |
| 4068 | - <code><a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content/bindings.ts">BindingGetResponse</a></code> |
| 4069 | |
| 4070 | Methods: |
| 4071 | |
| 4072 | - <code title="get /accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/bindings">client.workersForPlatforms.dispatch.namespaces.scripts.content.bindings.<a href="./src/resources/workers-for-platforms/dispatch/namespaces/scripts/content/bindings.ts">get</a>(dispatchNamespace, scriptName, { ...params }) -> BindingGetResponse</code> |
| 4073 | |
| 4074 | # ZeroTrust |
| 4075 | |
| 4076 | ## Devices |
| 4077 | |
| 4078 | Types: |
| 4079 | |
| 4080 | - <code><a href="./src/resources/zero-trust/devices/devices.ts">TeamsDevicesDevices</a></code> |
| 4081 | - <code><a href="./src/resources/zero-trust/devices/devices.ts">DeviceListResponse</a></code> |
| 4082 | - <code><a href="./src/resources/zero-trust/devices/devices.ts">DeviceGetResponse</a></code> |
| 4083 | |
| 4084 | Methods: |
| 4085 | |
| 4086 | - <code title="get /accounts/{account_id}/devices">client.zeroTrust.devices.<a href="./src/resources/zero-trust/devices/devices.ts">list</a>({ ...params }) -> DeviceListResponse | null</code> |
| 4087 | - <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 | null</code> |
| 4088 | |
| 4089 | ### DEXTests |
| 4090 | |
| 4091 | Types: |
| 4092 | |
| 4093 | - <code><a href="./src/resources/zero-trust/devices/dex-tests.ts">TeamsDevicesDeviceDEXTestSchemasHTTP</a></code> |
| 4094 | - <code><a href="./src/resources/zero-trust/devices/dex-tests.ts">DEXTestListResponse</a></code> |
| 4095 | - <code><a href="./src/resources/zero-trust/devices/dex-tests.ts">DEXTestDeleteResponse</a></code> |
| 4096 | |
| 4097 | Methods: |
| 4098 | |
| 4099 | - <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 }) -> TeamsDevicesDeviceDEXTestSchemasHTTP | null</code> |
| 4100 | - <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 }) -> TeamsDevicesDeviceDEXTestSchemasHTTP | null</code> |
| 4101 | - <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 }) -> DEXTestListResponse | null</code> |
| 4102 | - <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> |
| 4103 | - <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 }) -> TeamsDevicesDeviceDEXTestSchemasHTTP | null</code> |
| 4104 | |
| 4105 | ### Networks |
| 4106 | |
| 4107 | Types: |
| 4108 | |
| 4109 | - <code><a href="./src/resources/zero-trust/devices/networks.ts">TeamsDevicesDeviceManagedNetworks</a></code> |
| 4110 | - <code><a href="./src/resources/zero-trust/devices/networks.ts">NetworkListResponse</a></code> |
| 4111 | - <code><a href="./src/resources/zero-trust/devices/networks.ts">NetworkDeleteResponse</a></code> |
| 4112 | |
| 4113 | Methods: |
| 4114 | |
| 4115 | - <code title="post /accounts/{account_id}/devices/networks">client.zeroTrust.devices.networks.<a href="./src/resources/zero-trust/devices/networks.ts">create</a>({ ...params }) -> TeamsDevicesDeviceManagedNetworks | null</code> |
| 4116 | - <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 }) -> TeamsDevicesDeviceManagedNetworks | null</code> |
| 4117 | - <code title="get /accounts/{account_id}/devices/networks">client.zeroTrust.devices.networks.<a href="./src/resources/zero-trust/devices/networks.ts">list</a>({ ...params }) -> NetworkListResponse | null</code> |
| 4118 | - <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> |
| 4119 | - <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 }) -> TeamsDevicesDeviceManagedNetworks | null</code> |
| 4120 | |
| 4121 | ### Policies |
| 4122 | |
| 4123 | Types: |
| 4124 | |
| 4125 | - <code><a href="./src/resources/zero-trust/devices/policies/policies.ts">TeamsDevicesDeviceSettingsPolicy</a></code> |
| 4126 | - <code><a href="./src/resources/zero-trust/devices/policies/policies.ts">PolicyListResponse</a></code> |
| 4127 | - <code><a href="./src/resources/zero-trust/devices/policies/policies.ts">PolicyDeleteResponse</a></code> |
| 4128 | |
| 4129 | Methods: |
| 4130 | |
| 4131 | - <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 }) -> TeamsDevicesDeviceSettingsPolicy | null</code> |
| 4132 | - <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 }) -> PolicyListResponse | null</code> |
| 4133 | - <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> |
| 4134 | - <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 }) -> TeamsDevicesDeviceSettingsPolicy | null</code> |
| 4135 | - <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 }) -> TeamsDevicesDeviceSettingsPolicy | null</code> |
| 4136 | |
| 4137 | #### DefaultPolicy |
| 4138 | |
| 4139 | Types: |
| 4140 | |
| 4141 | - <code><a href="./src/resources/zero-trust/devices/policies/default-policy.ts">DefaultPolicyGetResponse</a></code> |
| 4142 | |
| 4143 | Methods: |
| 4144 | |
| 4145 | - <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> |
| 4146 | |
| 4147 | #### Excludes |
| 4148 | |
| 4149 | Types: |
| 4150 | |
| 4151 | - <code><a href="./src/resources/zero-trust/devices/policies/excludes.ts">TeamsDevicesSplitTunnel</a></code> |
| 4152 | - <code><a href="./src/resources/zero-trust/devices/policies/excludes.ts">ExcludeUpdateResponse</a></code> |
| 4153 | - <code><a href="./src/resources/zero-trust/devices/policies/excludes.ts">ExcludeListResponse</a></code> |
| 4154 | - <code><a href="./src/resources/zero-trust/devices/policies/excludes.ts">ExcludeGetResponse</a></code> |
| 4155 | |
| 4156 | Methods: |
| 4157 | |
| 4158 | - <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> |
| 4159 | - <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 }) -> ExcludeListResponse | null</code> |
| 4160 | - <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> |
| 4161 | |
| 4162 | #### FallbackDomains |
| 4163 | |
| 4164 | Types: |
| 4165 | |
| 4166 | - <code><a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">TeamsDevicesFallbackDomain</a></code> |
| 4167 | - <code><a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">FallbackDomainUpdateResponse</a></code> |
| 4168 | - <code><a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">FallbackDomainListResponse</a></code> |
| 4169 | - <code><a href="./src/resources/zero-trust/devices/policies/fallback-domains.ts">FallbackDomainGetResponse</a></code> |
| 4170 | |
| 4171 | Methods: |
| 4172 | |
| 4173 | - <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> |
| 4174 | - <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 }) -> FallbackDomainListResponse | null</code> |
| 4175 | - <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> |
| 4176 | |
| 4177 | #### Includes |
| 4178 | |
| 4179 | Types: |
| 4180 | |
| 4181 | - <code><a href="./src/resources/zero-trust/devices/policies/includes.ts">TeamsDevicesSplitTunnelInclude</a></code> |
| 4182 | - <code><a href="./src/resources/zero-trust/devices/policies/includes.ts">IncludeUpdateResponse</a></code> |
| 4183 | - <code><a href="./src/resources/zero-trust/devices/policies/includes.ts">IncludeListResponse</a></code> |
| 4184 | - <code><a href="./src/resources/zero-trust/devices/policies/includes.ts">IncludeGetResponse</a></code> |
| 4185 | |
| 4186 | Methods: |
| 4187 | |
| 4188 | - <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> |
| 4189 | - <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 }) -> IncludeListResponse | null</code> |
| 4190 | - <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> |
| 4191 | |
| 4192 | ### Posture |
| 4193 | |
| 4194 | Types: |
| 4195 | |
| 4196 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">TeamsDevicesDevicePostureRules</a></code> |
| 4197 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">PostureListResponse</a></code> |
| 4198 | - <code><a href="./src/resources/zero-trust/devices/posture/posture.ts">PostureDeleteResponse</a></code> |
| 4199 | |
| 4200 | Methods: |
| 4201 | |
| 4202 | - <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 }) -> TeamsDevicesDevicePostureRules | null</code> |
| 4203 | - <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 }) -> TeamsDevicesDevicePostureRules | null</code> |
| 4204 | - <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 }) -> PostureListResponse | null</code> |
| 4205 | - <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> |
| 4206 | - <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 }) -> TeamsDevicesDevicePostureRules | null</code> |
| 4207 | |
| 4208 | #### Integrations |
| 4209 | |
| 4210 | Types: |
| 4211 | |
| 4212 | - <code><a href="./src/resources/zero-trust/devices/posture/integrations.ts">TeamsDevicesDevicePostureIntegrations</a></code> |
| 4213 | - <code><a href="./src/resources/zero-trust/devices/posture/integrations.ts">IntegrationListResponse</a></code> |
| 4214 | - <code><a href="./src/resources/zero-trust/devices/posture/integrations.ts">IntegrationDeleteResponse</a></code> |
| 4215 | |
| 4216 | Methods: |
| 4217 | |
| 4218 | - <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 }) -> TeamsDevicesDevicePostureIntegrations | null</code> |
| 4219 | - <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 }) -> IntegrationListResponse | null</code> |
| 4220 | - <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 | null</code> |
| 4221 | - <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 }) -> TeamsDevicesDevicePostureIntegrations | null</code> |
| 4222 | - <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 }) -> TeamsDevicesDevicePostureIntegrations | null</code> |
| 4223 | |
| 4224 | ### Revokes |
| 4225 | |
| 4226 | Types: |
| 4227 | |
| 4228 | - <code><a href="./src/resources/zero-trust/devices/revokes.ts">RevokeCreateResponse</a></code> |
| 4229 | |
| 4230 | Methods: |
| 4231 | |
| 4232 | - <code title="post /accounts/{account_id}/devices/revoke">client.zeroTrust.devices.revokes.<a href="./src/resources/zero-trust/devices/revokes.ts">create</a>([ ...body ]) -> RevokeCreateResponse | null</code> |
| 4233 | |
| 4234 | ### Settings |
| 4235 | |
| 4236 | Types: |
| 4237 | |
| 4238 | - <code><a href="./src/resources/zero-trust/devices/settings.ts">TeamsDevicesZeroTrustAccountDeviceSettings</a></code> |
| 4239 | |
| 4240 | Methods: |
| 4241 | |
| 4242 | - <code title="put /accounts/{account_id}/devices/settings">client.zeroTrust.devices.settings.<a href="./src/resources/zero-trust/devices/settings.ts">update</a>({ ...params }) -> TeamsDevicesZeroTrustAccountDeviceSettings | null</code> |
| 4243 | - <code title="get /accounts/{account_id}/devices/settings">client.zeroTrust.devices.settings.<a href="./src/resources/zero-trust/devices/settings.ts">list</a>({ ...params }) -> TeamsDevicesZeroTrustAccountDeviceSettings | null</code> |
| 4244 | |
| 4245 | ### Unrevokes |
| 4246 | |
| 4247 | Types: |
| 4248 | |
| 4249 | - <code><a href="./src/resources/zero-trust/devices/unrevokes.ts">UnrevokeCreateResponse</a></code> |
| 4250 | |
| 4251 | Methods: |
| 4252 | |
| 4253 | - <code title="post /accounts/{account_id}/devices/unrevoke">client.zeroTrust.devices.unrevokes.<a href="./src/resources/zero-trust/devices/unrevokes.ts">create</a>([ ...body ]) -> UnrevokeCreateResponse | null</code> |
| 4254 | |
| 4255 | ### OverrideCodes |
| 4256 | |
| 4257 | Types: |
| 4258 | |
| 4259 | - <code><a href="./src/resources/zero-trust/devices/override-codes.ts">OverrideCodeListResponse</a></code> |
| 4260 | |
| 4261 | Methods: |
| 4262 | |
| 4263 | - <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> |
| 4264 | |
| 4265 | ## IdentityProviders |
| 4266 | |
| 4267 | Types: |
| 4268 | |
| 4269 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">AccessIdentityProviders</a></code> |
| 4270 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">IdentityProviderListResponse</a></code> |
| 4271 | - <code><a href="./src/resources/zero-trust/identity-providers.ts">IdentityProviderDeleteResponse</a></code> |
| 4272 | |
| 4273 | Methods: |
| 4274 | |
| 4275 | - <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 }) -> AccessIdentityProviders</code> |
| 4276 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/identity_providers/{uuid}">client.zeroTrust.identityProviders.<a href="./src/resources/zero-trust/identity-providers.ts">update</a>(uuid, { ...params }) -> AccessIdentityProviders</code> |
| 4277 | - <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 }) -> IdentityProviderListResponse | null</code> |
| 4278 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/identity_providers/{uuid}">client.zeroTrust.identityProviders.<a href="./src/resources/zero-trust/identity-providers.ts">delete</a>(uuid, { ...params }) -> IdentityProviderDeleteResponse</code> |
| 4279 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/identity_providers/{uuid}">client.zeroTrust.identityProviders.<a href="./src/resources/zero-trust/identity-providers.ts">get</a>(uuid, { ...params }) -> AccessIdentityProviders</code> |
| 4280 | |
| 4281 | ## Organizations |
| 4282 | |
| 4283 | Types: |
| 4284 | |
| 4285 | - <code><a href="./src/resources/zero-trust/organizations.ts">AccessOrganizations</a></code> |
| 4286 | - <code><a href="./src/resources/zero-trust/organizations.ts">OrganizationRevokeUsersResponse</a></code> |
| 4287 | |
| 4288 | Methods: |
| 4289 | |
| 4290 | - <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 }) -> AccessOrganizations</code> |
| 4291 | - <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 }) -> AccessOrganizations</code> |
| 4292 | - <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 }) -> AccessOrganizations</code> |
| 4293 | - <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> |
| 4294 | |
| 4295 | ## Seats |
| 4296 | |
| 4297 | Types: |
| 4298 | |
| 4299 | - <code><a href="./src/resources/zero-trust/seats.ts">AccessSeats</a></code> |
| 4300 | - <code><a href="./src/resources/zero-trust/seats.ts">SeatEditResponse</a></code> |
| 4301 | |
| 4302 | Methods: |
| 4303 | |
| 4304 | - <code title="patch /accounts/{identifier}/access/seats">client.zeroTrust.seats.<a href="./src/resources/zero-trust/seats.ts">edit</a>(identifier, [ ...body ]) -> SeatEditResponse | null</code> |
| 4305 | |
| 4306 | ## Access |
| 4307 | |
| 4308 | ### Applications |
| 4309 | |
| 4310 | Types: |
| 4311 | |
| 4312 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">AccessApps</a></code> |
| 4313 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationListResponse</a></code> |
| 4314 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationDeleteResponse</a></code> |
| 4315 | - <code><a href="./src/resources/zero-trust/access/applications/applications.ts">ApplicationRevokeTokensResponse</a></code> |
| 4316 | |
| 4317 | Methods: |
| 4318 | |
| 4319 | - <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 }) -> AccessApps</code> |
| 4320 | - <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 }) -> AccessApps</code> |
| 4321 | - <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 }) -> ApplicationListResponse | null</code> |
| 4322 | - <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> |
| 4323 | - <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 }) -> AccessApps</code> |
| 4324 | - <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> |
| 4325 | |
| 4326 | #### CAs |
| 4327 | |
| 4328 | Types: |
| 4329 | |
| 4330 | - <code><a href="./src/resources/zero-trust/access/applications/cas.ts">AccessCA</a></code> |
| 4331 | - <code><a href="./src/resources/zero-trust/access/applications/cas.ts">CACreateResponse</a></code> |
| 4332 | - <code><a href="./src/resources/zero-trust/access/applications/cas.ts">CAListResponse</a></code> |
| 4333 | - <code><a href="./src/resources/zero-trust/access/applications/cas.ts">CADeleteResponse</a></code> |
| 4334 | - <code><a href="./src/resources/zero-trust/access/applications/cas.ts">CAGetResponse</a></code> |
| 4335 | |
| 4336 | Methods: |
| 4337 | |
| 4338 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/apps/{uuid}/ca">client.zeroTrust.access.applications.cas.<a href="./src/resources/zero-trust/access/applications/cas.ts">create</a>(uuid, { ...params }) -> CACreateResponse</code> |
| 4339 | - <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 }) -> CAListResponse | null</code> |
| 4340 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/apps/{uuid}/ca">client.zeroTrust.access.applications.cas.<a href="./src/resources/zero-trust/access/applications/cas.ts">delete</a>(uuid, { ...params }) -> CADeleteResponse</code> |
| 4341 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps/{uuid}/ca">client.zeroTrust.access.applications.cas.<a href="./src/resources/zero-trust/access/applications/cas.ts">get</a>(uuid, { ...params }) -> CAGetResponse</code> |
| 4342 | |
| 4343 | #### UserPolicyChecks |
| 4344 | |
| 4345 | Types: |
| 4346 | |
| 4347 | - <code><a href="./src/resources/zero-trust/access/applications/user-policy-checks.ts">UserPolicyCheckListResponse</a></code> |
| 4348 | |
| 4349 | Methods: |
| 4350 | |
| 4351 | - <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> |
| 4352 | |
| 4353 | #### Policies |
| 4354 | |
| 4355 | Types: |
| 4356 | |
| 4357 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">AccessPolicies</a></code> |
| 4358 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">PolicyListResponse</a></code> |
| 4359 | - <code><a href="./src/resources/zero-trust/access/applications/policies.ts">PolicyDeleteResponse</a></code> |
| 4360 | |
| 4361 | Methods: |
| 4362 | |
| 4363 | - <code title="post /{account_or_zone}/{account_or_zone_id}/access/apps/{uuid}/policies">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">create</a>(uuid, { ...params }) -> AccessPolicies</code> |
| 4364 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/apps/{uuid1}/policies/{uuid}">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">update</a>(uuid1, uuid, { ...params }) -> AccessPolicies</code> |
| 4365 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps/{uuid}/policies">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">list</a>(uuid, { ...params }) -> PolicyListResponse | null</code> |
| 4366 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/apps/{uuid1}/policies/{uuid}">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">delete</a>(uuid1, uuid, { ...params }) -> PolicyDeleteResponse</code> |
| 4367 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/apps/{uuid1}/policies/{uuid}">client.zeroTrust.access.applications.policies.<a href="./src/resources/zero-trust/access/applications/policies.ts">get</a>(uuid1, uuid, { ...params }) -> AccessPolicies</code> |
| 4368 | |
| 4369 | ### Certificates |
| 4370 | |
| 4371 | Types: |
| 4372 | |
| 4373 | - <code><a href="./src/resources/zero-trust/access/certificates/certificates.ts">AccessCertificates</a></code> |
| 4374 | - <code><a href="./src/resources/zero-trust/access/certificates/certificates.ts">CertificateListResponse</a></code> |
| 4375 | - <code><a href="./src/resources/zero-trust/access/certificates/certificates.ts">CertificateDeleteResponse</a></code> |
| 4376 | |
| 4377 | Methods: |
| 4378 | |
| 4379 | - <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 }) -> AccessCertificates</code> |
| 4380 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/certificates/{uuid}">client.zeroTrust.access.certificates.<a href="./src/resources/zero-trust/access/certificates/certificates.ts">update</a>(uuid, { ...params }) -> AccessCertificates</code> |
| 4381 | - <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 }) -> CertificateListResponse | null</code> |
| 4382 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/certificates/{uuid}">client.zeroTrust.access.certificates.<a href="./src/resources/zero-trust/access/certificates/certificates.ts">delete</a>(uuid, { ...params }) -> CertificateDeleteResponse</code> |
| 4383 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/certificates/{uuid}">client.zeroTrust.access.certificates.<a href="./src/resources/zero-trust/access/certificates/certificates.ts">get</a>(uuid, { ...params }) -> AccessCertificates</code> |
| 4384 | |
| 4385 | #### Settings |
| 4386 | |
| 4387 | Types: |
| 4388 | |
| 4389 | - <code><a href="./src/resources/zero-trust/access/certificates/settings.ts">AccessSettings</a></code> |
| 4390 | - <code><a href="./src/resources/zero-trust/access/certificates/settings.ts">SettingUpdateResponse</a></code> |
| 4391 | - <code><a href="./src/resources/zero-trust/access/certificates/settings.ts">SettingListResponse</a></code> |
| 4392 | |
| 4393 | Methods: |
| 4394 | |
| 4395 | - <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> |
| 4396 | - <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">list</a>({ ...params }) -> SettingListResponse | null</code> |
| 4397 | |
| 4398 | ### Groups |
| 4399 | |
| 4400 | Types: |
| 4401 | |
| 4402 | - <code><a href="./src/resources/zero-trust/access/groups.ts">AccessGroups</a></code> |
| 4403 | - <code><a href="./src/resources/zero-trust/access/groups.ts">GroupListResponse</a></code> |
| 4404 | - <code><a href="./src/resources/zero-trust/access/groups.ts">GroupDeleteResponse</a></code> |
| 4405 | |
| 4406 | Methods: |
| 4407 | |
| 4408 | - <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 }) -> AccessGroups</code> |
| 4409 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/groups/{uuid}">client.zeroTrust.access.groups.<a href="./src/resources/zero-trust/access/groups.ts">update</a>(uuid, { ...params }) -> AccessGroups</code> |
| 4410 | - <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 }) -> GroupListResponse | null</code> |
| 4411 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/groups/{uuid}">client.zeroTrust.access.groups.<a href="./src/resources/zero-trust/access/groups.ts">delete</a>(uuid, { ...params }) -> GroupDeleteResponse</code> |
| 4412 | - <code title="get /{account_or_zone}/{account_or_zone_id}/access/groups/{uuid}">client.zeroTrust.access.groups.<a href="./src/resources/zero-trust/access/groups.ts">get</a>(uuid, { ...params }) -> AccessGroups</code> |
| 4413 | |
| 4414 | ### ServiceTokens |
| 4415 | |
| 4416 | Types: |
| 4417 | |
| 4418 | - <code><a href="./src/resources/zero-trust/access/service-tokens.ts">AccessServiceTokens</a></code> |
| 4419 | - <code><a href="./src/resources/zero-trust/access/service-tokens.ts">ServiceTokenCreateResponse</a></code> |
| 4420 | - <code><a href="./src/resources/zero-trust/access/service-tokens.ts">ServiceTokenListResponse</a></code> |
| 4421 | - <code><a href="./src/resources/zero-trust/access/service-tokens.ts">ServiceTokenRotateResponse</a></code> |
| 4422 | |
| 4423 | Methods: |
| 4424 | |
| 4425 | - <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> |
| 4426 | - <code title="put /{account_or_zone}/{account_or_zone_id}/access/service_tokens/{uuid}">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">update</a>(uuid, { ...params }) -> AccessServiceTokens</code> |
| 4427 | - <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 }) -> ServiceTokenListResponse | null</code> |
| 4428 | - <code title="delete /{account_or_zone}/{account_or_zone_id}/access/service_tokens/{uuid}">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">delete</a>(uuid, { ...params }) -> AccessServiceTokens</code> |
| 4429 | - <code title="post /accounts/{identifier}/access/service_tokens/{uuid}/refresh">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">refresh</a>(identifier, uuid) -> AccessServiceTokens</code> |
| 4430 | - <code title="post /accounts/{identifier}/access/service_tokens/{uuid}/rotate">client.zeroTrust.access.serviceTokens.<a href="./src/resources/zero-trust/access/service-tokens.ts">rotate</a>(identifier, uuid) -> ServiceTokenRotateResponse</code> |
| 4431 | |
| 4432 | ### Bookmarks |
| 4433 | |
| 4434 | Types: |
| 4435 | |
| 4436 | - <code><a href="./src/resources/zero-trust/access/bookmarks.ts">AccessBookmarks</a></code> |
| 4437 | - <code><a href="./src/resources/zero-trust/access/bookmarks.ts">BookmarkListResponse</a></code> |
| 4438 | - <code><a href="./src/resources/zero-trust/access/bookmarks.ts">BookmarkDeleteResponse</a></code> |
| 4439 | |
| 4440 | Methods: |
| 4441 | |
| 4442 | - <code title="post /accounts/{identifier}/access/bookmarks/{uuid}">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">create</a>(identifier, uuid) -> AccessBookmarks</code> |
| 4443 | - <code title="put /accounts/{identifier}/access/bookmarks/{uuid}">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">update</a>(identifier, uuid) -> AccessBookmarks</code> |
| 4444 | - <code title="get /accounts/{identifier}/access/bookmarks">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">list</a>(identifier) -> BookmarkListResponse | null</code> |
| 4445 | - <code title="delete /accounts/{identifier}/access/bookmarks/{uuid}">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">delete</a>(identifier, uuid) -> BookmarkDeleteResponse</code> |
| 4446 | - <code title="get /accounts/{identifier}/access/bookmarks/{uuid}">client.zeroTrust.access.bookmarks.<a href="./src/resources/zero-trust/access/bookmarks.ts">get</a>(identifier, uuid) -> AccessBookmarks</code> |
| 4447 | |
| 4448 | ### Keys |
| 4449 | |
| 4450 | Types: |
| 4451 | |
| 4452 | - <code><a href="./src/resources/zero-trust/access/keys.ts">KeyUpdateResponse</a></code> |
| 4453 | - <code><a href="./src/resources/zero-trust/access/keys.ts">KeyListResponse</a></code> |
| 4454 | - <code><a href="./src/resources/zero-trust/access/keys.ts">KeyRotateResponse</a></code> |
| 4455 | |
| 4456 | Methods: |
| 4457 | |
| 4458 | - <code title="put /accounts/{identifier}/access/keys">client.zeroTrust.access.keys.<a href="./src/resources/zero-trust/access/keys.ts">update</a>(identifier, { ...params }) -> KeyUpdateResponse</code> |
| 4459 | - <code title="get /accounts/{identifier}/access/keys">client.zeroTrust.access.keys.<a href="./src/resources/zero-trust/access/keys.ts">list</a>(identifier) -> KeyListResponse</code> |
| 4460 | - <code title="post /accounts/{identifier}/access/keys/rotate">client.zeroTrust.access.keys.<a href="./src/resources/zero-trust/access/keys.ts">rotate</a>(identifier) -> KeyRotateResponse</code> |
| 4461 | |
| 4462 | ### Logs |
| 4463 | |
| 4464 | #### AccessRequests |
| 4465 | |
| 4466 | Types: |
| 4467 | |
| 4468 | - <code><a href="./src/resources/zero-trust/access/logs/access-requests.ts">AccessAccessRequests</a></code> |
| 4469 | - <code><a href="./src/resources/zero-trust/access/logs/access-requests.ts">AccessRequestListResponse</a></code> |
| 4470 | |
| 4471 | Methods: |
| 4472 | |
| 4473 | - <code title="get /accounts/{identifier}/access/logs/access_requests">client.zeroTrust.access.logs.accessRequests.<a href="./src/resources/zero-trust/access/logs/access-requests.ts">list</a>(identifier) -> AccessRequestListResponse | null</code> |
| 4474 | |
| 4475 | ### Users |
| 4476 | |
| 4477 | Types: |
| 4478 | |
| 4479 | - <code><a href="./src/resources/zero-trust/access/users/users.ts">AccessUsers</a></code> |
| 4480 | - <code><a href="./src/resources/zero-trust/access/users/users.ts">UserListResponse</a></code> |
| 4481 | |
| 4482 | Methods: |
| 4483 | |
| 4484 | - <code title="get /accounts/{identifier}/access/users">client.zeroTrust.access.users.<a href="./src/resources/zero-trust/access/users/users.ts">list</a>(identifier) -> UserListResponse | null</code> |
| 4485 | |
| 4486 | #### ActiveSessions |
| 4487 | |
| 4488 | Types: |
| 4489 | |
| 4490 | - <code><a href="./src/resources/zero-trust/access/users/active-sessions.ts">ActiveSessionListResponse</a></code> |
| 4491 | - <code><a href="./src/resources/zero-trust/access/users/active-sessions.ts">ActiveSessionGetResponse</a></code> |
| 4492 | |
| 4493 | Methods: |
| 4494 | |
| 4495 | - <code title="get /accounts/{identifier}/access/users/{id}/active_sessions">client.zeroTrust.access.users.activeSessions.<a href="./src/resources/zero-trust/access/users/active-sessions.ts">list</a>(identifier, id) -> ActiveSessionListResponse | null</code> |
| 4496 | - <code title="get /accounts/{identifier}/access/users/{id}/active_sessions/{nonce}">client.zeroTrust.access.users.activeSessions.<a href="./src/resources/zero-trust/access/users/active-sessions.ts">get</a>(identifier, id, nonce) -> ActiveSessionGetResponse</code> |
| 4497 | |
| 4498 | #### LastSeenIdentity |
| 4499 | |
| 4500 | Types: |
| 4501 | |
| 4502 | - <code><a href="./src/resources/zero-trust/access/users/last-seen-identity.ts">AccessIdentity</a></code> |
| 4503 | |
| 4504 | Methods: |
| 4505 | |
| 4506 | - <code title="get /accounts/{identifier}/access/users/{id}/last_seen_identity">client.zeroTrust.access.users.lastSeenIdentity.<a href="./src/resources/zero-trust/access/users/last-seen-identity.ts">get</a>(identifier, id) -> AccessIdentity</code> |
| 4507 | |
| 4508 | #### FailedLogins |
| 4509 | |
| 4510 | Types: |
| 4511 | |
| 4512 | - <code><a href="./src/resources/zero-trust/access/users/failed-logins.ts">FailedLoginListResponse</a></code> |
| 4513 | |
| 4514 | Methods: |
| 4515 | |
| 4516 | - <code title="get /accounts/{identifier}/access/users/{id}/failed_logins">client.zeroTrust.access.users.failedLogins.<a href="./src/resources/zero-trust/access/users/failed-logins.ts">list</a>(identifier, id) -> FailedLoginListResponse | null</code> |
| 4517 | |
| 4518 | ### CustomPages |
| 4519 | |
| 4520 | Types: |
| 4521 | |
| 4522 | - <code><a href="./src/resources/zero-trust/access/custom-pages.ts">AccessCustomPage</a></code> |
| 4523 | - <code><a href="./src/resources/zero-trust/access/custom-pages.ts">AccessCustomPageWithoutHTML</a></code> |
| 4524 | - <code><a href="./src/resources/zero-trust/access/custom-pages.ts">CustomPageListResponse</a></code> |
| 4525 | - <code><a href="./src/resources/zero-trust/access/custom-pages.ts">CustomPageDeleteResponse</a></code> |
| 4526 | |
| 4527 | Methods: |
| 4528 | |
| 4529 | - <code title="post /accounts/{identifier}/access/custom_pages">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">create</a>(identifier, { ...params }) -> AccessCustomPageWithoutHTML</code> |
| 4530 | - <code title="put /accounts/{identifier}/access/custom_pages/{uuid}">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">update</a>(identifier, uuid, { ...params }) -> AccessCustomPageWithoutHTML</code> |
| 4531 | - <code title="get /accounts/{identifier}/access/custom_pages">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">list</a>(identifier) -> CustomPageListResponse | null</code> |
| 4532 | - <code title="delete /accounts/{identifier}/access/custom_pages/{uuid}">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">delete</a>(identifier, uuid) -> CustomPageDeleteResponse</code> |
| 4533 | - <code title="get /accounts/{identifier}/access/custom_pages/{uuid}">client.zeroTrust.access.customPages.<a href="./src/resources/zero-trust/access/custom-pages.ts">get</a>(identifier, uuid) -> AccessCustomPage</code> |
| 4534 | |
| 4535 | ### Tags |
| 4536 | |
| 4537 | Types: |
| 4538 | |
| 4539 | - <code><a href="./src/resources/zero-trust/access/tags.ts">AccessTag</a></code> |
| 4540 | - <code><a href="./src/resources/zero-trust/access/tags.ts">TagListResponse</a></code> |
| 4541 | - <code><a href="./src/resources/zero-trust/access/tags.ts">TagDeleteResponse</a></code> |
| 4542 | |
| 4543 | Methods: |
| 4544 | |
| 4545 | - <code title="post /accounts/{identifier}/access/tags">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">create</a>(identifier, { ...params }) -> AccessTag</code> |
| 4546 | - <code title="put /accounts/{identifier}/access/tags/{name}">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">update</a>(identifier, tagName, { ...params }) -> AccessTag</code> |
| 4547 | - <code title="get /accounts/{identifier}/access/tags">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">list</a>(identifier) -> TagListResponse | null</code> |
| 4548 | - <code title="delete /accounts/{identifier}/access/tags/{name}">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">delete</a>(identifier, name) -> TagDeleteResponse</code> |
| 4549 | - <code title="get /accounts/{identifier}/access/tags/{name}">client.zeroTrust.access.tags.<a href="./src/resources/zero-trust/access/tags.ts">get</a>(identifier, name) -> AccessTag</code> |
| 4550 | |
| 4551 | ## DEX |
| 4552 | |
| 4553 | ### Colos |
| 4554 | |
| 4555 | Types: |
| 4556 | |
| 4557 | - <code><a href="./src/resources/zero-trust/dex/colos.ts">ColoListResponse</a></code> |
| 4558 | |
| 4559 | Methods: |
| 4560 | |
| 4561 | - <code title="get /accounts/{account_id}/dex/colos">client.zeroTrust.dex.colos.<a href="./src/resources/zero-trust/dex/colos.ts">list</a>({ ...params }) -> ColoListResponse | null</code> |
| 4562 | |
| 4563 | ### FleetStatus |
| 4564 | |
| 4565 | Types: |
| 4566 | |
| 4567 | - <code><a href="./src/resources/zero-trust/dex/fleet-status/fleet-status.ts">FleetStatusLiveResponse</a></code> |
| 4568 | |
| 4569 | Methods: |
| 4570 | |
| 4571 | - <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> |
| 4572 | - <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> |
| 4573 | |
| 4574 | #### Devices |
| 4575 | |
| 4576 | Types: |
| 4577 | |
| 4578 | - <code><a href="./src/resources/zero-trust/dex/fleet-status/devices.ts">DigitalExperienceMonitoringDevice</a></code> |
| 4579 | |
| 4580 | Methods: |
| 4581 | |
| 4582 | - <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 }) -> DigitalExperienceMonitoringDevicesV4PagePaginationArray</code> |
| 4583 | |
| 4584 | ### HTTPTests |
| 4585 | |
| 4586 | Types: |
| 4587 | |
| 4588 | - <code><a href="./src/resources/zero-trust/dex/http-tests/http-tests.ts">DigitalExperienceMonitoringHTTPDetails</a></code> |
| 4589 | |
| 4590 | Methods: |
| 4591 | |
| 4592 | - <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 }) -> DigitalExperienceMonitoringHTTPDetails</code> |
| 4593 | |
| 4594 | #### Percentiles |
| 4595 | |
| 4596 | Types: |
| 4597 | |
| 4598 | - <code><a href="./src/resources/zero-trust/dex/http-tests/percentiles.ts">DigitalExperienceMonitoringHTTPDetailsPercentiles</a></code> |
| 4599 | |
| 4600 | Methods: |
| 4601 | |
| 4602 | - <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 }) -> DigitalExperienceMonitoringHTTPDetailsPercentiles</code> |
| 4603 | |
| 4604 | ### Tests |
| 4605 | |
| 4606 | Types: |
| 4607 | |
| 4608 | - <code><a href="./src/resources/zero-trust/dex/tests/tests.ts">DigitalExperienceMonitoringTests</a></code> |
| 4609 | - <code><a href="./src/resources/zero-trust/dex/tests/tests.ts">TestListResponse</a></code> |
| 4610 | |
| 4611 | Methods: |
| 4612 | |
| 4613 | - <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> |
| 4614 | |
| 4615 | #### UniqueDevices |
| 4616 | |
| 4617 | Types: |
| 4618 | |
| 4619 | - <code><a href="./src/resources/zero-trust/dex/tests/unique-devices.ts">DigitalExperienceMonitoringUniqueDevices</a></code> |
| 4620 | |
| 4621 | Methods: |
| 4622 | |
| 4623 | - <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 }) -> DigitalExperienceMonitoringUniqueDevices</code> |
| 4624 | |
| 4625 | ### TracerouteTestResults |
| 4626 | |
| 4627 | #### NetworkPath |
| 4628 | |
| 4629 | Types: |
| 4630 | |
| 4631 | - <code><a href="./src/resources/zero-trust/dex/traceroute-test-results/network-path.ts">DigitalExperienceMonitoringTracerouteTestResultNetworkPath</a></code> |
| 4632 | |
| 4633 | Methods: |
| 4634 | |
| 4635 | - <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 }) -> DigitalExperienceMonitoringTracerouteTestResultNetworkPath</code> |
| 4636 | |
| 4637 | ### TracerouteTests |
| 4638 | |
| 4639 | Types: |
| 4640 | |
| 4641 | - <code><a href="./src/resources/zero-trust/dex/traceroute-tests.ts">DigitalExperienceMonitoringTracerouteDetails</a></code> |
| 4642 | - <code><a href="./src/resources/zero-trust/dex/traceroute-tests.ts">DigitalExperienceMonitoringTracerouteDetailsPercentiles</a></code> |
| 4643 | - <code><a href="./src/resources/zero-trust/dex/traceroute-tests.ts">DigitalExperienceMonitoringTracerouteTestNetworkPath</a></code> |
| 4644 | |
| 4645 | Methods: |
| 4646 | |
| 4647 | - <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 }) -> DigitalExperienceMonitoringTracerouteDetails</code> |
| 4648 | - <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 }) -> DigitalExperienceMonitoringTracerouteTestNetworkPath</code> |
| 4649 | - <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 }) -> DigitalExperienceMonitoringTracerouteDetailsPercentiles</code> |
| 4650 | |
| 4651 | ## Tunnels |
| 4652 | |
| 4653 | Types: |
| 4654 | |
| 4655 | - <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">TunnelArgoTunnel</a></code> |
| 4656 | - <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">TunnelListResponse</a></code> |
| 4657 | - <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">TunnelEditResponse</a></code> |
| 4658 | |
| 4659 | Methods: |
| 4660 | |
| 4661 | - <code title="post /accounts/{account_id}/tunnels">client.zeroTrust.tunnels.<a href="./src/resources/zero-trust/tunnels/tunnels.ts">create</a>({ ...params }) -> TunnelArgoTunnel</code> |
| 4662 | - <code title="get /accounts/{account_id}/tunnels">client.zeroTrust.tunnels.<a href="./src/resources/zero-trust/tunnels/tunnels.ts">list</a>({ ...params }) -> TunnelListResponsesV4PagePaginationArray</code> |
| 4663 | - <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 }) -> TunnelArgoTunnel</code> |
| 4664 | - <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> |
| 4665 | - <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 }) -> TunnelArgoTunnel</code> |
| 4666 | |
| 4667 | ### Configurations |
| 4668 | |
| 4669 | Types: |
| 4670 | |
| 4671 | - <code><a href="./src/resources/zero-trust/tunnels/configurations.ts">ConfigurationUpdateResponse</a></code> |
| 4672 | - <code><a href="./src/resources/zero-trust/tunnels/configurations.ts">ConfigurationGetResponse</a></code> |
| 4673 | |
| 4674 | Methods: |
| 4675 | |
| 4676 | - <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> |
| 4677 | - <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> |
| 4678 | |
| 4679 | ### Connections |
| 4680 | |
| 4681 | Types: |
| 4682 | |
| 4683 | - <code><a href="./src/resources/zero-trust/tunnels/connections.ts">TunnelTunnelClient</a></code> |
| 4684 | - <code><a href="./src/resources/zero-trust/tunnels/connections.ts">ConnectionDeleteResponse</a></code> |
| 4685 | - <code><a href="./src/resources/zero-trust/tunnels/connections.ts">ConnectionGetResponse</a></code> |
| 4686 | |
| 4687 | Methods: |
| 4688 | |
| 4689 | - <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> |
| 4690 | - <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> |
| 4691 | |
| 4692 | ### Token |
| 4693 | |
| 4694 | Types: |
| 4695 | |
| 4696 | - <code><a href="./src/resources/zero-trust/tunnels/token.ts">TokenGetResponse</a></code> |
| 4697 | |
| 4698 | Methods: |
| 4699 | |
| 4700 | - <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> |
| 4701 | |
| 4702 | ### Connectors |
| 4703 | |
| 4704 | Methods: |
| 4705 | |
| 4706 | - <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 }) -> TunnelTunnelClient</code> |
| 4707 | |
| 4708 | ### Management |
| 4709 | |
| 4710 | Types: |
| 4711 | |
| 4712 | - <code><a href="./src/resources/zero-trust/tunnels/management.ts">ManagementCreateResponse</a></code> |
| 4713 | |
| 4714 | Methods: |
| 4715 | |
| 4716 | - <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> |
| 4717 | |
| 4718 | ## ConnectivitySettings |
| 4719 | |
| 4720 | Types: |
| 4721 | |
| 4722 | - <code><a href="./src/resources/zero-trust/connectivity-settings.ts">ConnectivitySettingEditResponse</a></code> |
| 4723 | - <code><a href="./src/resources/zero-trust/connectivity-settings.ts">ConnectivitySettingGetResponse</a></code> |
| 4724 | |
| 4725 | Methods: |
| 4726 | |
| 4727 | - <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> |
| 4728 | - <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> |
| 4729 | |
| 4730 | ## DLP |
| 4731 | |
| 4732 | ### Datasets |
| 4733 | |
| 4734 | Types: |
| 4735 | |
| 4736 | - <code><a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">DLPDataset</a></code> |
| 4737 | - <code><a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">DLPDatasetArray</a></code> |
| 4738 | - <code><a href="./src/resources/zero-trust/dlp/datasets/datasets.ts">DLPDatasetCreation</a></code> |
| 4739 | |
| 4740 | Methods: |
| 4741 | |
| 4742 | - <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 }) -> DLPDatasetCreation</code> |
| 4743 | - <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 }) -> DLPDataset</code> |
| 4744 | - <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 }) -> DLPDatasetArray</code> |
| 4745 | - <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> |
| 4746 | - <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 }) -> DLPDataset</code> |
| 4747 | |
| 4748 | #### Upload |
| 4749 | |
| 4750 | Types: |
| 4751 | |
| 4752 | - <code><a href="./src/resources/zero-trust/dlp/datasets/upload.ts">DLPDatasetNewVersion</a></code> |
| 4753 | |
| 4754 | Methods: |
| 4755 | |
| 4756 | - <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 }) -> DLPDatasetNewVersion</code> |
| 4757 | - <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 }) -> DLPDataset</code> |
| 4758 | |
| 4759 | ### Patterns |
| 4760 | |
| 4761 | Types: |
| 4762 | |
| 4763 | - <code><a href="./src/resources/zero-trust/dlp/patterns.ts">PatternValidateResponse</a></code> |
| 4764 | |
| 4765 | Methods: |
| 4766 | |
| 4767 | - <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 }) -> PatternValidateResponse</code> |
| 4768 | |
| 4769 | ### PayloadLogs |
| 4770 | |
| 4771 | Types: |
| 4772 | |
| 4773 | - <code><a href="./src/resources/zero-trust/dlp/payload-logs.ts">PayloadLogUpdateResponse</a></code> |
| 4774 | - <code><a href="./src/resources/zero-trust/dlp/payload-logs.ts">PayloadLogGetResponse</a></code> |
| 4775 | |
| 4776 | Methods: |
| 4777 | |
| 4778 | - <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> |
| 4779 | - <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> |
| 4780 | |
| 4781 | ### Profiles |
| 4782 | |
| 4783 | Types: |
| 4784 | |
| 4785 | - <code><a href="./src/resources/zero-trust/dlp/profiles/profiles.ts">DLPProfiles</a></code> |
| 4786 | - <code><a href="./src/resources/zero-trust/dlp/profiles/profiles.ts">ProfileListResponse</a></code> |
| 4787 | - <code><a href="./src/resources/zero-trust/dlp/profiles/profiles.ts">ProfileGetResponse</a></code> |
| 4788 | |
| 4789 | Methods: |
| 4790 | |
| 4791 | - <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 }) -> ProfileListResponse | null</code> |
| 4792 | - <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> |
| 4793 | |
| 4794 | #### Custom |
| 4795 | |
| 4796 | Types: |
| 4797 | |
| 4798 | - <code><a href="./src/resources/zero-trust/dlp/profiles/custom.ts">DLPCustomProfile</a></code> |
| 4799 | - <code><a href="./src/resources/zero-trust/dlp/profiles/custom.ts">CustomCreateResponse</a></code> |
| 4800 | - <code><a href="./src/resources/zero-trust/dlp/profiles/custom.ts">CustomDeleteResponse</a></code> |
| 4801 | |
| 4802 | Methods: |
| 4803 | |
| 4804 | - <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> |
| 4805 | - <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 }) -> DLPCustomProfile</code> |
| 4806 | - <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> |
| 4807 | - <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 }) -> DLPCustomProfile</code> |
| 4808 | |
| 4809 | #### Predefined |
| 4810 | |
| 4811 | Types: |
| 4812 | |
| 4813 | - <code><a href="./src/resources/zero-trust/dlp/profiles/predefined.ts">DLPPredefinedProfile</a></code> |
| 4814 | |
| 4815 | Methods: |
| 4816 | |
| 4817 | - <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 }) -> DLPPredefinedProfile</code> |
| 4818 | - <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 }) -> DLPPredefinedProfile</code> |
| 4819 | |
| 4820 | ## Gateway |
| 4821 | |
| 4822 | Types: |
| 4823 | |
| 4824 | - <code><a href="./src/resources/zero-trust/gateway/gateway.ts">GatewayCreateResponse</a></code> |
| 4825 | - <code><a href="./src/resources/zero-trust/gateway/gateway.ts">GatewayListResponse</a></code> |
| 4826 | |
| 4827 | Methods: |
| 4828 | |
| 4829 | - <code title="post /accounts/{account_id}/gateway">client.zeroTrust.gateway.<a href="./src/resources/zero-trust/gateway/gateway.ts">create</a>({ ...params }) -> GatewayCreateResponse</code> |
| 4830 | - <code title="get /accounts/{account_id}/gateway">client.zeroTrust.gateway.<a href="./src/resources/zero-trust/gateway/gateway.ts">list</a>({ ...params }) -> GatewayListResponse</code> |
| 4831 | |
| 4832 | ### AuditSSHSettings |
| 4833 | |
| 4834 | Types: |
| 4835 | |
| 4836 | - <code><a href="./src/resources/zero-trust/gateway/audit-ssh-settings.ts">ZeroTrustGatewaySettings</a></code> |
| 4837 | |
| 4838 | Methods: |
| 4839 | |
| 4840 | - <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 }) -> ZeroTrustGatewaySettings</code> |
| 4841 | - <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 }) -> ZeroTrustGatewaySettings</code> |
| 4842 | |
| 4843 | ### Categories |
| 4844 | |
| 4845 | Types: |
| 4846 | |
| 4847 | - <code><a href="./src/resources/zero-trust/gateway/categories.ts">ZeroTrustGatewayCategories</a></code> |
| 4848 | - <code><a href="./src/resources/zero-trust/gateway/categories.ts">CategoryListResponse</a></code> |
| 4849 | |
| 4850 | Methods: |
| 4851 | |
| 4852 | - <code title="get /accounts/{account_id}/gateway/categories">client.zeroTrust.gateway.categories.<a href="./src/resources/zero-trust/gateway/categories.ts">list</a>({ ...params }) -> CategoryListResponse | null</code> |
| 4853 | |
| 4854 | ### AppTypes |
| 4855 | |
| 4856 | Types: |
| 4857 | |
| 4858 | - <code><a href="./src/resources/zero-trust/gateway/app-types.ts">ZeroTrustGatewayAppTypes</a></code> |
| 4859 | - <code><a href="./src/resources/zero-trust/gateway/app-types.ts">AppTypeListResponse</a></code> |
| 4860 | |
| 4861 | Methods: |
| 4862 | |
| 4863 | - <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 }) -> AppTypeListResponse | null</code> |
| 4864 | |
| 4865 | ### Configurations |
| 4866 | |
| 4867 | Types: |
| 4868 | |
| 4869 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">ConfigurationUpdateResponse</a></code> |
| 4870 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">ConfigurationEditResponse</a></code> |
| 4871 | - <code><a href="./src/resources/zero-trust/gateway/configurations.ts">ConfigurationGetResponse</a></code> |
| 4872 | |
| 4873 | Methods: |
| 4874 | |
| 4875 | - <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> |
| 4876 | - <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> |
| 4877 | - <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> |
| 4878 | |
| 4879 | ### Lists |
| 4880 | |
| 4881 | Types: |
| 4882 | |
| 4883 | - <code><a href="./src/resources/zero-trust/gateway/lists/lists.ts">ZeroTrustGatewayLists</a></code> |
| 4884 | - <code><a href="./src/resources/zero-trust/gateway/lists/lists.ts">ListCreateResponse</a></code> |
| 4885 | - <code><a href="./src/resources/zero-trust/gateway/lists/lists.ts">ListListResponse</a></code> |
| 4886 | - <code><a href="./src/resources/zero-trust/gateway/lists/lists.ts">ListDeleteResponse</a></code> |
| 4887 | |
| 4888 | Methods: |
| 4889 | |
| 4890 | - <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> |
| 4891 | - <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 }) -> ZeroTrustGatewayLists</code> |
| 4892 | - <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 }) -> ListListResponse | null</code> |
| 4893 | - <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> |
| 4894 | - <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 }) -> ZeroTrustGatewayLists</code> |
| 4895 | - <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 }) -> ZeroTrustGatewayLists</code> |
| 4896 | |
| 4897 | #### Items |
| 4898 | |
| 4899 | Types: |
| 4900 | |
| 4901 | - <code><a href="./src/resources/zero-trust/gateway/lists/items.ts">ItemListResponse</a></code> |
| 4902 | |
| 4903 | Methods: |
| 4904 | |
| 4905 | - <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 }) -> ItemListResponse | null</code> |
| 4906 | |
| 4907 | ### Locations |
| 4908 | |
| 4909 | Types: |
| 4910 | |
| 4911 | - <code><a href="./src/resources/zero-trust/gateway/locations.ts">ZeroTrustGatewayLocations</a></code> |
| 4912 | - <code><a href="./src/resources/zero-trust/gateway/locations.ts">LocationListResponse</a></code> |
| 4913 | - <code><a href="./src/resources/zero-trust/gateway/locations.ts">LocationDeleteResponse</a></code> |
| 4914 | |
| 4915 | Methods: |
| 4916 | |
| 4917 | - <code title="post /accounts/{account_id}/gateway/locations">client.zeroTrust.gateway.locations.<a href="./src/resources/zero-trust/gateway/locations.ts">create</a>({ ...params }) -> ZeroTrustGatewayLocations</code> |
| 4918 | - <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 }) -> ZeroTrustGatewayLocations</code> |
| 4919 | - <code title="get /accounts/{account_id}/gateway/locations">client.zeroTrust.gateway.locations.<a href="./src/resources/zero-trust/gateway/locations.ts">list</a>({ ...params }) -> LocationListResponse | null</code> |
| 4920 | - <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> |
| 4921 | - <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 }) -> ZeroTrustGatewayLocations</code> |
| 4922 | |
| 4923 | ### Logging |
| 4924 | |
| 4925 | Types: |
| 4926 | |
| 4927 | - <code><a href="./src/resources/zero-trust/gateway/logging.ts">ZeroTrustGatewayGatewayAccountLoggingSettings</a></code> |
| 4928 | |
| 4929 | Methods: |
| 4930 | |
| 4931 | - <code title="put /accounts/{account_id}/gateway/logging">client.zeroTrust.gateway.logging.<a href="./src/resources/zero-trust/gateway/logging.ts">update</a>({ ...params }) -> ZeroTrustGatewayGatewayAccountLoggingSettings</code> |
| 4932 | - <code title="get /accounts/{account_id}/gateway/logging">client.zeroTrust.gateway.logging.<a href="./src/resources/zero-trust/gateway/logging.ts">get</a>({ ...params }) -> ZeroTrustGatewayGatewayAccountLoggingSettings</code> |
| 4933 | |
| 4934 | ### ProxyEndpoints |
| 4935 | |
| 4936 | Types: |
| 4937 | |
| 4938 | - <code><a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">ZeroTrustGatewayProxyEndpoints</a></code> |
| 4939 | - <code><a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">ProxyEndpointListResponse</a></code> |
| 4940 | - <code><a href="./src/resources/zero-trust/gateway/proxy-endpoints.ts">ProxyEndpointDeleteResponse</a></code> |
| 4941 | |
| 4942 | Methods: |
| 4943 | |
| 4944 | - <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 }) -> ZeroTrustGatewayProxyEndpoints</code> |
| 4945 | - <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 }) -> ProxyEndpointListResponse | null</code> |
| 4946 | - <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> |
| 4947 | - <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 }) -> ZeroTrustGatewayProxyEndpoints</code> |
| 4948 | - <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 }) -> ZeroTrustGatewayProxyEndpoints</code> |
| 4949 | |
| 4950 | ### Rules |
| 4951 | |
| 4952 | Types: |
| 4953 | |
| 4954 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">ZeroTrustGatewayRules</a></code> |
| 4955 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">RuleListResponse</a></code> |
| 4956 | - <code><a href="./src/resources/zero-trust/gateway/rules.ts">RuleDeleteResponse</a></code> |
| 4957 | |
| 4958 | Methods: |
| 4959 | |
| 4960 | - <code title="post /accounts/{account_id}/gateway/rules">client.zeroTrust.gateway.rules.<a href="./src/resources/zero-trust/gateway/rules.ts">create</a>({ ...params }) -> ZeroTrustGatewayRules</code> |
| 4961 | - <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 }) -> ZeroTrustGatewayRules</code> |
| 4962 | - <code title="get /accounts/{account_id}/gateway/rules">client.zeroTrust.gateway.rules.<a href="./src/resources/zero-trust/gateway/rules.ts">list</a>({ ...params }) -> RuleListResponse | null</code> |
| 4963 | - <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> |
| 4964 | - <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 }) -> ZeroTrustGatewayRules</code> |
| 4965 | |
| 4966 | ## Networks |
| 4967 | |
| 4968 | ### Routes |
| 4969 | |
| 4970 | Types: |
| 4971 | |
| 4972 | - <code><a href="./src/resources/zero-trust/networks/routes/routes.ts">TunnelRoute</a></code> |
| 4973 | - <code><a href="./src/resources/zero-trust/networks/routes/routes.ts">TunnelTeamnet</a></code> |
| 4974 | |
| 4975 | Methods: |
| 4976 | |
| 4977 | - <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 }) -> TunnelRoute</code> |
| 4978 | - <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 }) -> TunnelTeamnetsV4PagePaginationArray</code> |
| 4979 | - <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 }) -> TunnelRoute</code> |
| 4980 | - <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 }) -> TunnelRoute</code> |
| 4981 | |
| 4982 | #### IPs |
| 4983 | |
| 4984 | Methods: |
| 4985 | |
| 4986 | - <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 }) -> TunnelTeamnet</code> |
| 4987 | |
| 4988 | #### Networks |
| 4989 | |
| 4990 | Methods: |
| 4991 | |
| 4992 | - <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 }) -> TunnelRoute</code> |
| 4993 | - <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 }) -> TunnelRoute</code> |
| 4994 | - <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 }) -> TunnelRoute</code> |
| 4995 | |
| 4996 | ### VirtualNetworks |
| 4997 | |
| 4998 | Types: |
| 4999 | |
| 5000 | - <code><a href="./src/resources/zero-trust/networks/virtual-networks.ts">TunnelVirtualNetwork</a></code> |
| 5001 | - <code><a href="./src/resources/zero-trust/networks/virtual-networks.ts">VirtualNetworkCreateResponse</a></code> |
| 5002 | - <code><a href="./src/resources/zero-trust/networks/virtual-networks.ts">VirtualNetworkListResponse</a></code> |
| 5003 | - <code><a href="./src/resources/zero-trust/networks/virtual-networks.ts">VirtualNetworkDeleteResponse</a></code> |
| 5004 | - <code><a href="./src/resources/zero-trust/networks/virtual-networks.ts">VirtualNetworkEditResponse</a></code> |
| 5005 | |
| 5006 | Methods: |
| 5007 | |
| 5008 | - <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> |
| 5009 | - <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 }) -> VirtualNetworkListResponse | null</code> |
| 5010 | - <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> |
| 5011 | - <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> |
| 5012 | |
| 5013 | # Challenges |
| 5014 | |
| 5015 | ## Widgets |
| 5016 | |
| 5017 | Types: |
| 5018 | |
| 5019 | - <code><a href="./src/resources/challenges/widgets.ts">NcChallengesAdminWidgetDetail</a></code> |
| 5020 | - <code><a href="./src/resources/challenges/widgets.ts">NcChallengesAdminWidgetList</a></code> |
| 5021 | |
| 5022 | Methods: |
| 5023 | |
| 5024 | - <code title="post /accounts/{account_id}/challenges/widgets">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">create</a>({ ...params }) -> NcChallengesAdminWidgetDetail</code> |
| 5025 | - <code title="put /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">update</a>(sitekey, { ...params }) -> NcChallengesAdminWidgetDetail</code> |
| 5026 | - <code title="get /accounts/{account_id}/challenges/widgets">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">list</a>({ ...params }) -> NcChallengesAdminWidgetListsV4PagePaginationArray</code> |
| 5027 | - <code title="delete /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">delete</a>(sitekey, { ...params }) -> NcChallengesAdminWidgetDetail</code> |
| 5028 | - <code title="get /accounts/{account_id}/challenges/widgets/{sitekey}">client.challenges.widgets.<a href="./src/resources/challenges/widgets.ts">get</a>(sitekey, { ...params }) -> NcChallengesAdminWidgetDetail</code> |
| 5029 | - <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 }) -> NcChallengesAdminWidgetDetail</code> |
| 5030 | |
| 5031 | # Hyperdrive |
| 5032 | |
| 5033 | ## Configs |
| 5034 | |
| 5035 | Types: |
| 5036 | |
| 5037 | - <code><a href="./src/resources/hyperdrive/configs.ts">HyperdriveHyperdriveWithIdentifier</a></code> |
| 5038 | - <code><a href="./src/resources/hyperdrive/configs.ts">ConfigCreateResponse</a></code> |
| 5039 | - <code><a href="./src/resources/hyperdrive/configs.ts">ConfigUpdateResponse</a></code> |
| 5040 | - <code><a href="./src/resources/hyperdrive/configs.ts">ConfigListResponse</a></code> |
| 5041 | - <code><a href="./src/resources/hyperdrive/configs.ts">ConfigDeleteResponse</a></code> |
| 5042 | - <code><a href="./src/resources/hyperdrive/configs.ts">ConfigEditResponse</a></code> |
| 5043 | - <code><a href="./src/resources/hyperdrive/configs.ts">ConfigGetResponse</a></code> |
| 5044 | |
| 5045 | Methods: |
| 5046 | |
| 5047 | - <code title="post /accounts/{account_id}/hyperdrive/configs">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">create</a>({ ...params }) -> ConfigCreateResponse | null</code> |
| 5048 | - <code title="put /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">update</a>(hyperdriveId, { ...params }) -> ConfigUpdateResponse | null</code> |
| 5049 | - <code title="get /accounts/{account_id}/hyperdrive/configs">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">list</a>({ ...params }) -> ConfigListResponse</code> |
| 5050 | - <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 | null</code> |
| 5051 | - <code title="patch /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">edit</a>(hyperdriveId, { ...params }) -> ConfigEditResponse | null</code> |
| 5052 | - <code title="get /accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}">client.hyperdrive.configs.<a href="./src/resources/hyperdrive/configs.ts">get</a>(hyperdriveId, { ...params }) -> ConfigGetResponse | null</code> |
| 5053 | |
| 5054 | # RUM |
| 5055 | |
| 5056 | ## SiteInfos |
| 5057 | |
| 5058 | Types: |
| 5059 | |
| 5060 | - <code><a href="./src/resources/rum/site-infos.ts">RUMSite</a></code> |
| 5061 | - <code><a href="./src/resources/rum/site-infos.ts">SiteInfoDeleteResponse</a></code> |
| 5062 | |
| 5063 | Methods: |
| 5064 | |
| 5065 | - <code title="post /accounts/{account_id}/rum/site_info">client.rum.siteInfos.<a href="./src/resources/rum/site-infos.ts">create</a>({ ...params }) -> RUMSite</code> |
| 5066 | - <code title="put /accounts/{account_id}/rum/site_info/{site_id}">client.rum.siteInfos.<a href="./src/resources/rum/site-infos.ts">update</a>(siteId, { ...params }) -> RUMSite</code> |
| 5067 | - <code title="get /accounts/{account_id}/rum/site_info/list">client.rum.siteInfos.<a href="./src/resources/rum/site-infos.ts">list</a>({ ...params }) -> RUMSitesV4PagePaginationArray</code> |
| 5068 | - <code title="delete /accounts/{account_id}/rum/site_info/{site_id}">client.rum.siteInfos.<a href="./src/resources/rum/site-infos.ts">delete</a>(siteId, { ...params }) -> SiteInfoDeleteResponse</code> |
| 5069 | - <code title="get /accounts/{account_id}/rum/site_info/{site_id}">client.rum.siteInfos.<a href="./src/resources/rum/site-infos.ts">get</a>(siteId, { ...params }) -> RUMSite</code> |
| 5070 | |
| 5071 | ## Rules |
| 5072 | |
| 5073 | Types: |
| 5074 | |
| 5075 | - <code><a href="./src/resources/rum/rules.ts">RUMRule</a></code> |
| 5076 | - <code><a href="./src/resources/rum/rules.ts">RuleListResponse</a></code> |
| 5077 | - <code><a href="./src/resources/rum/rules.ts">RuleDeleteResponse</a></code> |
| 5078 | |
| 5079 | Methods: |
| 5080 | |
| 5081 | - <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> |
| 5082 | - <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> |
| 5083 | - <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> |
| 5084 | - <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> |
| 5085 | |
| 5086 | # Vectorize |
| 5087 | |
| 5088 | ## Indexes |
| 5089 | |
| 5090 | Types: |
| 5091 | |
| 5092 | - <code><a href="./src/resources/vectorize/indexes.ts">VectorizeCreateIndex</a></code> |
| 5093 | - <code><a href="./src/resources/vectorize/indexes.ts">VectorizeIndexDeleteVectorsByID</a></code> |
| 5094 | - <code><a href="./src/resources/vectorize/indexes.ts">VectorizeIndexInsert</a></code> |
| 5095 | - <code><a href="./src/resources/vectorize/indexes.ts">VectorizeIndexQuery</a></code> |
| 5096 | - <code><a href="./src/resources/vectorize/indexes.ts">VectorizeIndexUpsert</a></code> |
| 5097 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexListResponse</a></code> |
| 5098 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexDeleteResponse</a></code> |
| 5099 | - <code><a href="./src/resources/vectorize/indexes.ts">IndexGetByIDsResponse</a></code> |
| 5100 | |
| 5101 | Methods: |
| 5102 | |
| 5103 | - <code title="post /accounts/{account_identifier}/vectorize/indexes">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">create</a>(accountIdentifier, { ...params }) -> VectorizeCreateIndex | null</code> |
| 5104 | - <code title="put /accounts/{account_identifier}/vectorize/indexes/{index_name}">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">update</a>(accountIdentifier, indexName, { ...params }) -> VectorizeCreateIndex | null</code> |
| 5105 | - <code title="get /accounts/{account_identifier}/vectorize/indexes">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">list</a>(accountIdentifier) -> IndexListResponse</code> |
| 5106 | - <code title="delete /accounts/{account_identifier}/vectorize/indexes/{index_name}">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">delete</a>(accountIdentifier, indexName) -> IndexDeleteResponse | null</code> |
| 5107 | - <code title="post /accounts/{account_identifier}/vectorize/indexes/{index_name}/delete-by-ids">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">deleteByIds</a>(accountIdentifier, indexName, { ...params }) -> VectorizeIndexDeleteVectorsByID | null</code> |
| 5108 | - <code title="get /accounts/{account_identifier}/vectorize/indexes/{index_name}">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">get</a>(accountIdentifier, indexName) -> VectorizeCreateIndex | null</code> |
| 5109 | - <code title="post /accounts/{account_identifier}/vectorize/indexes/{index_name}/get-by-ids">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">getByIds</a>(accountIdentifier, indexName, { ...params }) -> IndexGetByIDsResponse | null</code> |
| 5110 | - <code title="post /accounts/{account_identifier}/vectorize/indexes/{index_name}/insert">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">insert</a>(accountIdentifier, indexName) -> VectorizeIndexInsert | null</code> |
| 5111 | - <code title="post /accounts/{account_identifier}/vectorize/indexes/{index_name}/query">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">query</a>(accountIdentifier, indexName, { ...params }) -> VectorizeIndexQuery | null</code> |
| 5112 | - <code title="post /accounts/{account_identifier}/vectorize/indexes/{index_name}/upsert">client.vectorize.indexes.<a href="./src/resources/vectorize/indexes.ts">upsert</a>(accountIdentifier, indexName) -> VectorizeIndexUpsert | null</code> |
| 5113 | |
| 5114 | # URLScanner |
| 5115 | |
| 5116 | Types: |
| 5117 | |
| 5118 | - <code><a href="./src/resources/url-scanner/url-scanner.ts">URLScannerScanResponse</a></code> |
| 5119 | |
| 5120 | Methods: |
| 5121 | |
| 5122 | - <code title="get /accounts/{accountId}/urlscanner/scan">client.urlScanner.<a href="./src/resources/url-scanner/url-scanner.ts">scan</a>(accountId, { ...params }) -> URLScannerScanResponse</code> |
| 5123 | |
| 5124 | ## Scans |
| 5125 | |
| 5126 | Types: |
| 5127 | |
| 5128 | - <code><a href="./src/resources/url-scanner/scans.ts">ScanCreateResponse</a></code> |
| 5129 | - <code><a href="./src/resources/url-scanner/scans.ts">ScanGetResponse</a></code> |
| 5130 | - <code><a href="./src/resources/url-scanner/scans.ts">ScanHarResponse</a></code> |
| 5131 | |
| 5132 | Methods: |
| 5133 | |
| 5134 | - <code title="post /accounts/{accountId}/urlscanner/scan">client.urlScanner.scans.<a href="./src/resources/url-scanner/scans.ts">create</a>(accountId, { ...params }) -> ScanCreateResponse</code> |
| 5135 | - <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> |
| 5136 | - <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> |
| 5137 | - <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> |
| 5138 | |
| 5139 | # Radar |
| 5140 | |
| 5141 | ## Annotations |
| 5142 | |
| 5143 | ### Outages |
| 5144 | |
| 5145 | Types: |
| 5146 | |
| 5147 | - <code><a href="./src/resources/radar/annotations/outages.ts">OutageGetResponse</a></code> |
| 5148 | - <code><a href="./src/resources/radar/annotations/outages.ts">OutageLocationsResponse</a></code> |
| 5149 | |
| 5150 | Methods: |
| 5151 | |
| 5152 | - <code title="get /radar/annotations/outages">client.radar.annotations.outages.<a href="./src/resources/radar/annotations/outages.ts">get</a>({ ...params }) -> OutageGetResponse</code> |
| 5153 | - <code title="get /radar/annotations/outages/locations">client.radar.annotations.outages.<a href="./src/resources/radar/annotations/outages.ts">locations</a>({ ...params }) -> OutageLocationsResponse</code> |
| 5154 | |
| 5155 | ## BGP |
| 5156 | |
| 5157 | Types: |
| 5158 | |
| 5159 | - <code><a href="./src/resources/radar/bgp/bgp.ts">BGPTimeseriesResponse</a></code> |
| 5160 | |
| 5161 | Methods: |
| 5162 | |
| 5163 | - <code title="get /radar/bgp/timeseries">client.radar.bgp.<a href="./src/resources/radar/bgp/bgp.ts">timeseries</a>({ ...params }) -> BGPTimeseriesResponse</code> |
| 5164 | |
| 5165 | ### Leaks |
| 5166 | |
| 5167 | Types: |
| 5168 | |
| 5169 | - <code><a href="./src/resources/radar/bgp/leaks.ts">LeakEventsResponse</a></code> |
| 5170 | |
| 5171 | Methods: |
| 5172 | |
| 5173 | - <code title="get /radar/bgp/leaks/events">client.radar.bgp.leaks.<a href="./src/resources/radar/bgp/leaks.ts">events</a>({ ...params }) -> LeakEventsResponse</code> |
| 5174 | |
| 5175 | ### Top |
| 5176 | |
| 5177 | Types: |
| 5178 | |
| 5179 | - <code><a href="./src/resources/radar/bgp/top/top.ts">TopPrefixesResponse</a></code> |
| 5180 | |
| 5181 | Methods: |
| 5182 | |
| 5183 | - <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> |
| 5184 | |
| 5185 | #### Ases |
| 5186 | |
| 5187 | Types: |
| 5188 | |
| 5189 | - <code><a href="./src/resources/radar/bgp/top/ases.ts">AseGetResponse</a></code> |
| 5190 | - <code><a href="./src/resources/radar/bgp/top/ases.ts">AsePrefixesResponse</a></code> |
| 5191 | |
| 5192 | Methods: |
| 5193 | |
| 5194 | - <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> |
| 5195 | - <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> |
| 5196 | |
| 5197 | ### Hijacks |
| 5198 | |
| 5199 | Types: |
| 5200 | |
| 5201 | - <code><a href="./src/resources/radar/bgp/hijacks.ts">HijackEventsResponse</a></code> |
| 5202 | |
| 5203 | Methods: |
| 5204 | |
| 5205 | - <code title="get /radar/bgp/hijacks/events">client.radar.bgp.hijacks.<a href="./src/resources/radar/bgp/hijacks.ts">events</a>({ ...params }) -> HijackEventsResponse</code> |
| 5206 | |
| 5207 | ### Routes |
| 5208 | |
| 5209 | Types: |
| 5210 | |
| 5211 | - <code><a href="./src/resources/radar/bgp/routes.ts">RouteMoasResponse</a></code> |
| 5212 | - <code><a href="./src/resources/radar/bgp/routes.ts">RoutePfx2asResponse</a></code> |
| 5213 | - <code><a href="./src/resources/radar/bgp/routes.ts">RouteStatsResponse</a></code> |
| 5214 | - <code><a href="./src/resources/radar/bgp/routes.ts">RouteTimeseriesResponse</a></code> |
| 5215 | |
| 5216 | Methods: |
| 5217 | |
| 5218 | - <code title="get /radar/bgp/routes/moas">client.radar.bgp.routes.<a href="./src/resources/radar/bgp/routes.ts">moas</a>({ ...params }) -> RouteMoasResponse</code> |
| 5219 | - <code title="get /radar/bgp/routes/pfx2as">client.radar.bgp.routes.<a href="./src/resources/radar/bgp/routes.ts">pfx2as</a>({ ...params }) -> RoutePfx2asResponse</code> |
| 5220 | - <code title="get /radar/bgp/routes/stats">client.radar.bgp.routes.<a href="./src/resources/radar/bgp/routes.ts">stats</a>({ ...params }) -> RouteStatsResponse</code> |
| 5221 | - <code title="get /radar/bgp/routes/timeseries">client.radar.bgp.routes.<a href="./src/resources/radar/bgp/routes.ts">timeseries</a>({ ...params }) -> RouteTimeseriesResponse</code> |
| 5222 | |
| 5223 | ## Datasets |
| 5224 | |
| 5225 | Types: |
| 5226 | |
| 5227 | - <code><a href="./src/resources/radar/datasets.ts">DatasetListResponse</a></code> |
| 5228 | - <code><a href="./src/resources/radar/datasets.ts">DatasetDownloadResponse</a></code> |
| 5229 | - <code><a href="./src/resources/radar/datasets.ts">DatasetGetResponse</a></code> |
| 5230 | |
| 5231 | Methods: |
| 5232 | |
| 5233 | - <code title="get /radar/datasets">client.radar.datasets.<a href="./src/resources/radar/datasets.ts">list</a>({ ...params }) -> DatasetListResponse</code> |
| 5234 | - <code title="post /radar/datasets/download">client.radar.datasets.<a href="./src/resources/radar/datasets.ts">download</a>({ ...params }) -> DatasetDownloadResponse</code> |
| 5235 | - <code title="get /radar/datasets/{alias}">client.radar.datasets.<a href="./src/resources/radar/datasets.ts">get</a>(alias, { ...params }) -> string</code> |
| 5236 | |
| 5237 | ## DNS |
| 5238 | |
| 5239 | ### Top |
| 5240 | |
| 5241 | Types: |
| 5242 | |
| 5243 | - <code><a href="./src/resources/radar/dns/top.ts">TopAsesResponse</a></code> |
| 5244 | - <code><a href="./src/resources/radar/dns/top.ts">TopLocationsResponse</a></code> |
| 5245 | |
| 5246 | Methods: |
| 5247 | |
| 5248 | - <code title="get /radar/dns/top/ases">client.radar.dns.top.<a href="./src/resources/radar/dns/top.ts">ases</a>({ ...params }) -> TopAsesResponse</code> |
| 5249 | - <code title="get /radar/dns/top/locations">client.radar.dns.top.<a href="./src/resources/radar/dns/top.ts">locations</a>({ ...params }) -> TopLocationsResponse</code> |
| 5250 | |
| 5251 | ## Netflows |
| 5252 | |
| 5253 | Types: |
| 5254 | |
| 5255 | - <code><a href="./src/resources/radar/netflows/netflows.ts">NetflowTimeseriesResponse</a></code> |
| 5256 | |
| 5257 | Methods: |
| 5258 | |
| 5259 | - <code title="get /radar/netflows/timeseries">client.radar.netflows.<a href="./src/resources/radar/netflows/netflows.ts">timeseries</a>({ ...params }) -> NetflowTimeseriesResponse</code> |
| 5260 | |
| 5261 | ### Top |
| 5262 | |
| 5263 | Types: |
| 5264 | |
| 5265 | - <code><a href="./src/resources/radar/netflows/top.ts">TopAsesResponse</a></code> |
| 5266 | - <code><a href="./src/resources/radar/netflows/top.ts">TopLocationsResponse</a></code> |
| 5267 | |
| 5268 | Methods: |
| 5269 | |
| 5270 | - <code title="get /radar/netflows/top/ases">client.radar.netflows.top.<a href="./src/resources/radar/netflows/top.ts">ases</a>({ ...params }) -> TopAsesResponse</code> |
| 5271 | - <code title="get /radar/netflows/top/locations">client.radar.netflows.top.<a href="./src/resources/radar/netflows/top.ts">locations</a>({ ...params }) -> TopLocationsResponse</code> |
| 5272 | |
| 5273 | ## Search |
| 5274 | |
| 5275 | Types: |
| 5276 | |
| 5277 | - <code><a href="./src/resources/radar/search.ts">SearchGlobalResponse</a></code> |
| 5278 | |
| 5279 | Methods: |
| 5280 | |
| 5281 | - <code title="get /radar/search/global">client.radar.search.<a href="./src/resources/radar/search.ts">global</a>({ ...params }) -> SearchGlobalResponse</code> |
| 5282 | |
| 5283 | ## VerifiedBots |
| 5284 | |
| 5285 | ### Top |
| 5286 | |
| 5287 | Types: |
| 5288 | |
| 5289 | - <code><a href="./src/resources/radar/verified-bots/top.ts">TopBotsResponse</a></code> |
| 5290 | - <code><a href="./src/resources/radar/verified-bots/top.ts">TopCategoriesResponse</a></code> |
| 5291 | |
| 5292 | Methods: |
| 5293 | |
| 5294 | - <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> |
| 5295 | - <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> |
| 5296 | |
| 5297 | ## AS112 |
| 5298 | |
| 5299 | Types: |
| 5300 | |
| 5301 | - <code><a href="./src/resources/radar/as112/as112.ts">AS112TimeseriesResponse</a></code> |
| 5302 | |
| 5303 | Methods: |
| 5304 | |
| 5305 | - <code title="get /radar/as112/timeseries">client.radar.as112.<a href="./src/resources/radar/as112/as112.ts">timeseries</a>({ ...params }) -> AS112TimeseriesResponse</code> |
| 5306 | |
| 5307 | ### Summary |
| 5308 | |
| 5309 | Types: |
| 5310 | |
| 5311 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryDNSSECResponse</a></code> |
| 5312 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryEdnsResponse</a></code> |
| 5313 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryIPVersionResponse</a></code> |
| 5314 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryProtocolResponse</a></code> |
| 5315 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryQueryTypeResponse</a></code> |
| 5316 | - <code><a href="./src/resources/radar/as112/summary.ts">SummaryResponseCodesResponse</a></code> |
| 5317 | |
| 5318 | Methods: |
| 5319 | |
| 5320 | - <code title="get /radar/as112/summary/dnssec">client.radar.as112.summary.<a href="./src/resources/radar/as112/summary.ts">dnssec</a>({ ...params }) -> SummaryDNSSECResponse</code> |
| 5321 | - <code title="get /radar/as112/summary/edns">client.radar.as112.summary.<a href="./src/resources/radar/as112/summary.ts">edns</a>({ ...params }) -> SummaryEdnsResponse</code> |
| 5322 | - <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> |
| 5323 | - <code title="get /radar/as112/summary/protocol">client.radar.as112.summary.<a href="./src/resources/radar/as112/summary.ts">protocol</a>({ ...params }) -> SummaryProtocolResponse</code> |
| 5324 | - <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> |
| 5325 | - <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> |
| 5326 | |
| 5327 | ### TimeseriesGroups |
| 5328 | |
| 5329 | Types: |
| 5330 | |
| 5331 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupDNSSECResponse</a></code> |
| 5332 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupEdnsResponse</a></code> |
| 5333 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 5334 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupProtocolResponse</a></code> |
| 5335 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupQueryTypeResponse</a></code> |
| 5336 | - <code><a href="./src/resources/radar/as112/timeseries-groups.ts">TimeseriesGroupResponseCodesResponse</a></code> |
| 5337 | |
| 5338 | Methods: |
| 5339 | |
| 5340 | - <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> |
| 5341 | - <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> |
| 5342 | - <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> |
| 5343 | - <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> |
| 5344 | - <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> |
| 5345 | - <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> |
| 5346 | |
| 5347 | ### Top |
| 5348 | |
| 5349 | Types: |
| 5350 | |
| 5351 | - <code><a href="./src/resources/radar/as112/top.ts">TopDNSSECResponse</a></code> |
| 5352 | - <code><a href="./src/resources/radar/as112/top.ts">TopEdnsResponse</a></code> |
| 5353 | - <code><a href="./src/resources/radar/as112/top.ts">TopIPVersionResponse</a></code> |
| 5354 | - <code><a href="./src/resources/radar/as112/top.ts">TopLocationsResponse</a></code> |
| 5355 | |
| 5356 | Methods: |
| 5357 | |
| 5358 | - <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> |
| 5359 | - <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> |
| 5360 | - <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> |
| 5361 | - <code title="get /radar/as112/top/locations">client.radar.as112.top.<a href="./src/resources/radar/as112/top.ts">locations</a>({ ...params }) -> TopLocationsResponse</code> |
| 5362 | |
| 5363 | ## ConnectionTampering |
| 5364 | |
| 5365 | Types: |
| 5366 | |
| 5367 | - <code><a href="./src/resources/radar/connection-tampering.ts">ConnectionTamperingSummaryResponse</a></code> |
| 5368 | - <code><a href="./src/resources/radar/connection-tampering.ts">ConnectionTamperingTimeseriesGroupsResponse</a></code> |
| 5369 | |
| 5370 | Methods: |
| 5371 | |
| 5372 | - <code title="get /radar/connection_tampering/summary">client.radar.connectionTampering.<a href="./src/resources/radar/connection-tampering.ts">summary</a>({ ...params }) -> ConnectionTamperingSummaryResponse</code> |
| 5373 | - <code title="get /radar/connection_tampering/timeseries_groups">client.radar.connectionTampering.<a href="./src/resources/radar/connection-tampering.ts">timeseriesGroups</a>({ ...params }) -> ConnectionTamperingTimeseriesGroupsResponse</code> |
| 5374 | |
| 5375 | ## Email |
| 5376 | |
| 5377 | ### Routing |
| 5378 | |
| 5379 | #### Summary |
| 5380 | |
| 5381 | Types: |
| 5382 | |
| 5383 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryARCResponse</a></code> |
| 5384 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryDKIMResponse</a></code> |
| 5385 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryDMARCResponse</a></code> |
| 5386 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryEncryptedResponse</a></code> |
| 5387 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummaryIPVersionResponse</a></code> |
| 5388 | - <code><a href="./src/resources/radar/email/routing/summary.ts">SummarySPFResponse</a></code> |
| 5389 | |
| 5390 | Methods: |
| 5391 | |
| 5392 | - <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> |
| 5393 | - <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> |
| 5394 | - <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> |
| 5395 | - <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> |
| 5396 | - <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> |
| 5397 | - <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> |
| 5398 | |
| 5399 | #### TimeseriesGroups |
| 5400 | |
| 5401 | Types: |
| 5402 | |
| 5403 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupARCResponse</a></code> |
| 5404 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupDKIMResponse</a></code> |
| 5405 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupDMARCResponse</a></code> |
| 5406 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupEncryptedResponse</a></code> |
| 5407 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 5408 | - <code><a href="./src/resources/radar/email/routing/timeseries-groups.ts">TimeseriesGroupSPFResponse</a></code> |
| 5409 | |
| 5410 | Methods: |
| 5411 | |
| 5412 | - <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> |
| 5413 | - <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> |
| 5414 | - <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> |
| 5415 | - <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> |
| 5416 | - <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> |
| 5417 | - <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> |
| 5418 | |
| 5419 | ### Security |
| 5420 | |
| 5421 | #### Top |
| 5422 | |
| 5423 | ##### Tlds |
| 5424 | |
| 5425 | Types: |
| 5426 | |
| 5427 | - <code><a href="./src/resources/radar/email/security/top/tlds/tlds.ts">TldGetResponse</a></code> |
| 5428 | |
| 5429 | Methods: |
| 5430 | |
| 5431 | - <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> |
| 5432 | |
| 5433 | ###### Malicious |
| 5434 | |
| 5435 | Types: |
| 5436 | |
| 5437 | - <code><a href="./src/resources/radar/email/security/top/tlds/malicious.ts">MaliciousGetResponse</a></code> |
| 5438 | |
| 5439 | Methods: |
| 5440 | |
| 5441 | - <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> |
| 5442 | |
| 5443 | ###### Spam |
| 5444 | |
| 5445 | Types: |
| 5446 | |
| 5447 | - <code><a href="./src/resources/radar/email/security/top/tlds/spam.ts">SpamGetResponse</a></code> |
| 5448 | |
| 5449 | Methods: |
| 5450 | |
| 5451 | - <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> |
| 5452 | |
| 5453 | ###### Spoof |
| 5454 | |
| 5455 | Types: |
| 5456 | |
| 5457 | - <code><a href="./src/resources/radar/email/security/top/tlds/spoof.ts">SpoofGetResponse</a></code> |
| 5458 | |
| 5459 | Methods: |
| 5460 | |
| 5461 | - <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> |
| 5462 | |
| 5463 | #### Summary |
| 5464 | |
| 5465 | Types: |
| 5466 | |
| 5467 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryARCResponse</a></code> |
| 5468 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryDKIMResponse</a></code> |
| 5469 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryDMARCResponse</a></code> |
| 5470 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryMaliciousResponse</a></code> |
| 5471 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummarySpamResponse</a></code> |
| 5472 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummarySPFResponse</a></code> |
| 5473 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummarySpoofResponse</a></code> |
| 5474 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryThreatCategoryResponse</a></code> |
| 5475 | - <code><a href="./src/resources/radar/email/security/summary.ts">SummaryTLSVersionResponse</a></code> |
| 5476 | |
| 5477 | Methods: |
| 5478 | |
| 5479 | - <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> |
| 5480 | - <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> |
| 5481 | - <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> |
| 5482 | - <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> |
| 5483 | - <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> |
| 5484 | - <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> |
| 5485 | - <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> |
| 5486 | - <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> |
| 5487 | - <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> |
| 5488 | |
| 5489 | #### TimeseriesGroups |
| 5490 | |
| 5491 | Types: |
| 5492 | |
| 5493 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupARCResponse</a></code> |
| 5494 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupDKIMResponse</a></code> |
| 5495 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupDMARCResponse</a></code> |
| 5496 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupMaliciousResponse</a></code> |
| 5497 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupSpamResponse</a></code> |
| 5498 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupSPFResponse</a></code> |
| 5499 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupSpoofResponse</a></code> |
| 5500 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupThreatCategoryResponse</a></code> |
| 5501 | - <code><a href="./src/resources/radar/email/security/timeseries-groups.ts">TimeseriesGroupTLSVersionResponse</a></code> |
| 5502 | |
| 5503 | Methods: |
| 5504 | |
| 5505 | - <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> |
| 5506 | - <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> |
| 5507 | - <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> |
| 5508 | - <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> |
| 5509 | - <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> |
| 5510 | - <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> |
| 5511 | - <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> |
| 5512 | - <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> |
| 5513 | - <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> |
| 5514 | |
| 5515 | ## Attacks |
| 5516 | |
| 5517 | ### Layer3 |
| 5518 | |
| 5519 | Types: |
| 5520 | |
| 5521 | - <code><a href="./src/resources/radar/attacks/layer3/layer3.ts">Layer3TimeseriesResponse</a></code> |
| 5522 | |
| 5523 | Methods: |
| 5524 | |
| 5525 | - <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> |
| 5526 | |
| 5527 | #### Summary |
| 5528 | |
| 5529 | Types: |
| 5530 | |
| 5531 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryBitrateResponse</a></code> |
| 5532 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryDurationResponse</a></code> |
| 5533 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryGetResponse</a></code> |
| 5534 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryIPVersionResponse</a></code> |
| 5535 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryProtocolResponse</a></code> |
| 5536 | - <code><a href="./src/resources/radar/attacks/layer3/summary.ts">SummaryVectorResponse</a></code> |
| 5537 | |
| 5538 | Methods: |
| 5539 | |
| 5540 | - <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> |
| 5541 | - <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> |
| 5542 | - <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> |
| 5543 | - <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> |
| 5544 | - <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> |
| 5545 | - <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> |
| 5546 | |
| 5547 | #### TimeseriesGroups |
| 5548 | |
| 5549 | Types: |
| 5550 | |
| 5551 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupBitrateResponse</a></code> |
| 5552 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupDurationResponse</a></code> |
| 5553 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupGetResponse</a></code> |
| 5554 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupIndustryResponse</a></code> |
| 5555 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 5556 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupProtocolResponse</a></code> |
| 5557 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupVectorResponse</a></code> |
| 5558 | - <code><a href="./src/resources/radar/attacks/layer3/timeseries-groups.ts">TimeseriesGroupVerticalResponse</a></code> |
| 5559 | |
| 5560 | Methods: |
| 5561 | |
| 5562 | - <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> |
| 5563 | - <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> |
| 5564 | - <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> |
| 5565 | - <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> |
| 5566 | - <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> |
| 5567 | - <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> |
| 5568 | - <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> |
| 5569 | - <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> |
| 5570 | |
| 5571 | #### Top |
| 5572 | |
| 5573 | Types: |
| 5574 | |
| 5575 | - <code><a href="./src/resources/radar/attacks/layer3/top/top.ts">TopAttacksResponse</a></code> |
| 5576 | - <code><a href="./src/resources/radar/attacks/layer3/top/top.ts">TopIndustryResponse</a></code> |
| 5577 | - <code><a href="./src/resources/radar/attacks/layer3/top/top.ts">TopVerticalResponse</a></code> |
| 5578 | |
| 5579 | Methods: |
| 5580 | |
| 5581 | - <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> |
| 5582 | - <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> |
| 5583 | - <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> |
| 5584 | |
| 5585 | ##### Locations |
| 5586 | |
| 5587 | Types: |
| 5588 | |
| 5589 | - <code><a href="./src/resources/radar/attacks/layer3/top/locations.ts">LocationOriginResponse</a></code> |
| 5590 | - <code><a href="./src/resources/radar/attacks/layer3/top/locations.ts">LocationTargetResponse</a></code> |
| 5591 | |
| 5592 | Methods: |
| 5593 | |
| 5594 | - <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> |
| 5595 | - <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> |
| 5596 | |
| 5597 | ### Layer7 |
| 5598 | |
| 5599 | Types: |
| 5600 | |
| 5601 | - <code><a href="./src/resources/radar/attacks/layer7/layer7.ts">Layer7TimeseriesResponse</a></code> |
| 5602 | |
| 5603 | Methods: |
| 5604 | |
| 5605 | - <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> |
| 5606 | |
| 5607 | #### Summary |
| 5608 | |
| 5609 | Types: |
| 5610 | |
| 5611 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryGetResponse</a></code> |
| 5612 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryHTTPMethodResponse</a></code> |
| 5613 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryHTTPVersionResponse</a></code> |
| 5614 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryIPVersionResponse</a></code> |
| 5615 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryManagedRulesResponse</a></code> |
| 5616 | - <code><a href="./src/resources/radar/attacks/layer7/summary.ts">SummaryMitigationProductResponse</a></code> |
| 5617 | |
| 5618 | Methods: |
| 5619 | |
| 5620 | - <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> |
| 5621 | - <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> |
| 5622 | - <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> |
| 5623 | - <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> |
| 5624 | - <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> |
| 5625 | - <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> |
| 5626 | |
| 5627 | #### TimeseriesGroups |
| 5628 | |
| 5629 | Types: |
| 5630 | |
| 5631 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupGetResponse</a></code> |
| 5632 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupHTTPMethodResponse</a></code> |
| 5633 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupHTTPVersionResponse</a></code> |
| 5634 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupIndustryResponse</a></code> |
| 5635 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 5636 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupManagedRulesResponse</a></code> |
| 5637 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupMitigationProductResponse</a></code> |
| 5638 | - <code><a href="./src/resources/radar/attacks/layer7/timeseries-groups.ts">TimeseriesGroupVerticalResponse</a></code> |
| 5639 | |
| 5640 | Methods: |
| 5641 | |
| 5642 | - <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> |
| 5643 | - <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> |
| 5644 | - <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> |
| 5645 | - <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> |
| 5646 | - <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> |
| 5647 | - <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> |
| 5648 | - <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> |
| 5649 | - <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> |
| 5650 | |
| 5651 | #### Top |
| 5652 | |
| 5653 | Types: |
| 5654 | |
| 5655 | - <code><a href="./src/resources/radar/attacks/layer7/top/top.ts">TopAttacksResponse</a></code> |
| 5656 | - <code><a href="./src/resources/radar/attacks/layer7/top/top.ts">TopIndustryResponse</a></code> |
| 5657 | - <code><a href="./src/resources/radar/attacks/layer7/top/top.ts">TopVerticalResponse</a></code> |
| 5658 | |
| 5659 | Methods: |
| 5660 | |
| 5661 | - <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> |
| 5662 | - <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> |
| 5663 | - <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> |
| 5664 | |
| 5665 | ##### Locations |
| 5666 | |
| 5667 | Types: |
| 5668 | |
| 5669 | - <code><a href="./src/resources/radar/attacks/layer7/top/locations.ts">LocationOriginResponse</a></code> |
| 5670 | - <code><a href="./src/resources/radar/attacks/layer7/top/locations.ts">LocationTargetResponse</a></code> |
| 5671 | |
| 5672 | Methods: |
| 5673 | |
| 5674 | - <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> |
| 5675 | - <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> |
| 5676 | |
| 5677 | ##### Ases |
| 5678 | |
| 5679 | Types: |
| 5680 | |
| 5681 | - <code><a href="./src/resources/radar/attacks/layer7/top/ases.ts">AseOriginResponse</a></code> |
| 5682 | |
| 5683 | Methods: |
| 5684 | |
| 5685 | - <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> |
| 5686 | |
| 5687 | ## Entities |
| 5688 | |
| 5689 | Types: |
| 5690 | |
| 5691 | - <code><a href="./src/resources/radar/entities/entities.ts">EntityGetResponse</a></code> |
| 5692 | |
| 5693 | Methods: |
| 5694 | |
| 5695 | - <code title="get /radar/entities/ip">client.radar.entities.<a href="./src/resources/radar/entities/entities.ts">get</a>({ ...params }) -> EntityGetResponse</code> |
| 5696 | |
| 5697 | ### ASNs |
| 5698 | |
| 5699 | Types: |
| 5700 | |
| 5701 | - <code><a href="./src/resources/radar/entities/asns.ts">ASNListResponse</a></code> |
| 5702 | - <code><a href="./src/resources/radar/entities/asns.ts">ASNGetResponse</a></code> |
| 5703 | - <code><a href="./src/resources/radar/entities/asns.ts">ASNIPResponse</a></code> |
| 5704 | - <code><a href="./src/resources/radar/entities/asns.ts">ASNRelResponse</a></code> |
| 5705 | |
| 5706 | Methods: |
| 5707 | |
| 5708 | - <code title="get /radar/entities/asns">client.radar.entities.asns.<a href="./src/resources/radar/entities/asns.ts">list</a>({ ...params }) -> ASNListResponse</code> |
| 5709 | - <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> |
| 5710 | - <code title="get /radar/entities/asns/ip">client.radar.entities.asns.<a href="./src/resources/radar/entities/asns.ts">ip</a>({ ...params }) -> ASNIPResponse</code> |
| 5711 | - <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> |
| 5712 | |
| 5713 | ### Locations |
| 5714 | |
| 5715 | Types: |
| 5716 | |
| 5717 | - <code><a href="./src/resources/radar/entities/locations.ts">LocationListResponse</a></code> |
| 5718 | - <code><a href="./src/resources/radar/entities/locations.ts">LocationGetResponse</a></code> |
| 5719 | |
| 5720 | Methods: |
| 5721 | |
| 5722 | - <code title="get /radar/entities/locations">client.radar.entities.locations.<a href="./src/resources/radar/entities/locations.ts">list</a>({ ...params }) -> LocationListResponse</code> |
| 5723 | - <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> |
| 5724 | |
| 5725 | ## HTTP |
| 5726 | |
| 5727 | ### Top |
| 5728 | |
| 5729 | Types: |
| 5730 | |
| 5731 | - <code><a href="./src/resources/radar/http/top.ts">TopBrowserFamiliesResponse</a></code> |
| 5732 | - <code><a href="./src/resources/radar/http/top.ts">TopBrowsersResponse</a></code> |
| 5733 | |
| 5734 | Methods: |
| 5735 | |
| 5736 | - <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> |
| 5737 | - <code title="get /radar/http/top/browsers">client.radar.http.top.<a href="./src/resources/radar/http/top.ts">browsers</a>({ ...params }) -> TopBrowsersResponse</code> |
| 5738 | |
| 5739 | ### Locations |
| 5740 | |
| 5741 | Types: |
| 5742 | |
| 5743 | - <code><a href="./src/resources/radar/http/locations/locations.ts">LocationGetResponse</a></code> |
| 5744 | |
| 5745 | Methods: |
| 5746 | |
| 5747 | - <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> |
| 5748 | |
| 5749 | #### BotClass |
| 5750 | |
| 5751 | Types: |
| 5752 | |
| 5753 | - <code><a href="./src/resources/radar/http/locations/bot-class.ts">BotClassGetResponse</a></code> |
| 5754 | |
| 5755 | Methods: |
| 5756 | |
| 5757 | - <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> |
| 5758 | |
| 5759 | #### DeviceType |
| 5760 | |
| 5761 | Types: |
| 5762 | |
| 5763 | - <code><a href="./src/resources/radar/http/locations/device-type.ts">DeviceTypeGetResponse</a></code> |
| 5764 | |
| 5765 | Methods: |
| 5766 | |
| 5767 | - <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> |
| 5768 | |
| 5769 | #### HTTPProtocol |
| 5770 | |
| 5771 | Types: |
| 5772 | |
| 5773 | - <code><a href="./src/resources/radar/http/locations/http-protocol.ts">HTTPProtocolGetResponse</a></code> |
| 5774 | |
| 5775 | Methods: |
| 5776 | |
| 5777 | - <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> |
| 5778 | |
| 5779 | #### HTTPMethod |
| 5780 | |
| 5781 | Types: |
| 5782 | |
| 5783 | - <code><a href="./src/resources/radar/http/locations/http-method.ts">HTTPMethodGetResponse</a></code> |
| 5784 | |
| 5785 | Methods: |
| 5786 | |
| 5787 | - <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> |
| 5788 | |
| 5789 | #### IPVersion |
| 5790 | |
| 5791 | Types: |
| 5792 | |
| 5793 | - <code><a href="./src/resources/radar/http/locations/ip-version.ts">IPVersionGetResponse</a></code> |
| 5794 | |
| 5795 | Methods: |
| 5796 | |
| 5797 | - <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> |
| 5798 | |
| 5799 | #### OS |
| 5800 | |
| 5801 | Types: |
| 5802 | |
| 5803 | - <code><a href="./src/resources/radar/http/locations/os.ts">OSGetResponse</a></code> |
| 5804 | |
| 5805 | Methods: |
| 5806 | |
| 5807 | - <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> |
| 5808 | |
| 5809 | #### TLSVersion |
| 5810 | |
| 5811 | Types: |
| 5812 | |
| 5813 | - <code><a href="./src/resources/radar/http/locations/tls-version.ts">TLSVersionGetResponse</a></code> |
| 5814 | |
| 5815 | Methods: |
| 5816 | |
| 5817 | - <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> |
| 5818 | |
| 5819 | ### Ases |
| 5820 | |
| 5821 | Types: |
| 5822 | |
| 5823 | - <code><a href="./src/resources/radar/http/ases/ases.ts">AseGetResponse</a></code> |
| 5824 | |
| 5825 | Methods: |
| 5826 | |
| 5827 | - <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> |
| 5828 | |
| 5829 | #### BotClass |
| 5830 | |
| 5831 | Types: |
| 5832 | |
| 5833 | - <code><a href="./src/resources/radar/http/ases/bot-class.ts">BotClassGetResponse</a></code> |
| 5834 | |
| 5835 | Methods: |
| 5836 | |
| 5837 | - <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> |
| 5838 | |
| 5839 | #### DeviceType |
| 5840 | |
| 5841 | Types: |
| 5842 | |
| 5843 | - <code><a href="./src/resources/radar/http/ases/device-type.ts">DeviceTypeGetResponse</a></code> |
| 5844 | |
| 5845 | Methods: |
| 5846 | |
| 5847 | - <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> |
| 5848 | |
| 5849 | #### HTTPProtocol |
| 5850 | |
| 5851 | Types: |
| 5852 | |
| 5853 | - <code><a href="./src/resources/radar/http/ases/http-protocol.ts">HTTPProtocolGetResponse</a></code> |
| 5854 | |
| 5855 | Methods: |
| 5856 | |
| 5857 | - <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> |
| 5858 | |
| 5859 | #### HTTPMethod |
| 5860 | |
| 5861 | Types: |
| 5862 | |
| 5863 | - <code><a href="./src/resources/radar/http/ases/http-method.ts">HTTPMethodGetResponse</a></code> |
| 5864 | |
| 5865 | Methods: |
| 5866 | |
| 5867 | - <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> |
| 5868 | |
| 5869 | #### IPVersion |
| 5870 | |
| 5871 | Types: |
| 5872 | |
| 5873 | - <code><a href="./src/resources/radar/http/ases/ip-version.ts">IPVersionGetResponse</a></code> |
| 5874 | |
| 5875 | Methods: |
| 5876 | |
| 5877 | - <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> |
| 5878 | |
| 5879 | #### OS |
| 5880 | |
| 5881 | Types: |
| 5882 | |
| 5883 | - <code><a href="./src/resources/radar/http/ases/os.ts">OSGetResponse</a></code> |
| 5884 | |
| 5885 | Methods: |
| 5886 | |
| 5887 | - <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> |
| 5888 | |
| 5889 | #### TLSVersion |
| 5890 | |
| 5891 | Types: |
| 5892 | |
| 5893 | - <code><a href="./src/resources/radar/http/ases/tls-version.ts">TLSVersionGetResponse</a></code> |
| 5894 | |
| 5895 | Methods: |
| 5896 | |
| 5897 | - <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> |
| 5898 | |
| 5899 | ### Summary |
| 5900 | |
| 5901 | Types: |
| 5902 | |
| 5903 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryBotClassResponse</a></code> |
| 5904 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryDeviceTypeResponse</a></code> |
| 5905 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryHTTPProtocolResponse</a></code> |
| 5906 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryHTTPVersionResponse</a></code> |
| 5907 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryIPVersionResponse</a></code> |
| 5908 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryOSResponse</a></code> |
| 5909 | - <code><a href="./src/resources/radar/http/summary.ts">SummaryTLSVersionResponse</a></code> |
| 5910 | |
| 5911 | Methods: |
| 5912 | |
| 5913 | - <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> |
| 5914 | - <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> |
| 5915 | - <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> |
| 5916 | - <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> |
| 5917 | - <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> |
| 5918 | - <code title="get /radar/http/summary/os">client.radar.http.summary.<a href="./src/resources/radar/http/summary.ts">os</a>({ ...params }) -> SummaryOSResponse</code> |
| 5919 | - <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> |
| 5920 | |
| 5921 | ### TimeseriesGroups |
| 5922 | |
| 5923 | Types: |
| 5924 | |
| 5925 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupBotClassResponse</a></code> |
| 5926 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupBrowserResponse</a></code> |
| 5927 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupBrowserFamilyResponse</a></code> |
| 5928 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupDeviceTypeResponse</a></code> |
| 5929 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupHTTPProtocolResponse</a></code> |
| 5930 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupHTTPVersionResponse</a></code> |
| 5931 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupIPVersionResponse</a></code> |
| 5932 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupOSResponse</a></code> |
| 5933 | - <code><a href="./src/resources/radar/http/timeseries-groups.ts">TimeseriesGroupTLSVersionResponse</a></code> |
| 5934 | |
| 5935 | Methods: |
| 5936 | |
| 5937 | - <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> |
| 5938 | - <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> |
| 5939 | - <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> |
| 5940 | - <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> |
| 5941 | - <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> |
| 5942 | - <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> |
| 5943 | - <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> |
| 5944 | - <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> |
| 5945 | - <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> |
| 5946 | |
| 5947 | ## Quality |
| 5948 | |
| 5949 | ### IQI |
| 5950 | |
| 5951 | Types: |
| 5952 | |
| 5953 | - <code><a href="./src/resources/radar/quality/iqi.ts">IQISummaryResponse</a></code> |
| 5954 | - <code><a href="./src/resources/radar/quality/iqi.ts">IQITimeseriesGroupsResponse</a></code> |
| 5955 | |
| 5956 | Methods: |
| 5957 | |
| 5958 | - <code title="get /radar/quality/iqi/summary">client.radar.quality.iqi.<a href="./src/resources/radar/quality/iqi.ts">summary</a>({ ...params }) -> IQISummaryResponse</code> |
| 5959 | - <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> |
| 5960 | |
| 5961 | ### Speed |
| 5962 | |
| 5963 | Types: |
| 5964 | |
| 5965 | - <code><a href="./src/resources/radar/quality/speed/speed.ts">SpeedHistogramResponse</a></code> |
| 5966 | - <code><a href="./src/resources/radar/quality/speed/speed.ts">SpeedSummaryResponse</a></code> |
| 5967 | |
| 5968 | Methods: |
| 5969 | |
| 5970 | - <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> |
| 5971 | - <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> |
| 5972 | |
| 5973 | #### Top |
| 5974 | |
| 5975 | Types: |
| 5976 | |
| 5977 | - <code><a href="./src/resources/radar/quality/speed/top.ts">TopAsesResponse</a></code> |
| 5978 | - <code><a href="./src/resources/radar/quality/speed/top.ts">TopLocationsResponse</a></code> |
| 5979 | |
| 5980 | Methods: |
| 5981 | |
| 5982 | - <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> |
| 5983 | - <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> |
| 5984 | |
| 5985 | ## Ranking |
| 5986 | |
| 5987 | Types: |
| 5988 | |
| 5989 | - <code><a href="./src/resources/radar/ranking/ranking.ts">RankingTimeseriesGroupsResponse</a></code> |
| 5990 | - <code><a href="./src/resources/radar/ranking/ranking.ts">RankingTopResponse</a></code> |
| 5991 | |
| 5992 | Methods: |
| 5993 | |
| 5994 | - <code title="get /radar/ranking/timeseries_groups">client.radar.ranking.<a href="./src/resources/radar/ranking/ranking.ts">timeseriesGroups</a>({ ...params }) -> RankingTimeseriesGroupsResponse</code> |
| 5995 | - <code title="get /radar/ranking/top">client.radar.ranking.<a href="./src/resources/radar/ranking/ranking.ts">top</a>({ ...params }) -> RankingTopResponse</code> |
| 5996 | |
| 5997 | ### Domain |
| 5998 | |
| 5999 | Types: |
| 6000 | |
| 6001 | - <code><a href="./src/resources/radar/ranking/domain.ts">DomainGetResponse</a></code> |
| 6002 | |
| 6003 | Methods: |
| 6004 | |
| 6005 | - <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> |
| 6006 | |
| 6007 | ## TrafficAnomalies |
| 6008 | |
| 6009 | Types: |
| 6010 | |
| 6011 | - <code><a href="./src/resources/radar/traffic-anomalies/traffic-anomalies.ts">TrafficAnomalyGetResponse</a></code> |
| 6012 | |
| 6013 | Methods: |
| 6014 | |
| 6015 | - <code title="get /radar/traffic_anomalies">client.radar.trafficAnomalies.<a href="./src/resources/radar/traffic-anomalies/traffic-anomalies.ts">get</a>({ ...params }) -> TrafficAnomalyGetResponse</code> |
| 6016 | |
| 6017 | ### Locations |
| 6018 | |
| 6019 | Types: |
| 6020 | |
| 6021 | - <code><a href="./src/resources/radar/traffic-anomalies/locations.ts">LocationGetResponse</a></code> |
| 6022 | |
| 6023 | Methods: |
| 6024 | |
| 6025 | - <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> |
| 6026 | |
| 6027 | # BotManagement |
| 6028 | |
| 6029 | Types: |
| 6030 | |
| 6031 | - <code><a href="./src/resources/bot-management.ts">BotManagementUpdateResponse</a></code> |
| 6032 | - <code><a href="./src/resources/bot-management.ts">BotManagementGetResponse</a></code> |
| 6033 | |
| 6034 | Methods: |
| 6035 | |
| 6036 | - <code title="put /zones/{zone_id}/bot_management">client.botManagement.<a href="./src/resources/bot-management.ts">update</a>({ ...params }) -> BotManagementUpdateResponse</code> |
| 6037 | - <code title="get /zones/{zone_id}/bot_management">client.botManagement.<a href="./src/resources/bot-management.ts">get</a>({ ...params }) -> BotManagementGetResponse</code> |
| 6038 | |
| 6039 | # OriginPostQuantumEncryption |
| 6040 | |
| 6041 | Types: |
| 6042 | |
| 6043 | - <code><a href="./src/resources/origin-post-quantum-encryption.ts">OriginPostQuantumEncryptionUpdateResponse</a></code> |
| 6044 | - <code><a href="./src/resources/origin-post-quantum-encryption.ts">OriginPostQuantumEncryptionGetResponse</a></code> |
| 6045 | |
| 6046 | Methods: |
| 6047 | |
| 6048 | - <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> |
| 6049 | - <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> |
| 6050 | |
| 6051 | # Speed |
| 6052 | |
| 6053 | Types: |
| 6054 | |
| 6055 | - <code><a href="./src/resources/speed/speed.ts">ObservatorySchedule</a></code> |
| 6056 | - <code><a href="./src/resources/speed/speed.ts">ObservatoryTrend</a></code> |
| 6057 | - <code><a href="./src/resources/speed/speed.ts">SpeedDeleteResponse</a></code> |
| 6058 | |
| 6059 | Methods: |
| 6060 | |
| 6061 | - <code title="delete /zones/{zone_id}/speed_api/schedule/{url}">client.speed.<a href="./src/resources/speed/speed.ts">delete</a>(url, { ...params }) -> SpeedDeleteResponse</code> |
| 6062 | - <code title="get /zones/{zone_id}/speed_api/schedule/{url}">client.speed.<a href="./src/resources/speed/speed.ts">scheduleGet</a>(url, { ...params }) -> ObservatorySchedule</code> |
| 6063 | - <code title="get /zones/{zone_id}/speed_api/pages/{url}/trend">client.speed.<a href="./src/resources/speed/speed.ts">trendsList</a>(url, { ...params }) -> ObservatoryTrend</code> |
| 6064 | |
| 6065 | ## Tests |
| 6066 | |
| 6067 | Types: |
| 6068 | |
| 6069 | - <code><a href="./src/resources/speed/tests.ts">ObservatoryPageTest</a></code> |
| 6070 | - <code><a href="./src/resources/speed/tests.ts">TestListResponse</a></code> |
| 6071 | - <code><a href="./src/resources/speed/tests.ts">TestDeleteResponse</a></code> |
| 6072 | |
| 6073 | Methods: |
| 6074 | |
| 6075 | - <code title="post /zones/{zone_id}/speed_api/pages/{url}/tests">client.speed.tests.<a href="./src/resources/speed/tests.ts">create</a>(url, { ...params }) -> ObservatoryPageTest</code> |
| 6076 | - <code title="get /zones/{zone_id}/speed_api/pages/{url}/tests">client.speed.tests.<a href="./src/resources/speed/tests.ts">list</a>(url, { ...params }) -> TestListResponse</code> |
| 6077 | - <code title="delete /zones/{zone_id}/speed_api/pages/{url}/tests">client.speed.tests.<a href="./src/resources/speed/tests.ts">delete</a>(url, { ...params }) -> TestDeleteResponse</code> |
| 6078 | - <code title="get /zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}">client.speed.tests.<a href="./src/resources/speed/tests.ts">get</a>(url, testId, { ...params }) -> ObservatoryPageTest</code> |
| 6079 | |
| 6080 | ## Schedule |
| 6081 | |
| 6082 | Types: |
| 6083 | |
| 6084 | - <code><a href="./src/resources/speed/schedule.ts">ScheduleCreateResponse</a></code> |
| 6085 | |
| 6086 | Methods: |
| 6087 | |
| 6088 | - <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> |
| 6089 | |
| 6090 | ## Availabilities |
| 6091 | |
| 6092 | Types: |
| 6093 | |
| 6094 | - <code><a href="./src/resources/speed/availabilities.ts">ObservatoryAvailabilities</a></code> |
| 6095 | |
| 6096 | Methods: |
| 6097 | |
| 6098 | - <code title="get /zones/{zone_id}/speed_api/availabilities">client.speed.availabilities.<a href="./src/resources/speed/availabilities.ts">list</a>({ ...params }) -> ObservatoryAvailabilities</code> |
| 6099 | |
| 6100 | ## Pages |
| 6101 | |
| 6102 | Types: |
| 6103 | |
| 6104 | - <code><a href="./src/resources/speed/pages.ts">PageListResponse</a></code> |
| 6105 | |
| 6106 | Methods: |
| 6107 | |
| 6108 | - <code title="get /zones/{zone_id}/speed_api/pages">client.speed.pages.<a href="./src/resources/speed/pages.ts">list</a>({ ...params }) -> PageListResponse</code> |
| 6109 | |
| 6110 | # DCVDelegation |
| 6111 | |
| 6112 | ## UUID |
| 6113 | |
| 6114 | Types: |
| 6115 | |
| 6116 | - <code><a href="./src/resources/dcv-delegation/uuid.ts">TLSCertificatesAndHostnamesUUIDObject</a></code> |
| 6117 | |
| 6118 | Methods: |
| 6119 | |
| 6120 | - <code title="get /zones/{zone_id}/dcv_delegation/uuid">client.dcvDelegation.uuid.<a href="./src/resources/dcv-delegation/uuid.ts">get</a>({ ...params }) -> TLSCertificatesAndHostnamesUUIDObject</code> |
| 6121 | |
| 6122 | # Hostnames |
| 6123 | |
| 6124 | ## Settings |
| 6125 | |
| 6126 | ### TLS |
| 6127 | |
| 6128 | Types: |
| 6129 | |
| 6130 | - <code><a href="./src/resources/hostnames/settings/tls.ts">TLSCertificatesAndHostnamesSettingObject</a></code> |
| 6131 | - <code><a href="./src/resources/hostnames/settings/tls.ts">TLSCertificatesAndHostnamesSettingObjectDelete</a></code> |
| 6132 | - <code><a href="./src/resources/hostnames/settings/tls.ts">TLSGetResponse</a></code> |
| 6133 | |
| 6134 | Methods: |
| 6135 | |
| 6136 | - <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 }) -> TLSCertificatesAndHostnamesSettingObject</code> |
| 6137 | - <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 }) -> TLSCertificatesAndHostnamesSettingObjectDelete</code> |
| 6138 | - <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> |
| 6139 | |
| 6140 | # Snippets |
| 6141 | |
| 6142 | Types: |
| 6143 | |
| 6144 | - <code><a href="./src/resources/snippets/snippets.ts">Snippet</a></code> |
| 6145 | - <code><a href="./src/resources/snippets/snippets.ts">SnippetListResponse</a></code> |
| 6146 | - <code><a href="./src/resources/snippets/snippets.ts">SnippetDeleteResponse</a></code> |
| 6147 | |
| 6148 | Methods: |
| 6149 | |
| 6150 | - <code title="put /zones/{zone_identifier}/snippets/{snippet_name}">client.snippets.<a href="./src/resources/snippets/snippets.ts">update</a>(zoneIdentifier, snippetName, { ...params }) -> Snippet</code> |
| 6151 | - <code title="get /zones/{zone_identifier}/snippets">client.snippets.<a href="./src/resources/snippets/snippets.ts">list</a>(zoneIdentifier) -> SnippetListResponse</code> |
| 6152 | - <code title="delete /zones/{zone_identifier}/snippets/{snippet_name}">client.snippets.<a href="./src/resources/snippets/snippets.ts">delete</a>(zoneIdentifier, snippetName) -> SnippetDeleteResponse</code> |
| 6153 | - <code title="get /zones/{zone_identifier}/snippets/{snippet_name}">client.snippets.<a href="./src/resources/snippets/snippets.ts">get</a>(zoneIdentifier, snippetName) -> Snippet</code> |
| 6154 | |
| 6155 | ## Content |
| 6156 | |
| 6157 | Methods: |
| 6158 | |
| 6159 | - <code title="get /zones/{zone_identifier}/snippets/{snippet_name}/content">client.snippets.content.<a href="./src/resources/snippets/content.ts">get</a>(zoneIdentifier, snippetName) -> Response</code> |
| 6160 | |
| 6161 | ## Rules |
| 6162 | |
| 6163 | Types: |
| 6164 | |
| 6165 | - <code><a href="./src/resources/snippets/rules.ts">RuleUpdateResponse</a></code> |
| 6166 | - <code><a href="./src/resources/snippets/rules.ts">RuleListResponse</a></code> |
| 6167 | |
| 6168 | Methods: |
| 6169 | |
| 6170 | - <code title="put /zones/{zone_identifier}/snippets/snippet_rules">client.snippets.rules.<a href="./src/resources/snippets/rules.ts">update</a>(zoneIdentifier, { ...params }) -> RuleUpdateResponse</code> |
| 6171 | - <code title="get /zones/{zone_identifier}/snippets/snippet_rules">client.snippets.rules.<a href="./src/resources/snippets/rules.ts">list</a>(zoneIdentifier) -> RuleListResponse</code> |
| 6172 | |
| 6173 | # Calls |
| 6174 | |
| 6175 | Types: |
| 6176 | |
| 6177 | - <code><a href="./src/resources/calls.ts">CallsApp</a></code> |
| 6178 | - <code><a href="./src/resources/calls.ts">CallsAppWithSecret</a></code> |
| 6179 | - <code><a href="./src/resources/calls.ts">CallListResponse</a></code> |
| 6180 | |
| 6181 | Methods: |
| 6182 | |
| 6183 | - <code title="post /accounts/{account_id}/calls/apps">client.calls.<a href="./src/resources/calls.ts">create</a>({ ...params }) -> CallsAppWithSecret</code> |
| 6184 | - <code title="put /accounts/{account_id}/calls/apps/{app_id}">client.calls.<a href="./src/resources/calls.ts">update</a>(appId, { ...params }) -> CallsApp</code> |
| 6185 | - <code title="get /accounts/{account_id}/calls/apps">client.calls.<a href="./src/resources/calls.ts">list</a>({ ...params }) -> CallListResponse</code> |
| 6186 | - <code title="delete /accounts/{account_id}/calls/apps/{app_id}">client.calls.<a href="./src/resources/calls.ts">delete</a>(appId, { ...params }) -> CallsApp</code> |
| 6187 | - <code title="get /accounts/{account_id}/calls/apps/{app_id}">client.calls.<a href="./src/resources/calls.ts">get</a>(appId, { ...params }) -> CallsApp</code> |
| 6188 | |
| 6189 | # CloudforceOne |
| 6190 | |
| 6191 | ## Requests |
| 6192 | |
| 6193 | Types: |
| 6194 | |
| 6195 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">CloudforceOneQuota</a></code> |
| 6196 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">CloudforceOneRequestConstants</a></code> |
| 6197 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">CloudforceOneRequestItem</a></code> |
| 6198 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">CloudforceOneRequestListItem</a></code> |
| 6199 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">CloudforceOneRequestTypes</a></code> |
| 6200 | - <code><a href="./src/resources/cloudforce-one/requests/requests.ts">RequestDeleteResponse</a></code> |
| 6201 | |
| 6202 | Methods: |
| 6203 | |
| 6204 | - <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 }) -> CloudforceOneRequestItem</code> |
| 6205 | - <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 }) -> CloudforceOneRequestItem</code> |
| 6206 | - <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 }) -> CloudforceOneRequestListItemsV4PagePaginationArray</code> |
| 6207 | - <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> |
| 6208 | - <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) -> CloudforceOneRequestConstants</code> |
| 6209 | - <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) -> CloudforceOneRequestItem</code> |
| 6210 | - <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) -> CloudforceOneQuota</code> |
| 6211 | - <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) -> CloudforceOneRequestTypes</code> |
| 6212 | |
| 6213 | ### Message |
| 6214 | |
| 6215 | Types: |
| 6216 | |
| 6217 | - <code><a href="./src/resources/cloudforce-one/requests/message.ts">CloudforceOneRequestMessageItem</a></code> |
| 6218 | - <code><a href="./src/resources/cloudforce-one/requests/message.ts">MessageDeleteResponse</a></code> |
| 6219 | - <code><a href="./src/resources/cloudforce-one/requests/message.ts">MessageGetResponse</a></code> |
| 6220 | |
| 6221 | Methods: |
| 6222 | |
| 6223 | - <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 }) -> CloudforceOneRequestMessageItem</code> |
| 6224 | - <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 }) -> CloudforceOneRequestMessageItem</code> |
| 6225 | - <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> |
| 6226 | - <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> |
| 6227 | |
| 6228 | ### Priority |
| 6229 | |
| 6230 | Types: |
| 6231 | |
| 6232 | - <code><a href="./src/resources/cloudforce-one/requests/priority.ts">CloudforceOnePriorityItem</a></code> |
| 6233 | - <code><a href="./src/resources/cloudforce-one/requests/priority.ts">PriorityDeleteResponse</a></code> |
| 6234 | |
| 6235 | Methods: |
| 6236 | |
| 6237 | - <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 }) -> CloudforceOnePriorityItem</code> |
| 6238 | - <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 }) -> CloudforceOneRequestItem</code> |
| 6239 | - <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> |
| 6240 | - <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) -> CloudforceOneRequestItem</code> |
| 6241 | - <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) -> CloudforceOneQuota</code> |