Skip to main content

Get a Private Wireless Gateway

GET 

/private_wireless_gateways/:id

Retrieve information about a Private Wireless Gateway.

Request

Path Parameters

    id uuidrequired

    Identifies the resource.

Responses

200: Successful response

Schema

    data

    object

    id uuid

    Identifies the resource.

    network_id uuid

    The identification of the related network resource.

    record_type string
    created_at string

    ISO 8601 formatted date-time indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date-time indicating when the resource was updated.

    name string

    The private wireless gateway name.

    region_code string

    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.

    value string

    Possible values: [provisioning, provisioned, failed, decommissioning]

    Default value: provisioning

    The current status or failure details of the Private Wireless Gateway.

    • 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.
    Transitioning between the provisioning and provisioned states may take some time.
    error_description string

    This attribute provides a human-readable explanation of why a failure happened.

    error_code string

    This attribute is an error code related to the failure reason.

    ip_range string

    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

  • Array [

  • record_type string

    The type of the resource assigned to the Private Wireless Gateway

    count integer

    The current count of a resource type assigned to the Private Wireless Gateway

  • ]

404: Resource not found

Schema

    code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...