Nginx Instance

List the set of nginx_instance in a namespace.

Tools

Tool	Description
f5xc-api-nginxone-nginx-instance-get	GET Request.
f5xc-api-nginxone-nginx-instance-list	List NGINX One Instance Object configuration.

Parameters

Path Parameters

Parameter	Description	Example
name	Name	-
namespace	Namespace	-

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	-

Example Usage

Ask Claude to help you work with Nginx Instance resources:

List Nginx Instances

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

Get Nginx Instance Details

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

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/nginx_instances" \
  -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_instances/<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_instances" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @nginx_instance.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/nginx_instances/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"