SIGN UP

Managing Authorized IPs

Methods

AddAuthorizedAccountIP

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

Parameters

  • Follow link for authentication parameter names and details.

  • authorized_ip:

    string

    The authorized IP4 or network.

  • allowed:

    boolean
    Optional
    Defaults to true

    Set false to add the IP to the blacklist.

Returns

  • result:

    number

    1

Examples

request:

Add the 92.255.220.0/24 network to the white list.

https://api.voximplant.com/platform_api/AddAuthorizedAccountIP/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&authorized_ip=92.255.220.0%2F24

response:

Success.

{
    "result": 1
}

CheckAuthorizedAccountIP

Tests whether the IP4 is banned or allowed.

Parameters

  • Follow link for authentication parameter names and details.

  • authorized_ip:

    string

    The IP4 to test.

Returns

  • result:

    boolean

    True if IP is allowed.

  • authorized_ip:

    string

    The matched authorized IP or network (if found).

Examples

request:

https://api.voximplant.com/platform_api/CheckAuthorizedAccountIP/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&authorized_ip=92.255.220.0%2F24

response:

The IP is allowed.

{
    "result": true,
    "authorized_ip": "92.255.0.0\/16"
}

The IP is forbidden.

{
    "result": false,
    "authorized_ip": "92.255.0.0\/16"
}

The IP isn't allowed.

{
    "result": false
}

DelAuthorizedAccountIP

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

Parameters

  • Follow link for authentication parameter names and details.

  • authorized_ip:

    string

    The authorized IP4 or network to remove. Set the 'all' value to remove the 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 the all lists.

Returns

  • result:

    number

    The removed network count.

Examples

request:

Delete the 92.255.220.0/24 network from the all lists.

https://api.voximplant.com/platform_api/DelAuthorizedAccountIP/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&authorized_ip=92.255.220.0%2F24

response:

The network was removed.

{
    "result": 1
}

GetAuthorizedAccountIPs

Gets the authorized IP4 or network.

Parameters

  • Follow link for authentication parameter names and details.

  • authorized_ip:

    string
    Optional

    The authorized IP4 or network to filter.

  • allowed:

    boolean
    Optional

    The allowed flag to filter.

  • contains_ip:

    string

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

  • count:

    number
    Optional
    Defaults to 50

    The max returning record count.

  • offset:

    number
    Optional
    Defaults to 0

    The first N records will be skipped in the output.

Returns

  • total_count:

    number

    The total found network count.

  • count:

    number

    The returned network count.

Examples

request:

Show the all items.

https://api.voximplant.com/platform_api/GetAuthorizedAccountIPs/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac

response:

{
    "count": 2,
    "result": [
        {
            "allowed": "true",
            "created": "2015-02-01 20:10:15",
            "authorized_ip": "92.255.220.0\/24"
        },
        {
            "allowed": "false",
            "created": "2015-02-01 20:10:17",
            "authorized_ip": "92.255.220.10"
        }
    ],
    "total_count": 2
}