Skip to content

IG supports IEC.API Documentation V1.0

User Management

get user expiration information

GET /v1/admind/userinfo?username={username}

response:

1
2
3
4
5
6
7
8
9
{
  "results": {
    "username":"adm",
    "privilege":15,
    "sys_time":1720432453,
    "last_change":1720432453,
    "expires_days":30 //"0 means permanent"
  }
}

add User

POST /v1/admind/user

parameters:

1
2
3
4
5
6
{
  "privilege":1,
  "password":"Aaa.1234",
  "username":"u2",
  "expires_days":30,
}

modify User

PUT /v1/admind/user

parameters:

1
2
3
4
5
6
{
  "privilege":2,
  "password":"Aaa.1234",
  "username":"u1",
  "expires_days":30
}

user List

GET /v1/admind/user

return:

{
  "results": [
    {
      "administrator": 1,
      "username": "adm",
      "password": "$1$3h1ZJB06$QuJ.JRF5uATkL3b3LpAN4/",
      "privilege": 15,
      "expires_days":30
    },
  ]
}

get Password Strength

GET /v1/admind/pwquality

return:

{
  "result": {
    "enable":1,
    "minlen":8,
    "dcredit":1,
    "ucredit":1,
    "lcredit":1,
    "ocredit":1
  }
}

set password strength

POST /v1/admind/pwquality

parameters:

1
2
3
4
5
6
7
8
{
    "enable":1,
    "minlen":8,
    "dcredit":1,
    "ucredit":1,
    "lcredit":1,
    "ocredit":1
}

user Lock Configuration

PUT /v1/lockconfuser/lockconf?autosave=1

parameters:

1
2
3
4
5
6
{
    "enable" : 0/1,  //Switch, Default Off
    "locktime": 1,  //Time, 1-3600S
    "errornum": 5   //Error number 1-10
    "trytime": 6     //Try time window 10-60 min
}

return Value Return by Get User Lock Configuration

get User Lockout Configuration

GET /v1/lockconfuser/lockconf
1
2
3
4
5
6
7
8
{
    "results": {
        "enable" : 0/1,  //Switch, Default Off
        "locktime": 1,  //Time, 1-3600S
        "errornum": 5   //Error number 1-10
        "trytime": 6     //Try time window 10-60 min
    }
}

get user lock state

GET /v1/user/userlockstatus

return:

1
2
3
{
  "results" : ["user1","user2"]    //This endpoint will only return locked users. No information will be returned for unlocked users.
}

unlock User

PUT /v1/user/unlockuser

parameters:

1
2
3
{
      "username":"user1",      //This interface can only be called one at a time.
}

return value: Return to obtain the user lock status

antivirus protection

scan

GET /v1/tools/virus/scan

return:

1
2
3
{
  "results":"/bin;/bin/ash;/bin/base64"
}

validation

POST /v1/tools/virus/check

parameters:

1
2
3
{
  "file":"/bin/base64"
}

return:

1
2
3
{
  "results":"ok"
}

system Management

get system usage notifications

GET /v1/admind/notice

return:

1
2
3
4
5
{
  "results":{
    "notice":"XXXXXXXXXXXX"
  }
}

setup system Usage Notification

POST /v1/admind/notice

parameters:

1
2
3
{
  "notice":"XXXXXXXXXXXX"
}

System Backup

GET /v1/system/backup.bin

return:

Backing up files

system Restore

POST /v1/system/restore

parameters:

Backing up files

return:

1
2
3
{
  "results":"ok"
}