Create a Private Wireless Gateway
POST/private_wireless_gateways
Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network.
Request
- application/json
Body
required
The identification of the related network resource.
The private wireless gateway name.
Responses
202: Successful response
- application/json
- Schema
- Example (from schema)
Schema
provisioning
- the Private Wireless Gateway is being provisioned.provisioned
- the Private Wireless Gateway was provisioned and able to receive connections.failed
- the provisioning had failed for a reason and it requires an intervention.decommissioning
- the Private Wireless Gateway is being removed from the network.Array [
]
data
object
Identifies the resource.
The identification of the related network resource.
ISO 8601 formatted date-time indicating when the resource was created.
ISO 8601 formatted date-time indicating when the resource was updated.
The private wireless gateway name.
Default value: ashburn-va
The geographical region where the Private Wireless Gateway is deployed to.
status
object
The current status or failure details of the Private Wireless Gateway.
Possible values: [provisioning
, provisioned
, failed
, decommissioning
]
Default value: provisioning
The current status or failure details of the Private Wireless Gateway.
This attribute provides a human-readable explanation of why a failure happened.
This attribute is an error code related to the failure reason.
IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.
assigned_resources
object[]
A list of the resources that have been assigned to the Private Wireless Gateway
The type of the resource assigned to the Private Wireless Gateway
The current count of a resource type assigned to the Private Wireless Gateway
{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "private_wireless_gateway",
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z",
"name": "My private wireless gateway",
"region_code": "ashburn-va",
"status": {
"value": "provisioned",
"error_description": null,
"error_code": null
},
"ip_range": "100.64.1.0/24",
"assigned_resources": [
{
"record_type": "sim_card_group",
"count": 1
}
]
}
}
422: Unprocessable entity. Check the 'detail' field in response for details.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}