Skip to content

Nginx Service Discovery

API to replace NGINX Service Discovery object for a site or virtual site in system namespace.

ToolDescription
f5xc-api-nginxone-nginx-service-discovery-createCreate NGINX Service Discovery.
f5xc-api-nginxone-nginx-service-discovery-getGET NGINX Service Discovery.
f5xc-api-nginxone-nginx-service-discovery-listList NGINX Service Discovery.
f5xc-api-nginxone-nginx-service-discovery-updateReplace NGINX Service Discovery.
f5xc-api-nginxone-nginx-service-discovery-deleteDELETE NGINX Service Discovery.
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.discovery_target.config_sync_group-
spec.discovery_target.nginx_instance-

Ask Claude to help you work with Nginx Service Discovery resources:

“Create a nginx-service-discovery named ‘example’ in the ‘production’ namespace”

“List all nginx-service-discoverys in the ‘production’ namespace”

“Get details of the nginx-service-discovery named ‘example’ in namespace ‘production‘“

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