Subscribers¶

This section describes the RESTful API for managing network subscribers. Network subscribers are the devices that connect to the private mobile network.

List Subscribers¶

This path returns the list of network subscribers.

Method	Path
GET	`/api/v1/subscribers`

Query Parameters¶

Name	In	Type	Default	Allowed	Description
`page`	query	int	`1`	`>= 1`	1-based page index.
`per_page`	query	int	`25`	`1…100`	Number of items per page.
`radio`	query	str			Filter by radio name. Returns only subscribers connected to the specified radio.

Sample Response¶

{
    "result": {
        "items": [
            {
                "imsi": "001010100007487",
                "policyName": "default",
                "status": {
                    "registered": true
                },
                "pdu_sessions": [
                    {
                        "ipAddress": "1.2.3.4"
                    }
                ]
            }
        ],
        "page": 1,
        "per_page": 10,
        "total_count": 1
    }
}

Create a Subscriber¶

This path creates a new network subscriber.

Method	Path
POST	`/api/v1/subscribers`

Parameters¶

imsi (string): The IMSI of the subscriber. Must be a 15-digit string starting with <mcc><mnc>.
key (string): The key of the subscriber. Must be a 32-character hexadecimal string.
sequenceNumber (string): The sequence number of the subscriber. Must be a 6-byte hexadecimal string.
PolicyName (string): The policy name of the subscriber. Must be the name of an existing policy.
opc (optional string): The operator code of the subscriber. If not provided, it will be generated automatically using the Operator Code (OP) and the key parameter.

Sample Response¶

{
    "result": {
        "message": "Subscriber created successfully"
    }
}

Update a Subscriber¶

This path updates an existing network subscriber.

Method	Path
PUT	`/api/v1/subscribers/{imsi}`

Parameters¶

PolicyName (string): The policy name of the subscriber.

Sample Response¶

{
    "result": {
        "message": "Subscriber updated successfully"
    }
}

Get a Subscriber¶

This path returns the details of a specific network subscriber.

Method	Path
GET	`/api/v1/subscribers/{imsi}`

Parameters¶

None

Note: status.ipAddress is deprecated and will be removed in future versions. Prefer pdu_sessions[0].ipAddress.

Sample Response¶

{
  "result": {
    "imsi": "001010100007487",
    "policyName": "default",
    "status": {
      "registered": true,
      "ipAddress": "1.2.3.4",
      "imei": "359881234567890",
      "cipheringAlgorithm": "NEA1",
      "integrityAlgorithm": "NIA1",
      "lastSeenAt": "2026-03-16T12:34:56Z",
      "lastSeenRadio": "gNB-1"
    },
    "pdu_sessions": [
      {
        "status": "active",
        "ipAddress": "1.2.3.4"
      }
    ]
  }
}

Get Subscriber Credentials¶

This path returns the authentication credentials for a specific subscriber. The response includes the subscriber's permanent key, OPc, and sequence number. This is the preferred way to retrieve credentials and replaces the deprecated fields on the List and Get responses.

An audit log entry is created each time credentials are viewed.

Method	Path
GET	`/api/v1/subscribers/{imsi}/credentials`

Parameters¶

None

Sample Response¶

{
    "result": {
        "key": "5122250214c33e723a5dd523fc145fc0",
        "opc": "981d464c7c52eb6e5036234984ad0bcf",
        "sequenceNumber": "16f3b3f70fc7"
    }
}

Delete a Subscriber¶

This path deletes a subscriber from Ella Core.

Method	Path
DELETE	`/api/v1/subscribers/{imsi}`

Parameters¶

None

Sample Response¶

{
    "result": {
        "message": "Subscriber deleted successfully"
    }
}