Skip to main content

Path parameters

Path parameters identify a specific resource inside a path.

Example​

GET /browsers/\{profile_key\}

Here, profile_key is a path parameter. Your code must replace it with a real BrowserBee identifier before sending the request.

Good practices​

  • store stable BrowserBee identifiers exactly as returned
  • URL-encode values if your HTTP client does not do it for you
  • build paths with trusted helper functions instead of string concatenation everywhere
  • log which identifier was used when a resource lookup fails

Common mistakes​

  • using a display name instead of the stable identifier
  • leaving placeholder braces in the final request path
  • putting the identifier in the query string instead of the path
  • reusing identifiers across environments without validation

Example in shell​

PROFILE_KEY="<PROFILE_KEY>"

curl --silent \
  --request GET \
  --header "Authorization: Bearer ${BROWSERBEE_API_TOKEN}" \
  --header "Accept: application/json" \
  "${BROWSERBEE_BASE_URL}/browsers/${PROFILE_KEY}"