APIs.io Engineering Platform IP Address Management Prefix Delegation 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 Prefix Delegation 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 Prefix Delegation
paths:
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations:
    get:
      description: List all delegations for a given account IP prefix.
      operationId: ip-address-management-prefix-delegation-list-prefix-delegations
      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_schemas-response_collection'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: List Prefix Delegations response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_schemas-response_collection'
          description: List Prefix Delegations response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Prefix Delegations
      tags:
      - IP Address Management Prefix Delegation
    post:
      description: Create a new account delegation for a given IP prefix.
      operationId: ip-address-management-prefix-delegation-create-prefix-delegation
      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:
                cidr:
                  $ref: '#/components/schemas/addressing_cidr'
                delegated_account_id:
                  $ref: '#/components/schemas/addressing_delegated_account_identifier'
              required:
              - cidr
              - delegated_account_id
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_schemas-single_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Create Prefix Delegation response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_schemas-single_response'
          description: Create Prefix Delegation response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Prefix Delegation
      tags:
      - IP Address Management Prefix Delegation
      x-api-token-group:
      - 'IP Prefixes: Write'
  /accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}:
    delete:
      description: Delete an account delegation for a given IP prefix.
      operationId: ip-address-management-prefix-delegation-delete-prefix-delegation
      parameters:
      - in: path
        name: delegation_id
        required: true
        schema:
          $ref: '#/components/schemas/addressing_delegation_identifier'
      - 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: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_id_response'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Delete Prefix Delegation response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addressing_id_response'
          description: Delete Prefix Delegation response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Prefix Delegation
      tags:
      - IP Address Management Prefix Delegation
      x-api-token-group:
      - 'IP Prefixes: Write'
components:
  schemas:
    addressing_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    addressing_cidr:
      description: IP Prefix in Classless Inter-Domain Routing format.
      example: 192.0.2.0/24
      type: string
    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-collection:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/addressing_result_info'
      type: object
    addressing_schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/addressing_ipam-delegations'
    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_delegated_account_identifier:
      description: Account identifier for the account to which prefix is being delegated.
      example: b1946ac92492d2347c6235b4d2611184
      maxLength: 32
      type: string
    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_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    addressing_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    addressing_schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/addressing_ipam-delegations'
            type: array
    addressing_delegation_identifier:
      description: Delegation identifier tag.
      example: d933b1530bc56c9953cf8ce166da8004
      maxLength: 32
      readOnly: true
      type: string
    addressing_id_response:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/addressing_delegation_identifier'
            type: object
    addressing_ipam-delegations:
      properties:
        cidr:
          $ref: '#/components/schemas/addressing_cidr'
        created_at:
          $ref: '#/components/schemas/addressing_timestamp'
        delegated_account_id:
          $ref: '#/components/schemas/addressing_delegated_account_identifier'
        id:
          $ref: '#/components/schemas/addressing_delegation_identifier'
        modified_at:
          $ref: '#/components/schemas/addressing_timestamp'
        parent_prefix_id:
          $ref: '#/components/schemas/addressing_identifier'
      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