openapi: 3.0.0
info:
  title: AI Advisor AiAdvisorDataService FlowTagService API
  description: '# Overview

    Provides programmatic access to AI Advisor.'
  version: v202511
  contact:
    name: Kentik API Engineering
    url: https://github.com/kentik/api-schema-public
security:
- email: []
  token: []
tags:
- name: FlowTagService
paths:
  /flow_tag/v202404alpha1/tag:
    get:
      summary: Search flow tag configuration.
      description: Returns configuration of flow tag with search parameters.
      operationId: SearchFlowTag
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202404alpha1SearchFlowTagResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: search.limit
        description: Limit the number of rows to fetch
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: search.offset
        description: The number rows to skip before returning
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: search.lookupFields
        description: "List of lookup fields\n\n - LOOKUP_FIELD_UNSPECIFIED: Invalid value\n - LOOKUP_FIELD_VALUE: Lookup by name of tag"
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - LOOKUP_FIELD_UNSPECIFIED
            - LOOKUP_FIELD_VALUE
      - name: search.lookupValues
        description: List of lookup values
        in: query
        required: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: search.fieldLimit
        description: Limit the number of record to return for nested fields
        in: query
        required: false
        schema:
          type: integer
          format: int32
      tags:
      - FlowTagService
    post:
      summary: Create flow tag configuration.
      description: Create a flow tag configuration.
      operationId: CreateFlowTag
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202404alpha1CreateFlowTagResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v202404alpha1CreateFlowTagRequest'
        required: true
      tags:
      - FlowTagService
  /flow_tag/v202404alpha1/tag/{flowTag.id}:
    put:
      summary: Update flow tag configuration.
      description: Update a flow tag configuration.
      operationId: UpdateFlowTag
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202404alpha1UpdateFlowTagResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: flowTag.id
        description: Unique system assigned identifier of the flow tag
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlowTagServiceUpdateFlowTagBody'
        required: true
      tags:
      - FlowTagService
    get:
      summary: Get flow tag configuration.
      description: Returns configuration of flow tag with specified ID.
      operationId: GetFlowTag
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202404alpha1GetFlowTagResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: flowTag.id
        in: path
        required: true
        schema:
          type: string
      tags:
      - FlowTagService
    delete:
      summary: Delete flow tag configuration.
      description: Delete a flow tag configuration with id.
      operationId: DeleteFlowTag
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202404alpha1DeleteFlowTagResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: flowTag.id
        in: path
        required: true
        schema:
          type: string
      tags:
      - FlowTagService
