PassBridge NorthBound API Help Page

Returns a resourceID and Time to Live for a given CAN and Client IP combo. Time to live is 2 days converted to seconds. i.e : 172800

returns a List of NasClusters with a given CanId

Return Nasclusters with a given ClusterId

For a given {accId}, get the details of OTIZone with the id {otiZoneID}

create a new otizone for the given {accid}

Patches the otizones for this account with the specified {accId} with the data provided.

Deletes the otizone for the specified {accId}

Returns a list of Nasclusters for a given otiZoneID

Add a Nascluster to an OtiZone

Deletes a Nascluster for an OTIZone

Returns a list of NASClusterCountries for the current OTIZone

Adds a list of NASClusterCountries to the OTIZone. Replaces any existing NASClusterCountries for the OTIZone

Deletes a NASClusterCountries for the given OTIZone

Deletes all NASClusterCountries linked to a zone

returns a list of OTIZone policies for a given accId/accgrpId If a zoneName is given, returns OTIZone policies for that zone.

Returns the policy for a given zonePolicyId

Creates a new OTIZone policy for a given accId/accgrpId

updates the policy of an OTIZone with a given zonePolicyId

Deletes the OTIZone policy of a given zonePolicyId

returns the domain filtering for a give zonePolicyId

Creates a new dnf policy for a given zonePolicyId

deletes the dnf policy of the given zonePolicyId

Gets the whiteList Policy for a given zonePolicyId

creates a new whitelist policy for a give zonePolicyId

Gets blacklist policy for a given zonePolicyId

creates a new blacklist policy for a given zonePolicyId

returns the default action for the domain filtering of a given zonePolicyId

createes a new dnf default action for a give zonePolicyId

creates a new dnf rule for a given zonePolicyId

returns dnf rules for a given zonePolicyId

for a give zonePlolicyId, delete dnf rules matching the given ruleId

Returns the policyTestresult of a domainname for a zonePolicyId

Returns a List of OTIZoneQuotas for an AccessGroup, if a zoneName is provided filters for only that Zone

creates a new OTIZone quota for a given accId/accgrpId

Updates the OTIZone quota of a given otiZoneId

Delete OTIZone quota for a given otiZoneId

Delete OTIZoneQuota for a given zoneName

returns a list of zone restrictions for a given accgrpId/accId

returns otiZoneRestriction for a given accId, accgrpId with a {otiZoneRestrictionID}

creates a new otizoneRestriction for a given accId, accgrpId.

Updates the otiZoneRestriction of a given otizoneRestrictionId

Delete otizoneRestriction of a given {otiZoneRestrictionId}

Delete otiZoneRestriction of a given ZoneName

Get domain Filtering OTIZoneRestrictionPolicy for a gice {otiZoneRestrictionId}

create a new domain filtering OTIZone restriction for a given {otiZoneRestrictionId}

Deletes domainFiltering OTIZoneRestriction for a given {otiRestrictionId}

Gets the domainfiltering whiteList for a given {otiZoneRestrictionId}

Sets a domainFiltering OTIZOne restriction WhiteList for a given {otiZoneRestrictionId}

Returns domainFiltering BlackList for a given {otiZoneRestrictionId}

sets domain Filtering OTIZoneRestriction BlackList for a given {otiZoneRestricitonId}

Returns the domainFiltering DefaultAction for a given {otiZoneRestrictionId}

creates the domainFiltering DefaultAction for a given {otiZoneRestrictionId}

Returns a list of DomainFiltering rules for a given {otiZoneRestrictionId}

Adds a DomainFiltering rules for a given {otiZoneRestrictionId}

Delets DomainFiltering rules matching {ruleId} for a given {otiZoneRestrictionId}

Tests domainFiltering policy against a Domain for a given {otiZoneRestictionId} and {domainName}

returns resources available for this account

returns detail for a specific account

Update details for a specific account

returns detail for a specific account

Set the defaults for any new users created under this account

