OPopal
paladin

Get Paladins by name

Changed on

Returns all Paladins whose name exactly matches the given name. Names are not unique, so the result is a list and may be empty.

get/paladin/name/{paladin_name}

Request

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

Path parameters

paladin_namestring required

The name of the Paladin.

Response

The list of Paladins matching the passed-in name.

Example response

{
  "results": [
    {
      "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