APIs.io Engineering Platform Zero Trust Gateway Categories API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Zero Trust Gateway Categories API
  version: 4.0.0
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_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_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_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:
      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_beta:
      description: True if the category is in beta and subject to change.
      example: false
      type: boolean
    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_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_id:
      description: The identifier for this category. There is only one category per ID.
      type: integer
    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_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
    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
          type:
          - object
          - 'null'
        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-name:
      description: The name of the category.
      example: Education
      type: string
    zero-trust-gateway_schemas-identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey