Select the tab
ESET Connect – Table of Contents

GET List blocked executables

Relative path: /v1/blocked-executables

List all the blocked executables. Some of the listed executables might have details filled, some only contain the hash, UUID and scope.

Endpoint URL for Europe, Germany, United States, Canada and Japan regions:






Query parameters

Name

Type

Description

pageSize

integer

Limit for pagination purposes.

If unspecified or 0, the default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination

pageToken

string

Page token of the current page.

If not given or "", the first page is returned.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination



Responses

Code

Description and Example

Description, Schema and Headers

200

Successful response.


Response example

{
  "executables": [
    {
      "applicationDisplayName": "string",
      "blockingScopes": [
        {
          "deviceUuid": "string",
          "deviceGroupUuid": "string"
        }
      ],
      "description": "string",
      "displayName": "string",
      "fileFormat": "EXECUTABLE_FILE_FORMAT_UNSPECIFIED",
      "hash": {
        "md5": "string",
        "sha1": "string",
        "sha256": "string"
      },
      "liveGridFindings": {
        "ageDays": 0,
        "firstOccurTime": "string",
        "popularity": 0,
        "reputation": 0
      },
      "signatures": [
        {
          "certificateChain": [
            {
              "issuerCommonName": "string",
              "subjectCommonName": "string"
            }
          ],
          "signatureTrustLevel": "SIGNATURE_TRUST_LEVEL_UNSPECIFIED",
          "signerName": "string"
        }
      ],
      "versionName": "string",
      "pe": {
        "libraryId": "string",
        "versionInfo": {
          "companyName": "string",
          "fileDescription": "string",
          "fileVersion": "string",
          "internalName": "string",
          "originalFileName": "string",
          "productName": "string",
          "productVersion": "string"
        }
      },
      "uuid": "string"
    }
  ],
  "nextPageToken": "string"
}

Successful response.


Response schema

