Backend Services | Reblaze Documentation

Get Backend Services

Get all Backend Services in a configuration

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

Path parameters

config*Config

Response

Backend Services retrieved successfully

Body

totalinteger

Example: 1

itemsarray of BackendService

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Modify Backend Services

Updates an existing set of Backend Services for a configuration

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

Path parameters

config*Config

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

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.

defaulthttphttpsport_bridge

Response

Backend Services updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "http11": false,
        "transport_mode": "default",
        "sticky": "none",
        "sticky_cookie_name": "text",
        "least_conn": false,
        "back_hosts": [
          {
            "host": "text",
            "http_ports": [
              80,
              8080
            ],
            "https_ports": [
              443,
              8443
            ],
            "down": false,
            "monitor_state": "text",
            "backup": false
          }
        ]
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

Create Backend Services

Create a complete set of Backend Services for a configuration

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

Path parameters

config*Config

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

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.

defaulthttphttpsport_bridge

Response

Backend Services created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "http11": false,
        "transport_mode": "default",
        "sticky": "none",
        "sticky_cookie_name": "text",
        "least_conn": false,
        "back_hosts": [
          {
            "host": "text",
            "http_ports": [
              80,
              8080
            ],
            "https_ports": [
              443,
              8443
            ],
            "down": false,
            "monitor_state": "text",
            "backup": false
          }
        ]
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

Delete Backend Services

Delete all Backend Services in a configuration

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

Path parameters

config*Config

Response

Backend Services deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted entry"
}

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

config*Config

entry_id*Entry

Response

Backend Service retrieved successfully

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

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.

defaulthttphttpsport_bridge

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

config*Config

entry_id*Entry

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

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.

defaulthttphttpsport_bridge

Response

Backend Service updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "http11": false,
      "transport_mode": "default",
      "sticky": "none",
      "sticky_cookie_name": "text",
      "least_conn": false,
      "back_hosts": [
        {
          "host": "text",
          "http_ports": [
            80,
            8080
          ],
          "https_ports": [
            443,
            8443
          ],
          "down": false,
          "monitor_state": "text",
          "backup": false
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

Create single Backend Service

Create an individual Backend Service within a configuration

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

Path parameters

config*Config

entry_id*Entry

Body

back_hosts*Back Hosts

descriptionDescription

http11*Http11

Use HTTP/1.1

id*Id

least_conn*Least Conn

name*Name

sticky*Sticky

Load Balancing stickiness model

noneautocookiecustomcookieiphashleast_conn

sticky_cookie_name*Sticky Cookie Name

Custom cookie name

transport_mode*Transport Mode

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.

defaulthttphttpsport_bridge

Response

Backend Service created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "http11": false,
      "transport_mode": "default",
      "sticky": "none",
      "sticky_cookie_name": "text",
      "least_conn": false,
      "back_hosts": [
        {
          "host": "text",
          "http_ports": [
            80,
            8080
          ],
          "https_ports": [
            443,
            8443
          ],
          "down": false,
          "monitor_state": "text",
          "backup": false
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

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

config*Config

entry_id*Entry

Response

Backend Service deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted entry"
}

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

config*Config

Response

Backend Services version list retrieved successfully

Body

totalinteger

Example: 1

itemsarray of VersionEntry

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2024-09-19T16:11:53.470Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

Backend Service retrieved successfully

Body

totalinteger

Example: 1

itemsarray of BackendService

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

config*Config

version*Version

Response

Backend Service reversion was successful

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/backend-services/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}