Skip to content

Endpoint

Replacing an endpoint object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.

ToolDescription
f5xc-api-servicemesh-endpoint-createCreate Endpoint.
f5xc-api-servicemesh-endpoint-getGET Endpoint.
f5xc-api-servicemesh-endpoint-listList Endpoint.
f5xc-api-servicemesh-endpoint-updateReplace Endpoint.
f5xc-api-servicemesh-endpoint-deleteDELETE Endpoint.
ParameterDescriptionExample
metadata.namespaceNamespace-
nameName-
namespaceNamespace-
metadata.nameName-
ParameterDescriptionExample
response_formatThe format in which the configuration object is to be fetched. This could be for example-
label_filterA LabelSelectorType expression that every item in list response will satisfy.-
report_fieldsThe report_fields parameter-
report_status_fieldsThe report_status_fields parameter-

This resource includes mutually exclusive configuration options:

OptionDescriptionRecommended
spec.dns_name-
spec.dns_name_advanced-
spec.ip-
spec.service_info-
OptionDescriptionRecommended
spec.dns_name_advanced.refresh_interval-
OptionDescriptionRecommended
spec.service_info.service_name-
spec.service_info.service_selector-
OptionDescriptionRecommended
spec.snat_pool.no_snat_pool-
spec.snat_pool.snat_pool-
OptionDescriptionRecommended
spec.where.site-
spec.where.virtual_network-
spec.where.virtual_site-
OptionDescriptionRecommended
spec.where.site.disable_internet_vip-
spec.where.site.enable_internet_vip-

Ask Claude to help you work with Endpoint resources:

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

“List all endpoints in the ‘production’ namespace”

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

Terminal window
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/endpoints" \
-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}/endpoints/<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}/endpoints" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @endpoint.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/endpoints/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"