OPopal
opal-scripts

Get OpalScript by name

Changed on

Returns the OpalScript whose name exactly matches the given name. OpalScript names are not unique; when more than one script matches, the request fails and the script must be referenced by ID instead.

get/opal-scripts/name/{opal_script_name}

Request

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

Path parameters

opal_script_namestring required

The name of the OpalScript.

Response

The OpalScript associated with the passed-in name.

opal_script_idstring uuid required

The ID of the OpalScript.

namestring required

The name of the OpalScript.

script_type'REQUEST_REVIEW' | 'REQUEST_DELEGATION_CONDITION' | 'CONTEXT_PROVIDER' | 'REQUEST_CONFIGURATION_CONDITION' required

The kind of automation an OpalScript performs.

scriptstring required

The source of the OpalScript's latest version.

versioninteger required

The version number of the OpalScript's latest version.

updated_atstring date-time

The date the OpalScript was last updated.

Example response

{
  "opal_script_id": "32acc112-21ff-4669-91c2-21e27683eaa1",
  "name": "MFA check",
  "script_type": "REQUEST_REVIEW",
  "version": 3
}

Changes