Backend Services
Get all Backend Services in a configuration
GET /api/v4.0/conf/{config}/backend-services HTTP/1.1
Host:
Accept: */*
{
"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"
}
]
}
Updates an existing set of Backend Services for a configuration
""
Use HTTP/1.1
Load Balancing stickiness model
Custom cookie name
""
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.
PUT /api/v4.0/conf/{config}/backend-services HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 315
[
{
"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"
}
]
{
"message": "Successfully updated entry"
}
Create a complete set of Backend Services for a configuration
""
Use HTTP/1.1
Load Balancing stickiness model
Custom cookie name
""
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.
POST /api/v4.0/conf/{config}/backend-services HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 315
[
{
"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"
}
]
{
"message": "Successfully created entry"
}
Delete all Backend Services in a configuration
DELETE /api/v4.0/conf/{config}/backend-services HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get an individual Backend Service from the specified configuration
GET /api/v4.0/conf/{config}/backend-services/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"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"
}
Update an individual Backend Service within a configuration
""
Use HTTP/1.1
Load Balancing stickiness model
Custom cookie name
""
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.
PUT /api/v4.0/conf/{config}/backend-services/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 313
{
"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"
}
{
"message": "Successfully updated entry"
}
Create an individual Backend Service within a configuration
""
Use HTTP/1.1
Load Balancing stickiness model
Custom cookie name
""
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.
POST /api/v4.0/conf/{config}/backend-services/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 313
{
"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"
}
{
"message": "Successfully created entry"
}
Delete an individual Backend Service from the specified configuration
DELETE /api/v4.0/conf/{config}/backend-services/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get list of versions of Backend Services in a configuration
GET /api/v4.0/conf/{config}/backend-services/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-07-01T22:30:59.464Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}
Get a specific version of a Backend Service
GET /api/v4.0/conf/{config}/backend-services/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"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"
}
]
}
Set a previous Backend Service version to be the current one
PUT /api/v4.0/conf/{config}/backend-services/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}
Last updated
Was this helpful?