Retrieves the traffic filter by ID.

View as Markdown
GET /api/v1/serverless/traffic-filters/{id}
Api key

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

Path parameters

  • id string Required

    The traffic filter ID.

Responses

  • 200 application/json

    The container for a set of traffic filter rules.

    Hide response attributes Show response attributes object
    • id string Required

      The traffic filter ID

      Minimum length is 32, maximum length is 32.

    • name string Required

      Name of the traffic filter

      Minimum length is 1, maximum length is 128.

    • description string

      Description of the traffic filter

      Minimum length is 0, maximum length is 512.

    • type string Required

      Type of the traffic filter

      Minimum length is 1, maximum length is 32. Values are ip or vpce.

    • include_by_default boolean Required

      Should the traffic filter be automatically included in the new projects

    • region string Required

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

      Minimum length is 1, maximum length is 32.

    • rules array[object] Required

      List of rules

      The container for a traffic filter rule.

      Hide rules attributes Show rules attributes object
      • description string

        Description of the rule.

      • source string Required

        Allowed traffic filter source: IP address, CIDR mask, or VPC endpoint ID
  • 400 application/json

    Bad request

    Hide response attribute Show response attribute object
    • errors array[object] Required

      An error response returned by the API.

      Hide errors attributes Show errors attributes object
      • message string Required

        A human-readable message of the error.

      • code string Required

        An identifier for this type of error.
  • 401 application/json

    Unauthorized

    Hide response attribute Show response attribute object
    • errors array[object] Required

      An error response returned by the API.

      Hide errors attributes Show errors attributes object
      • message string Required

        A human-readable message of the error.

      • code string Required

        An identifier for this type of error.
  • 404 application/json

    Not Found

    Hide response attribute Show response attribute object
    • errors array[object] Required

      An error response returned by the API.

      Hide errors attributes Show errors attributes object
      • message string Required

        A human-readable message of the error.

      • code string Required

        An identifier for this type of error.
  • 500 application/json

    Internal server error

    Hide response attribute Show response attribute object
    • errors array[object] Required

      An error response returned by the API.

      Hide errors attributes Show errors attributes object
      • message string Required

        A human-readable message of the error.

      • code string Required

        An identifier for this type of error.
GET /api/v1/serverless/traffic-filters/{id} 
curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/serverless/traffic-filters/{id}' \
 --header "Authorization: $API_KEY"