External Connector

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

Tools

Tool	Description
`f5xc-api-marketplace-external-connector-create`	Create external_connector configuration.
`f5xc-api-marketplace-external-connector-get`	Get external_connector configuration.
`f5xc-api-marketplace-external-connector-list`	List External Connector Configuration.
`f5xc-api-marketplace-external-connector-update`	Update external_connector configuration.
`f5xc-api-marketplace-external-connector-delete`	Delete External Connector Configuration.

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:

connection_type

Option	Description	Recommended
`spec.ipsec`	Ipsec

Example Usage

Ask Claude to help you work with External Connector resources:

Create External Connector

“Create a external-connector named ‘example’ in the ‘production’ namespace”

List External Connectors

“List all external-connectors in the ‘production’ namespace”

Get External Connector Details

“Get details of the external-connector named ‘example’ in namespace ‘production‘“

CURL Examples

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

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

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

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