IP Whitelist Management
Hosts
Environment | Host |
---|---|
Test | https://test-my.tokenex.com |
Production (US) | https://my.tokenex.com |
Production (EU) | https://eu-my.tokenex.com |
Routes
HTTP Verb | Route | Description |
---|---|---|
GET | /api/api/ip/{TokenEx ID} | Retrieve a list of IP Whitelists and their Descriptions for the given TokenEx ID. |
POST | /api/api/ip/{TokenEx ID} | Add a new IP Whitelist (CIDR) entry to the given TokenEx ID. |
PUT | /api/api/ip/{TokenEx ID}/{CIDR} | Update the Description for the given IP Whitelist (CIDR). Note: the CIDR must include the IP and the Range, in XXX.XXX.XXX.XXX/XX format. |
DELETE | /api/api/ip/{TokenEx ID}/{CIDR} | Delete the given IP Whitelist (CIDR) entry. Note: the CIDR must include the IP and the Range, in XXX.XXX.XXX.XXX/XX format. |
Examples
GET Request
GET /api/api/ip/12345 HTTP/1.1
Host: test-my.tokenex.com
Content-Type: application/json
Authorization: {Your Authorization Value}
GET Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 85
[{"ip":"0.0.0.0/0","description":""},{"ip":"1.2.3.4/32","description":"Testing IP"}]
POST Request
POST /api/api/ip/12345 HTTP/1.1
Host: test-my.tokenex.com
Content-Type: application/json
Authorization: {Your Authorization Value}
{"ip":"0.0.0.0/32","description":"New entry"}
POST Response
HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
PUT Request
PUT /api/api/ip/12345/0.0.0.0/32 HTTP/1.1
Host: test-my.tokenex.com
Content-Type: application/json
Authorization: {Your Authorization Value}
{"description":"Updated Description"}
PUT Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
DELETE Request
DELETE /api/api/ip/12345/0.0.0.0/32 HTTP/1.1
Host: test-my.tokenex.com
Content-Type: application/json
Authorization: {Your Authorization Value}
DELETE Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Updated over 1 year ago