emnify

emnify Subpackage Sim Operation API

The subpackage_simOperation API from emnify — 4 operation(s) for subpackage_simoperation.

GitHub OpenAPI

Operations 5

GET /api/v1/sim/operation List SIM operations for organization #
POST /api/v1/sim/operation Trigger SIM operation #
GET /api/v1/sim/operation/action List SIM operation actions #
GET /api/v1/sim/operation/status List SIM operation status #
GET /api/v1/sim/operation/{operation_id} Get SIM operation details #

Documentation

📖
Documentation
https://docs.emnify.com/developers
📖
Documentation
https://docs.emnify.com/developers/api-guidelines/conventions
📖
Documentation
https://docs.emnify.com/llms-full.txt

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/openapi/emnify-subpackage-simoperation-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-schema/emnify-sim-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-schema/emnify-endpoint-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-schema/emnify-event-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-structure/emnify-sim-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-structure/emnify-endpoint-structure.json

Other Resources

🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/rules/emnify-rules.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/json-ld/emnify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/examples/emnify-authenticate-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/examples/emnify-list-endpoints-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/examples/emnify-send-sms-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/examples/emnify-list-events-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/vocabulary/emnify-vocabulary.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/emnify-subpackage-simoperation-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

emnify-subpackage-simoperation-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: emnify REST Subpackage Sim Operation API
  version: 1.0.0
  description: The emnify REST API gives programmatic access to the emnify IoT SuperNetwork — global cellular connectivity for IoT devices.
  contact:
    name: emnify Developer Support
    url: https://docs.emnify.com/developers
  license:
    name: Proprietary
    url: https://www.emnify.com/legal
servers:
- url: https://cdn.emnify.net
  description: emnify REST API base host
security:
- BearerAuth: []
tags:
- name: subpackage_simOperation
  x-display-name: Simoperation
paths:
  /api/v1/sim/operation:
    get:
      operationId: list-sim-operation
      summary: List SIM operations for organization
      description: List all SIM operations for your organization.
      tags:
      - subpackage_simOperation
      parameters:
      - name: page
        in: query
        description: Page number (1-based).
        required: false
        schema:
          type: integer
          default: 1
      - name: per_page
        in: query
        description: Items per page.
        required: false
        schema:
          type: integer
          default: 100
      - name: q
        in: query
        description: 'Filter parameter in `<field>:<criteria>` format.

          Expects a comma-separated list from the allowed fields:


          - `id`

          - `action`

          - `status`

          '
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: 'Sort properties according to a comma separated list from the allowed fields (prefix with `-` for descending):


          - `id`

          - `action`

          - `status`

          - `creation_date`

          - `finalization_date`

          '
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: SIM operation list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SimOperationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: trigger-sim-operation
      summary: Trigger SIM operation
      description: Trigger a SIM operation.
      tags:
      - subpackage_simOperation
      parameters:
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created, SIM operation scheduled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimOperationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimOperationRequest'
  /api/v1/sim/operation/action:
    get:
      operationId: list-sim-operation-action
      summary: List SIM operation actions
      description: List possible SIM operation action objects used in responses and requests.
      tags:
      - subpackage_simOperation
      parameters:
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of SIM operation actions
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OperationAction'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/sim/operation/status:
    get:
      operationId: list-sim-operation-status
      summary: List SIM operation status
      description: List possible SIM operation status objects used in responses.
      tags:
      - subpackage_simOperation
      parameters:
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of SIM operation status
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OperationStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/sim/operation/{operation_id}:
    get:
      operationId: get-sim-operation
      summary: Get SIM operation details
      description: Get details of a specific SIM operation.
      tags:
      - subpackage_simOperation
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: 'An auth_token should be provided to authenticate a session.

          To obtain an auth_token, see the POST request to `/api/v1/authenticate`.

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: SIM operation detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimOperationResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    SimOperationResponseTargetSim:
      type: object
      properties:
        id:
          type: integer
      required:
      - id
      title: SimOperationResponseTargetSim
    SimOperationResponseTarget:
      type: object
      properties:
        sim:
          $ref: '#/components/schemas/SimOperationResponseTargetSim'
        eid:
          $ref: '#/components/schemas/Eid'
      required:
      - sim
      title: SimOperationResponseTarget
    Eid:
      type: string
      title: Eid
    OperationAction:
      type: object
      properties:
        id:
          type: integer
        description:
          type: string
      required:
      - id
      - description
      title: OperationAction
    ProductRef:
      type: object
      properties:
        id:
          type: integer
      required:
      - id
      title: ProductRef
    Error:
      type: object
      properties:
        status_code:
          type: integer
        message:
          type: string
      required:
      - status_code
      - message
      title: Error
    OperationStatus:
      type: object
      properties:
        id:
          type: integer
        description:
          type: string
      required:
      - id
      - description
      title: OperationStatus
    SimOperationRequestTargetSim:
      type: object
      properties:
        id:
          type: integer
      required:
      - id
      title: SimOperationRequestTargetSim
    SimOperationResponseErrorItems:
      type: object
      properties:
        eid:
          $ref: '#/components/schemas/Eid'
        message:
          type: string
      required:
      - eid
      - message
      title: SimOperationResponseErrorItems
    SimOperationRequest:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/SimOperationActionRef'
        product:
          $ref: '#/components/schemas/ProductRef'
        target:
          type: array
          items:
            $ref: '#/components/schemas/SimOperationRequestTarget'
      required:
      - action
      - target
      title: SimOperationRequest
    SimOperationActionRef:
      type: object
      properties:
        id:
          type: integer
      required:
      - id
      title: SimOperationActionRef
    SimOperationRequestTarget:
      type: object
      properties:
        sim:
          $ref: '#/components/schemas/SimOperationRequestTargetSim'
        eid:
          $ref: '#/components/schemas/Eid'
      title: SimOperationRequestTarget
    SimOperationResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Operation ID
        action:
          $ref: '#/components/schemas/OperationAction'
        status:
          $ref: '#/components/schemas/OperationStatus'
        product:
          $ref: '#/components/schemas/ProductRef'
        creation_date:
          type: string
          format: date-time
        last_updated_at:
          type: string
          format: date-time
        finalization_date:
          type:
          - string
          - 'null'
          format: date-time
        target:
          type: array
          items:
            $ref: '#/components/schemas/SimOperationResponseTarget'
        total_count:
          type: integer
        failed_count:
          type: integer
        success_count:
          type: integer
        error:
          type: array
          items:
            $ref: '#/components/schemas/SimOperationResponseErrorItems'
      required:
      - id
      - action
      - status
      - creation_date
      - last_updated_at
      title: SimOperationResponse
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Retrieve a JWT via POST /api/v1/authenticate using an application_token or user credentials, then send it as `Authorization: Bearer <token>`.'