Tanium Packages API

openapi: 3.1.0
info:
  title: Tanium Connect Actions Packages API
  description: The Tanium Connect REST API allows creating, editing, and managing connections for delivering endpoint data to downstream systems. Connections link data sources (saved questions, event data, system status) to destinations (files, syslog, HTTP/webhooks, email, SQL databases) and can run on a schedule or be triggered by events. All endpoints are under the /plugin/products/connect/v1/ base path.
  version: 1.0.0
  contact:
    name: Tanium Support
    url: https://community.tanium.com/s/
  license:
    name: Proprietary
    url: https://www.tanium.com/terms-of-use/
  x-date: '2026-03-04'
servers:
- url: https://{tanium_server}
  description: Tanium Server
  variables:
    tanium_server:
      default: tanium.example.com
      description: Hostname or IP address of the Tanium server
security:
- apiToken: []
tags:
- name: Packages
  description: Manage deployment packages
paths:
  /api/v2/packages/by-name/{name}:
    get:
      operationId: getPackageByName
      summary: Get A Package By Name
      description: Retrieves the details of a deployment package identified by its name. Packages contain scripts and files that are deployed to endpoints via actions.
      tags:
      - Packages
      parameters:
      - name: name
        in: path
        required: true
        description: Name of the package
        schema:
          type: string
      responses:
        '200':
          description: Package retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Package'
        '404':
          description: Package not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v2/packages:
    get:
      operationId: listPackages
      summary: List All Packages
      description: Retrieves a list of all deployment packages configured on the Tanium server. Packages contain scripts and files that can be deployed to endpoints through actions.
      tags:
      - Packages
      responses:
        '200':
          description: Packages retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Package'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        text:
          type: string
          description: Error message text
    Package:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the package
        name:
          type: string
          description: Name of the package
        display_name:
          type: string
          description: Display name of the package
        command:
          type: string
          description: Command line to execute
        command_timeout:
          type: integer
          description: Timeout in seconds for the command
        expire_seconds:
          type: integer
          description: Seconds until the package expires
        content_set:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
          description: Content set the package belongs to
        files:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
              hash:
                type: string
              size:
                type: integer
          description: Files included in the package
        parameters:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              default_value:
                type: string
              label:
                type: string
          description: Configurable parameters for the package
        mod_time:
          type: string
          format: date-time
          description: Last modification timestamp
        creation_time:
          type: string
          format: date-time
          description: Creation timestamp
  securitySchemes:
    apiToken:
      type: apiKey
      name: session
      in: header
      description: API token passed in the session header for authenticating with the Tanium Connect API.