APIs.io Engineering Platform Zero Trust Gateway Proxy Endpoints API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Zero Trust Gateway Proxy Endpoints 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: Zero Trust Gateway Proxy Endpoints
paths:
  /accounts/{account_id}/gateway/proxy_endpoints:
    get:
      description: Fetches all Zero Trust Gateway proxy endpoints for an account.
      operationId: zero-trust-gateway-proxy-endpoints-list-proxy-endpoints
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List proxy endpoints response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
          description: List proxy endpoints response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List proxy endpoints
      tags:
      - Zero Trust Gateway Proxy Endpoints
    post:
      description: Creates a new Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-create-proxy-endpoint
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ips:
                  $ref: '#/components/schemas/zero-trust-gateway_ips'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
              required:
              - name
              - ips
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Create a proxy endpoint response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
          description: Create a proxy endpoint response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a proxy endpoint
      tags:
      - Zero Trust Gateway Proxy Endpoints
  /accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}:
    delete:
      description: Deletes a configured Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint
      parameters:
      - in: path
        name: proxy_endpoint_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_empty_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Delete a proxy endpoint response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_empty_response'
          description: Delete a proxy endpoint response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a proxy endpoint
      tags:
      - Zero Trust Gateway Proxy Endpoints
    get:
      description: Fetches a single Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-proxy-endpoint-details
      parameters:
      - in: path
        name: proxy_endpoint_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Get a proxy endpoint response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection'
          description: Get a proxy endpoint response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a proxy endpoint
      tags:
      - Zero Trust Gateway Proxy Endpoints
    patch:
      description: Updates a configured Zero Trust Gateway proxy endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-update-proxy-endpoint
      parameters:
      - in: path
        name: proxy_endpoint_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ips:
                  $ref: '#/components/schemas/zero-trust-gateway_ips'
                name:
                  $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: Update a proxy endpoint response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response'
          description: Update a proxy endpoint response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a proxy endpoint
      tags:
      - Zero Trust Gateway Proxy Endpoints
components:
  schemas:
    zero-trust-gateway_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    zero-trust-gateway_proxy-endpoints_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints'
            type: array
    zero-trust-gateway_schemas-subdomain:
      description: The subdomain to be used as the destination in the proxy client.
      example: oli3n9zkz5.proxy.cloudflare-gateway.com
      type: string
    zero-trust-gateway_empty_response:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
      - properties:
          result:
            type: object
    zero-trust-gateway_components-schemas-uuid:
      example: ed35569b41ce4d1facfe683550f54086
      type: string
    zero-trust-gateway_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/zero-trust-gateway_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/zero-trust-gateway_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
    zero-trust-gateway_proxy-endpoints:
      properties:
        created_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-uuid'
        ips:
          $ref: '#/components/schemas/zero-trust-gateway_ips'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name'
        subdomain:
          $ref: '#/components/schemas/zero-trust-gateway_schemas-subdomain'
        updated_at:
          $ref: '#/components/schemas/zero-trust-gateway_timestamp'
      type: object
    zero-trust-gateway_proxy-endpoints_components-schemas-name:
      description: The name of the proxy endpoint.
      example: Devops team
      type: string
    zero-trust-gateway_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    zero-trust-gateway_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zero-trust-gateway_messages'
        messages:
          $ref: '#/components/schemas/zero-trust-gateway_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    zero-trust-gateway_proxy-endpoints_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/zero-trust-gateway_proxy-endpoints'
    zero-trust-gateway_identifier:
      example: 699d98642c564d2e855e9661899b7252
      type: string
    zero-trust-gateway_api-response-single:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
      type: object
    zero-trust-gateway_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
    zero-trust-gateway_ips:
      description: A list of CIDRs to restrict ingress connections.
      items:
        description: The IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /109. IPv4 CIDRs are limited to a maximum of /25.
        example: 192.0.2.1/32
        type: string
      type: array
    zero-trust-gateway_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/zero-trust-gateway_result_info'
      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