web-service

Configure Web Services

web-service Specification

Parameter Value
Type Configuration Resource
Element Name web-service
Element URI /axapi/v3/web-service
Element Attributes web-service_attributes
Partition Visibility shared
Schema web-service schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/web-service

web-service attributes

Get Object

GET

/axapi/v3/web-service

web-service attributes

Modify Object

POST

/axapi/v3/web-service

web-service attributes

Replace Object

PUT

/axapi/v3/web-service

web-service attributes

Delete Object

DELETE

/axapi/v3/web-service

web-service attributes

web-service attributes

auto-redirt-disable

Description Diable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

axapi-idle

Description Idle timeout of a xml service connection in minutes (Connection idle timeout value in minutes, default 10, 0 means never timeout)

Type: number

Range: 0-60

Default: 10

axapi-session-limit

Description Set the max allowed aXAPI sessions (Session limit (default 30))

Type: number

Range: 1-100

Default: 30

gui-idle

Description Idle timeout of a connection in minutes (Connection idle timeout value in minutes, default 10, 0 means never timeout)

Type: number

Range: 0-60

Default: 10

gui-session-limit

Description Set the max allowed GUI sessions (Session limit (default 30))

Type: number

Range: 1-100

Default: 30

keep-alive-timeout

Description Set KeepAliveTimeout in seconds (KeepAliveTimeout in seconds (default 30))

Type: number

Range: 1-65535

Default: 30

login-message

Description Set GUI login message

Type: string

Format: string-rlx

Maximum Length: 1985 characters

Maximum Length: 1 characters

max-keep-alive-requests

Description Set MaxKeepAliveRequests (MaxKeepAliveRequests (default 100))

Type: number

Range: 0-65535

Default: 100

mpm-max-conn

Description Set Max Connections of MPM

Type: number

Range: 1-20000

mpm-max-conn-per-child

Description Set Max Connections Per Child of MPM

Type: number

Range: 0-20000

mpm-min-spare-conn

Description Set Min Spare Connections of MPM

Type: number

Range: 1-20000

port

Description Set Web Server Port (Port number(default 80))

Type: number

Range: 1-65535

Default: 80

pre-login-message

Description Set Pre GUI login message

Type: string

Format: string-rlx

Maximum Length: 1985 characters

Maximum Length: 1 characters

public-apis

Type: List

secure

Description: secure is a JSON Block. Please see below for secure

Type: Object

Reference Object: /axapi/v3/web-service/secure

secure-port

Description Set web secure server port number for listening (Secure Port Number(default 443))

Type: number

Range: 1-65535

Default: 443

secure-server-disable

Description Disable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server-disable

Description Disable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

secure

Specification Value
Type object

certificate

Description: certificate is a JSON Block. Please see below for secure_certificate

Type: Object

Reference Object: /axapi/v3/web-service/secure/certificate

generate

Description: generate is a JSON Block. Please see below for secure_generate

Type: Object

Reference Object: /axapi/v3/web-service/secure/generate

private-key

Description: private-key is a JSON Block. Please see below for secure_private-key

Type: Object

Reference Object: /axapi/v3/web-service/secure/private-key

regenerate

Description: regenerate is a JSON Block. Please see below for secure_regenerate

Type: Object

Reference Object: /axapi/v3/web-service/secure/regenerate

restart

Description Restart WEB service

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

wipe

Description Wipe WEB private-key and certificate

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

secure_certificate

Specification Value
Type object

file-url

Description File URL

Type: string

Format: url

load

Description Load WEB certificate

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description Use management port as source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

secure_regenerate

Specification Value
Type object

country

Description The country name

Type: string

Maximum Length: 2 characters

Maximum Length: 2 characters

domain-name

Description The domain name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

state

Description The location

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

secure_generate

Specification Value
Type object

country

Description The country name

Type: string

Maximum Length: 2 characters

Maximum Length: 2 characters

domain-name

Description The domain name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

state

Description The location

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

secure_private-key

Specification Value
Type object

file-url

Description File URL

Type: string

Format: url

load

Description Load WEB private-key

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

use-mgmt-port

Description Use management port as source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

public-apis

Specification Value
Type list
Block object keys  

api-uri

Description API URI

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters