Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Backend Services

Get Backend Services

get

Get all Backend Services in a configuration

Path parameters
configstringRequired
Responses
200

Backend Services retrieved successfully

application/json
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/backend-services
GET /api/v4.3/conf/{config}/backend-services HTTP/1.1
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",
      "mtls_certificate": "text",
      "mtls_trusted_certificate": "text"
    }
  ]
}

Modify Backend Services

put

Updates an existing set of Backend Services for a configuration

Path parameters
configstringRequired
Bodyobject · BackendService[]
descriptionany ofOptionalDefault: ""
stringOptional
http11booleanRequired

Use HTTP/1.1

idstringRequired
least_connbooleanRequired
namestring · min: 1Required
stickystring · enumRequired

Load Balancing stickiness model

Possible values:
sticky_cookie_nameany ofRequired

Custom cookie name

Default: ""
stringOptional
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.

Possible values:
mtls_certificatestringOptional

ID of mTLS certificate attached to backend service

mtls_trusted_certificatestringOptional

ID of CA certificate attached to backend service

Responses
200

Backend Services updated successfully

application/json
messagestringRequired

Information about successful update operation

Example: Successfully updated entry
put/api/v4.3/conf/{config}/backend-services
PUT /api/v4.3/conf/{config}/backend-services HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 375

[
  {
    "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",
    "mtls_certificate": "text",
    "mtls_trusted_certificate": "text"
  }
]
{
  "message": "Successfully updated entry"
}

Create Backend Services

post

Create a complete set of Backend Services for a configuration

Path parameters
configstringRequired
Bodyobject · BackendService[]
descriptionany ofOptionalDefault: ""
stringOptional
http11booleanRequired

Use HTTP/1.1

idstringRequired
least_connbooleanRequired
namestring · min: 1Required
stickystring · enumRequired

Load Balancing stickiness model

Possible values:
sticky_cookie_nameany ofRequired

Custom cookie name

Default: ""
stringOptional
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.

Possible values:
mtls_certificatestringOptional

ID of mTLS certificate attached to backend service

mtls_trusted_certificatestringOptional

ID of CA certificate attached to backend service

Responses
201

Backend Services created successfully

application/json
messagestringRequired

Information about successful create operation

Example: Successfully created entry
post/api/v4.3/conf/{config}/backend-services
POST /api/v4.3/conf/{config}/backend-services HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 375

[
  {
    "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",
    "mtls_certificate": "text",
    "mtls_trusted_certificate": "text"
  }
]
{
  "message": "Successfully created entry"
}

Delete Backend Services

delete

Delete all Backend Services in a configuration

Path parameters
configstringRequired
Responses
200

Backend Services deleted successfully

application/json
messagestringRequired

Information about successful delete operation

Example: Successfully deleted entry
delete/api/v4.3/conf/{config}/backend-services
DELETE /api/v4.3/conf/{config}/backend-services HTTP/1.1
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get single Backend Service

get

Get an individual Backend Service from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200

Backend Service retrieved successfully

application/json
descriptionany ofOptionalDefault: ""
stringOptional
http11booleanRequired

Use HTTP/1.1

idstringRequired
least_connbooleanRequired
namestring · min: 1Required
stickystring · enumRequired

Load Balancing stickiness model

Possible values:
sticky_cookie_nameany ofRequired

Custom cookie name

Default: ""
stringOptional
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.

Possible values:
mtls_certificatestringOptional

ID of mTLS certificate attached to backend service

mtls_trusted_certificatestringOptional

ID of CA certificate attached to backend service

get/api/v4.3/conf/{config}/backend-services/{entry_id}
GET /api/v4.3/conf/{config}/backend-services/{entry_id} HTTP/1.1
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",
  "mtls_certificate": "text",
  "mtls_trusted_certificate": "text"
}

Modify a single Backend Service

put

Update an individual Backend Service within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
descriptionany ofOptionalDefault: ""
stringOptional
http11booleanRequired

Use HTTP/1.1

idstringRequired
least_connbooleanRequired
namestring · min: 1Required
stickystring · enumRequired

Load Balancing stickiness model

Possible values:
sticky_cookie_nameany ofRequired

Custom cookie name

Default: ""
stringOptional
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.

Possible values:
mtls_certificatestringOptional

ID of mTLS certificate attached to backend service

mtls_trusted_certificatestringOptional

ID of CA certificate attached to backend service

Responses
200

Backend Service updated successfully

application/json
messagestringRequired

Information about successful update operation

Example: Successfully updated entry
put/api/v4.3/conf/{config}/backend-services/{entry_id}
PUT /api/v4.3/conf/{config}/backend-services/{entry_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "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",
  "mtls_certificate": "text",
  "mtls_trusted_certificate": "text"
}
{
  "message": "Successfully updated entry"
}

Create single Backend Service

post

Create an individual Backend Service within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
descriptionany ofOptionalDefault: ""
stringOptional
http11booleanRequired

Use HTTP/1.1

idstringRequired
least_connbooleanRequired
namestring · min: 1Required
stickystring · enumRequired

Load Balancing stickiness model

Possible values:
sticky_cookie_nameany ofRequired

Custom cookie name

Default: ""
stringOptional
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.

Possible values:
mtls_certificatestringOptional

ID of mTLS certificate attached to backend service

mtls_trusted_certificatestringOptional

ID of CA certificate attached to backend service

Responses
201

Backend Service created successfully

application/json
messagestringRequired

Information about successful create operation

Example: Successfully created entry
post/api/v4.3/conf/{config}/backend-services/{entry_id}
POST /api/v4.3/conf/{config}/backend-services/{entry_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 373

{
  "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",
  "mtls_certificate": "text",
  "mtls_trusted_certificate": "text"
}
{
  "message": "Successfully created entry"
}

Delete single Backend Service

delete

Delete an individual Backend Service from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200

Backend Service deleted successfully

application/json
messagestringRequired

Information about successful delete operation

Example: Successfully deleted entry
delete/api/v4.3/conf/{config}/backend-services/{entry_id}
DELETE /api/v4.3/conf/{config}/backend-services/{entry_id} HTTP/1.1
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get Backend Services version list

get

Get list of versions of Backend Services in a configuration

Path parameters
configstringRequired
Responses
200

Backend Services version list retrieved successfully

application/json
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/backend-services/versions
GET /api/v4.3/conf/{config}/backend-services/versions HTTP/1.1
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2026-01-01T00:00:00.000Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Backend Service

get

Get a specific version of a Backend Service

Path parameters
configstringRequired
versionstringRequired
Responses
200

Backend Service retrieved successfully

application/json
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/backend-services/versions/{version}
GET /api/v4.3/conf/{config}/backend-services/versions/{version} HTTP/1.1
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",
      "mtls_certificate": "text",
      "mtls_trusted_certificate": "text"
    }
  ]
}

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
200

Backend Service reversion was successful

application/json
messagestringRequired

Information about successful update operation

Example: Successfully updated entry
put/api/v4.3/conf/{config}/backend-services/versions/{version}/revert
PUT /api/v4.3/conf/{config}/backend-services/versions/{version}/revert HTTP/1.1
Accept: */*

{
  "message": "Successfully updated entry"
}
PreviousActions
NextCertificates

Last updated

Was this helpful?