Protected Application

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

Tools

Tool	Description
`f5xc-api-shape-protected-application-create`	Create Protected Application.
`f5xc-api-shape-protected-application-get`	Get Protected Application.
`f5xc-api-shape-protected-application-list`	List Protected Application.
`f5xc-api-shape-protected-application-update`	Update Protected Application.
`f5xc-api-shape-protected-application-delete`	Delete Protected Application.

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:

connector_type_choice

Option	Description	Recommended
`spec.adobe_commerce_connector`	Adobe commerce connector
`spec.big_ip_iapp`	Big ip iapp
`spec.cloudflare`	Cloudflare
`spec.cloudfront`	Cloudfront
`spec.custom_connector`	Custom connector
`spec.f5_big_ip`	F5 big ip
`spec.salesforce_commerce_connector`	Salesforce commerce connector

Example Usage

Ask Claude to help you work with Protected Application resources:

Create Protected Application

“Create a protected-application named ‘example’ in the ‘production’ namespace”

List Protected Applications

“List all protected-applications in the ‘production’ namespace”

Get Protected Application Details

“Get details of the protected-application named ‘example’ in namespace ‘production‘“

CURL Examples

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

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

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

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