Backends
Get backend
GET
/
api
/
admin
/
backends
/
{id}
Get backend
curl --request GET \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"auth_pipeline": {
"source_type": "inline",
"credential_type": "bearer",
"token_prefix": "token"
},
"connections": {
"assess.pan": {
"endpoint": {
"method": "POST",
"path": "/v1/decisions",
"content_type": "application/json",
"timeout_ms": 5000
},
"request_mapping": {
"body": {
"cardNumber": "{{ $.request.body.credential.pan.value | required }}",
"amount": "{{ $.request.body.transaction.amount | required }}",
"currency": "{{ $.request.body.transaction.currency | required }}"
}
},
"response_mapping": {
"200": {
"return": "200",
"body": {
"type": "enum",
"value": "{{ $.response.body.status | map({ ACCEPTED: ALLOW, REJECTED: BLOCK, PENDING: REVIEW }) | required }}",
"backend_reference": "{{ $.response.body.id | omit_if_null }}"
}
}
}
}
},
"enabled": true,
"encryption": {
"algorithm": "RSA-OAEP-256",
"encryption_method": "A256GCM",
"mode": "whole_body",
"request_key_kid": "a1b2c3d4e5f6",
"response_key_kids": [
"f6e5d4c3b2a1"
],
"extra_header_claims": [
"iat"
],
"request_field": "encryptedRequest",
"response_field": "encryptedResponse"
},
"host": "api.acme.example",
"id": "acme-risk",
"inserted_at": "2026-05-12T09:30:00Z",
"name": "Acme Risk",
"protocol": "https://developer.hellgate.io/protocols/specter/v1"
}{
"classifier": "UNAUTHORIZED",
"code": 401,
"message": "No valid means of authentication was provided"
}{
"classifier": "FORBIDDEN",
"code": 403,
"message": "Not allowed to access this resource or feature"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Backend detail
How outbound requests to the provider are authenticated. An empty object (or omitting the pipeline) adds no authentication. A non-empty pipeline requires source_type and credential_type.
Show child attributes
Show child attributes
Example:
{
"source_type": "inline",
"credential_type": "bearer",
"token_prefix": "token"
}
Map of action keys to connection configurations
Show child attributes
Show child attributes
Example:
{
"assess.pan": {
"endpoint": {
"method": "POST",
"path": "/v1/decisions",
"content_type": "application/json",
"timeout_ms": 5000
},
"request_mapping": {
"body": {
"cardNumber": "{{ $.request.body.credential.pan.value | required }}",
"amount": "{{ $.request.body.transaction.amount | required }}",
"currency": "{{ $.request.body.transaction.currency | required }}"
}
},
"response_mapping": {
"200": {
"return": "200",
"body": {
"type": "enum",
"value": "{{ $.response.body.status | map({ ACCEPTED: ALLOW, REJECTED: BLOCK, PENDING: REVIEW }) | required }}",
"backend_reference": "{{ $.response.body.id | omit_if_null }}"
}
}
}
}
}
Example:
true
Optional per-backend message-level encryption (MLE). When set, the mapped request body is JWE-encrypted before dispatch and the response body is decrypted before response mapping. Key material is managed via /api/admin/keys.
Show child attributes
Show child attributes
Example:
"api.acme.example"
Example:
"acme-risk"
Example:
"2026-05-12T09:30:00Z"
Example:
"Acme Risk"
Example:
"https://developer.hellgate.io/protocols/specter/v1"
⌘I
Get backend
curl --request GET \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"auth_pipeline": {
"source_type": "inline",
"credential_type": "bearer",
"token_prefix": "token"
},
"connections": {
"assess.pan": {
"endpoint": {
"method": "POST",
"path": "/v1/decisions",
"content_type": "application/json",
"timeout_ms": 5000
},
"request_mapping": {
"body": {
"cardNumber": "{{ $.request.body.credential.pan.value | required }}",
"amount": "{{ $.request.body.transaction.amount | required }}",
"currency": "{{ $.request.body.transaction.currency | required }}"
}
},
"response_mapping": {
"200": {
"return": "200",
"body": {
"type": "enum",
"value": "{{ $.response.body.status | map({ ACCEPTED: ALLOW, REJECTED: BLOCK, PENDING: REVIEW }) | required }}",
"backend_reference": "{{ $.response.body.id | omit_if_null }}"
}
}
}
}
},
"enabled": true,
"encryption": {
"algorithm": "RSA-OAEP-256",
"encryption_method": "A256GCM",
"mode": "whole_body",
"request_key_kid": "a1b2c3d4e5f6",
"response_key_kids": [
"f6e5d4c3b2a1"
],
"extra_header_claims": [
"iat"
],
"request_field": "encryptedRequest",
"response_field": "encryptedResponse"
},
"host": "api.acme.example",
"id": "acme-risk",
"inserted_at": "2026-05-12T09:30:00Z",
"name": "Acme Risk",
"protocol": "https://developer.hellgate.io/protocols/specter/v1"
}{
"classifier": "UNAUTHORIZED",
"code": 401,
"message": "No valid means of authentication was provided"
}{
"classifier": "FORBIDDEN",
"code": 403,
"message": "Not allowed to access this resource or feature"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}