APIs.io Engineering Platform IP Address Management Dynamic Advertisement API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 IP Address Management Dynamic Advertisement 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: IP Address Management Dynamic Advertisement
paths:
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status:
    get:
      description: List the current advertisement state for a prefix.
      operationId: ip-address-management-dynamic-advertisement-get-advertisement-status
      parameters:
      - in: path
        name: prefix_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_advertised_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Get Advertisement Status response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_advertised_response'
          description: Get Advertisement Status response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get Advertisement Status
      tags:
      - IP Address Management Dynamic Advertisement
      x-api-token-group:
      - Magic Transit Prefix Read
      - Magic Transit Prefix Write
      - 'IP Prefixes: Write'
      - 'IP Prefixes: Read'
      - 'IP Prefixes: BGP On Demand Write'
      - 'IP Prefixes: BGP On Demand Read'
    patch:
      description: Advertise or withdraw BGP route for a prefix.
      operationId: ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status
      parameters:
      - in: path
        name: prefix_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                advertised:
                  $ref: '#/components/schemas/addressing_schemas-advertised'
              required:
              - advertised
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_advertised_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Update Prefix Dynamic Advertisement Status response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_advertised_response'
          description: Update Prefix Dynamic Advertisement Status response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update Prefix Dynamic Advertisement Status
      tags:
      - IP Address Management Dynamic Advertisement
      x-api-token-group:
      - Magic Transit Prefix Write
      - 'IP Prefixes: Write'
      - 'IP Prefixes: BGP On Demand Write'
components:
  schemas:
    addressing_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    addressing_api-response-single:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-common'
      type: object
    addressing_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/addressing_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/addressing_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
    addressing_advertised_response:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-single'
      - properties:
          result:
            properties:
              advertised:
                $ref: '#/components/schemas/addressing_schemas-advertised'
              advertised_modified_at:
                $ref: '#/components/schemas/addressing_modified_at_nullable'
            type: object
    addressing_schemas-advertised:
      description: Enablement of prefix advertisement to the Internet.
      example: true
      type: boolean
    addressing_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/addressing_messages'
        messages:
          $ref: '#/components/schemas/addressing_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    addressing_modified_at_nullable:
      description: Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      nullable: true
      type: string
    addressing_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
  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