Alert Receiver

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

Tools

Tool	Description
`f5xc-api-statistics-alert-receiver-create`	Create Alert Receiver.
`f5xc-api-statistics-alert-receiver-get`	Get Alert Receiver.
`f5xc-api-statistics-alert-receiver-list`	List Alert Receiver.
`f5xc-api-statistics-alert-receiver-update`	Update Alert Receiver.
`f5xc-api-statistics-alert-receiver-delete`	Delete Alert Receiver.

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…	`-`

Configuration Choices

This resource includes mutually exclusive configuration options:

receiver

Option	Description	Recommended
`spec.email`	Email
`spec.opsgenie`	Opsgenie
`spec.pagerduty`	Pagerduty
`spec.slack`	Slack
`spec.sms`	Sms
`spec.webhook`	Webhook

Example Usage

Ask Claude to help you work with Alert Receiver resources:

Create Alert Receiver

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

List Alert Receivers

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

Get Alert Receiver Details

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

CURL Examples

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

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

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

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