find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/telnyx:telnyx-private-wireless-gateways-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Telnyx Private Wireless Gateways API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Private Wireless Gateways across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Private Wireless Gateways
  description: Private Wireless Gateways operations
paths:
  /private_wireless_gateways:
    get:
      summary: Get all Private Wireless Gateways
      description: Get all Private Wireless Gateways belonging to the user.
      operationId: GetPrivateWirelessGateways
      tags:
      - Private Wireless Gateways
      parameters:
      - $ref: '#/components/parameters/wireless_PageNumber_c5290d5308'
      - $ref: '#/components/parameters/wireless_PageSize_c5290d5308'
      - name: filter[name]
        description: The name of the Private Wireless Gateway.
        in: query
        required: false
        schema:
          type: string
        example: my private gateway
      - name: filter[ip_range]
        description: The IP address range of the Private Wireless Gateway.
        in: query
        required: false
        schema:
          type: string
        example: 192.168.0.0/24
      - name: filter[region_code]
        description: The name of the region where the Private Wireless Gateway is deployed.
        in: query
        required: false
        schema:
          type: string
        example: dc2
      - name: filter[created_at]
        description: Private Wireless Gateway resource creation date.
        in: query
        required: false
        schema:
          type: string
        example: '2018-02-02T22:25:27.521Z'
      - name: filter[updated_at]
        description: When the Private Wireless Gateway was last updated.
        in: query
        required: false
        schema:
          type: string
        example: '2018-02-02T22:25:27.521Z'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/wireless_PrivateWirelessGateway'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
    post:
      x-latency-category: background
      summary: Create a Private Wireless Gateway
      description: Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. This operation may take several minutes so you can check the Private Wireless Gateway status at the section Get a Private Wireless Gateway.
      operationId: CreatePrivateWirelessGateway
      tags:
      - Private Wireless Gateways
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                network_id:
                  description: The identification of the related network resource.
                  format: uuid
                  type: string
                  example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
                name:
                  description: The private wireless gateway name.
                  type: string
                  example: My private wireless gateway
                region_code:
                  description: The code of the region where the private wireless gateway will be assigned. A list of available regions can be found at the regions endpoint
                  type: string
                  example: dc2
                address_mode:
                  description: Determines how IP addresses are assigned to SIM cards using this gateway. With static, each SIM card gets a fixed IP address from the gateway's IP range that is preserved across sessions. With dynamic, an IP address is assigned by the network at attach time and may change between sessions. If omitted, the gateway is created with the default address mode, dynamic.
                  type: string
                  enum:
                  - static
                  - dynamic
                  default: dynamic
                  example: static
              required:
              - network_id
              - name
      responses:
        '202':
          description: Creation request accepted. Provisioning is asynchronous; poll GET /private_wireless_gateways/{id} with the returned id to check status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/wireless_PrivateWirelessGateway'
                example:
                  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
                    address_mode: dynamic
                    region_code: dc2
                    status:
                      value: provisioning
                      error_description: null
                      error_code: null
                    ip_range: 100.64.1.0/24
                    assigned_resources:
                    - record_type: sim_card_group
                      count: 1
        '422':
          $ref: '#/components/responses/wireless_UnprocessableEntity_c5290d5308'
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /private_wireless_gateways/{id}:
    delete:
      summary: Delete a Private Wireless Gateway
      description: Permanently deletes the specified Private Wireless Gateway from your account.
      operationId: DeleteWirelessGateway
      tags:
      - Private Wireless Gateways
      parameters:
      - $ref: '#/components/parameters/PrivateWirelessGatewayId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/wireless_PrivateWirelessGateway'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
    get:
      summary: Get a Private Wireless Gateway
      description: Retrieve information about a Private Wireless Gateway.
      operationId: GetPrivateWirelessGateway
      tags:
      - Private Wireless Gateways
      parameters:
      - $ref: '#/components/parameters/PrivateWirelessGatewayId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/wireless_PrivateWirelessGateway'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  parameters:
    wireless_PageSize_c5290d5308:
      name: page[size]
      in: query
      description: The size of the page.
      schema:
        type: integer
        minimum: 1
        maximum: 250
        default: 20
    wireless_PageNumber_c5290d5308:
      name: page[number]
      in: query
      description: The page number to load.
      schema:
        type: integer
        minimum: 1
        default: 1
    PrivateWirelessGatewayId:
      name: id
      description: Identifies the private wireless gateway.
      in: path
      required: true
      schema:
        format: uuid
        type: string
        example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
    wireless_PageNumber:
      description: The page number to load.
      in: query
      name: page[number]
      schema:
        default: 1
        minimum: 1
        type: integer
    wireless_PageSize:
      description: The size of the page.
      in: query
      name: page[size]
      schema:
        default: 20
        maximum: 250
        minimum: 1
        type: integer
  schemas:
    documents_Error:
      required:
      - code
      - title
      properties:
        code:
          type: string
        title:
          type: string
        detail:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          additionalProperties: true
      type: object
    Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/billing-group_Error'
      type: object
    PaginationMeta:
      type: object
      properties:
        total_pages:
          type: integer
          example: 3
        total_results:
          type: integer
          example: 55
        page_number:
          type: integer
          example: 2
        page_size:
          type: integer
          example: 25
    PrivateWirelessGatewayStatus:
      type: object
      description: The current status or failure details of the Private Wireless Gateway.
      properties:
        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
          readOnly: true
          default: provisioning
          example: provisioned
        error_description:
          type:
          - string
          - 'null'
          description: This attribute provides a human-readable explanation of why a failure happened.
          readOnly: true
          default: null
          example: null
        error_code:
          type:
          - string
          - 'null'
          description: This attribute is an [error code](https://developers.telnyx.com/docs/development/api-fundamentals/api-errors) related to the failure reason.
          readOnly: true
          default: null
          example: null
    PWGAssignedResourcesSummary:
      type: object
      description: The summary of the resource that have been assigned to the Private Wireless Gateway.
      properties:
        record_type:
          type: string
          description: The type of the resource assigned to the Private Wireless Gateway.
          example: sim_card_group
          readOnly: true
        count:
          type: integer
          description: The current count of a resource type assigned to the Private Wireless Gateway.
          example: 1
          readOnly: true
    billing-group_Error:
      type: object
      required:
      - code
      - title
      properties:
        code:
          type: integer
          format: int32
        title:
          type: string
        detail:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          properties: {}
          additionalProperties: true
    wireless_PrivateWirelessGateway:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identifies the resource.
          readOnly: true
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        network_id:
          type: string
          format: uuid
          description: The identification of the related network resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        record_type:
          type: string
          readOnly: true
          example: private_wireless_gateway
        created_at:
          type: string
          description: ISO 8601 formatted date-time indicating when the resource was created.
          readOnly: true
          example: '2018-02-02T22:25:27.521Z'
        updated_at:
          type: string
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          readOnly: true
          example: '2018-02-02T22:25:27.521Z'
        name:
          description: The private wireless gateway name.
          type: string
          example: My private wireless gateway
        address_mode:
          description: The address mode of the private wireless gateway. With static, each SIM card gets a fixed IP address from the gateway's IP range that is preserved across sessions. With dynamic, IP addresses are assigned by the network at attach time and may change between sessions.
          type: string
          enum:
          - static
          - dynamic
          example: dynamic
        region_code:
          description: The name of the region where the Private Wireless Gateway is deployed.
          type: string
          example: dc2
          default: null
        status:
          $ref: '#/components/schemas/PrivateWirelessGatewayStatus'
        ip_range:
          type: string
          description: IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.
          example: 100.64.1.0/24
          readOnly: true
          default: null
        assigned_resources:
          type: array
          description: A list of the resources that have been assigned to the Private Wireless Gateway.
          items:
            $ref: '#/components/schemas/PWGAssignedResourcesSummary'
    PrivateWirelessGatewayStatus_2:
      description: The current status or failure details of the Private Wireless Gateway.
      properties:
        error_code:
          default: null
          description: This attribute is an [error code](https://developers.telnyx.com/development/api-fundamentals/api-errors) related to the failure reason.
          example: null
          readOnly: true
          type:
          - string
          - 'null'
        error_description:
          default: null
          description: This attribute provides a human-readable explanation of why a failure happened.
          example: null
          readOnly: true
          type:
          - string
          - 'null'
        value:
          default: provisioning
          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
          example: provisioned
          readOnly: true
          type: string
      type: object
    wireless_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/wireless_Error'
          type: array
      type: object
    PrivateWirelessGateway:
      properties:
        assigned_resources:
          description: A list of the resources that have been assigned to the Private Wireless Gateway.
          items:
            $ref: '#/components/schemas/PWGAssignedResourcesSummary'
          type: array
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: '2018-02-02T22:25:27.521Z'
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        ip_range:
          default: null
          description: IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.
          example: 100.64.1.0/24
          readOnly: true
          type: string
        name:
          description: The private wireless gateway name.
          example: My private wireless gateway
          type: string
        network_id:
          description: The identification of the related network resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        record_type:
          example: private_wireless_gateway
          readOnly: true
          type: string
        region_code:
          default: null
          description: The name of the region where the Private Wireless Gateway is deployed.
          example: dc2
          type: string
        status:
          $ref: '#/components/schemas/PrivateWirelessGatewayStatus_2'
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: '2018-02-02T22:25:27.521Z'
          readOnly: true
          type: string
      type: object
    wireless_Error:
      properties:
        code:
          type: string
        detail:
          type: string
        meta:
          additionalProperties: true
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
          type: object
        title:
          type: string
      required:
      - code
      - title
      type: object
    Errors_2:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      type: object
    Error:
      required:
      - code
      - title
      properties:
        code:
          type: string
          x-format: int64
        title:
          type: string
        detail:
          type: string
          description: A human-readable explanation of the error.
        description:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              format: json-pointer
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          additionalProperties: true
      example:
        title: Invalid street address
        source:
          pointer: /street_address
        code: '20207'
        description: The street address provided is invalid.
      type: object
  responses:
    wireless_GenericErrorResponse_c5290d5308:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          examples:
            unexpectedError:
              summary: Unexpected API error
              value:
                errors:
                - code: '10007'
                  title: Unexpected error
                  detail: An unexpected error occured.
    ResourceNotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/documents_Error'
    wireless_UnprocessableEntity_c5290d5308:
      description: Unprocessable entity. Check the 'detail' field in response for details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          examples:
            unprocessableEntity:
              summary: Request could not be processed
              value:
                errors:
                - code: '10027'
                  title: Unprocessable Entity
                  detail: The server understood the syntax of the request but was unable to process the instructions.
    wireless_GenericErrorResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wireless_Errors'
      description: Unexpected error
    CreatePrivateWirelessGatewayResponse:
      content:
        application/json:
          schema:
            example:
              data:
                assigned_resources:
                - count: 1
                  record_type: sim_card_group
                created_at: '2018-02-02T22:25:27.521Z'
                id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
                ip_range: 100.64.1.0/24
                name: My private wireless gateway
                network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
                record_type: private_wireless_gateway
                region_code: dc2
                status:
                  error_code: null
                  error_description: null
                  value: provisioning
                updated_at: '2018-02-02T22:25:27.521Z'
            properties:
              data:
                $ref: '#/components/schemas/PrivateWirelessGateway'
            type: object
      description: Successful Response
    wireless_UnprocessableEntity:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wireless_Errors'
      description: Unprocessable entity. Check the 'detail' field in response for details.
    wireless_ResourceNotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wireless_Error'
      description: Resource not found
    GetAllPrivateWirelessGatewaysResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/PrivateWirelessGateway'
                type: array
              meta:
                $ref: '#/components/schemas/PaginationMeta'
            type: object
      description: Successful Response
    DeletePrivateWirelessGatewayResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/PrivateWirelessGateway'
            type: object
      description: Successful Response
    GetPrivateWirelessGatewayResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/PrivateWirelessGateway'
            type: object
      description: Successful Response
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt