Segment

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

Tools

Tool	Description
`f5xc-api-networksecurity-segment-create`	Create segment.
`f5xc-api-networksecurity-segment-get`	Get segment.
`f5xc-api-networksecurity-segment-list`	List Segment.
`f5xc-api-networksecurity-segment-update`	Update segment.
`f5xc-api-networksecurity-segment-delete`	Delete Segment.

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:

internet_connection_choice

Option	Description	Recommended
`spec.disable`	Disable
`spec.enable`	Enable

Example Usage

Ask Claude to help you work with Segment resources:

Create Segment

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

List Segments

“List all segments in the ‘production’ namespace”

Get Segment Details

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

CURL Examples

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

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

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

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