Skip to content

Latest commit

 

History

History
185 lines (100 loc) · 6.22 KB

ServiceLookupsAndConfigurationApi.md

File metadata and controls

185 lines (100 loc) · 6.22 KB

\ServiceLookupsAndConfigurationApi

All URIs are relative to https://cdn.emnify.net

Method HTTP request Description
dns_by_id_delete delete /api/v1/dns/{dns_id} Delete DNS config
dns_get get /api/v1/dns List DNS Configs
dns_post post /api/v1/dns Create DNS config
service_get get /api/v1/service List Services
service_traffic_limit_by_id_get get /api/v1/service/{service_id}/traffic_limit Get Service Traffic Limit
traffic_limit_get get /api/v1/traffic_limit List Traffic Limits

dns_by_id_delete

dns_by_id_delete(dns_id) Delete DNS config

Delete a DNS configuration object by ID. NOTE: A DNS config object cannot be deleted if it is in use by at least one Service Profile.

Parameters

Name Type Description Required Notes
dns_id f32 DNS configuration ID [required]

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dns_get

Veccrate::models::InlineResponse2003 dns_get() List DNS Configs

Retrieves a list of DNS configurations. DNS settings can be applied to a service profile and endpoints which use this service profile will have the associated DNS settings applied.

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::InlineResponse2003

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dns_post

dns_post(createa_dn_sentryrequest) Create DNS config

Creates a DNS configuration object. The DNS config can be applied to a service profile and all endpoints which use that service profile will have the associated DNS settings applied. DNS changes are instantly applied to any new PDP context; already connected devices with established PDPs will continue to use the previous nameserver config until the next time they reconnect. Primary and secondary nameservers and IP version (4 for IPV4 or 6 for IPV6) must be specified with this request. NOTE: The system currently falls back to IPV4 for the actually-enforced networking settings of endpoints, therefore the IPV6 parameter will be ignored when provided.

Parameters

Name Type Description Required Notes
createa_dn_sentryrequest CreateaDnSentryrequest [required]

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

service_get

Veccrate::models::RetrieveAvailableServicesresponse service_get() List Services

Retrieves a collection of available services. Services are read only objects. Service objects contain expanded traffic limit nested objects.

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::RetrieveAvailableServicesresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

service_traffic_limit_by_id_get

Veccrate::models::InlineResponse2002 service_traffic_limit_by_id_get(service_id) Get Service Traffic Limit

Traffic limits are system configuration parameters defined for a single service. Traffic limits do not have direct effect, but have to be explicitly assigned to an endpoint or a service profile.

Parameters

Name Type Description Required Notes
service_id f32 The Numeric ID of a Service, may be: * 0 - USSD * 3 - Voice, warning: voice services are not available! * 6 - SMS MT * 32 - SMS MO * 38 - Data [required]

Return type

Veccrate::models::InlineResponse2002

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

traffic_limit_get

Veccrate::models::RetrieveavailableTrafficLimitsresponse traffic_limit_get() List Traffic Limits

Retrieves a list of available traffic limits.

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::RetrieveavailableTrafficLimitsresponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]