netbox/docs/models/extras/configcontextprofile.md
Jeremy Stretch b4c88541da
Some checks failed
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, actions) (push) Has been cancelled
CodeQL / Analyze (${{ matrix.language }}) (none, javascript-typescript) (push) Has been cancelled
CI / build (20.x, 3.10) (push) Has been cancelled
CI / build (20.x, 3.11) (push) Has been cancelled
CI / build (20.x, 3.12) (push) Has been cancelled
Closes #19377: Introduce config context profiles (#20058)
2025-08-12 15:18:45 -07:00

833 B

Config Context Profiles

Profiles can be used to organize configuration contexts and to enforce a desired structure for their data. The later is achieved by defining a JSON schema to which all config context with this profile assigned must comply.

For example, the following schema defines two keys, size and priority, of which the former is required:

{
    "properties": {
        "size": {
            "type": "integer"
        },
        "priority": {
            "type": "string",
            "enum": ["high", "medium", "low"],
            "default": "medium"
        }
    },
    "required": [
        "size"
    ]
}

Fields

Name

A unique human-friendly name.

Schema

The JSON schema to be enforced for all assigned config contexts (optional).