Three lines

Uber

Developers

Get Sandbox Run

GEThttps://sandbox-api.uber.com/v1/health/sandbox/run/{run_id}

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

Retrieves the run’s test driver_ids to use in /v1/health/sandbox/driver-state. See Sandbox Guide for details on how to use interactive sandbox trips. Wait a minute after calling /v1/health/sandbox/run to use this.

Authorization

OAuth 2.0 Bearer token with the health scope.

Request Parameters
Name Type Description
run_id string A unique identifier of a sandbox create run request (required)
Example Request

Try It Replace the token in the below request to use it in a terminal to see the details. Note the runID will need to change and make sure to wait at least a minute after calling /v1/health/sandbox/run.

curl -X GET \
  -H "authorization: Bearer $UBER_TOKEN" \
  'https://sandbox-api.uber.com/v1/health/sandbox/run/REPLACERUNID'
Response Parameters
Name Type Description
run_id string A unique identifier of a sandbox create run request.
driver_ids array The list of driver IDs.
driver_ids[i] string The driver ID to use to change the driver’s state using /v1/health/sandbox/driver-state.
Example Responses
Example Accepted Trip Response
{
    "run_id": "4c11a40a-950a-4486-baf4-59858300190b",
    "driver_ids": [
      "actor_driver0",
      "actor_driver1"
    ]
}
Errors

A get run request can fail if the RunID is not found. This usually happens if you wait less than a minute after calling /v1/health/sandbox/run.

This can also happen if there’s a problem creating the run. Make sure that you use the correct parent_product_type_id for the pickup and dropoff locations with /v1/health/trips/estimates.

Also make sure that the driver locations are near the pickup point.

{
  "code": "entity_not_found",
  "message": "RunID is not valid"
}

In this scenario, run_id is critically failed and cannot be used, requiring the creation of a new one.

{
    "code": "internal_server_error",
    "message": "We have experienced a problem."
}

In this scenario, it is necessary to wait for the run to finish initializing, usually in 10 seconds, the driver will automatically be available ONLINE for 5 minutes and can receive trips.

{
    "message": "RunID interactive-2d73c91a-60f1-438f-82ed-57b3011c1ec1 on orchestrator is in state initialized",
    "metadata": {
        "statusCode": "400"
    },
    "code": "invalid_request_parameters"
}

Uber

Developers
© 2023 Uber Technologies Inc.