How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Stack (ELK Stack) Deployments Traffic Filter API

The DeploymentsTrafficFilter API from Elastic Stack (ELK Stack) — 8 operation(s) for deploymentstrafficfilter.

Elastic Stack (ELK Stack) Deployments Traffic Filter API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DeploymentsTrafficFilter. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 12 operations across 8 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://{{hostname}}/api/v1.

12 operations 8 paths 15 schemas 2 DELETE5 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://{elasticsearch_endpoint}
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Elastic Stack (ELK Stack) Deployments Traffic Filter API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKey). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

DeploymentsTrafficFilter 12
GET
/deployments/traffic-filter/associations/{association_type}/{associated_entity_id}/rulesets
Get associated rulesets
get-traffic-filter-deployment-ruleset-associations 2 params → 200400500
GET
/deployments/traffic-filter/link-ids
List traffic filter claimed link id
get-traffic-filter-claimed-link-ids 2 params → 200500
POST
/deployments/traffic-filter/link-ids/_claim
Claim a link id
claim-traffic-filter-link-id body → 201500
POST
/deployments/traffic-filter/link-ids/_unclaim
Unclaims a link id
unclaim-traffic-filter-link-id body → 200400500
GET
/deployments/traffic-filter/rulesets
List traffic filter rulesets
get-traffic-filter-rulesets 3 params → 200500
POST
/deployments/traffic-filter/rulesets
Create a ruleset
create-traffic-filter-ruleset body → 201500
GET
/deployments/traffic-filter/rulesets/{ruleset_id}
Retrieves the ruleset by ID.
get-traffic-filter-ruleset 2 params → 200404500
PUT
/deployments/traffic-filter/rulesets/{ruleset_id}
Updates a ruleset
update-traffic-filter-ruleset 1 param body → 200404500
DELETE
/deployments/traffic-filter/rulesets/{ruleset_id}
Delete a ruleset
delete-traffic-filter-ruleset 2 params → 200404500
GET
/deployments/traffic-filter/rulesets/{ruleset_id}/associations
Get associated deployments
get-traffic-filter-ruleset-deployment-associations 1 param → 200500
POST
/deployments/traffic-filter/rulesets/{ruleset_id}/associations
Create ruleset association
create-traffic-filter-ruleset-association 1 param body → 201200404500
DELETE
/deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}
Delete ruleset association
delete-traffic-filter-ruleset-association 3 params → 200404500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are TrafficFilterRulesetInfo (9 properties), TrafficFilterRule (8 properties), TrafficFilterRulesetRequest (6 properties), TrafficFilterClaimedLinkIdInfo (4 properties). Each schema is shown below with its type and property counts.

TrafficFilterEgressRule
object
The rule detail for a traffic filter egress rule.
3 properties 2 required
BasicFailedReplyElement
object
3 properties 2 required
TrafficFilterRule
object
The container for a traffic filter rule.
8 properties
TrafficFilterClaimedLinkIdInfo
object
4 properties 1 required
RulesetAssociations
object
The configuration settings for the traffic filter.
2 properties 2 required
TrafficFilterRulesetInfo
object
The container for a set of traffic filter rules.
9 properties 6 required
TrafficFilterSettings
object
The configuration settings for the traffic filter.
1 property 1 required
TrafficFilterRulesetRequest
object
The specification for traffic filter ruleset.
6 properties 5 required
BasicFailedReply
object
1 property 1 required
TrafficFilterClaimedLinkIds
object
The container for a set of traffic filter claimed link id.
1 property 1 required
TrafficFilterRulesets
object
The container for a set of traffic filter rulesets.
1 property 1 required
EmptyResponse
object
FilterAssociation
object
The association with a ruleset or user auth token for a deployment, template, or product.
2 properties 2 required
TrafficFilterRulesetResponse
object
The response after you create a new ruleset.
1 property 1 required
TrafficFilterClaimedLinkIdRequest
object
The specification for traffic filter claimed link id.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-deploymentstrafficfilter-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Deployments Traffic Filter API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.