FormField

FormField provides tools for creating, listing, and retrieving resources in F5 Distributed Cloud.

Tools

Tool	Description
f5xc-api-shape-formfield-create	List All Form Fields.
f5xc-api-shape-formfield-get	Get Form Field.
f5xc-api-shape-formfield-list	List All Form Fields with GET method.

Parameters

Path Parameters

Parameter	Description	Example
namespace	Namespace Namespace.	system
id	ID ID of the form field.	-

Query Parameters

Parameter	Description	Example
end_time	X-required format: unix epoch timestamp in seconds…	-
start_time	X-required format: unix epoch timestamp in seconds…	-

Example Usage

Ask Claude to help you work with FormField resources:

Create FormField

“Create a formField named ‘example’ in the ‘production’ namespace”

List FormFields

“List all formFields in the ‘production’ namespace”

Get FormField Details

“Get details of the formField named ‘example’ in namespace ‘production‘“

CURL Examples

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

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

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