SIM Cards V1

SIM Card operations

Get all SIM cards

Returns a list of all your sim cards

Request
query Parameters
page[number]
number

Current page based on pagination settings.

page[size]
number

Number of results to return per page based on pagination settings.

filter[sim_card_tags]
Array of strings

A list of SIM card tags to filter on.

filter[sim_card_id]
string <uuid>

A valid SIM card ID.

filter[sim_card_iccid]
string

A search string to partially match for the SIM card's ICCID.

filter[sim_card_group_id]
string <uuid>

A valid SIM card group ID.

filter[sim_card_group_name]
string

A search string to partially match for the SIM card's group.

Responses
200

Successful response

Response Schema: application/json
Array of objects (SIMCard)
object (Metadata)
401

Authentication error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

get/wireless/sim_cards
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "enabled": true,
      • "iccid": "string",
      • "id": "string",
      • "sim_card_group": {
        • "id": "string",
        • "data_allocation": "string",
        • "ingress_site_id": "string",
        • "egress_site_id": "string",
        • "created_at": "string",
        • "updated_at": "string"
        },
      • "tags": [
        • "string"
        ],
      • "updated_at": "string"
      }
    ],
  • "metadata": {
    • "total_pages": 13,
    • "total_results": 13,
    • "page_number": 3,
    • "page_size": 1
    }
}
Get SIM card
Returns the details regarding a specific SIM card.


Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the SIM card


 
Responses 
200
Successful response


Response Schema: application/json
object (SIMCard) 
 
enabled
boolean
Whether the SIM card is currently enabled or not


 
iccid
string
The ICCID of the given card


 
id
string
The id of the SIM card


 
object (SIMCardGroup) 
 
tags
Array of strings
The searchable tags associated with the SIM card


 
updated_at
string
Timestamp for when the SIM card was last updated


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
get/wireless/sim_cards/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "enabled": true,
    • "iccid": "string",
    • "id": "string",
    • "sim_card_group": {
      • "id": "string",
      • "data_allocation": "string",
      • "ingress_site_id": "string",
      • "egress_site_id": "string",
      • "created_at": "string",
      • "updated_at": "string"
      },
    • "tags": [
      • "string"
      ],
    • "updated_at": "string"
    }
}
Update SIM card
Updates a specific SIM card.


Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the SIM card


 
Request Body schema: application/json
required
SIM card update request


tags
Array of strings
A list of tags for the given SIM card.


 
enabled
boolean
Whether the SIM card should be enabled or disabled.


 
Responses 
200
Successful response


Response Schema: application/json
object (SIMCard) 
 
enabled
boolean
Whether the SIM card is currently enabled or not


 
iccid
string
The ICCID of the given card


 
id
string
The id of the SIM card


 
object (SIMCardGroup) 
 
tags
Array of strings
The searchable tags associated with the SIM card


 
updated_at
string
Timestamp for when the SIM card was last updated


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
patch/wireless/sim_cards/{id}
Request samples 
application/json
{
  • "tags": [
    • "string"
    ],
  • "enabled": true
}
Response samples 
application/json
{
  • "data": {
    • "enabled": true,
    • "iccid": "string",
    • "id": "string",
    • "sim_card_group": {
      • "id": "string",
      • "data_allocation": "string",
      • "ingress_site_id": "string",
      • "egress_site_id": "string",
      • "created_at": "string",
      • "updated_at": "string"
      },
    • "tags": [
      • "string"
      ],
    • "updated_at": "string"
    }
}
Get SIM card tags
A list of all the unique tags currently used across your SIM cards.


Responses 
200
Successful response


Response Schema: application/json
object (Tags) 
 
tags
Array of strings
 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
get/wireless/sim_cards/tags
Request samples 
Response samples 
application/json
{
  • "data": {
    • "tags": [
      • "string"
      ]
    }
}
Register SIM card
Register a SIM card code.


Request 
Request Body schema: application/json
required
SIM card update request


registration_codes
Array of strings
A list of SIM card registration codes.


 
sim_card_group_id
string <uuid> 
The SIM card group to which the provided SIM cards should be associated with after registration. If no ID is provided then the SIM cards will be registered to the default SIM card group.


 
tags
Array of strings
A list of tags to be applied to the SIM cards after registration.


 
Responses 
200
Successful response


Response Schema: application/json
object (RegistrationData) 
 
failed_registrations
Array of strings
 
successful_registrations
Array of strings
 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
post/wireless/sim_cards/actions/register
Request samples 
application/json
{
  • "registration_codes": [
    • "string"
    ],
  • "sim_card_group_id": "ca4fc7dc-162e-4665-a0ca-94e14f96f724",
  • "tags": [
    • "string"
    ]
}
Response samples 
application/json
{
  • "data": {
    • "failed_registrations": [
      • "string"
      ],
    • "successful_registrations": [
      • "string"
      ]
    }
}
Bulk update SIM cards
Bulk updates to perform on a list of SIM cards


Request 
Request Body schema: application/json
required
SIM card bulk update request


ids
Array of strings <uuid> 
A list of IDs for which the changes will apply to.


 
enabled
boolean
Whether the SIM card should be enabled or disabled.


 
sim_card_group_id
string <uuid> 
The SIM card group to which all the provided SIM card IDs will be moved to.


 
tags
Array of strings
A list of tags to apply to the provided SIM cards.


 
status
string
The SIM card status to which all the provided SIM card IDs will be moved to.


 Enum: "enabled" "disabled" "standby"  
authorized_imeis
Array of strings
A list of authorized IMEIs that will be applied to all the provided SIM cards.


 
Responses 
200
Successful response


Response Schema: application/json
failed_updates
Array of strings <uuid> 
 
object (UpdatedSimCard) 
 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
post/wireless/sim_cards/actions/bulk_update
Request samples 
application/json
{
  • "ids": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
  • "enabled": true,
  • "sim_card_group_id": "ca4fc7dc-162e-4665-a0ca-94e14f96f724",
  • "tags": [
    • "string"
    ],
  • "status": "enabled",
  • "authorized_imeis": [
    • "string"
    ]
}
Response samples 
application/json
{
  • "failed_updates": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
  • "successful_updates": {
    • "enabled": true,
    • "iccid": "string",
    • "id": "string",
    • "sim_card_group": {
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "name": "string"
      },
    • "tags": [
      • "string"
      ],
    • "updated_at": "string"
    }
}