emnify Service Lookups And Configuration API

openapi: 3.2.0
info:
  title: Enterprise Service Lookups And Configuration API
  version: 1.0.0
  description: Lookup and configuration services for API resources
servers:
- url: https://cdn.emnify.net
  description: emnify REST API
tags:
- name: serviceLookupsAndConfiguration
  description: Lookup and configuration services for API resources
paths:
  /api/v1/service:
    get:
      operationId: serviceLookupsAndConfiguration_ServiceGet
      summary: List services
      description: 'Required permissions Beta Learn more


        `Service` + `List`


        Roles: Administrator User Observer


        Retrieves a collection of available services. Services are read only objects.


        Service objects contain expanded traffic limit nested objects.'
      tags:
      - serviceLookupsAndConfiguration
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV1ServiceGetResponsesContentApplicationJsonSchemaItems'
        '403':
          description: 'Your role doesn''t include the permission this endpoint requires.


            Most endpoints return `error_code`, `error_token`, and `message`.

            Some return only `status_code` and `message`.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceGetRequestForbiddenError'
      security:
      - bearerAuth: []
  /api/v1/service/{service_id}/traffic_limit:
    get:
      operationId: serviceLookupsAndConfiguration_ServiceTrafficLimitByIdGet
      summary: Get service SMS limit
      description: 'Required permissions Beta Learn more


        `Service.TrafficLimit` + `List`


        Roles: Administrator User Observer


        SMS limits are system configuration parameters defined for a single service.

        SMS limits do not have direct effect, but have to be explicitly assigned to an endpoint or a service profile.'
      tags:
      - serviceLookupsAndConfiguration
      parameters:
      - name: service_id
        in: path
        description: "The numeric ID corresponding to one of the following services:\n * `6` - SMS MT\n * `32` - SMS MO\n\n <Warning>\n  USSD, Voice and Data services aren't available.\n </Warning>\n"
        required: true
        schema:
          $ref: '#/components/schemas/ApiV1ServiceServiceIdTrafficLimitGetParametersServiceId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV1ServiceServiceIdTrafficLimitGetResponsesContentApplicationJsonSchemaItems'
        '403':
          description: 'Your role doesn''t include the permission this endpoint requires.


            Most endpoints return `error_code`, `error_token`, and `message`.

            Some return only `status_code` and `message`.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceTrafficLimitByIdGetRequestForbiddenError'
      security:
      - bearerAuth: []
  /api/v1/traffic_limit:
    get:
      operationId: serviceLookupsAndConfiguration_TrafficLimitGet
      summary: List traffic limits
      description: 'Required permissions Beta Learn more


        `TrafficLimit` + `List`


        Roles: Administrator User Observer


        Retrieves a list of available traffic limits.'
      tags:
      - serviceLookupsAndConfiguration
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV1TrafficLimitGetResponsesContentApplicationJsonSchemaItems'
        '403':
          description: 'Your role doesn''t include the permission this endpoint requires.


            Most endpoints return `error_code`, `error_token`, and `message`.

            Some return only `status_code` and `message`.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrafficLimitGetRequestForbiddenError'
      security:
      - bearerAuth: []
  /api/v1/dns:
    get:
      operationId: serviceLookupsAndConfiguration_DnsGet
      summary: List DNS configs
      description: 'Required permissions Beta Learn more


        `Dns` + `List`


        Roles: Administrator User


        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.'
      tags:
      - serviceLookupsAndConfiguration
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV1DnsGetResponsesContentApplicationJsonSchemaItems'
        '403':
          description: 'Your role doesn''t include the permission this endpoint requires.


            Most endpoints return `error_code`, `error_token`, and `message`.

            Some return only `status_code` and `message`.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnsGetRequestForbiddenError'
      security:
      - bearerAuth: []
    post:
      operationId: serviceLookupsAndConfiguration_DnsPost
      summary: Create DNS config
      description: 'Required permissions Beta Learn more


        `Dns` + `Create`


        Roles: Administrator User


        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**.

        Connected devices with previously 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.


        The system currently falls back to IPV4 for the actually-enforced networking settings of endpoints, therefore **the IPV6 parameter will be ignored** when provided.'
      tags:
      - serviceLookupsAndConfiguration
      responses:
        '201':
          description: Resource Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Service_lookups_and_configuration_DnsPost_Response_201'
        '403':
          description: 'Your role doesn''t include the permission this endpoint requires.


            Most endpoints return `error_code`, `error_token`, and `message`.

            Some return only `status_code` and `message`.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnsPostRequestForbiddenError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                primary:
                  type: string
                secondary:
                  type: string
                ip_address_version:
                  type: integer
              required:
              - primary
              - secondary
              - ip_address_version
      security:
      - bearerAuth: []
  /api/v1/dns/{dns_id}:
    delete:
      operationId: serviceLookupsAndConfiguration_DnsByIdDelete
      summary: Delete DNS config
      description: 'Required permissions Beta Learn more


        `Dns` + `Delete`


        Roles: Administrator User


        Delete a DNS configuration object by ID.


        A DNS config object cannot be deleted if it is in use by at least one Service Profile.'
      tags:
      - serviceLookupsAndConfiguration
      parameters:
      - name: dns_id
        in: path
        description: DNS configuration ID
        required: true
        schema:
          type: number
          format: double
      responses:
        '204':
          description: The server has successfully fulfilled the request and that there is no additional content to send in the response payload body
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '403':
          description: 'Your role doesn''t include the permission this endpoint requires.


            Most endpoints return `error_code`, `error_token`, and `message`.

            Some return only `status_code` and `message`.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnsByIdDeleteRequestForbiddenError'
      security:
      - bearerAuth: []