returns the default quota settings specific account

creates network quotas default for the account

updates network quotas default for the account

returns the default alerts message for quota limits

create the default message templates for quotsa limits

update the default message templates for quotsa limits

returns the current capabilities for the account

Enable AccessBrokerUserAllowed for the network

Set the current capabilities for the account

returns the current network capabilities for the account

Get the current dns server for the account

Set the current dns server for the account

Get the current timezone for the account // European Zones GMT Greenwich Mean Time CET Central European Time EET Eastern European Time // North American Zones AST Atlantic Standard Time EST Eastern Standard Time CST Central Standard Time MST Mountain Standard Time PST Pacific Standard Time AKST Alaska Standard Time HAST Hawaii-Aleutian Standard Time // Russian Zones MSK Moscow (Moskva) time RZ3 Russia Zone 3 RZ4 Russia Zone 4 RZ5 Russia Zone 5 RZ1 Russia Zone 1 RZ6 Russia Zone 6 RZ7 Russia Zone 7 RZ8 Russia Zone 8 RZ9 Russia Zone 9 RZ10 Russia Zone 10 RZ11 Russia Zone 11 // Assorted other zones MSST Malaysia/Singapore DST Dateline Standard Time MIS Midway Island/Samoa MXP Mexico Pacific Time MXM Mexico Mountain Time MXC Mexico Central Time BLT Bogota/Lima time VST Venezuela BVT Bolivia Standard Time CHT Chilean Standard Time NST Newfoundland Standard Time BZT Brazilian Standard Time AGT Argentina Standard Time GST Greenland Standard Time UST Uruguay Standard Time JST Jordan Standard Time EGT Egypt Standard Time SAT South-African Time IST Iraq Standard Time SST Saudi Arabia Standard Time KST Kenya Standard Time INT Iran Standard Time WAT Western Australian Time NAT North Australian Time AUT South Australian Time QST Queensland Standard Time NWT New South Wales Australian Time

Set the current timezone for the account

Get the current mode of the network for the account This can be P2P or Packet

Set the current mode of the network for the account This can be P2P or Packet

Get the resources defined under this node

Get all routes on the network

List the blackhole routes for this account / network.

Delete blackhole route

Create a new blackhole route

Get all the defined static routes

Set a static route

Delete Static Routes - identified by NetworkRoute params Destination, Mask and NextHop. Destination=90.90.0.0 Mask=255.255.0.0 NextHop=172.10.10.10

List the PassThru routes for this account / network.

Create a new PassThru route

Returns the value of the DNS Forwarding address for the specified account.

Adds a DNS Forwarding address to the specified account so long as there is none set already.

Updates the DNS Forwarding address for the specified account using a JSON Patch Document.

Deletes the DNS Forwarding address for the specified Account

No documentation available.

No documentation available.

No documentation available.

Adds a DNS Forwarding Policy with respect to account.

No documentation available.

Deletes the DFP for the specified Account

Retrieve DNS Forwarding Policy for the Account

Retrieve Network DE Profile for the Account

creates network quotas default for the account

updates Network DE Profile for the account

Deletes Network DE Profile for the account

Get URI's that lie beneath this node.

GET upstream ACLs for network

GET downstream ACLs for network

Update upstream ACLs for network

Update downstream ACLs for network

Return the list of agents for this account

Return a specific agent within this account

Delete the specified agent

Enable / Disable specified agent

Return a specific agent within this account

Create an agent in this account

Retrieve details about Agent installation type

Return the list of URI's supported under this path

Get Agent Tunnel from

Assign DHCP to Host Tunnel

Delete Agent Host tunnel

Create an Agent Host tunnel

Returns the account uris for a specific channel

Returns a list of available APNs for the given channel

Creates a new account in the specified channel

Deletes an account in the specified channel

Return events for this channel - by default only one is returned

Delete an Event for this channel

Creates a new auth token based on the appid supplied and validated with the account administrator username and password supplied

