f5xc_api_testing Resource - terraform-provider-f5xc

f5xc_api_testing (Resource)

Manages an API Testing resource in F5 Distributed Cloud.

~> Note For more information about this resource, please refer to the F5 XC API Documentation.

Example Usage

# API Testing Resource Example
# Manages an API Testing resource in F5 Distributed Cloud.

terraform {
  required_version = ">= 1.0"

  required_providers {
    f5xc = {
      source  = "f5xc-salesdemos/f5xc"
      version = ">= 0.1.0"
    }
  }
}

# Basic API Testing configuration
resource "f5xc_api_testing" "example" {
  name      = "example-api-testing"
  namespace = "staging"

  labels = {
    environment = "production"
    managed_by  = "terraform"
  }

  annotations = {
    "owner" = "platform-team"
  }

  # Resource-specific configuration
  # Add and configure testing domains and credentials .
  domains {
    # Configure domains settings
  }
  # Add credentials for API testing to use in the selected en...
  credentials {
    # Configure credentials settings
  }
  # Enable this option
  admin {
    # Configure admin settings
  }
}

Argument Reference

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

Metadata Argument Reference

• name - Required String
Name of the API Testing. Must be unique within the namespace

• namespace - Required String
Namespace where the API Testing will be created

• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata

• description - Optional String
Human readable description for the object

• disable - Optional Bool
A value of true will administratively disable the object

• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering

Spec Argument Reference

• custom_header_value - Required String
Add x-F5-API-testing-identifier header value to prevent security flags on API testing traffic

• domains - Optional Block
Add and configure testing domains and credentials
See Domains below for details.

-> One of the following: • every_day - Optional Block
Enable this option

• every_month - Optional Block
Configuration parameter for every month

• every_week - Optional Block
Enable this option

• timeouts - Optional Block
See Timeouts below for details.

Attributes Reference

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

• id - Optional String
Unique identifier for the resource

---

Domains

A domains block supports the following:

• allow_destructive_methods - Optional Bool
Enable to allow API Testing to execute against destructive methods. Use with caution as these may modify or DELETE data

• credentials - Optional Block
Add credentials for API testing to use in the selected environment
See Credentials below.

• domain - Optional String
Add your testing environment domain. Be aware that running tests on a production domain can impact live applications, as API testing cannot distinguish between production and testing environments

Domains Credentials

A credentials block (within domains) supports the following:

• admin - Optional Block
Enable this option

• api_key - Optional Block
API Key
See API Key below.

• basic_auth - Optional Block
Basic Authentication
See Basic Auth below.

• bearer_token - Optional Block
Configuration parameter for bearer token
See Bearer Token below.

• credential_name - Optional String
Enter a unique name for the credentials used in API testing

• login_endpoint - Optional Block
Login Endpoint
See Login Endpoint below.

• standard - Optional Block
Enable this option

Domains Credentials API Key

An api_key block (within domains.credentials) supports the following:

• key - Optional String
Key

• value - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Value below.

Domains Credentials API Key Value

A value block (within domains.credentials.api_key) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

Domains Credentials API Key Value Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Domains Credentials API Key Value Clear Secret Info

Deeply nested Info block collapsed for readability.

Domains Credentials Basic Auth

A basic_auth block (within domains.credentials) supports the following:

• password - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Password below.

• user - Optional String
User

Domains Credentials Basic Auth Password

A password block (within domains.credentials.basic_auth) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

Domains Credentials Basic Auth Password Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Domains Credentials Basic Auth Password Clear Secret Info

Deeply nested Info block collapsed for readability.

Domains Credentials Bearer Token

A bearer_token block (within domains.credentials) supports the following:

• token - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Token below.

Domains Credentials Bearer Token Token

A token block (within domains.credentials.bearer_token) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

Domains Credentials Bearer Token Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Domains Credentials Bearer Token Token Clear Secret Info

Deeply nested Info block collapsed for readability.

Domains Credentials Login Endpoint

A login_endpoint block (within domains.credentials) supports the following:

• json_payload - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See JSON Payload below.

• method - Optional String Defaults to ANY
See HTTP Methods
Specifies the HTTP method used to access a resource. Any HTTP Method

• path - Optional String
Path

• token_response_key - Optional String
Token Response Key

Domains Credentials Login Endpoint JSON Payload

A json_payload block (within domains.credentials.login_endpoint) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

Domains Credentials Login Endpoint JSON Payload Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Domains Credentials Login Endpoint JSON Payload Clear Secret Info

Deeply nested Info block collapsed for readability.

Timeouts

A timeouts block supports the following:

• create - Optional String (Defaults to 10 minutes)
Used when creating the resource

• delete - Optional String (Defaults to 10 minutes)
Used when deleting the resource

• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource

• update - Optional String (Defaults to 10 minutes)
Used when updating the resource

---

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

Import

Import is supported using the following syntax:

# Import using namespace/name format
terraform import f5xc_api_testing.example system/example