Nginx Instance

Nginx Instance provides tools for listing, and retrieving resources in F5 Distributed Cloud.

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 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

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

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/$${PARAM}/nginx_instances" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/nginx_instances/$${PARAM}" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"