Skip to content
APIs
/Health API/Health

Health

Validate connectivity and credential metadata.

Operations

Validate API credentials.

Request

Returns metadata for the authenticated service user: org, environment, scopes, and label. Useful for testing connectivity and verifying your credentials are valid.

Security
BearerAuth
Headers
X-Org-Idstring, (uuid)required

Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.

X-Environmentstringrequired

Environment the call is scoped to. Resources are isolated per environment.

Enum:"beta""production"
curl -i -X GET \
  https://docs.deepcredentials.swiss/_mock/docs/openapi/health-v1/b2b/v1/health \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Environment: beta' \
  -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Success response

Bodyapplication/json
environmentstringrequired

Environment scoping the call (from X-Environment).

labelstringrequired

Human-readable label sourced from the JWT (e.g. preferred_username for service accounts).

org_idstring, (uuid)required

UUID v4 identifier.

Example:"550e8400-e29b-41d4-a716-446655440000"
scopesArray of stringsrequired

Scopes granted to this service user (from the JWT scope claim).

service_user_idstring, (uuid)required

UUID v4 identifier.

Example:"550e8400-e29b-41d4-a716-446655440000"
statusstringrequired

Always "ok" when the request is authenticated.

timestampstringrequired

Response time in RFC3339 UTC (for client logging and skew checks).

Response
{
  "environment": "string",
  "label": "string",
  "org_id": "550e8400-e29b-41d4-a716-446655440000",
  "scopes": [
    "string"
  ],
  "service_user_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "string",
  "timestamp": "string"
}