Telnyx API — Global IPs

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Global IPs
  description: 'Telnyx API — Global IPs. 20 operations. Lead operation: List all Global IP Allowed Ports. Self-contained Naftiko
    capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Global IPs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-global-ips
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Global IPs business capability. Self-contained, no shared references.
    resources:
    - name: global_ip_allowed_ports
      path: /global_ip_allowed_ports
      operations:
      - name: listglobalipallowedports
        method: GET
        description: List all Global IP Allowed Ports
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: global_ip_assignment_health
      path: /global_ip_assignment_health
      operations:
      - name: getglobalipassignmenthealth
        method: GET
        description: Global IP Assignment Health Check Metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in], filter[global_ip_assignment_id][in]'
    - name: global_ip_assignments
      path: /global_ip_assignments
      operations:
      - name: listglobalipassignments
        method: GET
        description: List all Global IP assignments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createglobalipassignment
        method: POST
        description: Create a Global IP assignment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: global_ip_assignments-id
      path: /global_ip_assignments/{id}
      operations:
      - name: deleteglobalipassignment
        method: DELETE
        description: Delete a Global IP assignment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getglobalipassignment
        method: GET
        description: Retrieve a Global IP
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateglobalipassignment
        method: PATCH
        description: Update a Global IP assignment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: global_ip_assignments_usage
      path: /global_ip_assignments_usage
      operations:
      - name: getglobalipassignmentusage
        method: GET
        description: Global IP Assignment Usage Metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[global_ip_assignment_id][in],
            filter[global_ip_id][in]'
    - name: global_ip_health_check_types
      path: /global_ip_health_check_types
      operations:
      - name: listglobaliphealthchecktypes
        method: GET
        description: List all Global IP Health check types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: global_ip_health_checks
      path: /global_ip_health_checks
      operations:
      - name: listglobaliphealthchecks
        method: GET
        description: List all Global IP health checks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createglobaliphealthcheck
        method: POST
        description: Create a Global IP health check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: global_ip_health_checks-id
      path: /global_ip_health_checks/{id}
      operations:
      - name: deleteglobaliphealthcheck
        method: DELETE
        description: Delete a Global IP health check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getglobaliphealthcheck
        method: GET
        description: Retrieve a Global IP health check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: global_ip_latency
      path: /global_ip_latency
      operations:
      - name: getglobaliplatency
        method: GET
        description: Global IP Latency Metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in]'
    - name: global_ip_protocols
      path: /global_ip_protocols
      operations:
      - name: listglobalipprotocols
        method: GET
        description: List all Global IP Protocols
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: global_ip_usage
      path: /global_ip_usage
      operations:
      - name: getglobalipusage
        method: GET
        description: Global IP Usage Metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in]'
    - name: global_ips
      path: /global_ips
      operations:
      - name: listglobalips
        method: GET
        description: List all Global IPs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createglobalip
        method: POST
        description: Create a Global IP
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: global_ips-id
      path: /global_ips/{id}
      operations:
      - name: deleteglobalip
        method: DELETE
        description: Delete a Global IP
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getglobalip
        method: GET
        description: Retrieve a Global IP
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-global-ips-rest
    port: 8080
    description: REST adapter for Telnyx API — Global IPs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/global-ip-allowed-ports
      name: global-ip-allowed-ports
      description: REST surface for global_ip_allowed_ports.
      operations:
      - method: GET
        name: listglobalipallowedports
        description: List all Global IP Allowed Ports
        call: telnyx-global-ips.listglobalipallowedports
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-assignment-health
      name: global-ip-assignment-health
      description: REST surface for global_ip_assignment_health.
      operations:
      - method: GET
        name: getglobalipassignmenthealth
        description: Global IP Assignment Health Check Metrics
        call: telnyx-global-ips.getglobalipassignmenthealth
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-assignments
      name: global-ip-assignments
      description: REST surface for global_ip_assignments.
      operations:
      - method: GET
        name: listglobalipassignments
        description: List all Global IP assignments
        call: telnyx-global-ips.listglobalipassignments
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createglobalipassignment
        description: Create a Global IP assignment
        call: telnyx-global-ips.createglobalipassignment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-assignments/{id}
      name: global-ip-assignments-id
      description: REST surface for global_ip_assignments-id.
      operations:
      - method: DELETE
        name: deleteglobalipassignment
        description: Delete a Global IP assignment
        call: telnyx-global-ips.deleteglobalipassignment
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getglobalipassignment
        description: Retrieve a Global IP
        call: telnyx-global-ips.getglobalipassignment
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateglobalipassignment
        description: Update a Global IP assignment
        call: telnyx-global-ips.updateglobalipassignment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-assignments-usage
      name: global-ip-assignments-usage
      description: REST surface for global_ip_assignments_usage.
      operations:
      - method: GET
        name: getglobalipassignmentusage
        description: Global IP Assignment Usage Metrics
        call: telnyx-global-ips.getglobalipassignmentusage
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-health-check-types
      name: global-ip-health-check-types
      description: REST surface for global_ip_health_check_types.
      operations:
      - method: GET
        name: listglobaliphealthchecktypes
        description: List all Global IP Health check types
        call: telnyx-global-ips.listglobaliphealthchecktypes
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-health-checks
      name: global-ip-health-checks
      description: REST surface for global_ip_health_checks.
      operations:
      - method: GET
        name: listglobaliphealthchecks
        description: List all Global IP health checks
        call: telnyx-global-ips.listglobaliphealthchecks
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createglobaliphealthcheck
        description: Create a Global IP health check
        call: telnyx-global-ips.createglobaliphealthcheck
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-health-checks/{id}
      name: global-ip-health-checks-id
      description: REST surface for global_ip_health_checks-id.
      operations:
      - method: DELETE
        name: deleteglobaliphealthcheck
        description: Delete a Global IP health check
        call: telnyx-global-ips.deleteglobaliphealthcheck
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getglobaliphealthcheck
        description: Retrieve a Global IP health check
        call: telnyx-global-ips.getglobaliphealthcheck
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-latency
      name: global-ip-latency
      description: REST surface for global_ip_latency.
      operations:
      - method: GET
        name: getglobaliplatency
        description: Global IP Latency Metrics
        call: telnyx-global-ips.getglobaliplatency
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-protocols
      name: global-ip-protocols
      description: REST surface for global_ip_protocols.
      operations:
      - method: GET
        name: listglobalipprotocols
        description: List all Global IP Protocols
        call: telnyx-global-ips.listglobalipprotocols
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ip-usage
      name: global-ip-usage
      description: REST surface for global_ip_usage.
      operations:
      - method: GET
        name: getglobalipusage
        description: Global IP Usage Metrics
        call: telnyx-global-ips.getglobalipusage
        with:
          filter: rest.filter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ips
      name: global-ips
      description: REST surface for global_ips.
      operations:
      - method: GET
        name: listglobalips
        description: List all Global IPs
        call: telnyx-global-ips.listglobalips
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createglobalip
        description: Create a Global IP
        call: telnyx-global-ips.createglobalip
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/global-ips/{id}
      name: global-ips-id
      description: REST surface for global_ips-id.
      operations:
      - method: DELETE
        name: deleteglobalip
        description: Delete a Global IP
        call: telnyx-global-ips.deleteglobalip
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getglobalip
        description: Retrieve a Global IP
        call: telnyx-global-ips.getglobalip
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-global-ips-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Global IPs. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-all-global-ip-allowed
      description: List all Global IP Allowed Ports
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.listglobalipallowedports
      outputParameters:
      - type: object
        mapping: $.
    - name: global-ip-assignment-health-check
      description: Global IP Assignment Health Check Metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.getglobalipassignmenthealth
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-global-ip-assignments
      description: List all Global IP assignments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.listglobalipassignments
      outputParameters:
      - type: object
        mapping: $.
    - name: create-global-ip-assignment
      description: Create a Global IP assignment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-global-ips.createglobalipassignment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-global-ip-assignment
      description: Delete a Global IP assignment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-global-ips.deleteglobalipassignment
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-global-ip
      description: Retrieve a Global IP
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.getglobalipassignment
      outputParameters:
      - type: object
        mapping: $.
    - name: update-global-ip-assignment
      description: Update a Global IP assignment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-global-ips.updateglobalipassignment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: global-ip-assignment-usage-metrics
      description: Global IP Assignment Usage Metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.getglobalipassignmentusage
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-global-ip-health
      description: List all Global IP Health check types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.listglobaliphealthchecktypes
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-global-ip-health-2
      description: List all Global IP health checks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.listglobaliphealthchecks
      outputParameters:
      - type: object
        mapping: $.
    - name: create-global-ip-health-check
      description: Create a Global IP health check
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-global-ips.createglobaliphealthcheck
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-global-ip-health-check
      description: Delete a Global IP health check
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-global-ips.deleteglobaliphealthcheck
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-global-ip-health-check
      description: Retrieve a Global IP health check
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.getglobaliphealthcheck
      outputParameters:
      - type: object
        mapping: $.
    - name: global-ip-latency-metrics
      description: Global IP Latency Metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.getglobaliplatency
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-global-ip-protocols
      description: List all Global IP Protocols
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.listglobalipprotocols
      outputParameters:
      - type: object
        mapping: $.
    - name: global-ip-usage-metrics
      description: Global IP Usage Metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.getglobalipusage
      with:
        filter: tools.filter
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-global-ips
      description: List all Global IPs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.listglobalips
      outputParameters:
      - type: object
        mapping: $.
    - name: create-global-ip
      description: Create a Global IP
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-global-ips.createglobalip
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-global-ip
      description: Delete a Global IP
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-global-ips.deleteglobalip
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-global-ip-2
      description: Retrieve a Global IP
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-global-ips.getglobalip
      outputParameters:
      - type: object
        mapping: $.