import-periodic auth-portal

Portal file for http authentication

auth-portal Specification

Parameter	Value
Type	Collection
Object Key(s)	auth-portal
Collection Name	auth-portal-list
Collection URI	/axapi/v3/import-periodic/auth-portal
Element Name	auth-portal
Element URI	/axapi/v3/import-periodic/auth-portal/{auth-portal}
Element Attributes	auth-portal_attributes
Partition Visibility	shared
Schema	auth-portal schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/import-periodic/auth-portal	auth-portal attributes	example close
POST /axapi/v3/import-periodic/auth-portal/ Payload: { "auth-portal": { "remote-file": "scp://user:single@10.64.21.234:/home/automation/TESTSUITES/Sdk_Test/sample-auth-portal.zip", "auth-portal": "a", "period": 60, "use-mgmt-port": 1 } }
Create List	POST	/axapi/v3/import-periodic/auth-portal	auth-portal attributes
Get Object	GET	/axapi/v3/import-periodic/auth-portal/{auth-portal}	auth-portal attributes	example close
GET /axapi/v3/import-periodic/auth-portal/a Reponse: { "auth-portal": { "auth-portal": "a", "use-mgmt-port": 1, "remote-file": "scp://user:single@10.64.21.234:/home/automation/TESTSUITES/Sdk_Test/sample-auth-portal.zip", "period": 60, "uuid": "d76e7a9e-64bd-11f0-b116-ef3c1d436f78", "a10-url": "/axapi/v3/import-periodic/auth-portal/a" } }
Get List	GET	/axapi/v3/import-periodic/auth-portal	auth-portal-list
Modify Object	POST	/axapi/v3/import-periodic/auth-portal/{auth-portal}	auth-portal attributes
Replace Object	PUT	/axapi/v3/import-periodic/auth-portal/{auth-portal}	auth-portal attributes	example close
PUT /axapi/v3/import-periodic/auth-portal/a Payload: { "auth-portal": { "remote-file": "scp://user:single@10.64.21.234:/home/automation/TESTSUITES/Sdk_Test/sample-auth-portal.zip", "auth-portal": "a", "period": 60, "use-mgmt-port": 1 } }
Replace List	PUT	/axapi/v3/import-periodic/auth-portal	auth-portal-list
Delete Object	DELETE	/axapi/v3/import-periodic/auth-portal/{auth-portal}	auth-portal attributes	example close
DELETE /axapi/v3/import-periodic/auth-portal/a Reponse: { "response": { "status": "OK" } }

auth-portal-list

auth-portal-list is JSON List of auth-portal attributes

auth-portal-list : [

{ auth-portal attributes },

{ auth-portal attributes },

…

]

auth-portal attributes

auth-portal

Description Portal file for http authentication

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

period

Description Specify the period in second

Type: number

Range: 60-31536000

remote-file

Description profile name for remote url

Type: string

Format: url

use-mgmt-port

Description Use management port as source port

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