Nginx Csg
Nginx Csg provides tools for listing, and retrieving resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-nginxone-nginx-csg-get | Get Request. |
f5xc-api-nginxone-nginx-csg-list | List NGINX One CSG Object configuration. |
Parameters
Section titled “Parameters”Path Parameters
Section titled “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
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 Nginx Csg resources:
List Nginx Csgs
Section titled “List Nginx Csgs”“List all nginx-csgs in the ‘production’ namespace”
Get Nginx Csg Details
Section titled “Get Nginx Csg Details”“Get details of the nginx-csg 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}/nginx_csgs" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/nginx_csgs/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"