Creates a new auth token based on the appid supplied and validated with the delegated administrator username and password supplied - permissions are inherited directly from the delegated user N.b. the credentials MUST be of a user that is configured as a delegated admin on Passbridge

Returns an Admin Token for a given account.

Creates a new auth token based on the appid supplied and validated with the account administrator username and password supplied

Validate a user credentials are correct for a channel.

returns resources available for this account credits

returns all vouchers

returns detail for a specific voucher

returns detail for a specific voucher

Return an existing key value or creates a new one.

Retrieve the list of L3VPNBindings on a network.

Retrieve a specific L3VPNBinding object for a given network.

Retrieve all APN L3VPNBindings for a given user.

Retrieve all IOT L3VPNBindings for a given user.

Add L3VPN binding settings to a given network.

Delete specific L3VPNNetworkBinding for a given account.

Add a APN L3VPNUserBinding for a given user.

Add a IOT L3VPNUserBinding for a given user.

Delete specific L3VPNUserBinding for a given userId and userBindingId.

Updates a network binding with specified ID with the data from JSON Patch object.

List the available MDM URI's for this account

Returns the status of available MDMs for this account.

Request an Apple MDM Account CSR (signed by a vendor cert). The action of requesting this pulls the provisioned CSR for this account and returns the CSR encapsulated in a plist with the vendor signature.

Upload a signed Apple MDM Account certificate - this is provided by the Account customer.

Return the latest MDM Vendor certificate

Get details of Apple MDM enabled device.

Enrol APN device for Mobile Device Management

Update Apple MDM status for the device,

Verify the AppleMDM signature presented by the device, verifies the PKCS7 signature and verify the Certificate is valid for the specific device.

Request a device be woken up by APNS to check server for MDM commands

Get MobileConfig document for device.

Return the list of observations for this channel

Create a subscription to an observation topic

Return an observation

Return the list of observations for this channel

Delete the observation

Returns all the valid app names for this channel

Return all the keys currently available for this app

Return all the keys and values for the list of keys supplied Note: If a key doesn't exist then no entry will be present in the return value for that key. This endpoint will always return Http 200 unless an unforeseeable error occurs The maximum number of keys that can be supplied is 100

Bulk craetes/updates a list of keys and values. The maximum number of key/values that can be supplied is 100

Deletes all the keys and values for the list of keys supplied This endpoint will always return Http 200 unless an unforeseeable error occurs The maximum number of keys that can be supplied is 100

Return a specific key for a given app

Create a new key under the specified app

Update or create a new key

Delete the specified keyname

Gets the currenices available on this channel

Gets the pricing for a specific product in this channel

Get all the products in this channel

Get all the products in this channel

Get details on a specific product in this channel

top usage report

No documentation available.

No documentation available.

No documentation available.

No documentation available.

Interim report endpoint which uses a report query which selects only APN devices and uses a new Utils / DAL query. NOTE as this endpoint is specifically for MODA this is reflected in the URL path and operates with UTC times for both the data range and the datetime values returned in the report itself.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

Gets the username for direct dialup tunnels

Updates the username for direct dialup tunnels

Deletes the username for direct dialup tunnels

returns uris defined under this node

returns uris defined under this node

returns all breakout tunnels defined on the account

creates a breakout tunnels on the account

returns all apn tunnels defined on the account

creates an apn tunnels on the account

returns all iot tunnels defined on the account

Get the details for a specific tunnel

Get the details for a specific tunnel

Get the details for a specific tunnel

Get the details for a specific tunnel

creates an iot tunnel on the account

Selectively update IOT tunnel

returns all TUXs for the account's broker

Returns details of the account administrator

Send partial Admin documents to the API and update the admin with that

List all the users in this account

List all the users in this account using a paged result set

List all the delegated admin roles available in this account

List all the delegated admins available in this account

Retrieve a specific user from this account

Get the delgated admin role, if any for, this user Returns success:false and a 404 if no role assigned

