Get all Private Wireless Gateways

v1.0.0

Get all Private Wireless Gateways belonging to the user.

Input

{
  "type": "object",
  "properties": {
    "filter[created_at]": {
      "type": "string"
    },
    "filter[ip_range]": {
      "type": "string"
    },
    "filter[name]": {
      "type": "string"
    },
    "filter[region_code]": {
      "type": "string"
    },
    "filter[updated_at]": {
      "type": "string"
    },
    "page[number]": {
      "type": "integer"
    },
    "page[size]": {
      "type": "integer"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "created_at": {
            "type": "string",
            "description": "ISO 8601 formatted date-time indicating when the resource was created."
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Identifies the resource."
          },
          "ip_range": {
            "type": "string",
            "description": "IP block used to assign IPs to the SIM cards in the Private Wireless Gateway."
          },
          "name": {
            "type": "string",
            "description": "The private wireless gateway name."
          },
          "network_id": {
            "type": "string",
            "format": "uuid",
            "description": "The identification of the related network resource."
          },
          "record_type": {
            "type": "string"
          },
          "region_code": {
            "type": "string",
            "description": "The geographical region where the Private Wireless Gateway is deployed to."
          },
          "status": {
            "type": "object",
            "description": "The current status or failure details of the Private Wireless Gateway.",
            "properties": {
              "error_code": {
                "type": "string",
                "description": "This attribute is an <a href=\"https://developers.telnyx.com/docs/api/v2/overview#errors\">error code</a> related to the failure reason."
              },
              "error_description": {
                "type": "string",
                "description": "This attribute provides a human-readable explanation of why a failure happened."
              },
              "value": {
                "type": "string",
                "description": "The current status or failure details of the Private Wireless Gateway. <ul>\n <li><code>provisioning</code> - the Private Wireless Gateway is being provisioned.</li>\n <li><code>provisioned</code> - the Private Wireless Gateway was provisioned and able to receive connections.</li>\n <li><code>failed</code> - the provisioning had failed for a reason and it requires an intervention.</li>\n <li><code>decommissioning</code> - the Private Wireless Gateway is being removed from the network.</li>\n </ul>\n Transitioning between the provisioning and provisioned states may take some time.",
                "enum": [
                  "provisioning",
                  "provisioned",
                  "failed",
                  "decommissioning"
                ]
              }
            }
          },
          "updated_at": {
            "type": "string",
            "description": "ISO 8601 formatted date-time indicating when the resource was updated."
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "page_number": {
          "type": "integer"
        },
        "page_size": {
          "type": "integer"
        },
        "total_pages": {
          "type": "integer"
        },
        "total_results": {
          "type": "integer"
        }
      }
    }
  }
}