Endpoint
Endpoint provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-servicemesh-endpoint-create | Create Endpoint. |
f5xc-api-servicemesh-endpoint-get | Get Endpoint. |
f5xc-api-servicemesh-endpoint-list | List Endpoint. |
f5xc-api-servicemesh-endpoint-update | Update Endpoint. |
f5xc-api-servicemesh-endpoint-delete | Delete Endpoint. |
Parameters
Section titled “Parameters”Path Parameters
Section titled “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
Section titled “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
Section titled “Configuration Choices”This resource includes mutually exclusive configuration options:
endpoint_address
Section titled “endpoint_address”| Option | Description | Recommended |
|---|---|---|
spec.dns_name | Dns name | |
spec.dns_name_advanced | Dns name advanced | |
spec.ip | Ip | |
spec.service_info | Service info |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Endpoint resources:
Create Endpoint
Section titled “Create Endpoint”“Create a endpoint named ‘example’ in the ‘production’ namespace”
List Endpoints
Section titled “List Endpoints”“List all endpoints in the ‘production’ namespace”
Get Endpoint Details
Section titled “Get Endpoint Details”“Get details of the endpoint named ‘example’ in namespace ‘production‘“
CURL Examples
Section titled “CURL Examples”# List resourcescurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/endpoints" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/endpoints/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/endpoints" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @endpoint.json
# Delete resourcecurl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/endpoints/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"