Alert Gen Policy¶

High Risk Operation

This resource includes operations that may cause significant changes. Review carefully before executing.

Confirmation Required

Some operations on this resource require explicit confirmation before execution.

Replaces the content of an Alert Generation Policy object.

Tools¶

Tool	Description
`f5xc-api-shape-alert-gen-policy-create`	Create Alert Generation Policy.
`f5xc-api-shape-alert-gen-policy-get`	GET Alert Generation Policy.
`f5xc-api-shape-alert-gen-policy-list`	List BRM Alert Generation Policy.
`f5xc-api-shape-alert-gen-policy-update`	Replace Alert Generation Policy.
`f5xc-api-shape-alert-gen-policy-delete`	DELETE BRM Alert Generation Policy.

Parameters¶

Path Parameters¶

Parameter	Description	Example
`metadata.namespace`	Namespace	`-`
`name`	Name	`-`
`namespace`	Namespace	`-`
`metadata.name`	Name	`-`

Query Parameters¶

Parameter	Description	Example
`response_format`	The format in which the configuration object is to be fetched. This could be for example	`-`
`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	`-`

Side Effects¶

Operations on this resource may have the following effects:

Creates:

alert-gen-policy

Modifies:

alert-gen-policy

Deletes:

alert-gen-policy
contained_resources

Example Usage¶

Ask Claude to help you work with Alert Gen Policy resources:

Create Alert Gen Policy¶

"Create a alert-gen-policy named 'example' in the 'production' namespace"

List Alert Gen Policys¶

"List all alert-gen-policys in the 'production' namespace"

Get Alert Gen Policy Details¶

"Get details of the alert-gen-policy named 'example' in namespace 'production'"

CURL Examples¶

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/alert_gen_policys" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/alert_gen_policys/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/alert_gen_policys" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @alert_gen_policy.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/alert_gen_policys/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"