APIs.io Engineering Platform Magic IPsec Tunnels API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Magic IPsec Tunnels API
  version: 4.0.0
tags:
- name: Magic IPsec Tunnels
paths:
  /accounts/{account_id}/magic/ipsec_tunnels:
    get:
      description: Lists IPsec tunnels associated with an account.
      operationId: magic-ipsec-tunnels-list-ipsec-tunnels
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List IPsec tunnels response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
          description: List IPsec tunnels response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List IPsec tunnels
      tags:
      - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates new IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
      operationId: magic-ipsec-tunnels-create-ipsec-tunnels
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_schemas-tunnel_add_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create IPsec tunnels response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnels_collection_response'
          description: Create IPsec tunnels response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create IPsec tunnels
      tags:
      - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
      operationId: magic-ipsec-tunnels-update-multiple-ipsec-tunnels
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - id
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_schemas-modified_tunnels_collection_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update multiple IPsec tunnels response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-modified_tunnels_collection_response'
          description: Update multiple IPsec tunnels response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update multiple IPsec tunnels
      tags:
      - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}:
    delete:
      description: Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
      operationId: magic-ipsec-tunnels-delete-ipsec-tunnel
      parameters:
      - in: path
        name: ipsec_tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_schemas-tunnel_deleted_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete IPsec Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnel_deleted_response'
          description: Delete IPsec Tunnel response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete IPsec Tunnel
      tags:
      - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Lists details for a specific IPsec tunnel.
      operationId: magic-ipsec-tunnels-list-ipsec-tunnel-details
      parameters:
      - in: path
        name: ipsec_tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_schemas-tunnel_single_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List IPsec tunnel details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnel_single_response'
          description: List IPsec tunnel details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List IPsec tunnel details
      tags:
      - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
      operationId: magic-ipsec-tunnels-update-ipsec-tunnel
      parameters:
      - in: path
        name: ipsec_tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_schemas-tunnel_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_schemas-tunnel_modified_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update IPsec Tunnel response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_schemas-tunnel_modified_response'
          description: Update IPsec Tunnel response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update IPsec Tunnel
      tags:
      - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}/psk_generate:
    post:
      description: Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place.
      operationId: magic-ipsec-tunnels-generate-pre-shared-key-(-psk)-for-ipsec-tunnels
      parameters:
      - in: path
        name: ipsec_tunnel_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/magic_psk_generation_response'
                - $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Generate Pre Shared Key (PSK) for IPsec tunnels response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_psk_generation_response'
          description: Generate Pre Shared Key (PSK) for IPsec tunnels response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Generate Pre Shared Key (PSK) for IPsec tunnels
      tags:
      - Magic IPsec Tunnels
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    magic_schemas-tunnel_add_request:
      allOf:
      - $ref: '#/components/schemas/magic_schemas-tunnel_add_single_request'
    magic_cloudflare_ipsec_endpoint:
      description: The IP address assigned to the Cloudflare side of the IPsec tunnel.
      example: 203.0.113.1
      type: string
    magic_schemas-tunnel_add_single_request:
      properties:
        cloudflare_endpoint:
          $ref: '#/components/schemas/magic_cloudflare_ipsec_endpoint'
        customer_endpoint:
          $ref: '#/components/schemas/magic_customer_ipsec_endpoint'
        description:
          $ref: '#/components/schemas/magic_components-schemas-description'
        health_check:
          $ref: '#/components/schemas/magic_health_check'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        name:
          $ref: '#/components/schemas/magic_schemas-name'
        psk:
          $ref: '#/components/schemas/magic_psk'
        replay_protection:
          $ref: '#/components/schemas/magic_replay_protection'
      required:
      - name
      - cloudflare_endpoint
      - interface_address
      type: object
    magic_schemas-created_on:
      description: The date and time the tunnel was created.
      example: '2017-06-14T00:00:00Z'
      format: date-time
      readOnly: true
      type: string
    magic_components-schemas-description:
      description: An optional description forthe IPsec tunnel.
      example: Tunnel for ISP X
      type: string
    magic_psk_metadata:
      description: The PSK metadata that includes when the PSK was generated.
      properties:
        last_generated_on:
          $ref: '#/components/schemas/magic_schemas-modified_on'
      type: object
    magic_health_check:
      properties:
        direction:
          default: unidirectional
          description: The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel. Note in the case of bidirecitonal healthchecks, the target field in health_check is ignored as the interface_address is used to send traffic into the tunnel.
          enum:
          - unidirectional
          - bidirectional
          example: bidirectional
          type: string
        enabled:
          default: true
          description: Determines whether to run healthchecks for a tunnel.
          example: true
          type: boolean
        rate:
          default: mid
          description: How frequent the health check is run. The default value is `mid`.
          enum:
          - low
          - mid
          - high
          example: low
          type: string
        target:
          description: The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.
          example: 203.0.113.1
          type: string
        type:
          default: reply
          description: The type of healthcheck to run, reply or request. The default value is `reply`.
          enum:
          - reply
          - request
          example: request
          type: string
      type: object
    magic_schemas-name:
      description: The name of the IPsec tunnel. The name cannot share a name with other tunnels.
      example: IPsec_1
      type: string
    magic_allow_null_cipher:
      description: When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).
      example: true
      type: boolean
    magic_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/magic_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/magic_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    magic_schemas-modified_tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              modified:
                example: true
                type: boolean
              modified_ipsec_tunnels:
                items:
                  $ref: '#/components/schemas/magic_ipsec-tunnel'
                type: array
    magic_tunnel_health_check:
      properties:
        enabled:
          default: true
          description: Determines whether to run healthchecks for a tunnel.
          example: true
          type: boolean
        rate:
          default: mid
          description: How frequent the health check is run. The default value is `mid`.
          enum:
          - low
          - mid
          - high
          example: low
          type: string
        target:
          description: The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.
          example: 203.0.113.1
          type: string
        type:
          default: reply
          description: The type of healthcheck to run, reply or request. The default value is `reply`.
          enum:
          - reply
          - request
          example: request
          type: string
      type: object
    magic_schemas-tunnel_modified_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              modified:
                example: true
                type: boolean
              modified_ipsec_tunnel:
                $ref: '#/components/schemas/magic_ipsec-tunnel'
            type: object
    magic_schemas-modified_on:
      description: The date and time the tunnel was last modified.
      example: '2017-06-14T05:20:00Z'
      format: date-time
      readOnly: true
      type: string
    magic_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    magic_interface_address:
      description: 'A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.'
      example: 192.0.2.0/31
      type: string
    magic_psk_generation_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              ipsec_tunnel_id:
                $ref: '#/components/schemas/magic_identifier'
              psk:
                $ref: '#/components/schemas/magic_psk'
              psk_metadata:
                $ref: '#/components/schemas/magic_psk_metadata'
    magic_replay_protection:
      default: false
      description: If `true`, then IPsec replay protection will be supported in the Cloudflare-to-customer direction.
      example: false
      type: boolean
    magic_schemas-tunnel_deleted_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              deleted:
                example: true
                type: boolean
              deleted_ipsec_tunnel:
                $ref: '#/components/schemas/magic_ipsec-tunnel'
            type: object
    magic_schemas-tunnel_single_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              ipsec_tunnel:
                $ref: '#/components/schemas/magic_ipsec-tunnel'
            type: object
    magic_psk:
      description: A randomly generated or provided string for use in the IPsec tunnel.
      example: O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy
      type: string
    magic_schemas-tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            properties:
              ipsec_tunnels:
                items:
                  $ref: '#/components/schemas/magic_ipsec-tunnel'
                type: array
    magic_api-response-single:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-common'
      - properties:
          result:
            anyOf:
            - type:
              - object
              - 'null'
            - type:
              - string
              - 'null'
      type: object
    magic_ipsec-tunnel:
      properties:
        allow_null_cipher:
          $ref: '#/components/schemas/magic_allow_null_cipher'
        cloudflare_endpoint:
          $ref: '#/components/schemas/magic_cloudflare_ipsec_endpoint'
        created_on:
          $ref: '#/components/schemas/magic_schemas-created_on'
        customer_endpoint:
          $ref: '#/components/schemas/magic_customer_ipsec_endpoint'
        description:
          $ref: '#/components/schemas/magic_components-schemas-description'
        id:
          $ref: '#/components/schemas/magic_schemas-identifier'
        interface_address:
          $ref: '#/components/schemas/magic_interface_address'
        modified_on:
          $ref: '#/components/schemas/magic_schemas-modified_on'
        name:
          $ref: '#/components/schemas/magic_schemas-name'
        psk_metadata:
          $ref: '#/components/schemas/magic_psk_metadata'
        replay_protection:
          $ref: '#/components/schemas/magic_replay_protection'
        tunnel_health_check:
          $ref: '#/components/schemas/magic_tunnel_health_check'
      required:
      - name
      - cloudflare_endpoint
      - interface_address
      type: object
    magic_customer_ipsec_endpoint:
      description: The IP address assigned to the customer side of the IPsec tunnel. Not required, but must be set for proactive traceroutes to work.
      example: 203.0.113.1
      type: string
    magic_schemas-identifier:
      description: Tunnel identifier tag.
      example: c4a7362d577a6c3019a474fd6f485821
      maxLength: 32
      readOnly: true
      type: string
    magic_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/magic_messages'
        messages:
          $ref: '#/components/schemas/magic_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
    magic_schemas-tunnel_update_request:
      allOf:
      - $ref: '#/components/schemas/magic_schemas-tunnel_add_single_request'
    magic_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey