Update backend
curl --request PUT \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connections": {},
"credentials": {
"password": "<string>",
"username": "<string>"
},
"enabled": true,
"encryption": {
"algorithm": "RSA-OAEP-256",
"encryption_method": "A256GCM",
"mode": "whole_body",
"request_key_kid": "<string>",
"response_key_kids": [
"<string>"
],
"extra_header_claims": [
"iat"
],
"request_field": "encryptedRequest",
"response_field": "encryptedResponse"
},
"host": "<string>",
"name": "<string>"
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}"
payload = {
"connections": {},
"credentials": {
"password": "<string>",
"username": "<string>"
},
"enabled": True,
"encryption": {
"algorithm": "RSA-OAEP-256",
"encryption_method": "A256GCM",
"mode": "whole_body",
"request_key_kid": "<string>",
"response_key_kids": ["<string>"],
"extra_header_claims": ["iat"],
"request_field": "encryptedRequest",
"response_field": "encryptedResponse"
},
"host": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connections: {},
credentials: {password: '<string>', username: '<string>'},
enabled: true,
encryption: {
algorithm: 'RSA-OAEP-256',
encryption_method: 'A256GCM',
mode: 'whole_body',
request_key_kid: '<string>',
response_key_kids: ['<string>'],
extra_header_claims: ['iat'],
request_field: 'encryptedRequest',
response_field: 'encryptedResponse'
},
host: '<string>',
name: '<string>'
})
};
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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'connections' => [
],
'credentials' => [
'password' => '<string>',
'username' => '<string>'
],
'enabled' => true,
'encryption' => [
'algorithm' => 'RSA-OAEP-256',
'encryption_method' => 'A256GCM',
'mode' => 'whole_body',
'request_key_kid' => '<string>',
'response_key_kids' => [
'<string>'
],
'extra_header_claims' => [
'iat'
],
'request_field' => 'encryptedRequest',
'response_field' => 'encryptedResponse'
],
'host' => '<string>',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}"
payload := strings.NewReader("{\n \"connections\": {},\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"enabled\": true,\n \"encryption\": {\n \"algorithm\": \"RSA-OAEP-256\",\n \"encryption_method\": \"A256GCM\",\n \"mode\": \"whole_body\",\n \"request_key_kid\": \"<string>\",\n \"response_key_kids\": [\n \"<string>\"\n ],\n \"extra_header_claims\": [\n \"iat\"\n ],\n \"request_field\": \"encryptedRequest\",\n \"response_field\": \"encryptedResponse\"\n },\n \"host\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connections\": {},\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"enabled\": true,\n \"encryption\": {\n \"algorithm\": \"RSA-OAEP-256\",\n \"encryption_method\": \"A256GCM\",\n \"mode\": \"whole_body\",\n \"request_key_kid\": \"<string>\",\n \"response_key_kids\": [\n \"<string>\"\n ],\n \"extra_header_claims\": [\n \"iat\"\n ],\n \"request_field\": \"encryptedRequest\",\n \"response_field\": \"encryptedResponse\"\n },\n \"host\": \"<string>\",\n \"name\": \"<string>\"\n}")
.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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connections\": {},\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"enabled\": true,\n \"encryption\": {\n \"algorithm\": \"RSA-OAEP-256\",\n \"encryption_method\": \"A256GCM\",\n \"mode\": \"whole_body\",\n \"request_key_kid\": \"<string>\",\n \"response_key_kids\": [\n \"<string>\"\n ],\n \"extra_header_claims\": [\n \"iat\"\n ],\n \"request_field\": \"encryptedRequest\",\n \"response_field\": \"encryptedResponse\"\n },\n \"host\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"auth_pipeline": {
"date_header": "<string>",
"extra_headers": {},
"header_values": {},
"method": "<string>",
"signed_headers": [
"<string>"
],
"token_prefix": "<string>"
},
"connections": {},
"enabled": true,
"encryption": {
"algorithm": "RSA-OAEP-256",
"encryption_method": "A256GCM",
"mode": "whole_body",
"request_key_kid": "<string>",
"response_key_kids": [
"<string>"
],
"extra_header_claims": [
"iat"
],
"request_field": "encryptedRequest",
"response_field": "encryptedResponse"
},
"host": "<string>",
"id": "<string>",
"inserted_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"protocol": "<string>"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "VALIDATION_ERROR",
"code": 422,
"validation_errors": [
{
"message": "url is required",
"path": "url"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Backend update
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Credential material for the auth pipeline. Shape is determined by auth_pipeline.source_type and auth_pipeline.credential_type.
- InlineBasicCredentials
- InlineBearerCredentials
- InlineHmacCredentials
- VaultCredentials
Show child attributes
Show child attributes
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
Response
Backend updated
Show child attributes
Show child attributes
Map of action keys to connection configurations
Show child attributes
Show child attributes
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
curl --request PUT \
--url https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connections": {},
"credentials": {
"password": "<string>",
"username": "<string>"
},
"enabled": true,
"encryption": {
"algorithm": "RSA-OAEP-256",
"encryption_method": "A256GCM",
"mode": "whole_body",
"request_key_kid": "<string>",
"response_key_kids": [
"<string>"
],
"extra_header_claims": [
"iat"
],
"request_field": "encryptedRequest",
"response_field": "encryptedResponse"
},
"host": "<string>",
"name": "<string>"
}
'import requests
url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}"
payload = {
"connections": {},
"credentials": {
"password": "<string>",
"username": "<string>"
},
"enabled": True,
"encryption": {
"algorithm": "RSA-OAEP-256",
"encryption_method": "A256GCM",
"mode": "whole_body",
"request_key_kid": "<string>",
"response_key_kids": ["<string>"],
"extra_header_claims": ["iat"],
"request_field": "encryptedRequest",
"response_field": "encryptedResponse"
},
"host": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
connections: {},
credentials: {password: '<string>', username: '<string>'},
enabled: true,
encryption: {
algorithm: 'RSA-OAEP-256',
encryption_method: 'A256GCM',
mode: 'whole_body',
request_key_kid: '<string>',
response_key_kids: ['<string>'],
extra_header_claims: ['iat'],
request_field: 'encryptedRequest',
response_field: 'encryptedResponse'
},
host: '<string>',
name: '<string>'
})
};
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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'connections' => [
],
'credentials' => [
'password' => '<string>',
'username' => '<string>'
],
'enabled' => true,
'encryption' => [
'algorithm' => 'RSA-OAEP-256',
'encryption_method' => 'A256GCM',
'mode' => 'whole_body',
'request_key_kid' => '<string>',
'response_key_kids' => [
'<string>'
],
'extra_header_claims' => [
'iat'
],
'request_field' => 'encryptedRequest',
'response_field' => 'encryptedResponse'
],
'host' => '<string>',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}"
payload := strings.NewReader("{\n \"connections\": {},\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"enabled\": true,\n \"encryption\": {\n \"algorithm\": \"RSA-OAEP-256\",\n \"encryption_method\": \"A256GCM\",\n \"mode\": \"whole_body\",\n \"request_key_kid\": \"<string>\",\n \"response_key_kids\": [\n \"<string>\"\n ],\n \"extra_header_claims\": [\n \"iat\"\n ],\n \"request_field\": \"encryptedRequest\",\n \"response_field\": \"encryptedResponse\"\n },\n \"host\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{instance}.{env}.on-hellgate.cloud/api/admin/backends/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connections\": {},\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"enabled\": true,\n \"encryption\": {\n \"algorithm\": \"RSA-OAEP-256\",\n \"encryption_method\": \"A256GCM\",\n \"mode\": \"whole_body\",\n \"request_key_kid\": \"<string>\",\n \"response_key_kids\": [\n \"<string>\"\n ],\n \"extra_header_claims\": [\n \"iat\"\n ],\n \"request_field\": \"encryptedRequest\",\n \"response_field\": \"encryptedResponse\"\n },\n \"host\": \"<string>\",\n \"name\": \"<string>\"\n}")
.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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connections\": {},\n \"credentials\": {\n \"password\": \"<string>\",\n \"username\": \"<string>\"\n },\n \"enabled\": true,\n \"encryption\": {\n \"algorithm\": \"RSA-OAEP-256\",\n \"encryption_method\": \"A256GCM\",\n \"mode\": \"whole_body\",\n \"request_key_kid\": \"<string>\",\n \"response_key_kids\": [\n \"<string>\"\n ],\n \"extra_header_claims\": [\n \"iat\"\n ],\n \"request_field\": \"encryptedRequest\",\n \"response_field\": \"encryptedResponse\"\n },\n \"host\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"auth_pipeline": {
"date_header": "<string>",
"extra_headers": {},
"header_values": {},
"method": "<string>",
"signed_headers": [
"<string>"
],
"token_prefix": "<string>"
},
"connections": {},
"enabled": true,
"encryption": {
"algorithm": "RSA-OAEP-256",
"encryption_method": "A256GCM",
"mode": "whole_body",
"request_key_kid": "<string>",
"response_key_kids": [
"<string>"
],
"extra_header_claims": [
"iat"
],
"request_field": "encryptedRequest",
"response_field": "encryptedResponse"
},
"host": "<string>",
"id": "<string>",
"inserted_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"protocol": "<string>"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "NOT_FOUND",
"code": 404,
"message": "The requested resource does not exist"
}{
"classifier": "VALIDATION_ERROR",
"code": 422,
"validation_errors": [
{
"message": "url is required",
"path": "url"
}
]
}