list_classification_rules

GET

/api/v1/classification-rules

curl --request GET \
  --url https://example.com/api/v1/classification-rules \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Responses

200

Every rule, in evaluation order

Media typeapplication/json

Array<object>

A persisted rule mapping a device signature to a profile. At least one of sysobjectid_prefix / sysdescr_regex is set (the DB enforces this with a CHECK).

object

enabled

required

Disabled rules are skipped during classification.

boolean

id

required

Stable identity.

string format: uuid

model

See vendor.

string | null

priority

required

Evaluation order: ascending, lowest first. Most-specific rules get lower numbers.

integer format: int32

profile_id

required

The profile to suggest when this rule matches.

string format: uuid

sysdescr_regex

Match when the device’s sysDescr matches this regular expression — a fallback for devices whose sysObjectID isn’t covered by a prefix rule.

string | null

sysobjectid_prefix

Match when the device’s sysObjectID starts with this dotted-OID prefix (e.g. 1.3.6.1.4.1.9. for Cisco). Authoritative — preferred over sysDescr.

string | null

vendor

Optional vendor/model to pre-fill on the import row (overrides the sysDescr heuristic when set). Descriptive metadata only — never a TSDB label.

string | null

Example^generated

[
  {
    "enabled": true,
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "model": "example",
    "priority": 1,
    "profile_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "sysdescr_regex": "example",
    "sysobjectid_prefix": "example",
    "vendor": "example"
  }
]

401

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role below Admin

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

Skeleton mode has no write side

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}