Get all traffic policies

GET 
/api/v1/services/:service_id/traffic-policies/

Returns the list of traffic policies of a service.

Request

Path Parameters

service_id uuidrequired

Responses

200

application/json

Schema

Schema

• Array [

enable_performance_penalty booleannullable
failover boolean

geos

object[]

required

Array [

continent stringnullable

Possible values: <= 20 characters

country stringnullable

Possible values: <= 20 characters

subdivision stringnullable

Possible values: <= 20 characters

]

health_checks

object[]

required

Array [

health_check uuidrequired

]

id uuidrequired
is_default boolean

performance_checks

object[]

required

Array [

performance_check uuidrequired

]

performance_penalty integernullable

Possible values: >= 10 and <= 300

providers

object[]

required

Array [

is_commitment_priority booleannullable

priority integernullable

Possible values: >= -2147483648 and <= 2147483647

service_provider uuidrequired

weight integernullable

Possible values: >= -2147483648 and <= 2147483647

]

service uuidrequired
type TrafficPolicyTypeEnum (string)required

• Static - Static
• Dynamic - Dynamic
• Cost based - Cost Based

Possible values: [Static, Dynamic, Cost based]

• ]

Example (from schema)

[
  {
    "enable_performance_penalty": true,
    "failover": true,
    "geos": [
      {
        "continent": "string",
        "country": "string",
        "subdivision": "string"
      }
    ],
    "health_checks": [
      {
        "health_check": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "is_default": true,
    "performance_checks": [
      {
        "performance_check": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "performance_penalty": 0,
    "providers": [
      {
        "is_commitment_priority": true,
        "priority": 0,
        "service_provider": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "weight": 0
      }
    ],
    "service": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "Static"
  }
]

Loading...