Jump to Content
Home
Guides
API
Portal Login
Support
Demos
API
Portal Login
Support
Demos
Home
Guides
API
Update or Set a custom value
All
Pages
Start typing to search…
JUMP TO
Stacuity API
API Tokens
List the API Tokens used to access this API
get
Create a Token
post
Get a specific token
get
Update a specific token
put
Delete a specific token
del
Test if a token is valid
get
Audit
Fetch the logged audit activities on the account
get
Authorization
/api/v1/authorizations/customerSystemFunctions
get
Get the role(s) of the current user
get
Customer Accounts
Get Customer
get
Get Customer address
get
Get active customer sponsors
get
Get details of account
get
List Account Transactions
get
Edge Services
Get a specific Edge Service
get
Update an Edge Service
put
Delete a specific Routing Target
del
/api/v1/edgeservices
get
Create an Edge Service
post
Endpoint Groups
List the Endpoint Groups
get
Create an Endpoint Group
post
Create a new Endpoint Group
get
Update an existing Endpoint Group
put
Delete an Endpoint Group
del
Add Endpoints to an Endpoint Group
post
Remove an Endpoint from an Endpoint Group
del
Endpoints
Get a list of Endpoints
get
Get a specific Endpoint
get
Update a specific Endpoint
put
List data transfer for an Endpoint
get
Activate an Endpoint
post
Allocate an IP address to an endpoint
post
List events for an Endpoint
get
Get the Carrier Network an Endpoint is attached to
get
Get the Radio Access Technology (2G/3G/4G/5G) an Endpoint is attached to
get
Get the IMEI of the device using an Endpoint
get
Get Country, Carrier Network and Cell ID that an Endpoint is located in
get
Get the time-stamp the Endpoint was last seen and the status of the Endpoint
get
Get the IP address of an Endpoint
get
List the Edge Key/Values for an Endpoint
get
Remove an Edge Key/Value for an Endpoint
del
Update an Edge Key/Value for an Endpoint
put
Send an SMS (Mobile Terminated) to the Endpoint
post
Suspend a specific Endpoint
post
Resume a specific Endpoint
post
Terminate a specific Endpoint
post
Reset a specific Endpoint
post
Event Endpoints
List the Event Endpoint(s)
get
Create a new Event Endpoint
post
Get an Event Endpoint
get
Update an existing Event Endpoint
put
Delete an Event Endpoint
del
Event Handlers
List the Event Handler(s)
get
Create a new Event Handler
post
Get an Event Handler
get
Update an existing Event Handler
put
Delete an Event Handler
del
Event Maps
List the Event Map(s)
get
Create a new Event Map
post
Get an Event Map
get
Update an existing Event Map
put
Delete an Event Map
del
List subscribed events for an Event Map
get
Subscribe to an event for an Event Map
post
Event Subscriptions
List Event Subscription(s)
get
Get details of an Event Subscription
get
Remove an Event Subscription
del
Events
List all events on the account
get
Lookups
List the DNS Modes
get
List the IP Allocation Types
get
List the IP Address Families
get
List the Event Endpoint Types
get
List the Event Types
get
List the Trace Session Statuses
get
List the Rate Limits
get
List the Routing Target Types
get
List the Routing Policy Status
get
List the Bundle Statuses
get
List the Bundle Scopes
get
List the Bundle Element Service Types
get
List the Date Durations Units
get
List the Event Scopes
get
List the Customer Roles
get
List the Countries
get
List the Charging Types
get
List the Network Operators
get
List the Routing Redundancy Zones
get
List the Transport Protocols
get
List the VPN IKE Options
get
List the VPN ESP Options
get
List the VPN Key Exchange Types
get
List the VPN Encryption Algorithm Types
get
List the VPN Authentication Algorithm Types
get
List the VPN Diffie Hellman Groups
get
List the VPN PRF Algorithms
get
List the Edge Service Types
get
List the Tariff Elements
get
List available currencies
get
List the Usage Export Types
get
List the Usage Reporting Types
get
List the Usage Reporting Statuses
get
List available Credential Types
get
List available ACL Modes
get
Metrics
List details of Data Transferred
get
Operator Policies
List Operator Policy(s)
get
Create a new Operator Policy
post
Get a specific Operator Policy
get
Update a specific Operator Policy
put
Delete a specific Operator Policy
del
List the entries of a specific Operator Policy
get
Add an item to a specific Operator Policy
post
Update the Radio Access Technology of a specific Operator Policy
post
Packet Traces
List Packet Capture(s)
get
Get packet(s) of a Packet Capture
get
Radius Server
List RADIUS Server(s)
get
Create a new RADIUS Server
post
Get a specific RADIUS Server
get
Update an existing RADIUS Server
put
Delete a RADIUS Server
del
Regional Gateways
/api/v1/regionalpolicies/gateways
get
/api/v1/regionalpolicies
get
/api/v1/regionalpolicies
post
/api/v1/regionalpolicies/{idOrMoniker}
get
/api/v1/regionalpolicies/{idOrMoniker}
put
/api/v1/regionalpolicies/{idOrMoniker}
del
/api/v1/regionalpolicies/{regionalGatewayPolicyIdOrMoniker}/entries
get
/api/v1/regionalpolicies/{regionalGatewayPolicyIdOrMoniker}/entries
post
/api/v1/regionalpolicies/{regionalGatewayPolicyIdOrMoniker}/entries
del
Routing Policies
List Routing Policies
get
Create a new Routing Policy
post
Get a specific Routing Policy
get
Update a specific Routing Policy
put
Delete a specific Routing Policy
del
Routing Targets
List Routing Targets
get
Create a Routing Target
post
Get a specific Routing Target
get
Update a specific Routing Target
put
Delete a specific Routing Target
del
Get a specific Routing Target Type Instance
get
Signalling Traces
Get an event's specific Signalling Trace PCAP
get
Get an event's specific Signalling Traces
get
Get packet(s) of a Signalling Trace for an endpoint
get
Get PCAP containing Signalling Tracing for an endpoint
get
Steering Profiles
List Steering Profile(s)
get
Create a new Steering Profile
post
Get a specific Steering Profile
get
Update a specific Steering Profile
put
Delete a specific Steering Profile
del
List the entries of a specific Steering Profile
get
Add an item to a specific Steering Profile
post
Update the Radio Access Technology of a specific Steering Profile
post
Tariffs
Get the Tariff Entries
get
Get the Tariff Zones Entries
get
Themes
Retrieve a list of themes
get
Gets a theme given its id
get
Updates a theme
put
Trace Sessions
List Trace Session(s)
get
Start a Trace Session for an Endpoint
post
Get a specific Trace Session
get
Update a Trace Session for an Endpoint
put
Delete Trace Session
del
UsersControllerV1
/api/v1/users
get
/api/v1/users/{userProfileId}
get
/api/v1/users/invites
post
/api/v1/users/invites
get
/api/v1/users/invites/{email}
del
/api/v1/users/customers
get
VSlices
List VSlice(s)
get
Create a new VSlice
post
Get a specific VSlice
get
Update a specific VSlice
put
Delete a VSlice
del
List the IP sub-network(s) of a VSlice
get
Add an IP sub-network to a VSlice
post
Modify an IP sub-network on a VSlice
put
Remove an IP sub-network from a VSlice
del
List the RADIUS Server(s) linked to a VSlice
get
Link a RADIUS Server(s) to a VSlice
post
Unlink a RADIUS Server(s) from a VSlice
del
Returns the vSlice APN Specification, which is inherited from the Tenant hierarchy.
get
Credentials
List the Credential(s)
get
Create a new Credential
post
Get an Credential
get
Update an existing Credential
put
Delete an Credential
del
/api/v1/credentials/{idOrMoniker}/regeneratecredential
post
Stacuity Edge API
Edge Endpoint
Get Endpoint ID
get
Get Endpoint MSISDN
get
Get Endpoint IMSI
get
Get Endpoint ICCID
get
Get Endpoint IP address
get
Get Current MCC/MNC
get
Get Country
get
Get Radio Access Type
get
Get Endpoint Reference
get
Get Endpoint Group
get
Get Current VSlice
get
Get Endpoint Name
get
Get Current Time
get
Get all Endpoint Values
get
Edge Endpoint Key Value
Get a custom key value
get
Create a new custom key value
post
Update or Set a custom value
put
Delete a custom key
del
Get all custom key values
get
Stacuity Tenant API
API Tokens
List the API Tokens used to access this API
get
Create a Token
post
Get a specific token
get
Update a specific token
put
Delete a specific token
del
Test if a token is valid
get
Authorization
/tenant/api/v1/authorizations/tenantSystemFunctions
get
Bundles
Check if you are allowed to administer bundles
get
Get a list of available bundle(s)
get
Add a bundle
post
Get a specific bundle
get
Update a bundle
put
Delete a bundle
del
Clone a bundle
post
Get a list of active bundle instance(s)
get
Delete bundle instance(s)
post
Suspend bundle instance(s)
post
Resume a bundle instance(s) which have been 'Suspended'
post
Get a list of pending bundle(s)
get
Get a list of pending bundle(s)
get
Cancel a pending bundle(s)
post
Get a list of inactive bundle instance(s)
get
Get a list of bundle element instance(s)
get
Get a list of bundle element(s)
get
Suspend a bundle
post
Resume a bundle
post
Add a bundle element
post
Get a specific bundle element
get
Update a bundle element
put
Delete a specific bundle element
del
Apply a bundle to a customer
post
Apply a bundle to an endpoint
post
Get a list of bundle reservations
get
Add a zone to a bundle element
post
Delete a bundle element zone
del
Get a list of bundle instance(s)
get
Delete all the bundle instance(s) in a sequence
post
Suspend all the 'Active' bundle instance(s) in a sequence
post
Resume all the bundle instance(s) in a sequence which have been 'Suspended'
post
Update a bundle instance start and end time
put
View bundle alias(es)
get
Create a bundle alias
post
Convert a bundle alias to a master bundle
post
Customers
Get a list of Customers which belongs to the Tenant
get
Create a Customer
post
Get details for a specific Customer
get
Update a Customer
put
Get account details for a specific Customer
get
Get a list of account transactions for a specific Customer
get
Top up a Customer Account
post
Apply ad-hoc debit to the Customer Account
post
Apply ad-hoc credit to the Customer Account
post
List the Credit pots of a Customer
get
Update the warning threshold of a Customer
post
Update the account limit of a Customer
post
Create the default configuration for the customer
post
Endpoints
Get a list of Endpoints
get
Assign endpoints to a Tenant or Customer.
post
Assign an Batch of Endpoints to a Tenant or Customer.
post
Unassign an Batch of Endpoints from their Customers.
post
Unassign endpoints from an existing customer to a Tenant
post
Allocate or re-allocate Endpoints to a Tenant and optionally assign to a customer
post
Allocate or re-allocate an Endpoint Batch to a Tenant and optionally assign to a customer
post
Get a specific Endpoint
get
Update a specific Endpoint
put
Allocate an IP address to an endpoint
post
Get the Carrier Network an Endpoint is attached to
get
Get the Radio Access Technology (2G/3G/4G/5G) an Endpoint is attached to
get
Get the IMEI of the device using an Endpoint
get
Get Country, Carrier Network and Cell ID that an Endpoint is located in
get
Get the time-stamp the Endpoint was last seen and the status of the Endpoint
get
Get the IP address of an Endpoint
get
List the Edge Key/Values for an Endpoint
get
Remove an Edge Key/Value for an Endpoint
del
Update an Edge Key/Value for an Endpoint
put
Event Endpoints
List the Event Endpoint(s)
get
Create a new Event Endpoint
post
Get an Event Endpoint
get
Update an existing Event Endpoint
put
Delete an Event Endpoint
del
Event Handlers
List the Event Handler(s)
get
Create a new Event Handler
post
Get an Event Handler
get
Update an existing Event Handler
put
Delete an Event Handler
del
Event Maps
List the Event Map(s)
get
Create a new Event Map
post
Get an Event Map
get
Update an existing Event Map
put
Delete an Event Map
del
List subscribed events for an Event Map
get
Subscribe to an event for an Event Map
post
Event Subscriptions
List Event Subscription(s)
get
Get details of an Event Subscription
get
Remove an Event Subscription
del
Events
Lists all events for this Tenant and any child Customers
get
Signalling Traces
Get an event's specific Signalling Trace PCAP
get
Get an event's specific Signalling Traces
get
Get packet(s) of a Signalling Trace for an endpoint
get
Get PCAP containing Signalling Tracing for an endpoint
get
Tenant Accounts
Get details of account
get
Get details of specific Tenant Account
get
List account transactions
get
Top up a Tenant Account
post
Apply ad-hoc debit to the Tenant Account
post
Apply ad-hoc credit to the Tenant Account
post
Update the account limit of a Tenant
post
Update the warning threshold of a Tenant
post
Tenants
Get a list of sub-tenants
get
Add a sub-tenant
post
Get a tenant's hierarchy tree
get
Get a specific tenant
get
Update a sub-tenant
put
Move a sub-tenant
put
Delete a sub-tenant
del
Usage Reports
Get Tenant usage
get
Delete an Usage Report
del
Get usage reports
get
Create a usage report
post
Download a completed usage report
get
Get an specific Usage Report
get
Download a completed usage report
get
Users
Get tenant user(s)
get
Get details for a specific user
get
Invite a user to the tenant account
post
Get a list of user(s), who are invited to the tenant account
get
Cancel a pending user invitation to the tenant account
del
/tenant/api/v1/users/tenants
get
Zone Schemes
List the Zone Schemes
get
Get a Zone Scheme
get
Get the child zones of a specific parent zone
get
Credentials
List the Credential(s)
get
Create a new Credential
post
Get an Credential
get
Update an existing Credential
put
Delete an Credential
del
/tenant/api/v1/credentials/{idOrMoniker}/regeneratecredential
post
Endpoints
Copy the authentication detail from a source to a destination endpoint by ICCID
put
Copy the authentication detail from a source to a destination endpoint by IMSI
put
Powered by
Update or Set a custom value
Ask AI
put
http://edge.stacuity.io/ep/kv/
{key}
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
