Network Lists

Retrieve information about all Network Lists

get

Retrieves a list of all Network Lists connected to your organization.

The response includes Network List objects containing the name, associated Tags, and a list of network objects with mcc (Mobile Country Code) and mnc (Mobile Network Code) values.

Authorizations
Responses
200

OK

application/json
get
GET /network-whitelists HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "name": "Americas",
    "tags": [
      {
        "name": "Supplier",
        "id": "a5023f47-1db8-425e-b664-dc0b8921f644",
        "can_write": false,
        "color": "#5ba571"
      }
    ],
    "networks": [
      {
        "mcc": "310",
        "mnc": "010"
      },
      {
        "mcc": "310",
        "mnc": "012"
      },
      {
        "mcc": "302",
        "mnc": "720"
      }
    ]
  },
  {
    "name": "Sweden",
    "tags": [
      {
        "name": "Supplier",
        "id": "a5023f47-1db8-425e-b664-dc0b8921f644",
        "can_write": false,
        "color": "#5ba571"
      }
    ],
    "networks": [
      {
        "mcc": "240",
        "mnc": "01"
      },
      {
        "mcc": "240",
        "mnc": "02"
      },
      {
        "mcc": "240",
        "mnc": "03"
      }
    ]
  },
  {
    "name": "Nordics",
    "tags": [
      {
        "name": "Product A",
        "id": "ecc27df1-3f2e-40f0-a6bc-3a8a3f78b726",
        "can_write": false,
        "color": "#5b8fa5"
      }
    ],
    "networks": [
      {
        "mcc": "242",
        "mnc": "01"
      },
      {
        "mcc": "240",
        "mnc": null
      },
      {
        "mcc": "238",
        "mnc": "01"
      }
    ]
  }
]

Retrieve a specific Network List

get

Retrieves a specific Network List by named that is connected to the account.

Authorizations
Path parameters
network_whitelist_namestringRequired
Responses
200

OK

application/json
Responseobject
get
GET /network-whitelists/{network_whitelist_name} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "name": "Nordics",
  "tags": [
    {
      "name": "Product A",
      "id": "ecc27df1-3f2e-40f0-a6bc-3a8a3f78b726",
      "can_write": false,
      "color": "#5b8fa5"
    }
  ],
  "networks": [
    {
      "mcc": "242",
      "mnc": "01"
    },
    {
      "mcc": "242",
      "mnc": "08"
    },
    {
      "mcc": "240",
      "mnc": null
    },
    {
      "mcc": "238",
      "mnc": "01"
    },
    {
      "mcc": "238",
      "mnc": "02"
    },
    {
      "mcc": "238",
      "mnc": "10"
    },
    {
      "mcc": "238",
      "mnc": "20"
    },
    {
      "mcc": "238",
      "mnc": "77"
    },
    {
      "mcc": "238",
      "mnc": "66"
    }
  ]
}

Add Network List

post

Creates a new Network List connected to the account.

Once the Network List is created, you can map SIMs to it by updating the desired SIMs.

Authorizations
Body
namestringOptionalExample: foobar
tagsstring[]Optional

An array of Tag IDs to be associated with the Network List.

Example: ["tag-id-1"]
networksobject[]Optional

An array of networks to be associated with a SIM.

Example: [{"mcc":"242","mnc":"01"},{"mcc":"240","mnc":"02"}]
Responses
200

OK

application/json
Responseobject
post
POST /network-whitelists HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "name": "foobar",
  "tags": [
    "tag-id-1"
  ],
  "networks": [
    {
      "mcc": "242",
      "mnc": "01"
    },
    {
      "mcc": "240",
      "mnc": "02"
    }
  ]
}
200

OK

{
  "name": "test",
  "tags": [
    {
      "name": "Product A",
      "id": "ecc27df1-3f2e-40f0-a6bc-3a8a3f78b726",
      "can_write": false,
      "color": "#5b8fa5"
    }
  ],
  "networks": [
    {
      "mcc": "242",
      "mnc": "01"
    },
    {
      "mcc": "242",
      "mnc": "08"
    },
    {
      "mcc": "240",
      "mnc": null
    }
  ]
}

Update Network List

patch

Modify a specific Network List.

Authorizations
Path parameters
network_whitelist_namestringRequired
Body
tagsstring[]Optional

An array of Tag IDs to be associated with the Network List. Caution: Include all Tags you want to keep plus any new ones, as this replaces the entire list of Tags.

Example: ["tag-id-1","tag-id-2"]
networksobject[]Optional

An array of networks to be associated with a SIM. Caution: Include all networks you want to keep plus any new ones, as this replaces the entire list of networks.

Example: [{"mcc":"242","mnc":"01"},{"mcc":"240","mnc":"02"},{"mcc":"238","mnc":"20"}]
Responses
200

OK

application/json
Responseobject
patch
PATCH /network-whitelists/{network_whitelist_name} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "tags": [
    "tag-id-1",
    "tag-id-2"
  ],
  "networks": [
    {
      "mcc": "242",
      "mnc": "01"
    },
    {
      "mcc": "240",
      "mnc": "02"
    },
    {
      "mcc": "238",
      "mnc": "20"
    }
  ]
}
200

OK

{
  "name": "test",
  "tags": [],
  "networks": [
    {
      "mcc": "242",
      "mnc": null
    },
    {
      "mcc": "240",
      "mnc": null
    },
    {
      "mcc": "238",
      "mnc": null
    }
  ]
}

Delete Network List

delete

Removes a specific Network List.

Note that all mappings to said Network List will need to be removed prior to the removal of the Network List itself, otherwise a 403 status code will be encountered.

Authorizations
Path parameters
network_whitelist_namestringRequired
Responses
200

OK

application/json
Responseobject
delete
DELETE /network-whitelists/{network_whitelist_name} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "message": "ok"
}

Last updated