Get associated deployments

GET /deployments/traffic-filter/rulesets/{ruleset_id}/associations

Retrieves a list of deployments that are associated to the specified ruleset.

Path parameters

Responses

  • 200

    Associations referred by traffic filter rulesets were successfully returned

    Hide response attributes Show response attributes object
    • associations array[object] Required

      List of associations

      Hide associations attributes Show associations attributes object
      • entity_type string Required

        Type of the traffic filter ruleset association, such as 'deployment', 'cluster'

      • id string Required

        ID of the entity, such as the deployment ID or Elasticsearch cluster ID.

    • total_associations integer(int32) Required

      Total number of associations. This includes associations the user does not have permission to view.
  • 500

    Error fetching deployments. (code: traffic_filter.request_execution_failed)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is traffic_filter.request_execution_failed.

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

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
GET /deployments/traffic-filter/rulesets/{ruleset_id}/associations 
curl \
 -X GET https://{{hostname}}/api/v1/deployments/traffic-filter/rulesets/{ruleset_id}/associations
Response examples (200) 
{
  "associations": [
    {
      "entity_type": "string",
      "id": "string"
    }
  ],
  "total_associations": 42
}
Response examples (500) 
# Headers
x-cloud-error-codes: traffic_filter.request_execution_failed

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}