components:
  schemas:
    ApiV1TrafficLimitGetResponsesContentApplicationJsonSchemaItemsPeriod:
      type: object
      properties: {}
      title: ApiV1TrafficLimitGetResponsesContentApplicationJsonSchemaItemsPeriod
    ApiV1DnsGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        id:
          type: integer
        primary:
          type: string
        secondary:
          type: string
        ip_address_version:
          type: integer
      title: ApiV1DnsGetResponsesContentApplicationJsonSchemaItems
    TrafficLimitGetRequestForbiddenError:
      type: object
      properties:
        error_code:
          type: integer
        error_token:
          type: string
        status_code:
          type: integer
        message:
          type: string
      title: TrafficLimitGetRequestForbiddenError
    ApiV1ServiceGetResponsesContentApplicationJsonSchemaItemsTrafficType:
      type: object
      properties: {}
      title: ApiV1ServiceGetResponsesContentApplicationJsonSchemaItemsTrafficType
    ApiV1ServiceServiceIdTrafficLimitGetResponsesContentApplicationJsonSchemaItemsPeriod:
      type: object
      properties:
        id:
          type: integer
        time_units:
          type: integer
        unit:
          type: string
      title: ApiV1ServiceServiceIdTrafficLimitGetResponsesContentApplicationJsonSchemaItemsPeriod
    ServiceTrafficLimitByIdGetRequestForbiddenError:
      type: object
      properties:
        error_code:
          type: integer
        error_token:
          type: string
        status_code:
          type: integer
        message:
          type: string
      title: ServiceTrafficLimitByIdGetRequestForbiddenError
    ApiV1ServiceServiceIdTrafficLimitGetParametersServiceId:
      type: string
      enum:
      - '6'
      - '32'
      title: ApiV1ServiceServiceIdTrafficLimitGetParametersServiceId
    DnsByIdDeleteRequestForbiddenError:
      type: object
      properties:
        error_code:
          type: integer
        error_token:
          type: string
        status_code:
          type: integer
        message:
          type: string
      title: DnsByIdDeleteRequestForbiddenError
    ApiV1TrafficLimitGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        id:
          type: integer
        service:
          $ref: '#/components/schemas/ApiV1TrafficLimitGetResponsesContentApplicationJsonSchemaItemsService'
        volume:
          type: integer
        period:
          $ref: '#/components/schemas/ApiV1TrafficLimitGetResponsesContentApplicationJsonSchemaItemsPeriod'
      title: ApiV1TrafficLimitGetResponsesContentApplicationJsonSchemaItems
    ApiV1ServiceGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        id:
          type: integer
        description:
          type: string
        teleservice_code:
          type: integer
        used_with_vlr:
          type: boolean
        used_with_sgsn:
          type: boolean
        traffic_type:
          $ref: '#/components/schemas/ApiV1ServiceGetResponsesContentApplicationJsonSchemaItemsTrafficType'
      title: ApiV1ServiceGetResponsesContentApplicationJsonSchemaItems
    Service_lookups_and_configuration_DnsPost_Response_201:
      type: object
      properties: {}
      description: Empty response body
      title: Service lookups and configuration_DnsPost_Response_201
    DnsPostRequestForbiddenError:
      type: object
      properties:
        error_code:
          type: integer
        error_token:
          type: string
        status_code:
          type: integer
        message:
          type: string
      title: DnsPostRequestForbiddenError
    ApiV1TrafficLimitGetResponsesContentApplicationJsonSchemaItemsService:
      type: object
      properties: {}
      title: ApiV1TrafficLimitGetResponsesContentApplicationJsonSchemaItemsService
    ApiV1ServiceServiceIdTrafficLimitGetResponsesContentApplicationJsonSchemaItems:
      type: object
      properties:
        id:
          type: integer
        volume:
          type: integer
        period:
          $ref: '#/components/schemas/ApiV1ServiceServiceIdTrafficLimitGetResponsesContentApplicationJsonSchemaItemsPeriod'
      title: ApiV1ServiceServiceIdTrafficLimitGetResponsesContentApplicationJsonSchemaItems
    DnsGetRequestForbiddenError:
      type: object
      properties:
        error_code:
          type: integer
        error_token:
          type: string
        status_code:
          type: integer
        message:
          type: string
      title: DnsGetRequestForbiddenError
    ServiceGetRequestForbiddenError:
      type: object
      properties:
        error_code:
          type: integer
        error_token:
          type: string
        status_code:
          type: integer
        message:
          type: string
      title: ServiceGetRequestForbiddenError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'An `auth_token` should be provided to authenticate a session.


        To obtain an `auth_token`, see the [`/api/v1/authenticate` **POST** request](/developers/api/authentication/authenticate).

        '
x-provenance:
  method: harvested
  publisher: emnify
  source: https://docs.emnify.com/openapi/enterprise.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)