web-service

Configure Web Services.

web-service Specification

Type Configuration Resource
Element Name web-service
Element URI /axapi/v3/web-service
Element Attributes web-service_attributes
Schema web-service schema

Operations Allowed:

Operation Method URI Payload

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)

Type: number

Range: 0-60

Default: 10

axapi-session-limit

Description: Set Web service axapi Session Limit (Session limit (default 30))

Type: number

Range: 1-100

Default: 30

port

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

Type: number

Range: 1-65535

Default: 80

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

secure

Specification
Type object

certificate

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

Type: Object

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

generate

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

Type: Object

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

private-key

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

Type: Object

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

regenerate

Description: regenerate is a JSON Block . Please see below for l73_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
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
Type object

country

Description: The country name

Type: string

domain-name

Description: The domain name

Type: string

state

Description: The location

Type: string

secure.generate

Specification
Type object

country

Description: The country name

Type: string

domain-name

Description: The domain name

Type: string

state

Description: The location

Type: string

secure.private-key

Specification
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