Skip to content

pack-metadata-reference.md

Latest commit

 

History

History
107 lines (92 loc) · 2.67 KB

pack-metadata-reference.md

File metadata and controls

107 lines (92 loc) · 2.67 KB

pack_metadata.json Complete Reference

Full Schema

{
    "name": "Pack Display Name",
    "description": "A short overview of the pack (1-2 sentences)",
    "support": "community",
    "currentVersion": "1.0.0",
    "author": "Author Name",
    "url": "https://support-url.com",
    "email": "support@example.com",
    "created": "2024-01-15T00:00:00Z",
    "categories": ["Network Security"],
    "tags": ["tag1", "tag2"],
    "useCases": [],
    "keywords": ["search", "terms"],
    "dependencies": {
        "CommonScripts": {
            "mandatory": true,
            "display_name": "Common Scripts"
        }
    },
    "displayedImages": [],
    "marketplaces": ["xsoar", "marketplacev2"],
    "githubUser": ["github-username"],
    "devEmail": ["dev@example.com"],
    "certification": "",
    "hidden": false,
    "defaultDataSource": "",
    "itemPrefix": "",
    "supportedModules": []
}

Field Reference

Required Fields

Field Type Rules
name string Display name of the pack
description string Short overview, 1-2 sentences
support string One of: xsoar, partner, developer, community
currentVersion string Semantic version X.Y.Z, start at 1.0.0
author string Organization or developer name
categories list At least one from approved list
created string ISO 8601: YYYY-MM-DDTHH:MM:SSZ

Approved Categories

  • Analytics & SIEM
  • Authentication & Identity Management
  • Case Management
  • Cloud Services
  • Data Enrichment & Threat Intelligence
  • Database
  • Deception & Breach Simulation
  • Email
  • Endpoint
  • Forensics & Malware Analysis
  • IT Services
  • Messaging & Conferencing
  • Network Security
  • Utilities
  • Vulnerability Management

Support Types

Type Meaning
xsoar Maintained by Palo Alto Networks
partner Maintained by a technology partner
developer Maintained by an individual developer
community Community-maintained

Marketplace Values

Value Platform
xsoar XSOAR 6.x
xsoar_on_prem XSOAR 6.x on-prem
xsoar_saas XSOAR 8 SaaS
marketplacev2 XSIAM marketplace
xpanse Xpanse
platform Cortex Platform

Version Bumping Rules

Patch (0.0.X) - Bug fixes, small changes

1.0.0 -> 1.0.1

Backwards-compatible fixes: typos, minor bugs, Docker image updates.

Minor (0.X.0) - New features

1.0.5 -> 1.1.0

Backwards-compatible additions: new commands, new parameters, new scripts.

Major (X.0.0) - Breaking changes

1.5.3 -> 2.0.0

Breaking changes: removed commands, changed output schemas, renamed parameters.