Set the delegated admin role for this user This will overwrite any previously set role. The Role Id needs to be feeched first from the /users/roles endpoint

Remove the delegated admin role for this user

Create a new user in this account

Update the user. This will only update Username, PasswordInfo and AccessTypes.

Send partial User documents to the API and update the local User with that. This will only update Username, PasswordInfo and AccessTypes.

Delete a user within this account

Retrieve the quota for a specific user from this account

Set the quota for a specific user from this account

Update the quota for a specific user from this account

Update the access modes for this user This can be P2P or Packet

get the APN access modes for this user This can be P2P or Packet

gpdate the APN access modes for this user This can be P2P or Packet

get the IP over TLS access modes for this user This can be P2P or Packet

Update the the IP over TLS access modes for this user This can be P2P or Packet

get the IPSEC access modes for this user This can be P2P or Packet

Update the IPSEC access modes for this user This can be P2P or Packet

Returns a user from the Channel for the specified username

Assembly Version Number

Returns the documentation summary as a JSON Object.

Returns documentation for an API call for supplied API ID.

Get the DHCP setting for this network.

Create DHCP network config.

Delete a DHCP network config.

Returns all routes for an account.

Returns all tunnels for a DHCP Network config.

Returns all available uris at this point

Returns all available Domain Name filters for an account

Get the Default policy action at the Access Group level

Set the Default policy action at the Access Group level

Return details for the default domain filtering policy It will indicate if it is linedked to a named policy or if it a local policy

Get the Whitelist at the Access Group level

Set the Whitelist at the Access Group level

Get the Blacklist at the Access Group level

Set the Blacklist at the Access Group level

Create a new blank policy placeholder (if linked false) OR a linkage to a Named policy (if linked true)

Remove the default domain filtering policy for this AccessGroup

Get all the policy rules i.e. the set of matching filters and associated actions

Add a policy rule on a filter.

Delete a policy rule

Get the Default policy action at the Access Group Zone Restriction level

Set the Default policy action at the Access Group Zone Restriction level

Get the Whitelist at the Access Group Zone Restriction level

Set the Whitelist at the Access Group Zone Restriction level

Get the Blacklist at the Access Group Zone Restriction level

Set the Blacklist at the Access Group Zone Restriction level

Get all the zone restriction policy rules i.e. the set of matching filters and associated actions

Add a new rule to a policy at the Access Group Zone Restriction level

Remove a rule from a policy at the Access Group Zone Restriction level

Return a list of Named policies for this account

Return the blocked addresses for an account

Sets the blocked addresses for an account

Deletes the blocked addresses for an account

Create a named DNF policy.

Mark the named policy as deleted

Return the specified named policy

Update the named policy

Get the result of a testing a domain against the given named policypolicy

Get the blacklist URI for this policy

Get the whitelist URI for this policy

Get the default action for this policy

Get the Rules list for this policy

Delete the specified rule for the named policy

Add or update the Blacklist for the specified named policy.

Add or update the Whitelist for the specified named policy.

Update the default action for the named policy

Add a rule to the named policy.

List the available resources under Domain filtering for this zone restriction If a local policy is in force then the blacklist, whitelist and rule resources are shown. If a named policy is being used then just a link resource is shown

Remove DNF Policy for this AccessGroup and APN Zone restriction

Create a new blank policy placeholder (if linked false) OR a linkage to a Named policy (if linked true)

Test DNF policy

Creates a custom filter.

Returns a custom filter by ID.

Updates a custom filter with specified ID.

Deletes a custom filter with specified ID.

Returns the valid Uris

Returns a list of expanded Filters for the specified Channel

Returns filter and category info for the domain

Returns filter and category info for the domain

Returns a list of supported category maps for the channel.

Returns all iotdevices for user and CName. Can also return last device to connect.

Returns all IOT Devices for provided IDs for a max request of 50 IDs

List a paged set of IOT devices

List a paged set of expanded IOT devices

