openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Zero Trust Accounts API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Zero Trust Accounts
paths:
  /accounts/{account_id}/devices/settings:
    get:
      description: Describes the current device settings for a Zero Trust account.
      operationId: zero-trust-accounts-get-device-settings-for-zero-trust-account
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get device settings for a Zero Trust account response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
          description: Get device settings for a Zero Trust account response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get device settings for a Zero Trust account
      tags:
      - Zero Trust Accounts
      x-api-token-group:
      - Teams Read
      - Teams Write
    patch:
      description: Patches the current device settings for a Zero Trust account.
      operationId: zero-trust-accounts-patch-device-settings-for-the-zero-trust-account
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Patch device settings for a Zero Trust account response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
          description: Patch device settings for a Zero Trust account response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Patch device settings for a Zero Trust account
      tags:
      - Zero Trust Accounts
      x-api-token-group:
      - Teams Write
    put:
      description: Updates the current device settings for a Zero Trust account.
      operationId: zero-trust-accounts-update-device-settings-for-the-zero-trust-account
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update device settings for a Zero Trust account response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings-response'
          description: Update device settings for a Zero Trust account response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update device settings for a Zero Trust account
      tags:
      - Zero Trust Accounts
      x-api-token-group:
      - Teams Write
  /accounts/{account_id}/gateway:
    get:
      description: Gets information about the current Zero Trust account.
      operationId: zero-trust-accounts-get-zero-trust-account-information
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust account information response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
          description: Get Zero Trust account information response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust account information
      tags:
      - Zero Trust Accounts
      x-api-token-group:
      - Teams Read
      - Teams Write
    post:
      description: Creates a Zero Trust account with an existing Cloudflare account.
      operationId: zero-trust-accounts-create-zero-trust-account
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create Zero Trust account response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account'
          description: Create Zero Trust account response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Zero Trust account
      tags:
      - Zero Trust Accounts
      x-api-token-group:
      - Teams Write
  /accounts/{account_id}/gateway/configuration:
    get:
      description: Fetches the current Zero Trust account configuration.
      operationId: zero-trust-accounts-get-zero-trust-account-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust account configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
          description: Get Zero Trust account configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust account configuration
      tags:
      - Zero Trust Accounts
    patch:
      description: Patches the current Zero Trust account configuration. This endpoint can update a single subcollection of settings such as `antivirus`, `tls_decrypt`, `activity_log`, `block_page`, `browser_isolation`, `fips`, `body_scanning`, or `certificate`, without updating the entire configuration object. Returns an error if any collection of settings is not properly configured.
      operationId: zero-trust-accounts-patch-zero-trust-account-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update Zero Trust account configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
          description: Update Zero Trust account configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Patch Zero Trust account configuration
      tags:
      - Zero Trust Accounts
    put:
      description: Updates the current Zero Trust account configuration.
      operationId: zero-trust-accounts-update-zero-trust-account-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update Zero Trust account configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_account_config'
          description: Update Zero Trust account configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Zero Trust account configuration
      tags:
      - Zero Trust Accounts
  /accounts/{account_id}/gateway/configuration/custom_certificate:
    get:
      description: Fetches the current Zero Trust certificate configuration.
      operationId: zero-trust-accounts-get-zero-trust-certificate-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_custom-certificate-settings'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get Zero Trust account configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_custom-certificate-settings'
          description: Get Zero Trust account configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Zero Trust certificate configuration
      tags:
      - Zero Trust Accounts
  /accounts/{account_id}/gateway/logging:
    get:
      description: Fetches the current logging settings for Zero Trust account.
      operationId: zero-trust-accounts-get-logging-settings-for-the-zero-trust-account
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get logging settings for the Zero Trust account response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
          description: Get logging settings for the Zero Trust account response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get logging settings for the Zero Trust account
      tags:
      - Zero Trust Accounts
    put:
      description: Updates logging settings for the current Zero Trust account.
      operationId: zero-trust-accounts-update-logging-settings-for-the-zero-trust-account
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update logging settings for the Zero Trust account response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response'
          description: Update logging settings for the Zero Trust account response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Zero Trust account logging settings
      tags:
      - Zero Trust Accounts
