Backend Services

PreviousActions NextCertificates

Last updated 2 months ago

Was this helpful?

Get Backend Services

Get all Backend Services in a configuration

get

/api/v4.0/conf/{config}/backend-services

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "total": 1,
  "items": [
    {
      "http11": true,
      "id": "text",
      "least_conn": true,
      "name": "text",
      "sticky": "none",
      "transport_mode": "default",
      "back_hosts": [
        {
          "backup": true,
          "down": true,
          "fail_timeout": 1,
          "host": "text",
          "max_fails": 1,
          "monitor_state": "text",
          "weight": 1,
          "http_ports": [
            80,
            8080
          ],
          "https_ports": [
            443,
            8443
          ]
        }
      ],
      "description": "",
      "sticky_cookie_name": ""
    }
  ]
}

Backend Services retrieved successfully

Modify Backend Services

Updates an existing set of Backend Services for a configuration

put

/api/v4.0/conf/{config}/backend-services

Path parameters

configConfigrequired

Body

http11Http11required

Use HTTP/1.1

idIdrequired

least_connLeast Connrequired

nameNamerequired

stickyStickyrequired

Load Balancing stickiness model

Options: none, autocookie, customcookie, iphash, least_conn

transport_modeTransport Moderequired

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

back_hostsBack Hostsrequired

descriptionDescription

sticky_cookie_nameSticky Cookie Namerequired

Custom cookie name

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 '[{"http11":true,"id":"text","least_conn":true,"name":"text","sticky":"none","transport_mode":"default","back_hosts":[{"backup":true,"down":true,"fail_timeout":1,"host":"text","max_fails":1,"monitor_state":"text","weight":1,"http_ports":[80,8080],"https_ports":[443,8443]}],"description":"","sticky_cookie_name":""}]'

200

422

{
  "message": "Successfully updated entry"
}

Backend Services updated successfully

Create Backend Services

Create a complete set of Backend Services for a configuration

post

/api/v4.0/conf/{config}/backend-services

Path parameters

configConfigrequired

Body

http11Http11required

Use HTTP/1.1

idIdrequired

least_connLeast Connrequired

nameNamerequired

stickyStickyrequired

Load Balancing stickiness model

Options: none, autocookie, customcookie, iphash, least_conn

transport_modeTransport Moderequired

Options: default, http, https, port_bridge

back_hostsBack Hostsrequired

descriptionDescription

sticky_cookie_nameSticky Cookie Namerequired

Custom cookie name

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 '[{"http11":true,"id":"text","least_conn":true,"name":"text","sticky":"none","transport_mode":"default","back_hosts":[{"backup":true,"down":true,"fail_timeout":1,"host":"text","max_fails":1,"monitor_state":"text","weight":1,"http_ports":[80,8080],"https_ports":[443,8443]}],"description":"","sticky_cookie_name":""}]'

201

422

{
  "message": "Successfully created entry"
}

Backend Services created successfully

Delete Backend Services

Delete all Backend Services in a configuration

delete

/api/v4.0/conf/{config}/backend-services

Path parameters

configConfigrequired

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 an individual Backend Service from the specified configuration

get

/api/v4.0/conf/{config}/backend-services/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "http11": true,
  "id": "text",
  "least_conn": true,
  "name": "text",
  "sticky": "none",
  "transport_mode": "default",
  "back_hosts": [
    {
      "backup": true,
      "down": true,
      "fail_timeout": 1,
      "host": "text",
      "max_fails": 1,
      "monitor_state": "text",
      "weight": 1,
      "http_ports": [
        80,
        8080
      ],
      "https_ports": [
        443,
        8443
      ]
    }
  ],
  "description": "",
  "sticky_cookie_name": ""
}

Backend Service retrieved successfully

Modify a single Backend Service

Update an individual Backend Service within a configuration

put

/api/v4.0/conf/{config}/backend-services/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

http11Http11required

Use HTTP/1.1

idIdrequired

least_connLeast Connrequired

nameNamerequired

stickyStickyrequired

Load Balancing stickiness model

Options: none, autocookie, customcookie, iphash, least_conn

transport_modeTransport Moderequired

Options: default, http, https, port_bridge

back_hostsBack Hostsrequired

descriptionDescription

sticky_cookie_nameSticky Cookie Namerequired

Custom cookie name

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 '{"http11":true,"id":"text","least_conn":true,"name":"text","sticky":"none","transport_mode":"default","back_hosts":[{"backup":true,"down":true,"fail_timeout":1,"host":"text","max_fails":1,"monitor_state":"text","weight":1,"http_ports":[80,8080],"https_ports":[443,8443]}],"description":"","sticky_cookie_name":""}'

200

422

{
  "message": "Successfully updated entry"
}

Backend Service updated successfully

Create single Backend Service

Create an individual Backend Service within a configuration

post

/api/v4.0/conf/{config}/backend-services/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

http11Http11required

Use HTTP/1.1

idIdrequired

least_connLeast Connrequired

nameNamerequired

stickyStickyrequired

Load Balancing stickiness model

Options: none, autocookie, customcookie, iphash, least_conn

transport_modeTransport Moderequired

Options: default, http, https, port_bridge

back_hostsBack Hostsrequired

descriptionDescription

sticky_cookie_nameSticky Cookie Namerequired

Custom cookie name

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 '{"http11":true,"id":"text","least_conn":true,"name":"text","sticky":"none","transport_mode":"default","back_hosts":[{"backup":true,"down":true,"fail_timeout":1,"host":"text","max_fails":1,"monitor_state":"text","weight":1,"http_ports":[80,8080],"https_ports":[443,8443]}],"description":"","sticky_cookie_name":""}'

201

422

{
  "message": "Successfully created entry"
}

Backend Service created successfully

Delete single Backend Service

Delete an individual Backend Service from the specified configuration

delete

/api/v4.0/conf/{config}/backend-services/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

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 list of versions of Backend Services in a configuration

get

/api/v4.0/conf/{config}/backend-services/versions

Path parameters

configConfigrequired

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-02-22T08:33:17.104Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Backend Services version list retrieved successfully

Get version of Backend Service

Get a specific version of a Backend Service

get

/api/v4.0/conf/{config}/backend-services/versions/{version}

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "total": 1,
  "items": [
    {
      "http11": true,
      "id": "text",
      "least_conn": true,
      "name": "text",
      "sticky": "none",
      "transport_mode": "default",
      "back_hosts": [
        {
          "backup": true,
          "down": true,
          "fail_timeout": 1,
          "host": "text",
          "max_fails": 1,
          "monitor_state": "text",
          "weight": 1,
          "http_ports": [
            80,
            8080
          ],
          "https_ports": [
            443,
            8443
          ]
        }
      ],
      "description": "",
      "sticky_cookie_name": ""
    }
  ]
}

Backend Service retrieved successfully

Revert a Backend Service to the specified version

Set a previous Backend Service version to be the current one

put

/api/v4.0/conf/{config}/backend-services/versions/{version}/revert

Path parameters

configConfigrequired

versionVersionrequired

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