All pages
Powered by GitBook
1 of 1

Backend Services

Get Backend Services

get

Get all Backend Services in a configuration

Path parameters
configstringrequired
Responses
get
curl -L \
  --url '/api/v4.0/conf/{config}/backend-services'
{
  "total": 1,
  "items": [
    {
      "back_hosts": [
        {
          "backup": true,
          "down": true,
          "fail_timeout": 1,
          "host": "text",
          "http_ports": [
            80,
            8080
          ],
          "https_ports": [
            443,
            8443
          ],
          "max_fails": 1,
          "monitor_state": "text",
          "weight": 1
        }
      ],
      "description": "text",
      "http11": true,
      "id": "text",
      "least_conn": true,
      "name": "text",
      "sticky": "none",
      "sticky_cookie_name": "text",
      "transport_mode": "default"
    }
  ]
}

Backend Services retrieved successfully

Modify Backend Services

put

Updates an existing set of Backend Services for a configuration

Path parameters
configstringrequired
Body
back_hostsobject[]required

descriptionany ofoptionalDefault: ""

http11booleanrequired

Use HTTP/1.1

idstringrequired
least_connbooleanrequired
namestring · min: 1required
stickystring · enumrequired

Load Balancing stickiness model

Available options:
sticky_cookie_nameany ofrequired

Custom cookie name

Default: ""

transport_modestring · enumrequired

Tranport protocol Service connectivity might follow incoming requests, will always be HTTP, or always HTTPS. Port-bridge mode means that Reblaze will target port numbers identical to incoming requests' port numbers.

Available options:
Responses
put
curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/backend-services' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "back_hosts": [
        {
          "backup": true,
          "down": true,
          "fail_timeout": 1,
          "host": "text",
          "http_ports": [
            80,
            8080
          ],
          "https_ports": [
            443,
            8443
          ],
          "max_fails": 1,
          "monitor_state": "text",
          "weight": 1
        }
      ],
      "description": "text",
      "http11": true,
      "id": "text",
      "least_conn": true,
      "name": "text",
      "sticky": "none",
      "sticky_cookie_name": "text",
      "transport_mode": "default"
    }
  ]'
{
  "message": "Successfully updated entry"
}

Backend Services updated successfully