components:
  schemas:
    zero-trust-gateway_block-page-settings:
      description: Block page layout settings.
      properties:
        background_color:
          description: 'Block page background color in #rrggbb format.'
          type: string
        enabled:
          description: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
          example: true
          type: boolean
        footer_text:
          description: Block page footer text.
          example: --footer--
          type: string
        header_text:
          description: Block page header text.
          example: --header--
          type: string
        logo_path:
          description: Full URL to the logo file.
          example: https://logos.com/a.png
          type: string
        mailto_address:
          description: Admin email for users to contact.
          example: admin@example.com
          type: string
        mailto_subject:
          description: Subject line for emails created from block page.
          example: Blocked User Inquiry
          type: string
        name:
          description: Block page title.
          example: Cloudflare
          type: string
        suppress_footer:
          description: Suppress detailed info at the bottom of the block page.
          example: false
          type: boolean
      type: object
    zero-trust-gateway_gateway_tag:
      description: Gateway internal ID.
      example: f174e90afafe4643bbbc4a0ed4fc8415
      maxLength: 32
      type: string
    zero-trust-gateway_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    teams-devices_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/teams-devices_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/teams-devices_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    zero-trust-gateway_gateway-account-logging-settings-response:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/zero-trust-gateway_gateway-account-logging-settings'
      type: object
    zero-trust-gateway_api-response-single:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
      type: object
    zero-trust-gateway_gateway_account:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
      - properties:
          result:
            properties:
              gateway_tag:
                $ref: '#/components/schemas/zero-trust-gateway_gateway_tag'
              id:
                $ref: '#/components/schemas/zero-trust-gateway_cf_account_id'
              provider_name:
                $ref: '#/components/schemas/zero-trust-gateway_provider_name'
            type: object
      type: object
    zero-trust-gateway_fips-settings:
      description: FIPS settings.
      properties:
        tls:
          description: Enable only cipher suites and TLS versions compliant with FIPS 140-2.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_gateway-account-logging-settings:
      properties:
        redact_pii:
          description: 'Redact personally identifiable information from activity logging (PII fields are: source IP, user email, user ID, device ID, URL, referrer, user agent).'
          example: true
          type: boolean
        settings_by_rule_type:
          description: Logging settings by rule type.
          properties:
            dns:
              description: Logging settings for DNS firewall.
              type: object
            http:
              description: Logging settings for HTTP/HTTPS firewall.
              type: object
            l4:
              description: Logging settings for Network firewall.
              type: object
          type: object
      type: object
    zero-trust-gateway_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/zero-trust-gateway_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/zero-trust-gateway_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    zero-trust-gateway_enabled_upload_phase:
      description: Enable anti-virus scanning on uploads.
      example: false
      type: boolean
    zero-trust-gateway_gateway-account-settings:
      description: account settings.
      properties:
        settings:
          description: account settings.
          properties:
            activity_log:
              $ref: '#/components/schemas/zero-trust-gateway_activity-log-settings'
            antivirus:
              $ref: '#/components/schemas/zero-trust-gateway_anti-virus-settings'
            block_page:
              $ref: '#/components/schemas/zero-trust-gateway_block-page-settings'
            body_scanning:
              $ref: '#/components/schemas/zero-trust-gateway_body-scanning-settings'
            browser_isolation:
              $ref: '#/components/schemas/zero-trust-gateway_browser-isolation-settings'
            certificate:
              $ref: '#/components/schemas/zero-trust-gateway_certificate-settings'
            custom_certificate:
              $ref: '#/components/schemas/zero-trust-gateway_custom-certificate-settings'
            extended_email_matching:
              $ref: '#/components/schemas/zero-trust-gateway_extended-email-matching'
            fips:
              $ref: '#/components/schemas/zero-trust-gateway_fips-settings'
            protocol_detection:
              $ref: '#/components/schemas/zero-trust-gateway_protocol-detection'
            tls_decrypt:
              $ref: '#/components/schemas/zero-trust-gateway_tls-settings'
          type: object
      type: object
    teams-devices_zero-trust-account-device-settings:
      properties:
        disable_for_time:
          description: Sets the time limit, in seconds, that a user can use an override code to bypass WARP.
          type: number
        gateway_proxy_enabled:
          description: Enable gateway proxy filtering on TCP.
          example: true
          type: boolean
        gateway_udp_proxy_enabled:
          description: Enable gateway proxy filtering on UDP.
          example: true
          type: boolean
        root_certificate_installation_enabled:
          description: Enable installation of cloudflare managed root certificate.
          example: true
          type: boolean
        use_zt_virtual_ip:
          description: Enable using CGNAT virtual IPv4.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zero-trust-gateway_messages'
        messages:
          $ref: '#/components/schemas/zero-trust-gateway_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    teams-devices_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/teams-devices_messages'
        messages:
          $ref: '#/components/schemas/teams-devices_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful.
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    teams-devices_identifier:
      example: 699d98642c564d2e855e9661899b7252
    zero-trust-gateway_cf_account_id:
      description: Cloudflare account ID.
      example: 699d98642c564d2e855e9661899b7252
      maxLength: 32
      type: string
    zero-trust-gateway_activity-log-settings:
      description: Activity log settings.
      properties:
        enabled:
          description: Enable activity logging.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_identifier:
      example: 699d98642c564d2e855e9661899b7252
      type: string
    zero-trust-gateway_body-scanning-settings:
      description: DLP body scanning settings.
      properties:
        inspection_mode:
          description: Set the inspection mode to either `deep` or `shallow`.
          example: deep
          type: string
      type: object
    zero-trust-gateway_gateway_account_config:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/zero-trust-gateway_gateway-account-settings'
            - properties:
                created_at:
                  $ref: '#/components/schemas/zero-trust-gateway_timestamp'
                updated_at:
                  $ref: '#/components/schemas/zero-trust-gateway_timestamp'
            type: object
      type: object
    zero-trust-gateway_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    zero-trust-gateway_extended-email-matching:
      description: Extended e-mail matching settings.
      properties:
        enabled:
          description: Enable matching all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_enabled_download_phase:
      description: Enable anti-virus scanning on downloads.
      example: false
      type: boolean
    zero-trust-gateway_protocol-detection:
      description: Protocol Detection settings.
      properties:
        enabled:
          description: Enable detecting protocol on initial bytes of client traffic.
          example: true
          type: boolean
      type: object
    teams-devices_api-response-single:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
            nullable: true
            type: object
      type: object
    zero-trust-gateway_anti-virus-settings:
      description: Anti-virus settings.
      properties:
        enabled_download_phase:
          $ref: '#/components/schemas/zero-trust-gateway_enabled_download_phase'
        enabled_upload_phase:
          $ref: '#/components/schemas/zero-trust-gateway_enabled_upload_phase'
        fail_closed:
          $ref: '#/components/schemas/zero-trust-gateway_fail_closed'
        notification_settings:
          $ref: '#/components/schemas/zero-trust-gateway_notification_settings'
      type: object
    zero-trust-gateway_certificate-settings:
      description: Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
      properties:
        id:
          description: UUID of certificate to be used for interception. Certificate must be active on the edge. A nil UUID will indicate the Cloudflare Root CA should be used.
          example: d1b364c5-1311-466e-a194-f0e943e0799f
          type: string
      required:
      - id
      type: object
    zero-trust-gateway_browser-isolation-settings:
      description: Browser isolation settings.
      properties:
        non_identity_enabled:
          description: Enable non-identity onramp support for Browser Isolation.
          example: true
          type: boolean
        url_browser_isolation_enabled:
          description: Enable Clientless Browser Isolation.
          example: true
          type: boolean
      type: object
    zero-trust-gateway_custom-certificate-settings:
      deprecated: true
      description: Custom certificate settings for BYO-PKI. (deprecated and replaced by `certificate`)
      properties:
        binding_status:
          description: Certificate status (internal).
          example: pending_deployment
          readOnly: true
          type: string
        enabled:
          description: Enable use of custom certificate authority for signing Gateway traffic.
          example: true
          type: boolean
        id:
          description: UUID of certificate (ID from MTLS certificate store).
          example: d1b364c5-1311-466e-a194-f0e943e0799f
          type: string
        updated_at:
          format: date-time
          readOnly: true
          type: string
      required:
      - enabled
      type: object
    zero-trust-gateway_fail_closed:
      description: Block requests for files that cannot be scanned.
      example: false
      type: boolean
    zero-trust-gateway_notification_settings:
      description: Configure a message to display on the user's device when an antivirus search is performed.
      properties:
        enabled:
          description: Set notification on
          type: boolean
        msg:
          description: Customize the message shown in the notification.
          type: string
        support_url:
          description: Optional URL to direct users to additional information. If not set, the notification will open a block page.
          type: string
      type: object
    zero-trust-gateway_provider_name:
      description: The name of the provider. Usually Cloudflare.
      example: Cloudflare
      type: string
    teams-devices_zero-trust-account-device-settings-response:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/teams-devices_zero-trust-account-device-settings'
      type: object
    teams-devices_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    zero-trust-gateway_tls-settings:
      description: TLS interception settings.
      properties:
        enabled:
          description: Enable inspecting encrypted HTTP traffic.
          example: true
          type: boolean
      type: object
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true