Connectors

Retrieve information for all Connectors

get

Returns detailed information for all registered Connectors. Note that sensitive data will not be returned but information around when it was updated and if its set can be found in the meta object.

Minimum package requirement: Enterprise

Authorizations
Responses
200

OK

application/json
Responseobject
get
GET /connectors HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "name": "my-azure-connector",
    "type": "microsoft_azure_iot",
    "passthrough": [],
    "tags": [
      {
        "name": "Supplier",
        "id": "a5023f47-1db8-425e-b664-dc0b8921f644",
        "can_write": false,
        "color": "#5ba571"
      }
    ],
    "options": {},
    "meta": {
      "connectionString": {
        "is_set": true,
        "last_updated_at": "2024-09-26T09:25:42.898Z"
      }
    }
  },
  {
    "name": "my_tls_connector",
    "type": "tls",
    "passthrough": [],
    "tags": [],
    "options": {
      "host": "87.65.43.21",
      "port": 443,
      "server_name": "foobar.example.com"
    },
    "meta": {
      "ca": {
        "is_set": false,
        "last_updated_at": "2024-09-26T09:10:22.367Z"
      },
      "key": {
        "is_set": true,
        "last_updated_at": "2024-09-26T09:25:50.140Z"
      },
      "cert": {
        "is_set": true,
        "last_updated_at": "2024-09-26T09:25:42.898Z"
      }
    }
  }
]

Add Connector

post

Creates a Connector. The object various depending on the type. passthrough and tags are shared amongst all types though and are the mechanisms to route parts of the traffic around the Connector as well as grouping and access control.

Read more about Connectors here.

Minimum package requirement: Enterprise

Note: Some Connectors are not included in the documentation here as they are currently in a beta state. Moreover, then some Connectors are easier to create in the web app, e.g. AWS IoT Core Connector.

Authorizations
Body
namestringOptional

A descriptive name for the connector (3-255 characters, alphanumeric, hyphens, and underscores only)

Example: my-tls-connectorPattern: ^[-_a-zA-Z0-9]{3,255}$
typestring · enumRequired

The type of Connector to create

Possible values:
tagsstring · uuid[] | nullableOptional

Tags for grouping and access control (UUIDs)

optionsone ofOptional

Connector-specific configuration options

or
or
or
Responses
200

Connector successfully created

application/json
post
POST /connectors HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 409

{
  "name": "my-tls-connector",
  "type": "tls",
  "tags": [],
  "passthrough": [
    {
      "protocol": "udp",
      "ip": "1.1.1.1",
      "port": 53
    }
  ],
  "options": {
    "host": "123.123.123.123",
    "port": 443,
    "server_name": "foobar.example.com",
    "key": "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----",
    "ca": "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----",
    "cert": "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----"
  }
}
200

Connector successfully created

{
  "name": "my-tls-connector",
  "type": "tls",
  "passthrough": [
    {
      "protocol": "udp",
      "ip": "1.1.1.1",
      "port": 53
    }
  ],
  "tags": [],
  "options": {
    "host": "123.123.123.123",
    "port": 443,
    "server_name": "foobar.example.com"
  },
  "meta": {
    "ca": {
      "is_set": true,
      "last_updated_at": "2025-09-18T09:38:36.087Z"
    },
    "key": {
      "is_set": true,
      "last_updated_at": "2025-09-18T09:38:36.087Z"
    },
    "cert": {
      "is_set": true,
      "last_updated_at": "2025-09-18T09:38:36.087Z"
    }
  }
}

Update Connector

patch

Use a PATCH request to update an Onomondo Connector in your account.

Update one of the settings of your Connector:

  • name: Change the name

  • type: Change the type of the Connector. For this to be successful, you will need to also update the options field with the new Connector type details.

  • passthrough: An array of objects to exclude being processed up by the connector. Each object requires at least a "protocol" (of either udp,tcp, or icmp).

  • tags: An array of Tag IDs to be associated with a Connector.

  • options: See the POST requests for each of the Connectors for fields required in the options field.

Minimum package requirement: Enterprise

Authorizations
Path parameters
connector_namestringRequiredExample: foobar
Body
typestring · enumOptional

The type of Connector (must update options field when changing type)

Possible values:
tagsstring[]Optional

An array of Tag IDs to be associated with a SIM. Tag IDs require string format and can be obtained using GET /tags endpoint. Caution: Include all Tags you want to keep plus any new ones, as this replaces the entire list of Tags.

Example: ["tag-id-1","tag-id-2"]
optionsone ofOptional

Connector-specific configuration options (see POST examples for each connector type)

or
or
or
Responses
200

Connector successfully updated

application/json
patch
PATCH /connectors/{connector_name} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "name": "updated-tls-connector",
  "passthrough": [
    {
      "protocol": "udp",
      "ip": "8.8.8.8",
      "port": 53
    }
  ]
}
200

Connector successfully updated

{
  "id": 3202,
  "uuid": "2a48f7a9-140d-47a0-a85c-f7b024798a13",
  "organization_id": 2,
  "name": "updated-tls-connector",
  "type": "tls",
  "passthrough": [
    {
      "protocol": "udp",
      "ip": "8.8.8.8",
      "port": 53
    }
  ],
  "tags": [],
  "options": {
    "host": "123.123.123.123",
    "port": 443,
    "server_name": "foobar.example.com"
  },
  "meta": {
    "ca": {
      "is_set": true,
      "last_updated_at": "2025-09-18T09:38:36.087Z"
    },
    "key": {
      "is_set": true,
      "last_updated_at": "2025-09-18T09:38:36.087Z"
    },
    "cert": {
      "is_set": true,
      "last_updated_at": "2025-09-18T09:38:36.087Z"
    }
  }
}

Remove Connector

delete

Removes a specific Connector.

Note that all mappings to said Connector will need to be removed prior to the removal of the Connector itself, otherwise a 403 status code will be encountered.

Minimum package requirement: Enterprise

Authorizations
Path parameters
connector_namestringRequiredExample: foobar
Responses
200

OK

application/json
Responseobject
delete
DELETE /connectors/{connector_name} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "ok"
}
PreviousNetwork ListsNextUsage

Last updated