APIs.io Engineering Platform Magic Site App Configs 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 App Configs 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 App Configs
paths:
  /accounts/{account_id}/magic/sites/{site_id}/app_configs:
    get:
      description: Lists App Configs associated with a site.
      operationId: magic-site-app-configs-list-app-configs
      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 App Configs response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_configs_collection_response'
          description: List App Configs response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List App Configs
      tags:
      - Magic Site App Configs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Creates a new App Config for a site
      operationId: magic-site-app-configs-add-app-config
      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_app_config_add_single_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Create Site App Config response failure
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_config_single_response'
          description: Create Site App Config response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a new App Config
      tags:
      - Magic Site App Configs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}:
    delete:
      description: Deletes specific App Config associated with a site.
      operationId: magic-site-app-configs-delete-app-config
      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'
      - in: path
        name: app_config_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Delete App Config response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_config_single_response'
          description: Delete App Config response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete App Config
      tags:
      - Magic Site App Configs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Updates an App Config for a site
      operationId: magic-site-app-configs-update-app-config
      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'
      - in: path
        name: app_config_id
        required: true
        schema:
          $ref: '#/components/schemas/magic_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/magic_app_config_update_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_api-response-common-failure'
          description: Update Site App Config response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/magic_app_config_single_response'
          description: Update Site App Config response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an App Config
      tags:
      - Magic Site App Configs
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    magic_account_app_id:
      description: Magic account app ID.
      example: ac60d3d0435248289d446cedd870bcf4
      type: string
    magic_app_configs_collection_response:
      allOf:
      - $ref: '#/components/schemas/magic_apps-response-object'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/magic_app_config'
            type: array
    magic_app_config_add_single_request:
      allOf:
      - oneOf:
        - properties:
            account_app_id:
              $ref: '#/components/schemas/magic_account_app_id'
          required:
          - account_app_id
          title: Account App
        - properties:
            managed_app_id:
              $ref: '#/components/schemas/magic_managed_app_id'
          required:
          - managed_app_id
          title: Managed App
      - anyOf:
        - required:
          - breakout
          title: Breakout
        - required:
          - priority
          title: Prioritize
      - properties:
          breakout:
            $ref: '#/components/schemas/magic_app_breakout'
          priority:
            $ref: '#/components/schemas/magic_app_priority'
      type: object
    magic_apps-response-object:
      properties:
        errors:
          $ref: '#/components/schemas/magic_messages'
        messages:
          $ref: '#/components/schemas/magic_messages'
        result:
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    magic_app_config:
      allOf:
      - properties:
          breakout:
            $ref: '#/components/schemas/magic_app_breakout'
          id:
            $ref: '#/components/schemas/magic_identifier'
          priority:
            $ref: '#/components/schemas/magic_app_priority'
          site_id:
            $ref: '#/components/schemas/magic_identifier'
        required:
        - id
        - site_id
      - oneOf:
        - properties:
            account_app_id:
              $ref: '#/components/schemas/magic_account_app_id'
          required:
          - account_app_id
          title: Account App
        - properties:
            managed_app_id:
              $ref: '#/components/schemas/magic_managed_app_id'
          required:
          - managed_app_id
          title: Managed App
      description: Traffic decision configuration for an app.
      type: object
    magic_app_breakout:
      description: Whether to breakout traffic to the app's endpoints directly. Null preserves default behavior.
      example: true
      type: boolean
    magic_managed_app_id:
      description: Managed app ID.
      example: cloudflare
      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_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    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_app_priority:
      description: Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)
      maximum: 1
      minimum: 0
      type: integer
    magic_app_config_update_request:
      properties:
        account_app_id:
          $ref: '#/components/schemas/magic_account_app_id'
        breakout:
          $ref: '#/components/schemas/magic_app_breakout'
        managed_app_id:
          $ref: '#/components/schemas/magic_managed_app_id'
        priority:
          $ref: '#/components/schemas/magic_app_priority'
      type: object
    magic_app_config_single_response:
      allOf:
      - $ref: '#/components/schemas/magic_apps-response-object'
      - properties:
          result:
            $ref: '#/components/schemas/magic_app_config'
  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