Create filtered group of proxies

POST /platform/infrastructure/proxies/filtered-groups

Create the settings for a filtered group of proxies.

Body Required

Data for the filtered group of proxies to create

id string

Identifier of the filtered group of proxies
filters array[object] Required

Filters to be matched
Hide filters attributes Show filters attributes object
- key string Required
  
  Key of the proxy metadata item to be matched
- value string Required
  
  Value of the proxy metadata item to be matched
expected_proxies_count integer(int32) Required

Expected minimum number of proxies matching all filters in this group

Responses

200

Returns the created or updated filtered group of proxies
Hide headers attributes Show headers attributes
- x-cloud-resource-version string
  
  The resource version, which is used to avoid update conflicts with concurrent operations
- x-cloud-resource-created string
  
  The date-time when the resource was created (ISO format relative to UTC)
- x-cloud-resource-last-modified string
  
  The date-time when the resource was last modified (ISO format relative to UTC)
Hide response attributes Show response attributes object
- id string
  
  Identifier of the filtered group of proxies
- filters array[object] Required
  
  Filters to be matched
  
  Hide filters attributes Show filters attributes object
  
  key string Required
  
  Key of the proxy metadata item to be matched
  
  value string Required
  
  Value of the proxy metadata item to be matched
- expected_proxies_count integer(int32) Required
  
  Expected minimum number of proxies matching all filters in this group
400
- The filtered group of proxies has empty id. (code: proxies.proxies_filtered_group_empty_id)
- A filtered group of proxies with the same identifier already exists. (code: proxies.proxies_filtered_group_already_exists)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are proxies.proxies_filtered_group_empty_id or proxies.proxies_filtered_group_already_exists.
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

POST /platform/infrastructure/proxies/filtered-groups

curl \
 -X POST https://{{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups \
 -d '{"id":"string","filters":[{"key":"string","value":"string"}],"expected_proxies_count":42}'

Request examples

{
  "id": "string",
  "filters": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "expected_proxies_count": 42
}

Response examples (200)

# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "id": "string",
  "filters": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "expected_proxies_count": 42
}

Response examples (400)

# Headers
x-cloud-error-codes: proxies.proxies_filtered_group_empty_id

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