Get settings schema

Example response

{
  "type": "object",
  "properties": {
    "enable_telemetry": {
      "type": "boolean",
      "title": "Enable Telemetry Streaming log forwarding",
      "description": "Automatically setup log forwarding for Telemetry Streaming when deploying FAST applications.\nMore information can be found [here](https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/event-listener.html)\n",
      "propertyOrder": 0,
      "format": "checkbox"
    },
    "log_afm": {
      "type": "boolean",
      "title": "Forward AFM logs to Telemetry Streaming",
      "description": "Requires AFM and ASM to be provisioned",
      "options": {
        "hidden": true,
        "dependencies": {
          "enable_telemetry": true
        }
      },
      "propertyOrder": 1,
      "format": "checkbox"
    },
    "log_asm": {
      "type": "boolean",
      "title": "Forward ASM logs to Telemetry Streaming",
      "description": "Requires ASM to be provisioned",
      "options": {
        "hidden": true,
        "dependencies": {
          "enable_telemetry": true
        }
      },
      "propertyOrder": 2,
      "format": "checkbox"
    },
    "deletedTemplateSets": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "\\uniqueItems": true,
      "options": {
        "hidden": true
      },
      "propertyOrder": 0,
      "format": "table"
    },
    "disableDeclarationCache": {
      "title": "Disable AS3 Declaration Cache",
      "type": "boolean",
      "description": "Do not cache AS3 declarations. This ensures FAST is always using up-to-date declarations from AS3, which is only an issue if something other than FAST (e.g., config sync) is modifying AS3 config. Disabling declaration caching will negatively impact FAST performance.",
      "propertyOrder": 1,
      "format": "checkbox"
    },
    "pendingTasksMaxNumber": {
      "title": "Maximum number of pending tasks",
      "type": "number",
      "description": "Specifies max number of pending tasks which can be accepted by FAST. When max limit reached, FAST would return 503 error."
    },
    "enableIpam": {
      "title": "Enable IPAM for Official F5 FAST Templates (Experimental/Beta)",
      "description": "**NOTE: An IPAM provider must be configured to deploy a valid application using IPAM.**",
      "type": "boolean",
      "propertyOrder": 2,
      "format": "checkbox"
    },
    "ipamProviders": {
      "title": "IPAM Providers (Experimental/Beta)",
      "description": "Configure IPAM providers that can be used in FAST templates to automatically manage IP addresses",
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "title": "Infoblox",
            "format": "grid-strict",
            "properties": {
              "serviceType": {
                "title": "Service Type",
                "type": "string",
                "enum": [
                  "Infoblox"
                ],
                "default": "Infoblox",
                "options": {
                  "hidden": true
                }
              },
              "name": {
                "title": "Name",
                "type": "string",
                "options": {
                  "grid_columns": 2,
                  "grid_break": true
                }
              },
              "host": {
                "title": "Host",
                "type": "string",
                "options": {
                  "grid_columns": 4
                }
              },
              "username": {
                "title": "Username",
                "type": "string",
                "options": {
                  "grid_columns": 4
                }
              },
              "password": {
                "title": "Password",
                "type": "string",
                "format": "password",
                "options": {
                  "grid_columns": 4,
                  "grid_break": true
                }
              },
              "retrieveUrl": {
                "title": "Retrieve URL",
                "type": "string",
                "format": "textarea",
                "options": {
                  "grid_columns": 4,
                  "hidden": true
                },
                "default": "{{host}}/wapi/{{apiVersion}}/fixedaddress?_return_as_object=1&_return_fields=ipv4addr"
              },
              "retrieveBody": {
                "title": "Retrieve Body",
                "type": "string",
                "format": "textarea",
                "default": "{'ipv4addr': 'func: nextavailableip: network/{{network}}','mac': '00: 00: 00: 00: 00: 00','comment': 'Created by F5 Application Services Templates'}",
                "options": {
                  "grid_columns": 4,
                  "grid_break": true,
                  "hidden": true
                }
              },
              "retrievePathQuery": {
                "title": "Retrieve Path Query",
                "type": "string",
                "format": "textarea",
                "default": "$.result.ipv4addr",
                "options": {
                  "grid_columns": 4,
                  "hidden": true
                }
              },
              "retrieveRefPathQuery": {
                "title": "Retrieve Reference Path Query",
                "type": "string",
                "format": "textarea",
                "default": "$.result._ref",
                "options": {
                  "grid_columns": 4,
                  "grid_break": true,
                  "hidden": true
                }
              },
              "releaseUrl": {
                "title": "Release URL",
                "type": "string",
                "format": "textarea",
                "options": {
                  "grid_columns": 4,
                  "hidden": true
                },
                "default": "{{host}}/wapi/{{apiVersion}}/{{addressRef}}"
              },
              "releaseBody": {
                "title": "Release Body",
                "type": "string",
                "format": "textarea",
                "default": "{}",
                "options": {
                  "grid_columns": 4,
                  "hidden": true
                }
              },
              "releaseMethod": {
                "title": "Release Method",
                "type": "string",
                "enum": [
                  "get",
                  "post",
                  "put",
                  "patch",
                  "delete"
                ],
                "default": "delete",
                "options": {
                  "hidden": true
                }
              },
              "authHeaderName": {
                "title": "Authorization Header Name",
                "type": "string",
                "default": "",
                "options": {
                  "hidden": true
                }
              },
              "authHeaderValue": {
                "title": "Authorization Header Value",
                "type": "string",
                "default": "",
                "options": {
                  "hidden": true
                }
              },
              "apiVersion": {
                "title": "API Version",
                "type": "string",
                "default": "v2.4",
                "options": {
                  "grid_columns": 2
                }
              },
              "network": {
                "title": "Network Name",
                "type": "string",
                "options": {
                  "grid_columns": 3,
                  "grid_break": true
                }
              }
            }
          },
          {
            "type": "object",
            "title": "Generic",
            "format": "grid-strict",
            "properties": {
              "serviceType": {
                "title": "Service Type",
                "type": "string",
                "enum": [
                  "Generic"
                ],
                "default": "Generic",
                "options": {
                  "hidden": true
                }
              },
              "name": {
                "title": "Name",
                "type": "string",
                "options": {
                  "grid_columns": 2,
                  "grid_break": true
                }
              },
              "host": {
                "title": "Host",
                "type": "string",
                "options": {
                  "grid_columns": 4
                }
              },
              "username": {
                "title": "Username",
                "type": "string",
                "options": {
                  "grid_columns": 4
                }
              },
              "password": {
                "title": "Password",
                "type": "string",
                "format": "password",
                "options": {
                  "grid_columns": 4,
                  "grid_break": true
                }
              },
              "retrieveUrl": {
                "title": "Retrieve URL",
                "type": "string",
                "format": "textarea",
                "options": {
                  "grid_columns": 4
                }
              },
              "retrieveBody": {
                "title": "Retrieve Body",
                "type": "string",
                "format": "textarea",
                "default": "{}",
                "options": {
                  "grid_columns": 4,
                  "grid_break": true
                }
              },
              "retrievePathQuery": {
                "title": "Retrieve Path Query",
                "type": "string",
                "format": "textarea",
                "default": "$",
                "options": {
                  "grid_columns": 4
                }
              },
              "retrieveRefPathQuery": {
                "title": "Retrieve Reference Path Query",
                "type": "string",
                "format": "textarea",
                "default": "",
                "options": {
                  "grid_columns": 4,
                  "grid_break": true
                }
              },
              "releaseUrl": {
                "title": "Release URL",
                "type": "string",
                "format": "textarea",
                "options": {
                  "grid_columns": 4
                }
              },
              "releaseBody": {
                "title": "Release Body",
                "type": "string",
                "format": "textarea",
                "default": "{}",
                "options": {
                  "grid_columns": 4
                }
              },
              "releaseMethod": {
                "title": "Release Method",
                "type": "string",
                "enum": [
                  "get",
                  "post",
                  "put",
                  "patch",
                  "delete"
                ],
                "default": "post",
                "options": {
                  "hidden": true
                }
              },
              "authHeaderName": {
                "title": "Authorization Header Name",
                "type": "string",
                "default": "Authorization"
              },
              "authHeaderValue": {
                "title": "Authorization Header Value",
                "type": "string"
              }
            }
          }
        ]
      },
      "propertyOrder": 3,
      "format": "table"
    }
  },
  "required": [
    "enable_telemetry",
    "deletedTemplateSets"
  ],
  "dependencies": {
    "log_afm": [
      "enable_telemetry"
    ],
    "log_asm": [
      "enable_telemetry"
    ]
  },
  "title": "FAST Settings",
  "description": "",
  "definitions": {},
  "$schema": "http://json-schema.org/schema#"
}