Kentik LabelService API

openapi: 3.0.0
info:
  title: AI Advisor AiAdvisorDataService LabelService 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: LabelService
paths:
  /label/v202210/labels:
    get:
      summary: List all configured labels
      description: Returns list of all labels configured in the account.
      operationId: ListLabels
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210ListLabelsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      tags:
      - LabelService
    post:
      summary: Create a new label.
      description: Creates a new label based on data in the request.
      operationId: CreateLabel
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210CreateLabelResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v202210CreateLabelRequest'
        required: true
      tags:
      - LabelService
  /label/v202210/labels/{id}:
    delete:
      summary: Delete a label.
      description: Deletes label with specified with id.
      operationId: DeleteLabel
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210DeleteLabelResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: id
        description: ID of the label to be deleted
        in: path
        required: true
        schema:
          type: string
      tags:
      - LabelService
    post:
      summary: Update an existing label.
      description: Updates configuration of a label.
      operationId: UpdateLabel
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210UpdateLabelResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: id
        description: Unique system assigned identifier of the label
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelServiceUpdateLabelBody'
        required: true
      tags:
      - LabelService
components:
  schemas:
    v202210DeleteLabelResponse:
      type: object
      title: DeleteLabelResponse
    rpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    labelv202210Label:
      type: object
      properties:
        id:
          type: string
          description: Unique system assigned identifier of the label
          readOnly: true
        name:
          type: string
          description: Label text visible in listing of configuration of objects to which it has been applied
        description:
          type: string
          description: Optional description of the label, visible only in API responses
        color:
          type: string
          description: '[Hexadecimal code of the color](https://www.color-hex.com/) of the label text background in the portal'
        cdate:
          type: string
          format: date-time
          description: Creation timestamp (UTC)
          readOnly: true
        edate:
          type: string
          format: date-time
          description: Last modification timestamp (UTC)
          readOnly: true
      title: Label
      required:
      - name
    v202210UpdateLabelResponse:
      type: object
      properties:
        label:
          $ref: '#/components/schemas/labelv202210Label'
      title: UpdateLabelResponse
    v202210CreateLabelRequest:
      type: object
      properties:
        label:
          $ref: '#/components/schemas/labelv202210Label'
      title: CreateLabelRequest
      required:
      - label
    v202210ListLabelsResponse:
      type: object
      properties:
        labels:
          type: array
          items:
            $ref: '#/components/schemas/labelv202210Label'
          description: List of configured labels
          readOnly: true
        invalidCount:
          type: integer
          format: int32
          description: Number of invalid entries encountered while collecting data (should be always 0)
      title: ListLabelsResponse
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
      additionalProperties: {}
    LabelServiceUpdateLabelBody:
      type: object
      properties:
        label:
          type: object
          properties:
            name:
              type: string
              description: Label text visible in listing of configuration of objects to which it has been applied
            description:
              type: string
              description: Optional description of the label, visible only in API responses
            color:
              type: string
              description: '[Hexadecimal code of the color](https://www.color-hex.com/) of the label text background in the portal'
            cdate:
              type: string
              format: date-time
              description: Creation timestamp (UTC)
              readOnly: true
            edate:
              type: string
              format: date-time
              description: Last modification timestamp (UTC)
              readOnly: true
          title: Label
      title: UpdateLabelRequest
      required:
      - name
      - label
    v202210CreateLabelResponse:
      type: object
      properties:
        label:
          $ref: '#/components/schemas/labelv202210Label'
      title: CreateLabelResponse
  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