APIs.io Engineering Platform Zero Trust Gateway Categories 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 Categories 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 Categories
paths:
  /accounts/{account_id}/gateway/categories:
    get:
      description: Fetches a list of all categories.
      operationId: zero-trust-gateway-categories-list-categories
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/zero-trust-gateway_schemas-identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-response_collection'
                - $ref: '#/components/schemas/zero-trust-gateway_api-response-common-failure'
          description: List categories response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-response_collection'
          description: List categories response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List categories
      tags:
      - Zero Trust Gateway Categories
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_categories_components-schemas-name:
      description: The name of the category.
      example: Education
      type: string
    zero-trust-gateway_categories:
      properties:
        beta:
          $ref: '#/components/schemas/zero-trust-gateway_beta'
        class:
          $ref: '#/components/schemas/zero-trust-gateway_class'
        description:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-description'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_id'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-name'
        subcategories:
          description: All subcategories for this category.
          items:
            $ref: '#/components/schemas/zero-trust-gateway_subcategory'
          type: array
      readOnly: true
      type: object
    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_categories_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/zero-trust-gateway_categories'
            type: array
    zero-trust-gateway_subcategory:
      properties:
        beta:
          $ref: '#/components/schemas/zero-trust-gateway_beta'
        class:
          $ref: '#/components/schemas/zero-trust-gateway_class'
        description:
          $ref: '#/components/schemas/zero-trust-gateway_components-schemas-description'
        id:
          $ref: '#/components/schemas/zero-trust-gateway_id'
        name:
          $ref: '#/components/schemas/zero-trust-gateway_categories_components-schemas-name'
      type: object
    zero-trust-gateway_components-schemas-description:
      description: A short summary of domains in the category.
      example: Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.
      type: string
    zero-trust-gateway_beta:
      description: True if the category is in beta and subject to change.
      example: false
      type: boolean
    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_schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    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_id:
      description: The identifier for this category. There is only one category per ID.
      type: integer
    zero-trust-gateway_class:
      description: Which account types are allowed to create policies based on this category. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked.
      enum:
      - free
      - premium
      - blocked
      - removalPending
      - noBlock
      example: premium
      type: string
    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