Get a particular IOT device for an account

Create a new IOT Device for a specified user

Patch a the specified IOT Device

Update a the specified IOT Device

Remove the specified APN device

Clears the pins for the certificate associated with the specified IOT Device.

Returns all APN Devices for provided IDs for a max request of 50 IDs

Get all the APNDevices for an account

Get a particular APN devices for an account

List a paged set of APN devices

List a paged set of expanded APN devices

Get a particular APN devices for an account

Create a new APN Device for a specified user

Patches an existing apn device with a list of supplied properties

Remove the specified APN device

No documentation available.

No documentation available.

No documentation available.

Update whitelist with new list

Remove an entry from the list of allowed networks

Return list of APN policies for Access Group if zonename parameter not supplied, if zonename is specified then return single policy if found.

Create a new APN zone policy

Delete the APN Zone policy

Update the Polocy for the Access Group Zone

Get the policy Access Group Zone policy

Get the DNF policy for Access Group Zone - returns the URLs and if the policy is linked or not

Delete the DNF policy for the specified Access Group Zone

Create a DNF policy for Access Group Zone

Set DNF whitelist for the specified Access Group Zone DNF policy

Set DNF blacklist for the specified Access Group Zone DNF policy

Set the default action for the Access Group Zone DNF policy

Add a Rule to the Access Group Zone rules

Returns a list of DNF rules for an Access Group APN Zone Policy.

Deletes a DNF rule for an Access Group APN Zone Policy.

Get DNF whitelist for the specified Access Group Zone DNF policy

Get DNF blacklist for the specified Access Group Zone DNF policy

Get the default action for the Access Group Zone DNF policy

Test the domain name against the policy

Return all blocked networks (MCC and MNC) for this access group

Return a blocked networks (MCC and MNC) for this access group

Update blacklist with new list

Remove an entry from the list of blocked networks

Return all the members in the group

Return a paged set of members in the group

Return a particular member in the group

Delete a particular member in the group by usrId

Add a new member to the group

Remove a member from the group

Gets a detail list of authtokens - for a given appId there will only be one authtoken available. This will inform the caller of the type of token they can expect when they make a request to create one

Creates a new auth token with the requested duration (max is 60 minutes) The auth token is then passed with all subsequent calls either on the query string or in the HTTP Auth header as a pbnb auth ticket

Returns the logs for this appId

No documentation available.

No documentation available.

Creates a token to allow a proxy login to the Asavie admin portal

Return all APN zone in the account

Returns the APN Zone with the given id

Returns the APN zone with particualr name within the account

Creates an new apn zone in the account

Remove the APN zone from the system

returns all the access groups in an account

returns an AccessGroup based on its Id

returns an access group with a member with the specified group name

returns an access group with a member with the specified username

returns an AccessGroup with a member with the specified id

Create a new access group with default policy

Update the access group with the new details

Delete the specified access group from the account

Returns all zone quota definitions for the group

Return the Quota for the supplied zone name

Add a new zone quota to the group

update a zone quota for the group based on the zone id specified in the supplied object

Remove a zone quota using the specified zonename

Remove a zone quota using the specified zone id

Return all the defined zone restriction for this Access Group

Return all the defined zone restriction for this Access Group

Return a particular zone restriction for this access group based on the zonename

Add a new zone restriction for this access group

Update a new zone restriction for this access group

Delete a zone restriction for this access group for a given zone

Delete a zone restriction for this access group

Get the default policy for this Access Group

Update the default policy for this Access Group

Return the time of day policy for the group Each day is represented by a boolean array with 24 entries, 1 for each hour True=allow, False=deny

set the time of day policy for the group

Get the default zones for this Access Group

Update the default zones for this Access Group

Create the default zones for this Access Group

Get all the quota alerts that have been setup for this access group

Update all the quota alerts that have been setup for this access group

Remove all the quota alerts that have been setup for this access group

The Devices resource return a list of uris to the different devices within this account