Vectra AI

Vectra AI Tagging API

Dedicated endpoint to manage entities's tags

GitHub OpenAPI

Operations 8

GET /tagging/account/{accountID} Get all Account's tags #
PATCH /tagging/account/{accountID} Replace all Account's tags #
GET /tagging/detection/{detectionID} Get all Detection's tags #
PATCH /tagging/detection/{detectionID} Replace all Detection's tags #
GET /tagging/host/{hostID} Get all Host's tags #
PATCH /tagging/host/{hostID} Replace all Host's tags #
GET /tagging/detection/{detection_id} Retrieve tags for a specific detection #
POST /tagging/detection/{detection_id} Add tags to a detection #

Documentation

📖
APIReference
https://vectranetworks.github.io/openapi-rux/
📖
APIReference
https://vectranetworks.github.io/detect-openapi/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vectranetworks/refs/heads/main/openapi/vectranetworks-tagging-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/vectranetworks-tagging-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vectranetworks-tagging-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Vectranetworks Tagging API
  version: '1.0'
  description: 'Operations tagged Tagging across 2 of this provider''s published API definitions: vectranetworks-detect-v2.3-openapi.yml, vectranetworks-rux-v3.3-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{fqdn}/api/{apiVersion}
  description: Vectra Detect API
  variables:
    fqdn:
      description: The FQDN or IP to join the Vectra Detect instance
      default: detect-api.demo.vectra.io
    apiVersion:
      description: The API version to use
      default: v2.3
- url: https://{vectra_portal_url}/api/v3.3
  description: Vectra Platform API Server
  variables:
    vectra_portal_url:
      default: platform.vectra.ai
tags:
- name: Tagging
  description: Dedicated endpoint to manage entities's tags
