Tpm API Key

Tpm API Key provides tools for creating, listing, retrieving, and updating resources in F5 Distributed Cloud.

Tools

Tool	Description
f5xc-api-botandthreatdefense-tpm-api-key-create	Create TPM API Key.
f5xc-api-botandthreatdefense-tpm-api-key-get	Get TPM API Key.
f5xc-api-botandthreatdefense-tpm-api-key-list	List TPM API Key.
f5xc-api-botandthreatdefense-tpm-api-key-update	Update TPM API Key.

Parameters

Path Parameters

Parameter	Description	Example
namespace	Namespace This defines the workspace within which each the configuration object is to be created.	system
name	Name The name of the configuration object to be fetched.	example-resource

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 Tpm API Key resources:

Create Tpm API Key

“Create a tpm-api-key named ‘example’ in the ‘production’ namespace”

List Tpm API Keys

“List all tpm-api-keys in the ‘production’ namespace”

Get Tpm API Key Details

“Get details of the tpm-api-key named ‘example’ in namespace ‘production‘“

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/tpm/namespaces/$${PARAM}/tpm_api_keys" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"

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

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/tpm/namespaces/$${PARAM}/tpm_api_keys" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @tpm_api_key.json