Get Device ID by Name

GET

///v1/parameter/device-id

Convert device hostname to device ID.

Args: device_name: The hostname/name of the device.

Returns: Device object with id and name.

Raises: HTTPException: If device not found or multiple devices match.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Query parameters

device_namestringRequired

Response

Successful Response

idstring

namestring

platformstring or null

Errors

422

Unprocessable Entity Error

$	curl -G /v1/parameter/device-id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d device_name=router-nyc-01