components:
  schemas:
    rpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    v202404alpha1UpdateFlowTagResponse:
      type: object
      properties:
        flowTag:
          $ref: '#/components/schemas/v202404alpha1FlowTag'
      title: UpdateFlowTagResponse
    v202404alpha1CreateFlowTagRequest:
      type: object
      properties:
        flowTag:
          $ref: '#/components/schemas/v202404alpha1FlowTag'
      title: CreateFlowTagRequest
    v202404alpha1CreateFlowTagResponse:
      type: object
      properties:
        flowTag:
          $ref: '#/components/schemas/v202404alpha1FlowTag'
      title: CreateFlowTagResponse
    v202404alpha1DeleteFlowTagResponse:
      type: object
      title: DeleteFlowTagResponse
    v202404alpha1SearchFlowTagResponse:
      type: object
      properties:
        flowTags:
          type: array
          items:
            $ref: '#/components/schemas/v202404alpha1FlowTag'
        totalCount:
          type: integer
          format: int64
        invalidCount:
          type: integer
          format: int64
      title: SearchFlowTagResponse
    v202404alpha1AddressInfo:
      type: object
      properties:
        addresses:
          type: array
          items:
            type: string
          title: List of returning mac or ip address
        totalCount:
          type: integer
          format: int32
          title: Total number of addresses available
      title: AddressInfo
    v202404alpha1FlowTag:
      type: object
      properties:
        id:
          type: string
          description: Unique system assigned identifier of the flow tag
          readOnly: true
        name:
          type: string
          description: This will appear in places where selecting a tag is necessary
          readOnly: true
        editedBy:
          type: string
          description: User who last edited this tag
          readOnly: true
        createdBy:
          type: string
          description: User who created this tag
          readOnly: true
        cdate:
          type: string
          format: date-time
          description: Date and time when this tag was created
          readOnly: true
        edate:
          type: string
          format: date-time
          description: Date and time when this tag was last updated
          readOnly: true
        ip:
          $ref: '#/components/schemas/v202404alpha1AddressInfo'
        port:
          type: array
          items:
            type: string
          description: Port number associated with the flow tag
        tcpFlags:
          type: integer
          format: int64
          description: TCP flags associated with the flow tag
        protocol:
          type: array
          items:
            type: integer
            format: int64
          description: Protocol numbers associated with the flow tag
        deviceName:
          type: array
          items:
            type: string
          description: Name of the device associated with the flow tag
        deviceType:
          type: array
          items:
            type: string
          description: Type of the device associated with the flow tag
        site:
          type: array
          items:
            type: string
          description: Site where the device associated with the flow tag is located
        interfaceName:
          type: array
          items:
            type: string
          description: Name of the interface associated with the flow tag
        asn:
          type: array
          items:
            type: string
          description: Autonomous System Number (ASN) associated with the flow tag
        lasthopAsName:
          type: array
          items:
            type: string
          description: Name of the last hop's Autonomous System (AS) associated with the flow tag
        nexthopAsn:
          type: array
          items:
            type: string
          description: Autonomous System Number (ASN) of the next hop associated with the flow tag
        nexthopAsName:
          type: array
          items:
            type: string
          description: Name of the next hop's Autonomous System (AS) associated with the flow tag
        nexthop:
          type: array
          items:
            type: string
          description: Next hop associated with the flow tag
        bgpAspath:
          type: array
          items:
            type: string
          description: BGP AS path associated with the flow tag
        bgpCommunity:
          type: array
          items:
            type: string
          description: BGP community associated with the flow tag
        mac:
          $ref: '#/components/schemas/v202404alpha1AddressInfo'
        country:
          type: array
          items:
            type: string
          description: Country associated with the flow tag
        vlans:
          type: array
          items:
            type: string
          description: VLANs associated with the flow tag
      title: FlowTag
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
      additionalProperties: {}
    v202404alpha1GetFlowTagResponse:
      type: object
      properties:
        flowTag:
          $ref: '#/components/schemas/v202404alpha1FlowTag'
      title: GetFlowTagResponse
    FlowTagServiceUpdateFlowTagBody:
      type: object
      properties:
        flowTag:
          type: object
          properties:
            name:
              type: string
              description: This will appear in places where selecting a tag is necessary
              readOnly: true
            editedBy:
              type: string
              description: User who last edited this tag
              readOnly: true
            createdBy:
              type: string
              description: User who created this tag
              readOnly: true
            cdate:
              type: string
              format: date-time
              description: Date and time when this tag was created
              readOnly: true
            edate:
              type: string
              format: date-time
              description: Date and time when this tag was last updated
              readOnly: true
            ip:
              $ref: '#/components/schemas/v202404alpha1AddressInfo'
            port:
              type: array
              items:
                type: string
              description: Port number associated with the flow tag
            tcpFlags:
              type: integer
              format: int64
              description: TCP flags associated with the flow tag
            protocol:
              type: array
              items:
                type: integer
                format: int64
              description: Protocol numbers associated with the flow tag
            deviceName:
              type: array
              items:
                type: string
              description: Name of the device associated with the flow tag
            deviceType:
              type: array
              items:
                type: string
              description: Type of the device associated with the flow tag
            site:
              type: array
              items:
                type: string
              description: Site where the device associated with the flow tag is located
            interfaceName:
              type: array
              items:
                type: string
              description: Name of the interface associated with the flow tag
            asn:
              type: array
              items:
                type: string
              description: Autonomous System Number (ASN) associated with the flow tag
            lasthopAsName:
              type: array
              items:
                type: string
              description: Name of the last hop's Autonomous System (AS) associated with the flow tag
            nexthopAsn:
              type: array
              items:
                type: string
              description: Autonomous System Number (ASN) of the next hop associated with the flow tag
            nexthopAsName:
              type: array
              items:
                type: string
              description: Name of the next hop's Autonomous System (AS) associated with the flow tag
            nexthop:
              type: array
              items:
                type: string
              description: Next hop associated with the flow tag
            bgpAspath:
              type: array
              items:
                type: string
              description: BGP AS path associated with the flow tag
            bgpCommunity:
              type: array
              items:
                type: string
              description: BGP community associated with the flow tag
            mac:
              $ref: '#/components/schemas/v202404alpha1AddressInfo'
            country:
              type: array
              items:
                type: string
              description: Country associated with the flow tag
            vlans:
              type: array
              items:
                type: string
              description: VLANs associated with the flow tag
          title: FlowTag
      title: UpdateFlowTagRequest
  securitySchemes:
    email:
      type: apiKey
      name: X-CH-Auth-Email
      in: header
    token:
      type: apiKey
      name: X-CH-Auth-API-Token
      in: header
externalDocs:
  description: General information about Kentik APIs
  url: https://kb.kentik.com/v0/Ab09.htm#Ab09-APIs_Overview