Backend Services

Get Backend Services

get

Get all Backend Services in a configuration

Path parameters
configstringrequired
Responses
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
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

Create Backend Services

post

Create a complete 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
curl -L \
  --request POST \
  --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 created entry"
}

Backend Services created successfully

Delete Backend Services

delete

Delete all Backend Services in a configuration

Path parameters
configstringrequired
Responses
curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/backend-services'
{
  "message": "Successfully deleted entry"
}

Backend Services deleted successfully

Get single Backend Service

get

Get an individual Backend Service from the specified configuration

Path parameters
configstringrequired
entry_idstringrequired
Responses
curl -L \
  --url '/api/v4.0/conf/{config}/backend-services/{entry_id}'
{
  "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 Service retrieved successfully

Modify a single Backend Service

put

Update an individual Backend Service within a configuration

Path parameters
configstringrequired
entry_idstringrequired
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
curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/backend-services/{entry_id}' \
  --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 Service updated successfully

Create single Backend Service

post

Create an individual Backend Service within a configuration

Path parameters
configstringrequired
entry_idstringrequired
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
curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/backend-services/{entry_id}' \
  --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 created entry"
}

Backend Service created successfully

Delete single Backend Service

delete

Delete an individual Backend Service from the specified configuration

Path parameters
configstringrequired
entry_idstringrequired
Responses
curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/backend-services/{entry_id}'
{
  "message": "Successfully deleted entry"
}

Backend Service deleted successfully

Get Backend Services version list

get

Get list of versions of Backend Services in a configuration

Path parameters
configstringrequired
Responses
curl -L \
  --url '/api/v4.0/conf/{config}/backend-services/versions'
{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2025-04-07T15:42:08.050Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Backend Services version list retrieved successfully

Get version of Backend Service

get

Get a specific version of a Backend Service

Path parameters
configstringrequired
versionstringrequired
Responses
curl -L \
  --url '/api/v4.0/conf/{config}/backend-services/versions/{version}'
{
  "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 Service retrieved successfully

Revert a Backend Service to the specified version

put

Set a previous Backend Service version to be the current one

Path parameters
configstringrequired
versionstringrequired
Responses
curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/backend-services/versions/{version}/revert'
{
  "message": "Successfully updated entry"
}

Backend Service reversion was successful

PreviousActionsNextCertificates

Last updated

Was this helpful?