Swagger Blocklisting examples

You can get and set the blocklisting configuration.

Swagger GET /blockListingConfig example

Perform the following steps to get the blocklisting configuration:
  1. Expand the blockListing section.
  2. Click GET /blockListingConfig.
  3. Click Try it Out.
  4. Select the media type from the drop-down menu. This controls the header accept type in the curl command. Possible values are application/json and application/xml.
  5. Click Execute.
    Swagger UI submits the request and shows the curl command that was submitted. If successful, the Responses section shows the response with an HTTP status code of 200 OK.
    Response body{
  "configIdsByHostname": {
    "system-name.com": "id1"
  },
  "configsById": {
    "id1": {
      "hashFiles": [
        "example_md5.md5"
      ],
      "scanFolders": [
        "/home/usera"
      ]
    }
  }
}

Swagger PUT /blockListingConfig example

Perform the following steps to update the blocklisting configuration:
  1. Expand the blockListing section.
  2. Click PUT /blockListingConfig.
  3. Click Try it Out.
  4. Select the media type from the drop-down menu. This controls the header accept type in the curl command. Possible values are application/json and application/xml.
  5. Supply the request body in the following format.
    {
  "configIdsByHostname": {
    "vm1.example.com": "id1",
    "vm2.example.com": "id2"
  },
  "configsById": {
    "id1": {
      "hashFiles": [
        "hashes.txt"
      ],
      "scanFolders": [
        "/home"
      ]
    },
    "id2": {
      "hashFiles": [
        "hashes.txt",
        "hashes2.txt"
      ],
      "scanFolders": [
        "/opt"
      ]
    }
  }
}
  6. Click Execute.

    Swagger UI submits the request and shows the curl command that was submitted. If successful, the Responses section shows the response with an HTTP status code of 200 OK.

Swagger GET /hashFiles example

Perform the following steps to get the blocklisting hash files:
  1. Expand the blockListing section.
  2. Click GET /hashFiles.
  3. Click Try it Out.
  4. Select the media type from the drop-down menu. This controls the header accept type in the curl command. Possible values are application/json and application/xml.
  5. Click Execute.
    Swagger UI submits the request and shows the curl command that was submitted. If successful, the Responses section shows the response with an HTTP status code of 200 OK.
    Response body
{
  "KBM_TYPE": "root",
  "hashFiles": [
    {
      "KBM_TYPE": "file",
      "hashFile": "example_md5.md5",
      "hashType": "MD5",
      "hashCount": 1,
      "nonEmptyLines": 1
    },
    {
      "KBM_TYPE": "file",
      "hashFile": "hash.md5.txt",
      "hashType": "MD5",
      "hashCount": 1,
      "nonEmptyLines": 1
    },
    {
      "KBM_TYPE": "file",
      "hashFile": "md5_test_error.md5",
      "hashType": "MD5",
      "hashCount": 1,
      "nonEmptyLines": 1
    }
  ]
}

Swagger POST /hashFiles example

Perform the following steps to update the blocklisting hash files:
  1. Expand the blockListing section.
  2. Click POST /hashFiles.
  3. Click Try it Out.
  4. Click Filename Add string item.
  5. Click Choose File and upload the hash file.
  6. Continue to click Add string item to upload additional hash files as needed.
  7. Click Execute.

Swagger DELETE /hashFiles example

Perform the following steps to delete a blocklisting hash file:
  1. Expand the blockListing section.
  2. Click DELETE /hashFiles.
  3. Click Try it Out.
  4. Enter the name of the hash file that you want to delete.
  5. Click Execute.

    Swagger UI submits the request and shows the curl command that was submitted. If successful, the Responses section shows the response with an HTTP status code of 200 OK.