Channel type "HTTP" (via HTTP)

Use the following file for an HTTP channel.

JSON


{
"type": "HTTP",
"operation": "add",
"name": "My HTTP channel",
"relation": "My partner",
"dmz": true,
"direction": "both",
"active": true,
"id": 0,
"local": {
"id": "my local id",
"password": "secret",
"server": ""
},
"remote": {
"id": "my remote id",
"password": "secret"
},
"types": {
"http": false,
"https": true
},
"certificates": {
"own": {
"encryption": 0
},
"partner": {
"encryption": 0
}
},
"realm": "",
"roles": "",
"refreshURL": "",
"preemtive": false,
"contact": {
"language": "de",
"name": "John Doe",
"fax": "",
"email": "john.doe@example.com",
"note": ""
}
}

Parameters


Name

Description

type

Fixed value HTTP.

operation

Fixed value add.

name

Name of the channel to be added.

relation

Name of the existing partner for which the channel is to be added.

dmz

Checkbox Invisible to DMZ in the channel GUI will be set for value false.

direction

The value in sets the value incoming in field Direction in the channel GUI.

The value out sets the value outgoing in field Direction in the channel GUI.

The value both sets the value incoming and outgoing in field Direction in the channel GUI.

active

Checkbox Active in the channel GUI will be set for value true.

id

Fixed value 0.

local (id, password, server)

Fields Own ID, Own password and Partner address in tab Own ID in the channel GUI.

remote (id, password)

Fields Partner ID and Partner password in tab Partner ID in the channel GUI.

types (http, https)

Checkboxes HTTP and HTTPS in the channel GUI.

logSettings (retainDays, enabled)

Checkboxes Retain days and Use Comm-Log in the channel GUI.

certificates

own (encryption)

partner (encryption)

Here you can specify the certificate ID (see sections Local Certificates and Partner Certificates) for the fields Local certificate (encryption) and Partner certificate (encryption) in the channel GUI.

realm

Field Realm in the channel GUI.

roles

Field Roles in the channel GUI.

refreshURL

Field OAuth2 Refresh URL in the channel GUI.

preemtive

Checkbox Use preemptive login in the channel GUI.

contact (language, name, fax, email, note)

See tab "Partner contact" (self-explanatory) in the channel GUI.