{
  "$ref": "v1ListBlockedExecutablesResponse",
  "executables": [
    {
      "$ref": "v1BlockedExecutable",
      "description": {
        "type": "string",
        "description": "The description of the file, for example, 'Keyboard Driver for AT-Style Keyboards'."
      },
      "applicationDisplayName": {
        "type": "string",
        "description": "The name of the application with which the file is distributed."
      },
      "blockingScopes": [
        {
          "$ref": "v1BlockingScope",
          "description": "Scope in which an executable is blocked from execution.",
          "deviceUuid": {
            "type": "string",
            "description": "Reference to the device where the executable is blocked. type: device_management.v1.Device"
          },
          "deviceGroupUuid": {
            "type": "string",
            "description": "Reference to the device group where the executable is blocked. type: device_management.v1.DeviceGroup"
          }
        }
      ],
      "displayName": {
        "type": "string",
        "description": "The name of the executable or DLL."
      },
      "fileFormat": {
        "$ref": "v1ExecutableFileFormat",
        "type": "string",
        "description": "Format of executable. Subset of more complete list. EXECUTABLE_FILE_FORMAT_UNSPECIFIED: fallback EXECUTABLE_FILE_FORMAT_ELF: Unix-like, OpenVMS, BeOS from R4 onwards, Haiku, SerenityOS EXECUTABLE_FILE_FORMAT_PE: Windows, ReactOS, HX DOS Extender, BeOS (R3 only) EXECUTABLE_FILE_FORMAT_MACHO: NeXTSTEP, macOS, iOS, watchOS, tvOS",
        "default": "EXECUTABLE_FILE_FORMAT_UNSPECIFIED",
        "enum": [
          "EXECUTABLE_FILE_FORMAT_UNSPECIFIED",
          "EXECUTABLE_FILE_FORMAT_ELF",
          "EXECUTABLE_FILE_FORMAT_PE",
          "EXECUTABLE_FILE_FORMAT_MACHO"
        ]
      },
      "hash": {
        "$ref": "v1Hash",
        "description": "Describes hash of some data. The hash fields represent different bitwise hash algorithms and their values.",
        "md5": {
          "type": "string",
          "description": "MD5 hash."
        },
        "sha1": {
          "type": "string",
          "description": "SHA1 hash."
        },
        "sha256": {
          "type": "string",
          "description": "SHA-256 hash."
        }
      },
      "liveGridFindings": {
        "$ref": "v1LiveGridFindings",
        "description": "Findings of LiveGrid.",
        "ageDays": {
          "type": "integer",
          "description": "Age of the finding in days.",
          "format": "int64"
        },
        "firstOccurTime": {
          "type": "string",
          "description": "When an executable was first seen on any computer connected to LiveGrid®.",
          "format": "date-time"
        },
        "popularity": {
          "type": "number",
          "description": "How many computers reported an executable to LiveGrid®. Normalized to value between 0 and 1. This value is frequently shown in UI as a severity bar.",
          "format": "double"
        },
        "reputation": {
          "type": "number",
          "description": "Is a number from 0 to 1, indicating how safe the file is. Reputation > 0.0 && < 0.3 -> malicious Reputation > 0.3 && < 0.8 -> suspicious Reputation > 0.8 -> safe.",
          "format": "double"
        }
      },
      "signatures": [
        {
          "$ref": "v1CodeSignature",
          "description": "Code signature details.",
          "certificateChain": [
            {
              "$ref": "v1Certificate",
              "description": "Represents cryptographic certificate.",
              "issuerCommonName": {
                "title": "CN part of the distinguished Issuer Name (OID 2.5.4.3)",
                "type": "string",
                "description": "The Issuer is the entity (Certificate Authority) that issues the certificate. The Issuer's identity is typically specified in the certificate."
              },
              "subjectCommonName": {
                "title": "CN part of the distinguished Subject Name (OID 2.5.4.3)",
                "type": "string",
                "description": "The Subject is the entity whose public key is bound to the certificate. The Subject's identity is also specified in the certificate."
              }
            }
          ],
          "signatureTrustLevel": {
            "$ref": "v1SignatureTrustLevel",
            "type": "string",
            "description": "Level of signature trust. Items are sorted by their trustworthiness from the least trustworthy case of ad-hoc signature to the signature trusted by ESET. Basically, 0—79 means untrusted and 80+ means trusted. SIGNATURE_TRUST_LEVEL_UNSPECIFIED: fallback SIGNATURE_TRUST_LEVEL_AD_HOC: A signature that is created without a certificate from a Certificate Authority (CA) is the least trustworthy because it cannot be traced back to a known entity. For example, Apple Developer Documentation: Code Signature Flags - adhoc - SIGNATURE_TRUST_LEVEL_INVALID: The signature does not match the content it is supposed to be signing, or it has been signed with a certificate that is expired or revoked. It is not trustworthy. - SIGNATURE_TRUST_LEVEL_NO_SIGNATURE: There is no signature at all. It is not trustworthy because there is no way to verify the source or integrity of the content. - SIGNATURE_TRUST_LEVEL_SELF_SIGNED: The signature was created with a self-signed certificate. It is somewhat trustworthy but less so than a signature from a CA because it cannot be traced back to a known entity. - SIGNATURE_TRUST_LEVEL_OS_TRUSTED: This means the signature was created with a certificate from a CA that is trusted by the operating system. It is generally trustworthy. - SIGNATURE_TRUST_LEVEL_ESET_TRUSTED: This means the signature was created with a certificate from a CA that is trusted by ESET. It is generally trustworthy.",
            "default": "SIGNATURE_TRUST_LEVEL_UNSPECIFIED",
            "enum": [
              "SIGNATURE_TRUST_LEVEL_UNSPECIFIED",
              "SIGNATURE_TRUST_LEVEL_AD_HOC",
              "SIGNATURE_TRUST_LEVEL_INVALID",
              "SIGNATURE_TRUST_LEVEL_NO_SIGNATURE",
              "SIGNATURE_TRUST_LEVEL_SELF_SIGNED",
              "SIGNATURE_TRUST_LEVEL_OS_TRUSTED",
              "SIGNATURE_TRUST_LEVEL_ESET_TRUSTED"
            ]
          },
          "signerName": {
            "type": "string",
            "description": "The Signer name extracted from the signature by heuristics."
          }
        }
      ],
      "versionName": {
        "type": "string",
        "description": "Version number of the file, for example, '3.10' or '5.00.RC2'."
      },
      "pe": {
        "$ref": "v1PeExecutable",
        "libraryId": {
          "title": "Internal name for PE DLLs Shared object name in ELF dynamic libraries Library ID in MACHO dynamic libraries",
          "type": "string",
          "description": "Examples: Library ID for a MACHO dylib: 'System/Library/Frameworks/OpenCL.framework/Versions/A/Libraries/ImageFormats/snorm16_rgba.dylib' And ELF shared object name (for a file called 'libhgfs.so.0.0.0“): 'libhgfs.so.0'"
        },
        "versionInfo": {
          "$ref": "v1PeVersionInfo",
          "description": "Windows VersionInfo about portable executable.",
          "companyName": {
            "type": "string",
            "description": "A company that produced the file, for example, Microsoft Corporation or Standard Microsystems Corporation, Inc."
          },
          "fileDescription": {
            "type": "string",
            "description": "File description to be presented to users. This string may be displayed in a list box when the user is choosing files to install, for example, Keyboard Driver for AT-Style Keyboards."
          },
          "fileVersion": {
            "type": "string",
            "description": "Version number of the file, for example, 3.10 or 5.00.RC2."
          },
          "internalName": {
            "type": "string",
            "description": "The internal name of the file, if one exists, for example, a module name if the file is a dynamic-link library. If the file has no internal name, this string should be the original filename without extension."
          },
          "originalFileName": {
            "type": "string",
            "description": "The original name of the file, not including a path. This information enables an application to determine whether a file has been renamed by a user. The format of the name depends on the file system for which the file was created."
          },
          "productName": {
            "type": "string",
            "description": "The name of the product with which the file is distributed."
          },
          "productVersion": {
            "type": "string",
            "description": "Version of the product with which the file is distributed, for example, 3.10 or 5.00.RC2."
          }
        }
      },
      "uuid": {
        "type": "string",
        "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within the entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 9562: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier, albeit of predictable length and alphabet. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
      }
    }
  ],
  "nextPageToken": {
    "type": "string",
    "description": "Page token of the next page. Empty or '' for the last page. Info: For more information, refer to Paginating Requests in APIs or Design Patterns: Pagination"
  }
}


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

202

Response took too long; request cached. Response can be retrieved later using the response-id header.

Response took too long; request cached. Response can be retrieved later using the response-id header.


Response schema

[]


Headers

{
  "response-id": {
    "description": "Unique ID of a pending request. Used to retrieve cached result.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

400

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

401

Token has expired or is invalid.

Token has expired or is invalid.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

403

Access denied. Check permissions.

Access denied. Check permissions.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

404

Requested resource not found.

Requested resource not found.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

429

Rate limit reached. Try again later.

Rate limit reached. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

500

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

502

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

503

Environment under maintenance. Try again later.

Environment under maintenance. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

504

Action took too long; timeout reached

Action took too long; timeout reached


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}