Subscriber Services API

Services

Reference material for usage on Subscriber Management > Service Profiles.

GET

/v1/services

(subscriber)

List Services.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
id	query	string	Filter by id. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
name	query	string	Filter by name. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (id, name)
sd	query	string	Sort direction. asc for Ascending or desc for Descending

Response Status Codes

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

Response Properties

Name	In	Type	Description
id	body	string	Unique Entity ID.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
name	body	string	Name of Entity.

Response Example

{
    "payload": [
        {
            "id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
            "name": "BROADBAND PPPOE"
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v1/service/{service_id}

(subscriber)

Show Service.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
service_id	url	string	Service Id.	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
authentication	body	string	Authentication.
creation_time	body	string	Creation Time.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
pool_id	body	string	Pool Id.
pool_id_deactivate	body	string	Pool Id Deactivate.

Response Example

{
    "id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
    "domain": "interstellio.io",
    "name": "BROADBAND PPPOE",
    "pool_id": null,
    "pool_id_deactivate": null,
    "authentication": "username+password",
    "creation_time": "2021-04-14T12:03:15.000Z"
}

POST

/v1/service

(subscriber)

Create Service.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
authentication	body	string	Authentication.	X
name	body	string	Name of Entity.
pool_id	body	string	Pool Id.
pool_id_deactivate	body	string	Pool Id Deactivate.

Request Example

{
    "name": "BROADBAND PPPOE",
    "authentication": "username+password"
}

Response Status Codes

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

Response Properties

Name	In	Type	Description
authentication	body	string	Authentication.
creation_time	body	string	Creation Time.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
pool_id	body	string	Pool Id.
pool_id_deactivate	body	string	Pool Id Deactivate.

Response Example

{
    "id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
    "domain": "interstellio.io",
    "name": "BROADBAND PPPOE",
    "pool_id": null,
    "pool_id_deactivate": null,
    "authentication": "username+password",
    "creation_time": "2021-04-14T12:03:15.000Z"
}

PATCH

/v1/service/{service_id}

(subscriber)

Update Service.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
service_id	url	string	Service Id.	X
authentication	body	string	Authentication.
name	body	string	Name of Entity.
pool_id	body	string	Pool Id.
pool_id_deactivate	body	string	Pool Id Deactivate.

Request Example

{
    "name": "BROADBAND PPPOE",
    "authentication": "username+password"
}

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
authentication	body	string	Authentication.
creation_time	body	string	Creation Time.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
pool_id	body	string	Pool Id.
pool_id_deactivate	body	string	Pool Id Deactivate.

Response Example

{
    "id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
    "domain": "interstellio.io",
    "name": "BROADBAND PPPOE",
    "pool_id": null,
    "pool_id_deactivate": null,
    "authentication": "username+password",
    "creation_time": "2021-04-14T12:03:15.000Z"
}

DELETE

/v1/service/{service_id}

(subscriber)

Delete Service.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
service_id	url	string	Service Id.	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

Attributes

For adding context attributes and other attributes we will need a list of of supported attributes.

GET

/v1/radius/attributes

(subscriber)

List Radius Atrributes.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
id	query	string	Filter by id. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50)
name	query	string	Filter by name. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (id, name)
sd	query	string	Sort direction. asc for Ascending or desc for Descending

Response Status Codes

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

Response Properties

Name	In	Type	Description
id	body	string	Unique Entity ID.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
name	body	string	Name of Entity.

Response Example

{
    "payload": [
        {
            "id": "3com-connect_id",
            "name": "3com-connect_id"
        },
        {
            "id": "3com-encryption-type",
            "name": "3com-encryption-type"
        },
        {
            "id": "3com-end-date",
            "name": "3com-end-date"
        },
        {
            "id": "3com-ip-host-addr",
            "name": "3com-ip-host-addr"
        },
        {
            "id": "3com-mobility-profile",
            "name": "3com-mobility-profile"
        },
        {
            "id": "3com-nas-startup-timestamp",
            "name": "3com-nas-startup-timestamp"
        },
        {
            "id": "3com-product-id",
            "name": "3com-product-id"
        },
        {
            "id": "3com-ssid",
            "name": "3com-ssid"
        },
        {
            "id": "3com-time-of-day",
            "name": "3com-time-of-day"
        },
        {
            "id": "3com-url",
            "name": "3com-url"
        }
    ],
    "metadata": {
        "records": 250,
        "page": 1,
        "pages": 25,
        "per_page": 10
    }
}

Context Attributes

Reference material for usage on Subscriber Management > Service Profiles -> Service Profile Radius Attributes.

GET

/v1/service/context_attributes/{service_id}

(subscriber)

List Service Context Attributes.

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)
service_id	url	string	Service Id.	X
attribute	query	string	Filter by attribute. (can suffix with wildcard )*
client_profile	query	string	Filter by client_profile. (can suffix with wildcard )*
ctx	query	string	Filter by ctx. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (attribute, ctx, client_profile)
sd	query	string	Sort direction. asc for Ascending or desc for Descending

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
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
creation_time	body	string	Creation Time.
ctx	body	string	activate-login, deactivate-login, activate-coa, deactivate-coa, deactivate-pod
id	body	string	Unique Entity ID.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
tag	body	string	Tag.
value	body	string	Value.

Response Example

{
    "payload": [
        {
            "id": "b0e42c98-5f82-11ef-a350-aff022b163c4",
            "service_id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
            "attribute": "mikrotik-rate-limit",
            "tag": null,
            "value": "{{upload}}M/{{download}}M",
            "ctx": "activate-login",
            "client_profile": "MIKROTIK",
            "creation_time": "2024-08-21T06:00:38.000Z"
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v1/service/context_attribute/{attribute_id}

(subscriber)

Show Service Context Attribute.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
attribute_id	url	string	Attribute Id.	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
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
creation_time	body	string	Creation Time.
ctx	body	string	activate-login, deactivate-login, activate-coa, deactivate-coa, deactivate-pod
id	body	string	Unique Entity ID.
tag	body	string	Tag.
value	body	string	Value.

Response Example

{
    "id": "b0e42c98-5f82-11ef-a350-aff022b163c4",
    "service_id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
    "attribute": "mikrotik-rate-limit",
    "tag": null,
    "value": "{{upload}}M/{{download}}M",
    "ctx": "activate-login",
    "client_profile": "MIKROTIK",
    "creation_time": "2024-08-21T06:00:38.000Z"
}

POST

/v1/service/context_attributes/{service_id}

(subscriber)

Add Context Attribute to Service.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
service_id	url	string	Service Id.	X
attribute	body	string	Attribute.	X
client_profile	body	string	Client Profile.	X
ctx	body	string	activate-login, deactivate-login, activate-coa, deactivate-coa, deactivate-pod	X
tag	body	string	Tag.
value	body	string	Value.	X

Request Example

{
    "attribute": "mikrotik-rate-limit",
    "value": "{{upload}}M/{{download}}M",
    "ctx": "activate-login",
    "client_profile": "MIKROTIK"
}

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
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
creation_time	body	string	Creation Time.
ctx	body	string	activate-login, deactivate-login, activate-coa, deactivate-coa, deactivate-pod
id	body	string	Unique Entity ID.
tag	body	string	Tag.
value	body	string	Value.

Response Example

{
    "id": "b0e42c98-5f82-11ef-a350-aff022b163c4",
    "service_id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
    "attribute": "mikrotik-rate-limit",
    "tag": null,
    "value": "{{upload}}M/{{download}}M",
    "ctx": "activate-login",
    "client_profile": "MIKROTIK",
    "creation_time": "2024-08-21T06:00:38.000Z"
}

PATCH

/v1/service/context_attribute/{attribute_id}

(subscriber)

Update Context Attribute.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
attribute_id	url	string	Attribute Id.	X
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
ctx	body	string	activate-login, deactivate-login, activate-coa, deactivate-coa, deactivate-pod
tag	body	string	Tag.
value	body	string	Value.

Request Example

{
    "attribute": "mikrotik-rate-limit",
    "value": "{{upload}}M/{{download}}M",
    "ctx": "activate-login",
    "client_profile": "MIKROTIK"
}

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
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
creation_time	body	string	Creation Time.
ctx	body	string	activate-login, deactivate-login, activate-coa, deactivate-coa, deactivate-pod
id	body	string	Unique Entity ID.
tag	body	string	Tag.
value	body	string	Value.

Response Example

{
    "id": "b0e42c98-5f82-11ef-a350-aff022b163c4",
    "service_id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
    "attribute": "mikrotik-rate-limit",
    "tag": null,
    "value": "{{upload}}M/{{download}}M",
    "ctx": "activate-login",
    "client_profile": "MIKROTIK",
    "creation_time": "2024-08-21T06:00:38.000Z"
}

DELETE

/v1/service/context_attribute/{attribute_id}

(subscriber)

Delete Context Attribute of Service.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
attribute_id	url	string	Attribute Id.	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

Other Attributes

Reference material for usage on Subscriber Management > Service Profiles -> Service Profile Radius Attributes.

GET

/v1/service/other_attributes/{service_id}

(subscriber)

List Service Other Attributes.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
service_id	url	string	Service Id.	X
attribute	query	string	Filter by attribute. (can suffix with wildcard )*
client_profile	query	string	Filter by client_profile. (can suffix with wildcard )*
ctx	query	string	Filter by ctx. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (attribute, ctx, client_profile)
sd	query	string	Sort direction. asc for Ascending or desc for Descending

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
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
creation_time	body	string	Creation Time.
ctx	body	string	ipv4-address, ipv6-address, ipv4-route, ipv6-route
id	body	string	Unique Entity ID.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
tag	body	string	Tag.
value	body	string	Value.

Response Example

{
    "payload": [
        {
            "id": "7fde9bf0-65c3-11ef-8c16-cfca366fc35d",
            "service_id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
            "attribute": "framed-ip-address",
            "tag": null,
            "value": "{{ ip_address }}",
            "ctx": "ipv4-address",
            "client_profile": "MIKROTIK",
            "creation_time": "2024-08-29T04:59:41.000Z"
        },
        {
            "id": "639bcf8a-65c3-11ef-8c0d-cfca366fc35d",
            "service_id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
            "attribute": "framed-route",
            "tag": null,
            "value": "{{ ip_prefix }}",
            "ctx": "ipv4-route",
            "client_profile": "MIKROTIK",
            "creation_time": "2024-08-29T04:58:53.000Z"
        }
    ],
    "metadata": {
        "records": 2,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v1/service/other_attribute/{attribute_id}

(subscriber)

Show Service Other Attribute.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
attribute_id	url	string	Attribute Id.	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
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
creation_time	body	string	Creation Time.
ctx	body	string	ipv4-address, ipv6-address, ipv4-route, ipv6-route
id	body	string	Unique Entity ID.
tag	body	string	Tag.
value	body	string	Value.

Response Example

{
    "id": "639bcf8a-65c3-11ef-8c0d-cfca366fc35d",
    "service_id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
    "attribute": "framed-route",
    "tag": null,
    "value": "{{ ip_prefix }}",
    "ctx": "ipv4-route",
    "client_profile": "MIKROTIK",
    "creation_time": "2024-08-29T04:58:53.000Z"
}

POST

/v1/service/other_attributes/{service_id}

(subscriber)

Add Other Attribute to Service.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
service_id	url	string	Service Id.	X

Request Example

{
    "attribute": "framed-route",
    "tag": null,
    "value": "{{ ip_prefix }}",
    "ctx": "ipv4-route",
    "client_profile": "MIKROTIK",
}

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
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
creation_time	body	string	Creation Time.
ctx	body	string	ipv4-address, ipv6-address, ipv4-route, ipv6-route
id	body	string	Unique Entity ID.
tag	body	string	Tag.
value	body	string	Value.

Response Example

{
    "id": "639bcf8a-65c3-11ef-8c0d-cfca366fc35d",
    "service_id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
    "attribute": "framed-route",
    "tag": null,
    "value": "{{ ip_prefix }}",
    "ctx": "ipv4-route",
    "client_profile": "MIKROTIK",
    "creation_time": "2024-08-29T04:58:53.000Z"
}

PATCH

/v1/service/other_attribute/{attribute_id}

(subscriber)

Update Other Attribute.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

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)
attribute_id	url	string	Attribute Id.	X
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
ctx	body	string	ipv4-address, ipv6-address, ipv4-route, ipv6-route
tag	body	string	Tag.
value	body	string	Value.

Request Example

{
    "attribute": "framed-route",
    "value": "{{ ip_prefix }}",
    "ctx": "ipv4-route",
    "client_profile": "MIKROTIK"
}

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
attribute	body	string	Attribute.
client_profile	body	string	Client Profile.
creation_time	body	string	Creation Time.
ctx	body	string	ipv4-address, ipv6-address, ipv4-route, ipv6-route
id	body	string	Unique Entity ID.
tag	body	string	Tag.
value	body	string	Value.

Response Example

{
    "id": "639bcf8a-65c3-11ef-8c0d-cfca366fc35d",
    "service_id": "a13610c7-6ea3-4f3e-afb9-e422d530473a",
    "attribute": "framed-route",
    "tag": null,
    "value": "{{ ip_prefix }}",
    "ctx": "ipv4-route",
    "client_profile": "MIKROTIK",
    "creation_time": "2024-08-29T04:58:53.000Z"
}

DELETE

/v1/service/other_attribute/{attribute_id}

(subscriber)

Delete Other Attribute of Service.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
attribute_id	url	string	Attribute Id.	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

Navigation

Subscriber Services API

Services

Attributes

Context Attributes

Other Attributes