Deployments - Traffic Filter Claimed Link Id | Elasticsearch Service Documentation

› › ›

« Deployments - Traffic Filter - CRUD Organizations »

Deployments - Traffic Filter Claimed Link Idedit

List traffic filter claimed link idedit

List all of the traffic filter claimed link id.

Requestedit

GET /api/v1/deployments/traffic-filter/link-ids

Query parametersedit

Name	Type	Required	Description
`organization_id`	`string`	N	Retrieves a list of resources that are associated to the specified organization ID. It only takes effect if the user is an admin.
`region`	`string`	N	If provided limits the claimed id to that region only.

Responsesedit

200

(TrafficFilterClaimedLinkIds)

The collection of traffic filter claimed link id

500

(BasicFailedReply)

Error fetching traffic filter claimed link ids. (code: traffic_filter_claimed_link_id.request_execution_failed)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter_claimed_link_id.request_execution_failed]): The error codes associated with the response

Request exampleedit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/link-ids \
-H "Authorization: ApiKey $EC_API_KEY"

Claim a link idedit

Claim the ownership of a link id.

Requestedit

POST /api/v1/deployments/traffic-filter/link-ids/_claim

Request bodyedit

(TrafficFilterClaimedLinkIdRequest) (required) The specification for traffic filter claimed link id.

Responsesedit

201

(TrafficFilterClaimedLinkIdInfo)

The ruleset definition is valid and the creation has started.

500

(BasicFailedReply)

Error creating the traffic filter ruleset. (code: traffic_filter_claimed_link_id.request_execution_failed)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter_claimed_link_id.request_execution_failed]): The error codes associated with the response

Request exampleedit

curl -XPOST https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/link-ids/_claim \
-H "Authorization: ApiKey $EC_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "azure_endpoint_guid" : "string",
   "azure_endpoint_name" : "string",
   "link_id" : "string",
   "region" : "string"
}
'

Unclaims a link idedit

Unclaims the ownership of a link id.

Requestedit

POST /api/v1/deployments/traffic-filter/link-ids/_unclaim

Request bodyedit

(TrafficFilterClaimedLinkIdRequest) (required) The specification for traffic filter claimed link id.

Responsesedit

200

(EmptyResponse)

The claimed link id was successfully deleted.

400

(BasicFailedReply)

Error validating the request. (code: traffic_filter_claimed_link_id.invalid_input)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter_claimed_link_id.invalid_input]): The error codes associated with the response

500

(BasicFailedReply)

Error deleting the traffic filter claimed link id. (code: traffic_filter_claimed_link_id.request_execution_failed)

Headers

x-cloud-error-codes (string; allowed values: [traffic_filter_claimed_link_id.request_execution_failed]): The error codes associated with the response

Request exampleedit

curl -XPOST https://api.elastic-cloud.com/api/v1/deployments/traffic-filter/link-ids/_unclaim \
-H "Authorization: ApiKey $EC_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "azure_endpoint_guid" : "string",
   "azure_endpoint_name" : "string",
   "link_id" : "string",
   "region" : "string"
}
'

« Deployments - Traffic Filter - CRUD Organizations »