v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB
Techniques

List methods

Get all generic methods metadata

get/methods

Response

Methods information

result'success' | 'error' required

Result of the request

action'listTechniques' required

The id of the action

Example response

{
  "data": {
    "methods": {
      "id": "package_present",
      "name": "Package present",
      "version": "1.0",
      "category": "user_techniques",
      "desc": "Enforce the presence of a package",
      "documentation": "This methods allows...",
      "parameters": [
        {
          "name": "package",
          "description": "Name of a package to install",
          "constraints": {
            "allow_whitespace_string": true,
            "max_length": 250,
            "min_length": 5,
            "regex": ".*",
            "not_regex": "^c.*",
            "select": [
              "!="
            ]
          }
        }
      ],
      "agents": [
        "dsc"
      ],
      "condition": {
        "prefix": "package_present",
        "parameter": "package"
      },
      "deprecated": {
        "info": "The method has been deprecated because of X",
        "replacedBy": "package_present"
      }
    }
  }
}