---
type: api
title: Retrieves the traffic filter by ID.
description: Retrieves a list of resources that are associated to the specified traffic filter.
url: https://www.elastic.co/docs/api/doc/cloud-serverless/operation/operation-gettrafficfilter
resource: https://www.elastic.co/docs/api/doc/cloud-serverless/operation/operation-gettrafficfilter
products:
  - Elastic Cloud Serverless
---

# Retrieves the traffic filter by ID.

Authentication: required

- Server: `https://api.elastic-cloud.com`

## Paths

- `GET` `/api/v1/serverless/traffic-filters/{id}`

#### Path parameters

- `id` (string) — required
  The traffic filter ID.

## Description

Retrieves a list of resources that are associated to the specified traffic filter.

## Responses

#### `200`

The container for a set of traffic filter rules.

`application/json`

- `id` (string · min length: 32 · max length: 32)
  The traffic filter ID
- `name` (string · min length: 1 · max length: 128)
  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)
  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)
  The traffic filter can be attached only to projects in the specific region
- `rules` (object[])
  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)

#### `400`

Bad request

`application/json`

- `errors` (object[])
  - `message` (string)
    A human-readable message of the error.
  - `code` (string)
    An identifier for this type of error.
#### `401`

Unauthorized

`application/json`

- `errors` (object[])
  - `message` (string)
    A human-readable message of the error.
  - `code` (string)
    An identifier for this type of error.
#### `404`

Not Found

`application/json`

- `errors` (object[])
  - `message` (string)
    A human-readable message of the error.
  - `code` (string)
    An identifier for this type of error.
#### `500`

Internal server error

`application/json`

- `errors` (object[])
  - `message` (string)
    A human-readable message of the error.
  - `code` (string)
    An identifier for this type of error.
## Code examples

#### curl

```curl
curl -X GET "https://api.elastic-cloud.com/api/v1/serverless/traffic-filters/${ID}" \
  -H "Authorization: ApiKey ${API_KEY}"
```

## Response examples

#### 200

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "type": "ip",
  "include_by_default": false,
  "region": "string",
  "rules": [
    {
      "description": "string",
      "source": "vpce-0123456789abcdef0",
      "azure_endpoint_name": "my-private-endpoint",
      "azure_endpoint_guid": "7c0f05e4-e32b-4b10-a246-7b77f7dcc63c"
    }
  ]
}
```

#### 400

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}
```

#### 401

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}
```

#### 404

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}
```

#### 500

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}
```