Type to search.

Create a traffic filter

Base URL
https://api.elastic-cloud.com
  • POST /api/v1/serverless/traffic-filters
Auth

Creates a traffic filter that consists of a set of rules.

See Private connectivity for setup guides and regional service names.

AWS PrivateLink (type: vpce)

Each rule must include:

  • source — the VPC endpoint ID (format: vpce- followed by 17 lowercase hex characters).

Do not set azure_endpoint_name or azure_endpoint_guid on AWS rules.

Azure Private Link (type: private_endpoint)

Each rule must include:

  • azure_endpoint_name — the Azure Private Endpoint resource name (2–80 characters).
  • azure_endpoint_guid — the PE resource GUID (properties.resourceGuid), a lowercase UUID. This is not the ARM resource ID.

Do not set source on Azure rules.

GCP Private Service Connect (type: psc_endpoint)

Each rule must include:

  • source — the decimal PSC connection ID reported by the consumer forwarding rule.

Do not set azure_endpoint_name or azure_endpoint_guid on GCP rules. GCP PSC connections are accepted automatically by the service attachment, so creating this traffic filter does not trigger a cloud approval or resolution operation.

Request body

The specification for traffic filter.

name string · min length: 1 · max length: 128 required

Name of the traffic filter

description string · min length: 0 · max length: 512

Description of the traffic filter

type enum · min length: 1 · max length: 32 required

Type of the traffic filter. Determines which rule fields are valid:

  • ip — IP/CIDR allowlist (source)
  • vpce — AWS PrivateLink VPC endpoint (source)
  • private_endpoint — Azure Private Link (azure_endpoint_name, azure_endpoint_guid)
  • psc_endpoint — GCP Private Service Connect endpoint (source)
Values: ip vpce private_endpoint psc_endpoint
include_by_default boolean

Should the traffic filter be automatically included in the new projects

region string · min length: 1 · max length: 32 required

Serverless region ID the filter applies to (e.g. azure-australiaeast, aws-eu-west-1). The filter can only be attached to projects in this region.

Responses

The traffic filter definition is valid and the creation has started.

application/json
id string · min length: 32 · max length: 32 required

The traffic filter ID

name string · min length: 1 · max length: 128 required

Name of the traffic filter

description string · min length: 0 · max length: 512

Description of the traffic filter

type enum · min length: 1 · max length: 32 required

Type of the traffic filter. Determines which rule fields are valid:

  • ip — IP/CIDR allowlist (source)
  • vpce — AWS PrivateLink VPC endpoint (source)
  • private_endpoint — Azure Private Link (azure_endpoint_name, azure_endpoint_guid)
  • psc_endpoint — GCP Private Service Connect endpoint (source)
Values: ip vpce private_endpoint psc_endpoint
include_by_default boolean required

Should the traffic filter be automatically included in the new projects

region string · min length: 1 · max length: 32 required

The traffic filter can be attached only to projects in the specific region

rules object[] required

List of rules

description string

Optional human-readable description of the rule.

source string

Allowed source for ip, vpce, or psc_endpoint filters: an IP address, CIDR mask, AWS VPC endpoint ID (vpce- followed by 17 lowercase hex characters), or GCP PSC connection ID. Must not be set for private_endpoint filters.

azure_endpoint_name string · min length: 2 · max length: 80 · pattern: ^[a-zA-Z0-9][-\w.]{0,78}[\w]$

Azure Private Endpoint resource name. Required for private_endpoint filters; not applicable to ip, vpce, or psc_endpoint filters. Must be 2–80 characters, start with an alphanumeric character, and end with an alphanumeric character or underscore. May contain alphanumerics, underscores, periods, and hyphens.

azure_endpoint_guid string · pattern: ^[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}$

Azure Private Endpoint resource GUID (properties.resourceGuid from the Azure resource). Required for private_endpoint filters. Must be a lowercase UUID. This is not the ARM resource ID.

Response headers

ETag string