xcsh_api_discovery (Data Source)

Retrieves information about API discovery creates a new object in the storage backend for metadata.namespace in F5 Distributed Cloud. This is a read-only data source.

~> Note: For more information, see the F5 Distributed Cloud API documentation.

Example Usage

# APIDiscovery Data Source Example

terraform {
  required_version = ">= 1.0"

  required_providers {
    xcsh = {
      source  = "f5-sales-demo/xcsh"
      version = ">= 0.1.0"
    }
  }
}

# Look up an existing APIDiscovery by name
data "xcsh_api_discovery" "example" {
  name      = "example-api-discovery"
  namespace = "staging"
}

output "api_discovery_id" {
  value = data.xcsh_api_discovery.example.id
}

Argument Reference

-> Syntax Rule: This provider uses OneOf groups for mutually exclusive options. Fields documented as “Optional Block” use block syntax field_name { ... }. Empty OneOf object attributes use field_name = {}; conditional selection uses condition ? {} : null. Boolean attributes (such as add_hsts and http_redirect) use = true or = false.

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

Minimum Configuration

Required fields:

• name
• namespace
• user_defined_api_discovery_policy

Example (API format):

apiVersion: v1
kind: api_discovery
metadata:
  name: example-discovery
  namespace: demo-app
spec:
  user_defined_api_discovery_policy: {}

Metadata Argument Reference

• name - Required String
Name of the APIDiscovery

• namespace - Required String
Namespace where the APIDiscovery exists

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• annotations - Optional Map
Annotations applied to this resource

• custom_auth_types - Optional List Defaults to []
Select your custom authentication types to be detected in the API discovery. Server applies default when omitted

• description - Optional String
Description of the APIDiscovery

• id - Optional String
Unique identifier for the resource

• labels - Optional Map
Labels applied to this resource

• user_defined_api_discovery_policy - Optional String
Rules are evaluated sequentially, top to bottom. If no rules are added, all traffic will be discovered or ignored based on the selection in the ‘Default Behaviour of the Rule Set’ field

• parameter_name - Optional String
Parameter Name. The authentication parameter name

• parameter_type - Optional String Defaults to QUERY_PARAMETER
Possible values are QUERY_PARAMETER, HEADER, COOKIE
[Enum: QUERY_PARAMETER|HEADER|COOKIE] Enumeration for authentication parameter types

• discovery_rules - Optional List Defaults to []
Define rules to include or exclude endpoints by path, domain, or header. Rules run top to bottom; unmatched endpoints follow the default action. Server applies default when omitted

• exclusive - Optional String
Exclusion Configuration. Configuration for exclusion action

• inclusive - Optional Object Defaults to map[]
Enable this option. Server applies default when omitted

• labels - Optional String
Map of string keys and values that can be used to organize and categorize the rule

• metadata - Optional String
MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create

• rule_properties - Optional String
Determines whether matching endpoints are included in API Discovery or excluded

• description_spec - Optional String
Description. Human readable description

• name - Optional String
Name of the message. The value of name has to follow DNS-1035 format

• exclusion - Optional String
Exclusion Configuration. Configuration for exclusion action

• http_header_criteria - Optional String
Configuration parameter for HTTP header criteria

• inclusion - Optional Object
Enable this option

• pattern - Optional String
Patterns are matched against the request path to identify endpoints by path structure, file extension, or version prefix. Endpoints that match this pattern are affected by the rule

• archive - Optional Object
Enable this option

• ignore - Optional Object
Enable this option

• field_name - Optional String
HTTP Header Name. Human-readable name for the resource

• location - Optional String Defaults to REQUEST
Possible values are REQUEST, RESPONSE
[Enum: REQUEST|RESPONSE] Specifies whether the rule criteria should be evaluated against request or response Applies the rule to incoming traffic from the client. Applies the rule to outgoing traffic sent back to the client

• match_type - Optional String Defaults to EXACT_MATCH
Possible values are EXACT_MATCH, SUBSTRING, REGEX
[Enum: EXACT_MATCH|SUBSTRING|REGEX] Specifies how the value should be matched

• value - Optional String
Value. Configuration parameter for value

• archive - Optional Object
Enable this option

• ignore - Optional Object
Enable this option

---

Common Types

The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.

Object Reference {#common-object-reference}

Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.

Field	Type	Description
name	String	Name of the referenced object
namespace	String	Namespace containing the referenced object
tenant	String	Tenant of the referenced object (system-managed)

Transformers {#common-transformers}

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

Value	Description
LOWER_CASE	Convert to lowercase
UPPER_CASE	Convert to uppercase
BASE64_DECODE	Decodebase64 content
NORMALIZE_PATH	Normalize URL path
REMOVE_WHITESPACE	Remove whitespace characters
URL_DECODE	Decode URL-encoded characters
TRIM_LEFT	Trim leading whitespace
TRIM_RIGHT	Trim trailing whitespace
TRIM	Trim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

HTTP methods used for request matching.

Value	Description
ANY	Match any HTTP method
GET	HTTP GET request
HEAD	HTTP HEAD request
POST	HTTP POST request
PUT	HTTP PUT request
DELETE	HTTP DELETE request
CONNECT	HTTP CONNECT request
OPTIONS	HTTP OPTIONS request
TRACE	HTTP TRACE request
PATCH	HTTP PATCH request
COPY	HTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

TLS fingerprint categories for malicious client detection.

Value	Description
TLS_FINGERPRINT_NONE	No fingerprint matching
ANY_MALICIOUS_FINGERPRINT	Match any known malicious fingerprint
ADWARE	Adware-associated fingerprints
DRIDEX	Dridex malware fingerprints
GOOTKIT	Gootkit malware fingerprints
RANSOMWARE	Ransomware-associated fingerprints
TRICKBOT	Trickbot malware fingerprints

IP Threat Categories {#common-ip-threat-categories}

IP address threat categories for security filtering.

Value	Description
SPAM_SOURCES	Known spam sources
WINDOWS_EXPLOITS	Windows exploit sources
WEB_ATTACKS	Web attack sources
BOTNETS	Known botnet IPs
SCANNERS	Network scanner IPs
REPUTATION	Poor reputation IPs
PHISHING	Phishing-related IPs
PROXY	Anonymous proxy IPs
MOBILE_THREATS	Mobile threat sources
TOR_PROXY	Tor exit nodes
DENIAL_OF_SERVICE	DoS attack sources
NETWORK	Known bad network ranges