Segment¶

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.

List the set of segment in a namespace.

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`	Replace segment.
`f5xc-api-networksecurity-segment-delete`	DELETE Segment.

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:

segment

Modifies:

segment

Deletes:

segment
contained_resources

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/${NAMESPACE}/segments" \
  -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}/segments/<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}/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/${NAMESPACE}/segments/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"