Subscriber Routes API

GET

/v1/routes/{subscriber_id}

(subscriber)

List Routes for a subscriber.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	ID of the subscriber from which the routes are to be fetched	X
page	query	integer	Page Number (default 1)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
id	body	string	Unique ID of Route
ip_prefix	body	string	IP Range
ipv	body	string	IP Version
metric1	body	integer	Metric
metric2	body	integer	Metric
metric3	body	integer	Metric
pref	body	integer	Prefix
subscriber_id	body	string	Unique ID of subscriber to which route belongs
tag	body	string	Tag

Response Example

{
    "payload": [
        {
            "id": "0140714c-cb31-11ee-9127-a5b2efd1bd16",
            "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
            "ip_prefix": "192.168.0.1/32",
            "ipv": "4",
            "metric1": 1,
            "metric2": 1,
            "metric3": 1,
            "pref": 1,
            "tag": "tag"
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 10,
        "per_page": 10
    }
}

POST

/v1/route/{subscriber_id}

(subscriber)

Add Route for a subscriber.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	ID of the subscriber the route will be created	X
ip_prefix	body	string	IP Range
ipv	body	string	IP Version
metric1	body	integer	Metric
metric2	body	integer	Metric
metric3	body	integer	Metric
pref	body	integer	Prefix
tag	body	string	Tag

Request Example

{
    "ip_prefix": "192.168.0.1/32",
    "ipv": "4",
    "metric1": 1,
    "metric2": 1,
    "metric3": 1,
    "pref": 1,
    "tag": "tag"
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
id	body	string	Unique ID of route
ip_prefix	body	string	IP Range
ipv	body	string	IP Version
metric1	body	integer	Metric
metric2	body	integer	Metric
metric3	body	integer	Metric
pref	body	integer	Prefix
subscriber_id	body	string	Unique ID of subscriber to which route belongs
tag	body	string	Tag

Response Example

{
    "id": "0140714c-cb31-11ee-9127-a5b2efd1bd16",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
    "ip_prefix": "192.168.0.1/32",
    "ipv": "4",
    "metric1": 1,
    "metric2": 1,
    "metric3": 1,
    "pref": 1,
    "tag": "tag"
}

GET

/v1/route/{route_id}

(subscriber)

Get Route by ID.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
route_id	url	string	ID of the route that will be retrieved	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
id	body	string	Unique ID of route
ip_prefix	body	string	IP Range
ipv	body	string	IP Version
metric1	body	integer	Metric
metric2	body	integer	Metric
metric3	body	integer	Metric
pref	body	integer	Prefix
subscriber_id	body	string	Unique ID of subscriber to which route belongs
tag	body	string	Tag

Response Example

{
    "id": "0140714c-cb31-11ee-9127-a5b2efd1bd16",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
    "ip_prefix": "192.168.0.1/32",
    "ipv": "4",
    "metric1": 1,
    "metric2": 1,
    "metric3": 1,
    "pref": 1,
    "tag": "tag"
}

DELETE

/v1/route/{route_id}

(subscriber)

Remove Route by ID.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
route_id	url	string	ID of the route that will be removed	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
id	body	string	Unique ID of route
subscriber_id	body	string	Unique ID of subscriber to which route belongs

PUT

/v1/route/{route_id}

(subscriber)

Edit Route by ID.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
route_id	url	string	ID of the route will be updated	X
ip_prefix	body	string	IP Range
ipv	body	string	IP Version
metric1	body	integer	Metric
metric2	body	integer	Metric
metric3	body	integer	Metric
pref	body	integer	Prefix
tag	body	string	Tag

Request Example

{
    "ip_prefix": "192.168.0.1/32",
    "ipv": "4",
    "metric1": 1,
    "metric2": 1,
    "metric3": 1,
    "pref": 1,
    "tag": "tag"
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
id	body	string	Unique ID of route
ip_prefix	body	string	IP Range
ipv	body	string	IP Version
metric1	body	integer	Metric
metric2	body	integer	Metric
metric3	body	integer	Metric
pref	body	integer	Prefix
subscriber_id	body	string	Unique ID of subscriber to which route belongs
tag	body	string	Tag

Response Example

{
    "id": "0140714c-cb31-11ee-9127-a5b2efd1bd16",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
    "ip_prefix": "192.168.0.1/32",
    "ipv": "4",
    "metric1": 1,
    "metric2": 1,
    "metric3": 1,
    "pref": 1,
    "tag": "tag"
}