Backend Services

PreviousActions NextCertificates

Last updated 3 months ago

Was this helpful?

Get Backend Services

get

Get all Backend Services in a configuration

Path parameters

configstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/backend-services'

200

422

{
  "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": "",
      "http11": true,
      "id": "text",
      "least_conn": true,
      "name": "text",
      "sticky": "none",
      "sticky_cookie_name": "",
      "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 of · default: ""

http11booleanrequired

Use HTTP/1.1

idstringrequired

least_connbooleanrequired

namestring · min: 1required

stickystring · enumrequired

Load Balancing stickiness model

Options: none, autocookie, customcookie, iphash, least_conn

sticky_cookie_nameany of · default: ""required

Custom cookie name

transport_modestring · enumrequired

Tranport protocol <br> 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.

Options: default, http, https, port_bridge

Responses

application/json

cURL

JavaScript

Python

HTTP

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": "",
      "http11": true,
      "id": "text",
      "least_conn": true,
      "name": "text",
      "sticky": "none",
      "sticky_cookie_name": "",
      "transport_mode": "default"
    }
  ]'

200

422

{
  "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 of · default: ""

http11booleanrequired

Use HTTP/1.1

idstringrequired

least_connbooleanrequired

namestring · min: 1required

stickystring · enumrequired

Load Balancing stickiness model

Options: none, autocookie, customcookie, iphash, least_conn

sticky_cookie_nameany of · default: ""required

Custom cookie name

transport_modestring · enumrequired

Options: default, http, https, port_bridge

Responses

application/json

cURL

JavaScript

Python

HTTP

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": "",
      "http11": true,
      "id": "text",
      "least_conn": true,
      "name": "text",
      "sticky": "none",
      "sticky_cookie_name": "",
      "transport_mode": "default"
    }
  ]'

201

422

{
  "message": "Successfully created entry"
}

Backend Services created successfully

Delete Backend Services

delete

Delete all Backend Services in a configuration

Path parameters

configstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/backend-services'

200

422

{
  "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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/backend-services/{entry_id}'

200

422

{
  "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": "",
  "http11": true,
  "id": "text",
  "least_conn": true,
  "name": "text",
  "sticky": "none",
  "sticky_cookie_name": "",
  "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 of · default: ""

http11booleanrequired

Use HTTP/1.1

idstringrequired

least_connbooleanrequired

namestring · min: 1required

stickystring · enumrequired

Load Balancing stickiness model

Options: none, autocookie, customcookie, iphash, least_conn

sticky_cookie_nameany of · default: ""required

Custom cookie name

transport_modestring · enumrequired

Options: default, http, https, port_bridge

Responses

application/json

cURL

JavaScript

Python

HTTP

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": "",
    "http11": true,
    "id": "text",
    "least_conn": true,
    "name": "text",
    "sticky": "none",
    "sticky_cookie_name": "",
    "transport_mode": "default"
  }'

200

422

{
  "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 of · default: ""

http11booleanrequired

Use HTTP/1.1

idstringrequired

least_connbooleanrequired

namestring · min: 1required

stickystring · enumrequired

Load Balancing stickiness model

Options: none, autocookie, customcookie, iphash, least_conn

sticky_cookie_nameany of · default: ""required

Custom cookie name

transport_modestring · enumrequired

Options: default, http, https, port_bridge

Responses

application/json

cURL

JavaScript

Python

HTTP

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": "",
    "http11": true,
    "id": "text",
    "least_conn": true,
    "name": "text",
    "sticky": "none",
    "sticky_cookie_name": "",
    "transport_mode": "default"
  }'

201

422

{
  "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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/backend-services/{entry_id}'

200

422

{
  "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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/backend-services/versions'

200

422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "hello@example.com",
      "message": "text",
      "date": "2025-03-19T21:04:44.672Z",
      "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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/backend-services/versions/{version}'

200

422

{
  "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": "",
      "http11": true,
      "id": "text",
      "least_conn": true,
      "name": "text",
      "sticky": "none",
      "sticky_cookie_name": "",
      "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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/backend-services/versions/{version}/revert'

200

422

{
  "message": "Successfully updated entry"
}

Backend Service reversion was successful

Get Backend Services

Modify Backend Services

Show child attributes

Show child attributes

Show child attributes

Create Backend Services

Show child attributes

Show child attributes

Show child attributes

Delete Backend Services

Get single Backend Service

Modify a single Backend Service

Show child attributes

Show child attributes

Show child attributes

Create single Backend Service

Show child attributes

Show child attributes

Show child attributes

Delete single Backend Service

Get Backend Services version list

Get version of Backend Service

Revert a Backend Service to the specified version