1. References
  2. Management API
  3. AuthorizedIPs
Rate this page:

AuthorizedIPs

Methods

AddAuthorizedAccountIP

Copy URL

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

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
AddAuthorizedAccountIP example
Copy

AddAuthorizedAccountIP example

Add the 92.255.220.0/24 network to the white list.

Parameters

  • allowed:

    boolean

    Optional
    Defaults on:  true

    Whether to remove the IP from the blacklist

  • authorized_ip:

    string

    The authorized IP4 or network

  • description:

    string

    Optional

    The IP address description

Returns

  • result:

    number

    1

CheckAuthorizedAccountIP

Copy URL

Tests whether the IP4 is banned or allowed.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
CheckAuthorizedAccountIP example
Copy

CheckAuthorizedAccountIP example

Parameters

  • authorized_ip:

    string

    The IP4 to test

Returns

  • authorized_ip:

    string

    Optional

    The matched authorized IP or network (if found)

  • result:

    boolean

    Whether the IP is allowed

DelAuthorizedAccountIP

Copy URL

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

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
DelAuthorizedAccountIP example
Copy

DelAuthorizedAccountIP example

Delete the 92.255.220.0/24 network from all the lists.

Parameters

  • allowed:

    boolean

    Optional

    Whether 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

  • authorized_ip:

    string

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

  • contains_ip:

    string

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

Returns

  • result:

    number

    The removed network count

GetAuthorizedAccountIPs

Copy URL

Gets the authorized IP4 or network.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
GetAuthorizedAccountIPs example
Copy

GetAuthorizedAccountIPs example

Show the all items.

Parameters

  • allowed:

    boolean

    Optional

    Whether the IP is allowed

  • authorized_ip:

    string

    Optional

    The authorized IP4 or network 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

  • description:

    string

    Optional

    The IP address description

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records are skipped in the output

Returns