Apm

Apm provides tools for creating, listing, retrieving, updating, and deleting resources in F5 Distributed Cloud.

Tools

Tool	Description
`f5xc-api-bigip-apm-create`	Create APM Service.
`f5xc-api-bigip-apm-get`	Get APM Service.
`f5xc-api-bigip-apm-list`	List BIG-IP APM as a Service.
`f5xc-api-bigip-apm-update`	Update APM Service.
`f5xc-api-bigip-apm-delete`	Delete BIG-IP APM as a Service.

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

Configuration Choices

This resource includes mutually exclusive configuration options:

http_management_choice

Option	Description	Recommended
`spec.https_management`	Https management

site_type_choice

Option	Description	Recommended
`spec.aws_site_type_choice`	Aws site type choice
`spec.baremetal_site_type_choice`	Baremetal site type choice

Example Usage

Ask Claude to help you work with Apm resources:

Create Apm

“Create a apm named ‘example’ in the ‘production’ namespace”

List Apms

“List all apms in the ‘production’ namespace”

Get Apm Details

“Get details of the apm named ‘example’ in namespace ‘production‘“

CURL Examples

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

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

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

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