emnify REST API

The emnify REST API gives programmatic access to the emnify IoT SuperNetwork — global cellular connectivity for IoT devices. Manage SIMs, endpoints (devices), service and tariff profiles, events, SMS, eSIM (SGP.32) profiles, organizations, users, API callbacks, and the Data Streamer. Authenticate with short-lived JWTs obtained via application tokens or user credentials.

emnify REST API is one of 4 APIs that emnify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 machine-runnable capabilities that can be deployed as REST, MCP, or Agent Skill surfaces via Naftiko and 5 JSON Schema definitions.

Tagged areas include IoT, Cellular, Connectivity, SIM, and eSIM. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, a JSON-LD context, sample payloads, 7 Naftiko capability specs, and 5 JSON Schemas.

Documentation

Specifications

Examples

Schemas & Data

Other Resources

OpenAPI Specification

emnify-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: emnify REST API
  version: 1.0.0
  description: 'The emnify REST API gives programmatic access to the emnify IoT SuperNetwork — global cellular connectivity
    for IoT devices. Manage SIMs, endpoints (devices), service and tariff profiles, events, SMS, eSIM (SGP.32) profiles, organizations,
    users, API callbacks, and the Data Streamer. Authenticate with application tokens or user credentials; tokens are short-lived
    JWTs.


    Source: emnify developer documentation (https://docs.emnify.com/developers/api). This spec is assembled from the per-operation
    OpenAPI fragments published in the emnify llms-full.txt feed.'
  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_applicationTokens
  x-display-name: Applicationtokens
- name: subpackage_authentication
  x-display-name: Authentication
- name: subpackage_automations
  x-display-name: Automations
- name: subpackage_cloudConnect
  x-display-name: Cloudconnect
- name: subpackage_customEvents
  x-display-name: Customevents
- name: subpackage_endpoint
  x-display-name: Endpoint
- name: subpackage_euicc
  x-display-name: Euicc
- name: subpackage_euiccOperation
  x-display-name: Euiccoperation
- name: subpackage_events
  x-display-name: Events
- name: subpackage_integrations
  x-display-name: Integrations
- name: subpackage_ipAddressSpaces
  x-display-name: Ipaddressspaces
- name: subpackage_lookups
  x-display-name: Lookups
- name: subpackage_operator
  x-display-name: Operator
- name: subpackage_organization
  x-display-name: Organization
- name: subpackage_passwordManagementAndActivation
  x-display-name: Passwordmanagementandactivation
- name: subpackage_serviceLookupsAndConfiguration
  x-display-name: Servicelookupsandconfiguration
- name: subpackage_serviceProfiles
  x-display-name: Serviceprofiles
- name: subpackage_sim
  x-display-name: Sim
- name: subpackage_simOperation
  x-display-name: Simoperation
- name: subpackage_simUnlinkedProductStatistics
  x-display-name: Simunlinkedproductstatistics
- name: subpackage_systemEvents
  x-display-name: Systemevents
- name: subpackage_tagManagement
  x-display-name: Tagmanagement
- name: subpackage_tariffPlans
  x-display-name: Tariffplans
- name: subpackage_tariffProfiles
  x-display-name: Tariffprofiles
- name: subpackage_userManagement
  x-display-name: Usermanagement
- name: subpackage_workspaces
  x-display-name: Workspaces
paths:
  /api/v1/api_callback:
    get:
      operationId: get-api-callback-ur-ls
      summary: Retrieve list of API callback URLs
      tags:
      - subpackage_integrations
      parameters:
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved a list of API Callback URLs
          content:
            application/json:
              schema:
                type: array
                items:
                  description: Any type
    post:
      operationId: create-callback-url
      summary: Create a callback URL
      description: Create Callback URL
      tags:
      - subpackage_integrations
      parameters:
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Resource Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integrations_CreateCallbackURL_Response_201'
      requestBody:
        description: Creating an API callback URL
        content:
          application/json:
            schema:
              description: Any type
  /api/v1/api_callback/{api_callback_id}:
    get:
      operationId: get-callback-ur-lby-id
      summary: Get a callback URL by ID
      tags:
      - subpackage_integrations
      parameters:
      - name: api_callback_id
        in: path
        description: A numeric ID of an API Callback URL
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: API Callback by ID
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: API Callback with this ID not found
          content:
            application/json:
              schema:
                description: Any type
    delete:
      operationId: delete-callback-url
      summary: Delete a callback URL
      tags:
      - subpackage_integrations
      parameters:
      - name: api_callback_id
        in: path
        description: A numeric ID of an API Callback URL
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource Deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integrations_DeleteCallbackURL_Response_200'
        '404':
          description: API Callback with this ID not found
          content:
            application/json:
              schema:
                description: Any type
  /api/v1/api_secret:
    get:
      operationId: get-api-callback-secret
      summary: List API callback secrets
      description: "Lists API callback secrets.\n\n<Info>\n  The `secret` property itself is not returned in this call.\n\
        </Info>\n"
      tags:
      - subpackage_integrations
      parameters:
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved a list of API Callback Secrets
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV1ApiSecretGetResponsesContentApplicationJsonSchemaItems'
    post:
      operationId: create-callback-secret
      summary: Create a callback secret
      description: 'Creates a new secret that may be used by API callbacks.


        When an `api_secret` is assigned to a Service Profile with an API callback, API requests towards this URL will contain
        an `Authorization` header with a JSON Web Token.

        The `api_secret` is used as the **Signing Key** of the JWT.

        '
      tags:
      - subpackage_integrations
      parameters:
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Resource Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integrations_CreateCallbackSecret_Response_201'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                organisation_id:
                  type: string
                purpose:
                  type: string
                id:
                  type: integer
  /api/v1/api_secret/{api_secret_id}:
    get:
      operationId: get-callback-secretby-id
      summary: Get a callback secret by ID
      tags:
      - subpackage_integrations
      parameters:
      - name: api_secret_id
        in: path
        description: A numeric ID of an API secret
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: API Secret by ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integrations_GetCallbackSecretbyID_Response_200'
        '404':
          description: API Callback with this ID not found
          content:
            application/json:
              schema:
                description: Any type
    delete:
      operationId: delete-callback-secret
      summary: Delete a callback secret
      tags:
      - subpackage_integrations
      parameters:
      - name: api_secret_id
        in: path
        description: A numeric ID of an API Secret
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource Deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integrations_DeleteCallbackSecret_Response_200'
        '404':
          description: Secret with this ID not found
          content:
            application/json:
              schema:
                description: Any type
  /api/v1/application_token:
    get:
      operationId: application-token-get
      summary: List application tokens
      description: Returns the list of application tokens for the organisation of the requesting user.
      tags:
      - subpackage_applicationTokens
      parameters:
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV1ApplicationTokenGetResponsesContentApplicationJsonSchemaItems'
    post:
      operationId: application-token-post
      summary: Create application token
      description: 'Creates a new application token.

        ID must not be specified, as it is auto-generated and returned in case of a successful JSON response.

        You can provide following fields with this request:


        * `description` (String, optional)

        * `expiry_date` with optional time + time zone (String, optional)

        * `ip` - IP Address in CIDR notation (String, optional)

        '
      tags:
      - subpackage_applicationTokens
      parameters:
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application tokens_ApplicationTokenPost_Response_200'
        '422':
          description: Unprocessable Entity. See HTTP response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationTokenPostRequestUnprocessableEntityError'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                expiry_date:
                  type: string
                ip:
                  type: string
  /api/v1/application_token/{app_token_id}:
    patch:
      operationId: application-token-by-id-patch
      summary: Update application token
      description: 'The `description` of the token may be updated and the

        Application Token can be revoked by updating the `status`.

        The possible statuses of tokens are


        * `"id": 0` - Activated

        * `"id": 1` - Revoked

        '
      tags:
      - subpackage_applicationTokens
      parameters:
      - name: app_token_id
        in: path
        description: application token ID
        required: true
        schema:
          type: number
          format: double
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      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: {}
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                status:
                  $ref: '#/components/schemas/ApiV1ApplicationTokenAppTokenIdPatchRequestBodyContentApplicationJsonSchemaStatus'
  /api/v1/authenticate:
    post:
      operationId: authenticate
      summary: Retrieve authentication token
      description: "Returns a [JSON Web Token (JWT)](/developers/auth/jwts) `auth_token` for authenticating further requests\
        \ to the API.\n\n<Note>\n  This API path has a rate limit of 100 requests per IP in a 5-minute window.\n  Make sure\
        \ to store your authentication token to avoid hitting this limit.\n  For more information, see [Rate limits](/developers/api-guidelines/rate-limits).\n\
        </Note>\n\n### Multi-factor authentication flow\n\nWhen multi-factor authentication (MFA) is enabled for a user account:\n\
        \n1. **Initial login**: Send your username and SHA-1 hashed password.\n  If MFA is enabled and the device isn't trusted,\
        \ you receive an `mfa_token` instead of `auth_token` in the response and a one-time password (OTP) via email.\n2.\
        \ **MFA verification**: Send the `mfa_token` with the 6-digit OTP `code`.\n  Optionally include `trusted_device` information\
        \ to skip MFA for 90 days.\n3. **Subsequent logins**: If you included a trusted device fingerprint during verification,\
        \ send your username and SHA-1 hashed password with the `fingerprint` to bypass MFA.\n\nFor more information, see\
        \ [Multi-factor authentication](/developers/auth/multi-factor-authentication).\n"
      tags:
      - subpackage_authentication
      responses:
        '200':
          description: Successful Authentication Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Authentication_Authenticate_Response_200'
        '400':
          description: The request body is malformed or fails validation.
          content:
            application/json:
              schema:
                description: Any type
        '401':
          description: 'The response body is empty for most authentication failures (invalid credentials, suspended or deleted
            user, etc.).

            When account lockout is triggered after three consecutive failed authentication attempts, the response body contains
            the `TooManyRequests` error and further attempts are blocked for five minutes.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticateRequestUnauthorizedError'
        '404':
          description: 'Unexpected error in API call.

            See HTTP response body for details.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticateRequestNotFoundError'
      requestBody:
        description: "Authenticate with an [application token](/developers/auth/application-tokens).\n\n<Info>\n  **Temporary\
          \ exception**:\n  [User credentials](/developers/auth/user-credentials) are currently required for operations that\
          \ span multiple workspaces, such as switching between workspaces or transferring SIMs.\n  These APIs are being updated\
          \ to support application tokens.\n</Info>\n"
        content:
          application/json:
            schema:
              type: object
              properties:
                application_token:
                  type: string
                  description: Application token for authentication
                username:
                  type: string
                  description: Username for user credentials authentication
                password:
                  type: string
                  format: password
                  description: 'User password.

                    Must be SHA-1 hashed when authenticating with user credentials.

                    '
                fingerprint:
                  type: string
                  description: Device fingerprint for trusted device authentication (skips MFA)
                refresh_token:
                  type: string
                  description: Refresh token to obtain a new `auth_token`
                mfa_token:
                  type: string
                  description: MFA token received when MFA is enabled
                code:
                  type: string
                  description: 6-digit one-time password (OTP) for MFA verification
                trusted_device:
                  $ref: '#/components/schemas/ApiV1AuthenticatePostRequestBodyContentApplicationJsonSchemaTrustedDevice'
                  description: Device information to register as trusted (90-day MFA exemption)
  /api/v1/authenticate/workspace:
    post:
      operationId: authenticate-workspace
      summary: Switch to an assigned Workspace
      description: "Switch to an assigned Workspace and receive an authentication token for the target Workspace.\n\n<Note>\n\
        \  This endpoint requires authentication with [user credentials](/developers/auth/user-credentials) (not an application\
        \ token), as application tokens are scoped to a single Workspace.\n\n  The returned `auth_token` is valid for the\
        \ target Workspace.\n  Your original token remains valid for the source Workspace.\n</Note>\n"
      tags:
      - subpackage_workspaces
      parameters:
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully switched to the assigned Workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspaces_AuthenticateWorkspace_Response_200'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                target_organisation:
                  $ref: '#/components/schemas/ApiV1AuthenticateWorkspacePostRequestBodyContentApplicationJsonSchemaTargetOrganisation'
              required:
              - target_organisation
  /api/v1/automation:
    get:
      operationId: list-automations
      summary: List configured automations
      description: 'Returns a list of all configured automations for the organization.

        '
      tags:
      - subpackage_automations
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AutomationOutputDto'
    post:
      operationId: create-automation
      summary: Create an automation
      description: 'Creates an automation with the configured event and selected actions, respecting the configured targets.

        '
      tags:
      - subpackage_automations
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationOutputDto'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationCreateDto'
  /api/v1/automation/action:
    get:
      operationId: list-action
      summary: List available actions
      description: 'Returns a list of all available actions, as well as their possible configuration parameters and required
        fields.

        Availability depends on the parent organization.

        '
      tags:
      - subpackage_automations
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AutomationActionOutputDto'
  /api/v1/automation/action/{id}:
    get:
      operationId: get-action-by-id
      summary: Get an action by ID
      description: 'Retrieves a specified available actions, as well as the possible configuration parameters and required
        fields.

        Availability depends on the parent organization.

        '
      tags:
      - subpackage_automations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationActionOutputDto'
  /api/v1/automation/log:
    get:
      operationId: list-action-logs
      summary: List action logs
      description: 'Returns a list of all action logs for this organization.

        '
      tags:
      - subpackage_automations
      parameters:
      - name: automationId
        in: query
        required: true
        schema:
          type: string
      - name: automationExecutionNumber
        in: query
        required: true
        schema:
          type: number
          format: double
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AutomationActionLogOutputDto'
  /api/v1/automation/recipient/email/verification:
    post:
      operationId: verify-automation-recipient-email
      summary: Verify an automation recipient's email address
      description: 'Verifies the email address of an automation recipient using the verification token sent to the recipient
        via email.

        '
      tags:
      - subpackage_automations
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Email verification successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Automations_verifyAutomationRecipientEmail_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationRecipientEmailVerificationInputDto'
  /api/v1/automation/{id}:
    get:
      operationId: get-automation
      summary: Get configured automation by ID
      description: 'Retrieves the specified configured automation.

        '
      tags:
      - subpackage_automations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationOutputDto'
    delete:
      operationId: delete-automation
      summary: Delete a configured automation
      description: 'Deletes the specified configured automation.

        '
      tags:
      - subpackage_automations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
    patch:
      operationId: update-automation
      summary: Update an automation
      description: 'Updates an automation with the configured event and selected actions, respecting the configured targets.

        '
      tags:
      - subpackage_automations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationOutputDto'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationUpdateDto'
  /api/v1/breakout_region:
    get:
      operationId: breakout-region-get
      summary: List breakout regions
      description: Provides the list of available breakout regions.
      tags:
      - subpackage_lookups
      parameters:
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV1BreakoutRegionGetResponsesContentApplicationJsonSchemaItems'
  /api/v1/cnc/breakout:
    get:
      operationId: get-cloud-connect-attachments
      summary: List all Cloud Connect attachments of an organization
      description: 'Lists all Cloud Connect attachments of the logged in organisation if it is an Enterprise. For Master organisations

        it lists all attachments of the direct child organisations. Deleted attachments are left out by default.


        Additionally the attachments can be filtered by status and type.

        Master organisations can also filter by organisation ID of their direct child organisations.

        '
      tags:
      - subpackage_cloudConnect
      parameters:
      - name: status
        in: query
        description: 'Numerical ID of the Cloud Connect attachment status


          * `1` - Pending Customer Action

          * `2` - Pending AWS Activation

          * `3` - Pending EGN Activation

          * `4` - Pending CRG Activation

          * `5` - Active

          * `6` - Deactivation Pending

          * `7` - Deactivated

          * `8` - Rolling Back

          '
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1CncBreakoutGetParametersStatus'
      - name: type
        in: query
        description: 'Numerical ID of the Cloud Connect attachment type


          * `1` - Transit Gateway

          * `2` - IPSec VPN

          * `3` - IPSec VPN BGP

          * `4` - IPSec VPN BGP High Availability

          * `5` - Direct Connect

          * `6` - Shared

          * `7` - Transit Gateway (Classic)

          * `8` - IPSec VPN (Classic)

          '
        required: false
        schema:
          $ref: '#/components/schemas/ApiV1CncBreakoutGetParametersType'
      - name: organisation
        in: query
        description: Numerical ID of an Organization
        required: false
        schema:
          type: number
          format: double
      - name: Authorization
        in: header
        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).

          '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV1CncBreakoutGetResponsesContentApplicationJsonSchemaItems'
        '403':
          description: Authentication token is valid, but user has no access permissions to the request resource
          content:
            application/json:
              schema:
                description: Any type
  /api/v1/cnc/breakout/tgw:
    post:
      operationId: create-cloud-connect-attachment-tgw
      summary: Create a Cloud

# --- truncated at 32 KB (713 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/emnify/refs/heads/main/openapi/emnify-api-openapi.yml