Rate this page:

AuthorizedIPs

Methods

AddAuthorizedAccountIP

Copy URL

Adds a new authorized IP4 or network to the white/black list.

AddAuthorizedAccountIP example

AddAuthorizedAccountIP example

Add the 92.255.220.0/24 network to the white list.

Parameters

  • authorized_ip:

    string

    Optional

    The authorized IP4 or network.

  • allowed:

    boolean

    Optional
    Defaults on:  true

    Set false to add the IP to the blacklist.

Returns

  • result:

    number

    1

DelAuthorizedAccountIP

Copy URL

Removes the authorized IP4 or network from the white/black list.

DelAuthorizedAccountIP example

DelAuthorizedAccountIP example

Delete the 92.255.220.0/24 network from all the lists.

Parameters

  • authorized_ip:

    string

    The authorized IP4 or network to remove. Set to 'all' to remove all items.

  • contains_ip:

    string

    Can be used instead of autharized_ip. Specify the parameter to remove the networks that contains the particular IP4.

  • allowed:

    boolean

    Optional

    Set true to remove the network from the white list. Set false to remove the network from the black list. Omit the parameter to remove the network from all lists.

Returns

  • result:

    number

    The removed network count.

GetAuthorizedAccountIPs

Copy URL

Gets the authorized IP4 or network.

GetAuthorizedAccountIPs example

GetAuthorizedAccountIPs example

Show the all items.

Parameters

  • authorized_ip:

    string

    Optional

    The authorized IP4 or network to filter.

  • allowed:

    boolean

    Optional

    The allowed flag to filter.

  • contains_ip:

    string

    Optional

    Specify the parameter to filter the networks that contains the particular IP4.

  • count:

    number

    Optional
    Defaults on:  50

    The max returning record count.

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records will be skipped in the output.

Returns

CheckAuthorizedAccountIP

Copy URL

Tests whether the IP4 is banned or allowed.

CheckAuthorizedAccountIP example

CheckAuthorizedAccountIP example

Parameters

  • authorized_ip:

    string

    Optional

    The IP4 to test.

Returns

  • result:

    boolean

    True if IP is allowed.

  • authorized_ip:

    string

    Optional

    The matched authorized IP or network (if found).