Site
Site provides tools for creating, listing, retrieving, and updating resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-sites-site-create | Site Topology. |
f5xc-api-sites-site-get | Get Site. |
f5xc-api-sites-site-list | List Site. |
f5xc-api-sites-site-update | Update Site. |
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”| Parameter | Description | Example |
|---|---|---|
site | Site Name of the site. | - |
name | Name The name of the configuration object to be fetched. | example-resource |
namespace | Namespace The namespace in which the configuration object is present. | system |
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… | - |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Site resources:
Create Site
Section titled “Create Site”“Create a site named ‘example’ in the ‘production’ namespace”
List Sites
Section titled “List Sites”“List all sites in the ‘production’ namespace”
Get Site Details
Section titled “Get Site Details”“Get details of the site 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}/sites" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/sites/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Create resourcecurl -X POST "https://${TENANT}.console.ves.volterra.io/api/data/namespaces/system/topology/site/${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}" \ -H "Content-Type: application/json" \ -d @site.json