Kentik TenantService API

openapi: 3.0.0
info:
  title: AI Advisor AiAdvisorDataService TenantService 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: TenantService
paths:
  /mkp/v202407/tenants:
    get:
      summary: List MKP tenants.
      description: Returns a list of MKP tenants.
      operationId: TenantList
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202407ListTenantResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      tags:
      - TenantService
    post:
      summary: Create a tenant.
      description: Create tenant from request. returns created tenant.
      operationId: TenantCreate
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202407CreateTenantResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v202407CreateTenantRequest'
        required: true
      tags:
      - TenantService
  /mkp/v202407/tenants/{id}:
    get:
      summary: Get information aboout a tenant.
      description: Returns information about package specified with ID.
      operationId: TenantGet
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202407GetTenantResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - TenantService
    delete:
      summary: Delete a tenant.
      description: Deletes the tenant specified with id.
      operationId: TenantDelete
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202407DeleteTenantResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - TenantService
    put:
      summary: Update a tenant.
      description: Update tenant attributes specified with id.
      operationId: TenantUpdate
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202407UpdateTenantResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: id
        description: Unique system assigned identifier of the tenant
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantServiceUpdateTenantBody'
        required: true
      tags:
      - TenantService
components:
  schemas:
    v202407Mitigation:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        companyId:
          type: string
        pairingId:
          type: string
        thresholdId:
          type: string
        isMethodOverridable:
          type: boolean
        mitigationApplyType:
          type: string
        mitigationClearType:
          type: string
        mitigationApplyTimer:
          type: integer
          format: int64
        mitigationClearTimer:
          type: integer
          format: int64
        isPlatformOverridable:
          type: boolean
      title: Mitigation
    v202407CreateTenantResponse:
      type: object
      properties:
        tenant:
          $ref: '#/components/schemas/v202407Tenant'
      title: CreateTenantResponse
    v202407FilterField:
      type: object
      properties:
        filterField:
          type: string
        operator:
          type: string
        filterValue:
          type: string
      title: FilterField
    v202407GetTenantResponse:
      type: object
      properties:
        tenant:
          $ref: '#/components/schemas/v202407Tenant'
      title: GetTenantResponse
    v202407CustomDimension:
      type: object
      properties:
        dimension:
          type: string
        populator:
          type: string
      title: CustomDimension
    v202407Tenant:
      type: object
      properties:
        id:
          type: string
          description: Unique system assigned identifier of the tenant
          readOnly: true
        companyId:
          type: string
          description: Company id of the associated package
          readOnly: true
        name:
          type: string
          description: Name of tenant
          readOnly: true
        description:
          type: string
          description: Description of tenant
          readOnly: true
        type:
          type: string
          description: Subtenant
          readOnly: true
        enabled:
          type: boolean
          description: Is tenant actively enable
          readOnly: true
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/v202407Alert'
          description: Alert thresholds and policies
          title: config object
          readOnly: true
        assets:
          $ref: '#/components/schemas/v202407Asset'
        asn:
          type: string
          description: ASN data source.
          readOnly: true
        cidr:
          type: string
          description: CIDR data source.
          readOnly: true
        customDimensions:
          type: array
          items:
            $ref: '#/components/schemas/v202407CustomDimension'
          description: Custom dimension data source
          readOnly: true
        devices:
          $ref: '#/components/schemas/v202407Devices'
        filters:
          $ref: '#/components/schemas/v202407Filter'
        interfaceName:
          type: string
          description: Interface data source.
          readOnly: true
        snmpAlias:
          type: string
          description: SNMP data source.
          readOnly: true
        packages:
          type: array
          items:
            $ref: '#/components/schemas/v202407Package'
          description: Packages associated with the tenant.
          readOnly: true
        users:
          type: array
          items:
            $ref: '#/components/schemas/v202211User'
          description: Users associated with the tenant (deprecated; use ListTenantUser).
          readOnly: true
        templateId:
          type: string
          description: Package template ID to assign with tenant.
          readOnly: true
      title: Tenant
    v202407Asset:
      type: object
      properties:
        reports:
          type: array
          items:
            $ref: '#/components/schemas/AssetReport'
        defaultReport:
          $ref: '#/components/schemas/AssetReport'
      title: Asset
    v202407DeleteTenantResponse:
      type: object
      title: DeleteTenantResponse
    v202407NotificationChannel:
      type: object
      properties:
        id:
          type: string
      title: NotificationChannel
    v202407Devices:
      type: object
      properties:
        allDevices:
          type: boolean
        deviceTypes:
          type: array
          items:
            type: string
        deviceLabels:
          type: array
          items:
            type: integer
            format: int64
        deviceSites:
          type: array
          items:
            type: integer
            format: int64
        deviceName:
          type: array
          items:
            type: string
      title: Devices
    TenantServiceUpdateTenantBody:
      type: object
      properties:
        tenant:
          type: object
          properties:
            companyId:
              type: string
              description: Company id of the associated package
              readOnly: true
            name:
              type: string
              description: Name of tenant
              readOnly: true
            description:
              type: string
              description: Description of tenant
              readOnly: true
            type:
              type: string
              description: Subtenant
              readOnly: true
            enabled:
              type: boolean
              description: Is tenant actively enable
              readOnly: true
            alerts:
              type: array
              items:
                $ref: '#/components/schemas/v202407Alert'
              description: Alert thresholds and policies
              title: config object
              readOnly: true
            assets:
              $ref: '#/components/schemas/v202407Asset'
            asn:
              type: string
              description: ASN data source.
              readOnly: true
            cidr:
              type: string
              description: CIDR data source.
              readOnly: true
            customDimensions:
              type: array
              items:
                $ref: '#/components/schemas/v202407CustomDimension'
              description: Custom dimension data source
              readOnly: true
            devices:
              $ref: '#/components/schemas/v202407Devices'
            filters:
              $ref: '#/components/schemas/v202407Filter'
            interfaceName:
              type: string
              description: Interface data source.
              readOnly: true
            snmpAlias:
              type: string
              description: SNMP data source.
              readOnly: true
            packages:
              type: array
              items:
                $ref: '#/components/schemas/v202407Package'
              description: Packages associated with the tenant.
              readOnly: true
            users:
              type: array
              items:
                $ref: '#/components/schemas/v202211User'
              description: Users associated with the tenant (deprecated; use ListTenantUser).
              readOnly: true
            templateId:
              type: string
              description: Package template ID to assign with tenant.
              readOnly: true
          title: Tenant
      title: UpdateTenantRequest
    v202211LandingType:
      type: string
      enum:
      - LANDING_TYPE_UNSPECIFIED
      - LANDING_TYPE_LOCAL
      - LANDING_TYPE_OBSERVATION_DECK
      - LANDING_TYPE_NMS_DASHBOARD
      - LANDING_TYPE_NETWORK_EXPLORER
      - LANDING_TYPE_LIBRARY
      - LANDING_TYPE_SYNTHETICS
      - LANDING_TYPE_EXPLORER
      - LANDING_TYPE_ALERTING
      - LANDING_TYPE_INSIGHTS
      - LANDING_TYPE_DASHBOARD
      - LANDING_TYPE_SAVED_VIEW
      - LANDING_TYPE_QUICK_VIEW
      - LANDING_TYPE_MARKET_INTELLIGENCE
      default: LANDING_TYPE_UNSPECIFIED
      title: LandingType
    v202407Activate:
      type: object
      properties:
        times:
          type: integer
          format: int64
        operator:
          type: string
        timeWindowSeconds:
          type: integer
          format: int64
        gracePeriodSeconds:
          type: integer
          format: int64
      title: Activate
    rpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    v202407Package:
      type: object
      properties:
        id:
          type: string
          description: Unique system assigned identifier of the package
          readOnly: true
        companyId:
          type: string
          description: Company id of the associated package
          readOnly: true
        name:
          type: string
          description: Name of package template
          readOnly: true
        description:
          type: string
          description: Description of package template
          readOnly: true
        icon:
          type: string
          description: Icon to display
          readOnly: true
        color:
          type: string
          description: Color of Icon
          readOnly: true
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/v202407Alert'
          description: Alert thresholds and policies
          readOnly: true
        assets:
          $ref: '#/components/schemas/v202407Asset'
        isDefault:
          type: boolean
          description: Is default template
          readOnly: true
        tenants:
          type: array
          items:
            $ref: '#/components/schemas/v202407TenantLink'
          description: Tenant link information
          readOnly: true
      title: Package
    v202407Filter:
      type: object
      properties:
        name:
          type: string
        named:
          type: boolean
        connector:
          type: string
        not:
          type: boolean
        autoAdded:
          type: string
        savedFilters:
          type: array
          items:
            type: string
        filters:
          type: array
          items:
            $ref: '#/components/schemas/v202407FilterField'
        filterGroups:
          type: array
          items:
            $ref: '#/components/schemas/v202407Filter'
        metric:
          type: array
          items:
            type: string
      title: Filter
    v202211User:
      type: object
      properties:
        id:
          type: string
          description: System generated unique identifier
          readOnly: true
        userEmail:
          type: string
          description: User e-mail address (serves also as username)
        userFullName:
          type: string
          description: Full name
        role:
          $ref: '#/components/schemas/v202211Role'
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/v202211PermissionEntry'
          description: Legacy permissions granted to the user (deprecated, use rbac roles and role-sets)
          readOnly: true
        filter:
          type: string
          description: Optional JSON string defining filter for objects visible to the user
        lastLogin:
          type: string
          format: date-time
          description: UTC Timestamp of user's last login session
          readOnly: true
        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
        defaultLandingPageType:
          $ref: '#/components/schemas/v202211LandingType'
        defaultLandingPageValue:
          type: string
          description: Identifier of the specific landing page. Applies to Dashboard, Quick View, Saved View, and Observation Deck landing page types.
        roles:
          type: array
          items:
            type: string
          description: List of RBAC roles.
        roleSets:
          type: array
          items:
            type: string
          description: List of RBAC role sets.
      title: User
      required:
      - userEmail
      - userFullName
      - role
    AssetReport:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
    v202211PermissionEntry:
      type: object
      properties:
        capability:
          type: string
          description: String identifying capability that is granted of denied
        allowed:
          type: boolean
          description: Flag indicating whether operation is allowed
      title: PermissionEntry
      required:
      - capability
      - allowed
    v202407ListTenantResponse:
      type: object
      properties:
        tenants:
          type: array
          items:
            $ref: '#/components/schemas/v202407Tenant'
        invalidCount:
          type: integer
          format: int64
      title: ListTenantResponse
    v202407TenantLink:
      type: object
      properties:
        id:
          type: string
        pivotTemplateId:
          type: string
        pivotUserGroupId:
          type: string
      title: TenantLink
    v202407Alert:
      type: object
      properties:
        saved:
          type: boolean
        policyId:
          type: string
        thresholds:
          type: array
          items:
            $ref: '#/components/schemas/v202407Threshold'
        primaryMetric:
          type: string
        secondaryMetrics:
          type: array
          items:
            type: string
        isTemplate:
          type: boolean
        subpolicyId:
          type: string
      title: Alert
    v202211Role:
      type: string
      enum:
      - ROLE_UNSPECIFIED
      - ROLE_MEMBER
      - ROLE_ADMINISTRATOR
      - ROLE_SUPER_ADMINISTRATOR
      default: ROLE_UNSPECIFIED
      description: "- ROLE_UNSPECIFIED: Invalid value.\n - ROLE_MEMBER: Member\n - ROLE_ADMINISTRATOR: Administrator\n - ROLE_SUPER_ADMINISTRATOR: Super-administrator"
      title: Role
    v202407CreateTenantRequest:
      type: object
      properties:
        tenant:
          $ref: '#/components/schemas/v202407Tenant'
      title: CreateTenantRequest
    v202407UpdateTenantResponse:
      type: object
      properties:
        tenant:
          $ref: '#/components/schemas/v202407Tenant'
      title: UpdateTenantResponse
    v202407Condition:
      type: object
      properties:
        type:
          type: string
        value:
          type: string
        metric:
          type: string
        operator:
          type: string
        valueType:
          type: string
        valueSelect:
          type: string
      title: Condition
    v202407Threshold:
      type: object
      properties:
        id:
          type: string
        activate:
          $ref: '#/components/schemas/v202407Activate'
        severity:
          type: string
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/v202407Condition'
        mitigations:
          type: array
          items:
            $ref: '#/components/schemas/v202407Mitigation'
        notificationChannels:
          type: array
          items:
            $ref: '#/components/schemas/v202407NotificationChannel'
        thresholdAckRequired:
          type: boolean
        enableTenantNotifications:
          type: boolean
        receiveLandlordNotifications:
          type: boolean
      title: Threshold
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
      additionalProperties: {}
  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