Skip to content
OTA-Pulse Docs

Get tunnel credential metadata

GET
/api/devices/{device_id}/tunnel-credential

Return the active tunnel credential METADATA for a device.

The raw secret is NEVER exposed by this endpoint. Only the prefix, timestamps and rotation_count are returned. Use the rotate endpoint to obtain a new raw token.

Returns 404 if the device does not belong to the organisation, or if the device has no active tunnel credential (e.g. provisioned before this feature was deployed).

Authorizations

Parameters

Path Parameters

device_id
required
string format: uuid

Query Parameters

organization_id
required
string format: uuid

Responses

200

Successful Response

Metadata for the active tunnel credential.

The raw secret is NEVER included; only non-sensitive fields are returned. Use the rotate endpoint to obtain a new secret.

object
created_at
required
string format: date-time
is_active
required
boolean
last_rotated_at
Any of:
string format: date-time
last_used_at
Any of:
string format: date-time
rotation_count
required
integer
token_prefix
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string