Select the tab
ESET Inspect On-Prem – Table of Contents

GET Get a single rule

Relative path: /api/v1/rules/{rule}

Query parameters

Name

Type

Description

$idType

string

If $idType=uuid {id} in URL is interpreted as UUID

Parameters in path

Name

Type

Required

Description

rule

string

Yes

Rule ID or UUID

Responses

Display Schema+Headers instead of an Example or vice-versa

Code

Description and Example

Description, Schema and Headers

200

OK


Response example

{
  "RULE": {
    "body": "string",
    "enabled": true,
    "id": 0,
    "name": "string",
    "severity": 0,
    "severityScore": 0,
    "uuid": "string"
  },
  "targetIds": [
    0
  ],
  "targetUuids": [
    "string"
  ]
}

OK


Response schema

{
  "$ref": "RuleDetailsResponseSchema",
  "RULE": {
    "body": {
      "type": "string",
      "format": "xml"
    },
    "enabled": {
      "type": "boolean"
    },
    "id": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "severity": {
      "type": "integer",
      "enum": [
        1,
        2,
        3
      ]
    },
    "severityScore": {
      "type": "integer",
      "maximum": 100
    },
    "uuid": {
      "type": "string",
      "format": "uuid"
    }
  },
  "targetIds": [
    {
      "type": "integer"
    }
  ],
  "targetUuids": [
    {
      "type": "string"
    }
  ]
}


Headers

{
  "X-Security-Token": {
    "$ref": "X-Security-Token",
    "description": "Authentication token",
    "schema": {
      "$ref": "AuthenticateTokenResponse",
      "type": "string",
      "example": "eyJhbGciOi[..]ziJSUGusY5kAI"
    }
  }
}

401

Credentials or access token missing or invalid


Response example

{
  "error": "string"
}

Credentials or access token missing or invalid


Response schema

{
  "$ref": "UnauthorizedError",
  "error": {
    "type": "string"
  }
}

403

Insufficient permissions to perform action

Insufficient permissions to perform action


Response schema

{
  "$ref": "ForbiddenError",
  "description": "Insufficient permissions to perform action"
}