APIs.io Engineering Platform Magic Site WANs API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Magic Site WANs 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
    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: Magic Site WANs
paths:
  /accounts/{account_id}/magic/sites/{site_id}/wans:
    get:
      description: Lists Site WANs associated with an account.
      operationId: magic-site-wans-list-wans
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: List Site WANs response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wans_collection_response'
          description: List Site WANs response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Site WANs
      tags:
      - Magic Site WANs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new Site WAN.
      operationId: magic-site-wans-create-wan
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_wans_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Site WAN response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wans_collection_response'
          description: Create Site WAN response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a new Site WAN
      tags:
      - Magic Site WANs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}:
    delete:
      description: Remove a specific Site WAN.
      operationId: magic-site-wans-delete-wan
      parameters:
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: wan_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete Site WAN response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wan_deleted_response'
          description: Delete Site WAN response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Site WAN
      tags:
      - Magic Site WANs
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get a specific Site WAN.
      operationId: magic-site-wans-wan-details
      parameters:
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: wan_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Site WAN Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wan_single_response'
          description: Site WAN Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Site WAN Details
      tags:
      - Magic Site WANs
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Patch a specific Site WAN.
      operationId: magic-site-wans-patch-wan
      parameters:
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: wan_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_wan_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Patch Site WAN response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wan_modified_response'
          description: Patch Site WAN response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Patch Site WAN
      tags:
      - Magic Site WANs
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Update a specific Site WAN.
      operationId: magic-site-wans-update-wan
      parameters:
      - in: path
        name: site_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      - in: path
        name: wan_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_wan_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Site WAN response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_wan_modified_response'
          description: Update Site WAN response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Site WAN
      tags:
      - Magic Site WANs
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    magic_ip-address:
      description: A valid IPv4 address.
      example: 192.0.2.1
      type: string
    magic_api-response-single:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-common'
      - properties:
          result:
            anyOf:
            - nullable: true
              type: object
            - nullable: true
              type: string
      type: object
    magic_wans_add_single_request:
      properties:
        name:
          type: string
        physport:
          $ref: '#/components/schemas/magic_port'
        priority:
          type: integer
        static_addressing:
          $ref: '#/components/schemas/magic_wan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      required:
      - physport
      - vlan_tag
      type: object
    magic_wan_static_addressing:
      description: (optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.
      properties:
        address:
          $ref: '#/components/schemas/magic_cidr'
        gateway_address:
          $ref: '#/components/schemas/magic_ip-address'
        secondary_address:
          $ref: '#/components/schemas/magic_cidr'
      required:
      - address
      - gateway_address
      type: object
    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
          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
    magic_cidr:
      description: A valid CIDR notation representing an IP range.
      example: 192.0.2.0/24
      type: string
    magic_wan_deleted_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic_wan'
    magic_vlan_tag:
      description: VLAN port number.
      example: 0
      type: integer
    magic_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    magic_wan_modified_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic_wan'
    magic_wan_single_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/magic_wan'
    magic_wan_update_request:
      properties:
        name:
          type: string
        physport:
          $ref: '#/components/schemas/magic_port'
        priority:
          type: integer
        static_addressing:
          $ref: '#/components/schemas/magic_wan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      type: object
    magic_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    magic_port:
      example: 1
      type: integer
    magic_wan:
      properties:
        id:
          $ref: '#/components/schemas/magic_identifier'
        name:
          type: string
        physport:
          $ref: '#/components/schemas/magic_port'
        priority:
          description: Priority of WAN for traffic loadbalancing.
          type: integer
        site_id:
          $ref: '#/components/schemas/magic_identifier'
        static_addressing:
          $ref: '#/components/schemas/magic_wan_static_addressing'
        vlan_tag:
          $ref: '#/components/schemas/magic_vlan_tag'
      type: object
    magic_wans_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_api-response-single'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/magic_wan'
            type: array
    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
  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