Data Type¶
High Risk Operation
This resource includes operations that may cause significant changes. Review carefully before executing.
Confirmation Required
Some operations on this resource require explicit confirmation before execution.
Replace data_type replaces an existing object in the storage backend for metadata.namespace.
Tools¶
| Tool | Description |
|---|---|
f5xc-api-dataandprivacysecurity-data-type-create | Create Data Type. |
f5xc-api-dataandprivacysecurity-data-type-get | GET Data Type. |
f5xc-api-dataandprivacysecurity-data-type-list | List Data Type. |
f5xc-api-dataandprivacysecurity-data-type-update | Replace Data Type. |
f5xc-api-dataandprivacysecurity-data-type-delete | DELETE Data Type. |
Parameters¶
Path Parameters¶
| Parameter | Description | Example |
|---|---|---|
metadata.namespace | Namespace | - |
name | Name | - |
namespace | Namespace | - |
metadata.name | Name | - |
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 | - |
Side Effects¶
Operations on this resource may have the following effects:
Creates:
- data-type
Modifies:
- data-type
Deletes:
- data-type
- contained_resources
Example Usage¶
Ask Claude to help you work with Data Type resources:
Create Data Type¶
"Create a data-type named 'example' in the 'production' namespace"
List Data Types¶
"List all data-types in the 'production' namespace"
Get Data Type Details¶
"Get details of the data-type named 'example' in namespace 'production'"
CURL Examples¶
# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/data_types" \
-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}/data_types/<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}/data_types" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}" \
-H "Content-Type: application/json" \
-d @data_type.json
# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/data_types/<name>" \
-H "Authorization: APIToken ${F5XC_API_TOKEN}"