Skip to main content
GET
/
api
/
v1
/
actions
/
{action_id}
Get action by ID
curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/actions/{action_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "name": "user:read",
  "description": "Read user information",
  "endpoint_count": 3
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
action_id
integer
required

Response

Action information retrieved successfully

Response model for action information.

​
id
integer
required

Unique identifier for the action

Example:

1

​
name
string
required

Action name

Example:

"user:read"

​
description
string | null

Action description

Example:

"Read user information"

​
endpoint_count
integer
default:0

Number of API endpoints mapped to this action

Example:

3