Alert Template

Alert Template provides tools for creating, listing, retrieving, and deleting resources in F5 Distributed Cloud.

Tools

Tool	Description
`f5xc-api-shape-alert-template-create`	Create Domain to protect.
`f5xc-api-shape-alert-template-get`	Get Protected Domain.
`f5xc-api-shape-alert-template-list`	List BRM Alerts Alert Template.
`f5xc-api-shape-alert-template-delete`	Delete BRM Alerts Alert Template.

Parameters

Path Parameters

Parameter	Description	Example
`namespace`	Namespace This defines the workspace within which each the configuration object is to be created.	`system`
`name`	Name The name of the configuration object to be fetched.	`example-resource`

Query Parameters

Parameter	Description	Example
`response_format`	The format in which the configuration object is to be fetched. This could be for example - in GetSpec form for the contents of object…	`GET_RSP_FORMAT_DEFAULT`
`label_filter`	A LabelSelectorType expression that every item in list response will satisfy.	`-`
`report_fields`	The report_fields parameter…	`-`
`report_status_fields`	The report_status_fields parameter…	`-`

Example Usage

Ask Claude to help you work with Alert Template resources:

Create Alert Template

“Create a alert-template named ‘example’ in the ‘production’ namespace”

List Alert Templates

“List all alert-templates in the ‘production’ namespace”

Get Alert Template Details

“Get details of the alert-template named ‘example’ in namespace ‘production‘“

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/shape/alerts/namespaces/$${PARAM}/alert_templates" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/shape/alerts/namespaces/$${PARAM}/alert_templates/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/shape/alerts/namespaces/$${PARAM}/alert_templates" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @alert_template.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/shape/alerts/namespaces/$${PARAM}/alert_templates/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"