Skip to content
OTA-Pulse Docs

Get the fleet's shell access policy (fleet alias)

GET
/api/fleets/{fleet_id}/access-policy
 
curl --request GET \
  --url https://example.com/api/fleets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/access-policy \
  --header 'Authorization: Bearer <token>'

Return the shell access policy for the fleet (organisation).

fleet_id is the organisation UUID. Alias for GET /organizations/{organization_id}/access-policy — same logic, same auth gates.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
fleet_id
required
Fleet Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
AccessPolicyResponse

Full shell access policy document for an organisation.

is_default is True when no row exists yet in shell_access_policy and the response represents the documented model defaults. Once a PUT has been issued, is_default is always False.

id is None when the response is a virtual defaults object (is_default=True).

object
additions_require_approval
required
Additions Require Approval
boolean
allowed_tiers
required
Allowed Tiers
Array<string>
breakglass_enabled
required
Breakglass Enabled
boolean
breakglass_notification_channels
required
Breakglass Notification Channels
Array<string>
breakglass_session_timeout_minutes
required
Breakglass Session Timeout Minutes
integer
created_at
Any of:
string format: date-time
current_usage_bytes
Any of:
integer
elevated_approval_mode
required
Elevated Approval Mode
string
elevated_approval_timeout_minutes
required
Elevated Approval Timeout Minutes
integer
elevated_session_timeout_minutes
required
Elevated Session Timeout Minutes
integer
has_webhook_secret
Has Webhook Secret
boolean
id
Any of:
string format: uuid
is_default
Is Default
boolean
max_concurrent_sessions
Any of:
integer
organization_id
required
Organization Id
string format: uuid
recording_retention_days
required
Recording Retention Days
integer
recording_storage_quota_bytes
Any of:
integer
standard_recording_enabled
required
Standard Recording Enabled
boolean
updated_at
Any of:
string format: date-time
webhook_url
Any of:
string
Example 
{
  "has_webhook_secret": false,
  "is_default": false
}

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}