> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ping

> Ping a device to check connectivity.

| Scope | Required |
| - | - |
| `devices:read` | Yes |


## OpenAPI

````yaml /references/platform-api/2026-10-28.yaml post /devices/{device_id}/ping
openapi: 3.0.3
info:
  title: Miru Platform API
  description: The API between Miru and any external client
  version: 2026-10-28.everglades
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  x-release-version: 2026-10-28.everglades
  x-git-commit:
    sha: da19e118a12d7f7069f89d7781c0085522789785
    url: >-
      https://github.com/mirurobotics/openapi/commit/da19e118a12d7f7069f89d7781c0085522789785
    message: >-
      chore(stlc): seal custom-code tracking files (#381)


      Automated by the stlc generate workflow: a push-to-main or manual

      `workflow_dispatch` publish re-sealed custom code, updating the tracking

      files under `sdkgen/*/stainless/custom-code/`. Publishing targets the

      private staging repos. Safe to merge - this PR's head branch

      `stlc/seal-tracking` is skipped by the generate workflow's skip-bot

      guard in `detect`, and on merge the push loop-breaker `guard` sees only

      custom-code changes and runs no rebuild.


      <!-- codesmith:footer -->

      ---

      <a

      href="https://app.blacksmith.sh/mirurobotics/codesmith/openapi/pr/381?autoLogin=true&ref=codesmith_pr_footer"><picture><source

      media="(prefers-color-scheme: dark)"

      srcset="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-dark-v3.svg"><source

      media="(prefers-color-scheme: light)"

      srcset="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-light-v3.svg"><img

      alt="View with [code]smith"

      src="https://pr-comments-assets.blacksmith.sh/codesmith/view-with-codesmith-dark-v3-3x.png"

      width="162" height="28"></picture></a> <a

      href="https://backend.blacksmith.sh/track/enable-autofix?expires=1795806796&installation_model_id=425273&pr_number=381&ref=codesmith_pr_footer&repository=mirurobotics%2Fopenapi&return_to=https%3A%2F%2Fgithub.com%2Fmirurobotics%2Fopenapi%2Fpull%2F381&signature=22576ca30b7a9b5179ba686401e8539245f08cdc1682091295fe21383a37f37a"><picture><source

      media="(prefers-color-scheme: dark)"

      srcset="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-dark.svg"><source

      media="(prefers-color-scheme: light)"

      srcset="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-light.svg"><img

      alt="Autofix with [code]smith"

      src="https://pr-comments-assets.blacksmith.sh/codesmith/autofix-with-codesmith-dark-3x.png"

      width="190" height="28"></picture></a>

      <sup>Need help on this PR? Tag <code>@codesmith</code> with what you

      need.</sup>


      <!-- codesmith:autofix:disabled -->

      <!-- /codesmith:footer -->


      Co-authored-by: stlc-sealback-bot[bot]
      <298483487+stlc-sealback-bot[bot]@users.noreply.github.com>

      Co-authored-by: Ben <ben@mirurobotics.com>
    author: stlc-sealback-bot[bot]
    branch: HEAD
    dirty: false
  x-build:
    built_at: '2026-10-28T22:21:18.805528+00:00'
servers:
  - url: https://api.mirurobotics.com/beta
    description: Miru Platform API
security:
  - ApiKeyAuth: []
paths:
  /devices/{device_id}/ping:
    parameters:
      - $ref: '#/components/parameters/MiruVersion'
    post:
      tags:
        - Devices
      summary: Ping
      description: Ping a device to check connectivity.
      operationId: pingDevice
      parameters:
        - $ref: '#/components/parameters/device_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PingDeviceRequest'
      responses:
        '200':
          description: Successfully pinged the device.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingDeviceResponse'
components:
  parameters:
    MiruVersion:
      name: Miru-Version
      in: header
      required: true
      schema:
        type: string
        example: 2026-10-28.everglades
      description: The API version the client was built against.
    device_id:
      name: device_id
      in: path
      required: true
      description: The unique identifier of the device.
      schema:
        type: string
        example: dvc_123
  schemas:
    PingDeviceRequest:
      title: Ping Device Request
      type: object
      required:
        - timeout_nanos
      properties:
        timeout_nanos:
          type: integer
          format: int64
          example: 1000000000
          description: >-
            The timeout in nanoseconds to wait for the ping operation to
            complete. The maximum timeout is 10 seconds.
    PingDeviceResponse:
      title: Ping Device
      type: object
      required:
        - code
      properties:
        code:
          $ref: '#/components/schemas/PingResult'
        round_trip_nanos:
          type: integer
          format: int64
          example: 1000000000
          description: >-
            The round trip time in nanoseconds to send the ping to the device
            and receive the response. Only present when `code` is `success`.
      example:
        code: success
        round_trip_nanos: 1000000000
    PingResult:
      type: string
      enum:
        - success
        - timeout
      x-enum-varnames:
        - PING_RESULT_SUCCESS
        - PING_RESULT_TIMEOUT
      description: The result of the ping operation.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: The API key to use for authentication.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.