paths:
  /tagging/account/{accountID}:
    description: The tagging endpoint can be used to manage Account tags
    parameters:
    - name: accountID
      description: ID of the Account you're looking for
      in: path
      schema:
        $ref: '#/components/schemas/ID'
    get:
      operationId: accountTagsGetAll
      summary: Get all Account's tags
      tags:
      - Tagging
      responses:
        '200':
          description: Retrieved tags successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tags'
        '401':
          $ref: '#/components/responses/invalidToken'
        '403':
          $ref: '#/components/responses/invalidPermissions'
      security:
      - VectraToken: []
    patch:
      operationId: accountTagsReplace
      summary: Replace all Account's tags
      tags:
      - Tagging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tagsRequestBody'
      responses:
        '200':
          description: Replaced tags successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tags'
        '401':
          $ref: '#/components/responses/invalidToken'
        '403':
          $ref: '#/components/responses/invalidPermissions'
      security:
      - VectraToken: []
    servers:
    - url: https://{fqdn}/api/{apiVersion}
      description: Vectra Detect API
      variables:
        fqdn:
          description: The FQDN or IP to join the Vectra Detect instance
          default: detect-api.demo.vectra.io
        apiVersion:
          description: The API version to use
          default: v2.3
  /tagging/detection/{detectionID}:
    description: The tagging endpoint can be used to manage Detection tags
    parameters:
    - name: detectionID
      description: ID of the Detection you're looking for
      in: path
      schema:
        $ref: '#/components/schemas/ID'
    get:
      operationId: detectionTagsGetAll
      summary: Get all Detection's tags
      tags:
      - Tagging
      responses:
        '200':
          description: Retrieved tags successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tags'
        '401':
          $ref: '#/components/responses/invalidToken'
        '403':
          $ref: '#/components/responses/invalidPermissions'
      security:
      - VectraToken: []
    patch:
      operationId: detectionTagsReplace
      summary: Replace all Detection's tags
      tags:
      - Tagging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tagsRequestBody'
      responses:
        '200':
          description: Replaced tags successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tags'
        '401':
          $ref: '#/components/responses/invalidToken'
        '403':
          $ref: '#/components/responses/invalidPermissions'
      security:
      - VectraToken: []
    servers:
    - url: https://{fqdn}/api/{apiVersion}
      description: Vectra Detect API
      variables:
        fqdn:
          description: The FQDN or IP to join the Vectra Detect instance
          default: detect-api.demo.vectra.io
        apiVersion:
          description: The API version to use
          default: v2.3
  /tagging/host/{hostID}:
    description: The tagging endpoint can be used to manage Host tags
    parameters:
    - name: hostID
      description: ID of the Host you're looking for
      in: path
      schema:
        $ref: '#/components/schemas/ID'
    get:
      operationId: hostTagsGetAll
      summary: Get all Host's tags
      tags:
      - Tagging
      responses:
        '200':
          description: Retrieved tags successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tags'
        '401':
          $ref: '#/components/responses/invalidToken'
        '403':
          $ref: '#/components/responses/invalidPermissions'
      security:
      - VectraToken: []
    patch:
      operationId: hostTagsReplace
      summary: Replace all Host's tags
      tags:
      - Tagging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tagsRequestBody'
      responses:
        '200':
          description: Replaced tags successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tags'
        '401':
          $ref: '#/components/responses/invalidToken'
        '403':
          $ref: '#/components/responses/invalidPermissions'
      security:
      - VectraToken: []
    servers:
    - url: https://{fqdn}/api/{apiVersion}
      description: Vectra Detect API
      variables:
        fqdn:
          description: The FQDN or IP to join the Vectra Detect instance
          default: detect-api.demo.vectra.io
        apiVersion:
          description: The API version to use
          default: v2.3
  /tagging/detection/{detection_id}:
    get:
      summary: Retrieve tags for a specific detection
      operationId: getDetectionTags
      tags:
      - Tagging
      parameters:
      - name: detection_id
        in: path
        required: true
        schema:
          type: integer
        description: Unique ID for the detection
      responses:
        '200':
          description: Detection tags
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Tag'
      security:
      - oauth2: []
    post:
      summary: Add tags to a detection
      operationId: addDetectionTags
      tags:
      - Tagging
      parameters:
      - name: detection_id
        in: path
        required: true
        schema:
          type: integer
        description: Unique ID for the detection
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  items:
                    type: string
                  description: List of tags to add to the detection
      responses:
        '201':
          description: Tags added successfully
      security:
      - oauth2: []
    servers:
    - url: https://{vectra_portal_url}/api/v3.3
      description: Vectra Platform API Server
      variables:
        vectra_portal_url:
          default: platform.vectra.ai
components:
  responses:
    invalidToken:
      description: Invalid User Token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            details: Invalid token.
    invalidPermissions:
      description: Invalid User Permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            details: You do not have permission to perform this action.
  schemas:
    text:
      type: string
    tagsRequestBody:
      type: object
      properties:
        tags:
          type: array
          items:
          - $ref: '#/components/schemas/text'
      required:
      - tags
    tags:
      type: object
      properties:
        status:
          type: string
        tag_id:
          $ref: '#/components/schemas/ID'
        tags:
          type: array
          items:
          - $ref: '#/components/schemas/text'
    error:
      type: object
      properties:
        detail:
          description: A human readable error message
          type: string
        details:
          description: A human readable error message
          type: string
    ID:
      description: ID
      type: integer
      format: int32
      minimum: 1
    Tag:
      type: object
      properties:
        status:
          type: string
          enum:
          - success
          - failure
          description: Status of tagging request
        tag_id:
          type: string
          description: Corresponds to the account, host, or detection id of the object being tagged
        tags:
          type: array
          items:
            type: string
          description: List of tags for the host or detection object
        message:
          type: string
          description: Error message if operation was unsuccessful. Only present when status is 'failure'
        invalid_tags:
          type: array
          items:
            type: string
          description: List of tags which are invalid. Only present when status is 'failure'
  securitySchemes:
    VectraToken:
      type: apiKey
      name: authorization
      in: header
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{vectra_portal_url}/oauth2/token
          scopes: {}
x-refined-from:
- vectranetworks-detect-v2.3-openapi.yml
- vectranetworks-rux-v3.3-openapi.yml