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

GET Get module details

Relative path: /api/v1/modules/{modules}

Query parameters

Name

Type

Description

$idType

string

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

Parameters in path

Name

Type

Required

Description

modules

string

Yes

ID/UUID or hash: api/v1/modules/?$idType={sha1,sha256,uuid}

Responses

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

Code

Description and Example

Description, Schema and Headers

200

OK


Response example

{
  "LgAge": 0,
  "LgPopularity": 0,
  "LgReputation": 0,
  "id": 0,
  "name": "string",
  "sha1": "string",
  "sha256": "string",
  "signatureType": 0,
  "signer": "string",
  "uuid": "string"
}

OK


Response schema

{
  "$ref": "ModuleDetailsResponseSchema",
  "LgAge": {
    "type": "integer"
  },
  "LgPopularity": {
    "type": "integer"
  },
  "LgReputation": {
    "type": "integer"
  },
  "id": {
    "type": "integer"
  },
  "name": {
    "type": "string"
  },
  "sha1": {
    "type": "string"
  },
  "sha256": {
    "type": "string"
  },
  "signatureType": {
    "type": "integer"
  },
  "signer": {
    "type": "string"
  },
  "uuid": {
    "type": "string",
    "format": "uuid"
  }
}


Headers

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

400

Request is invalid

Request is invalid


Response schema

{
  "$ref": "BadRequestResponse",
  "description": "Request is invalid"
}

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"
  }
}

404

Specified element was not found

Specified element was not found


Response schema

{
  "$ref": "NotFoundResponse",
  "description": "Specified element was not found"
}