OPopal
paladin

Get Paladin by ID

Changed on

Returns a Paladin object.

get/paladin/{paladin_id}

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

paladin_idstring uuid required

The ID of the Paladin.

Response

The Paladin associated with the passed-in ID.

paladin_idstring uuid required

The ID of the Paladin. Use this value as a reviewer in a request configuration's service_user_ids.

namestring required

The name of the Paladin.

owner_idstring uuid required

The ID of the owner of the Paladin.

monitor_modeboolean required

When true, the Paladin reasons about requests but takes no action. Shown as "Monitor mode" in the UI.

admin_view_onlyboolean required

When true, the Paladin's recommendations are visible only to admins. Only meaningful when monitor_mode is true.

enabled_connectorsPaladinConnector[] required

The connectors the Paladin is allowed to use.

instructionsstring required

The free-form instructions that guide the Paladin's decisions.

Example response

{
  "paladin_id": "32acc112-21ff-4669-91c2-21e27683eaa1",
  "name": "paladin-agent-1",
  "owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "monitor_mode": true,
  "admin_view_only": false,
  "enabled_connectors": [
    "SLACK"
  ]
}

Changes

  • 5b5b5f694e25Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 13b58df96d40Revision changes
    • info

      endpoint added