NEW: Get a FREE 30-day trial of OpsLevel. Sign up here.

Table of Contents
Getting Started
Ownership
Single Sign On
User Management
Service Maturity
Service Creation
Campaigns
Custom Actions
Checks
Insights
Integrations
Self Hosted
Roles

Manual inputs allow users to add contextual information to an action as it is being invoked. They are defined using YAML markup. 

Example manual inputs for provisioning an S3 bucket.

The schema supports two root level keys:

Description
version The schema version (current version: 1).
inputs A list of input objects.

See the Input Object Schema for more information.

Example:

  
---
version: 1
inputs:
  - identifier: bucketName
    displayName: Bucket Name
    description: The name of the S3 bucket that will be provisioned
    type: text_input
    required: true
    maxLength: 20
    defaultValue: my-bucket
    pattern: "^[\\w-]+$" # Note: the escaped backslash.
  - identifier: bucketDescription
    displayName: Bucket Description
    description: The description of the S3 bucket that will be provisioned
    type: text_area
    required: false
    placeholder: Enter the description
  - identifier: region
    displayName: AWS Region
    description: The AWS Region that the bucket will be provisioned in
    type: dropdown
    values:
    - us-west-1
    - us-west-2
    - us-east-1
    defaultValue: us-west-2
    required: true
  

Input object schema

Inputs support the following properties:

Required Description
identifier true Define how to reference the input’s value from the action’s context.
label true The input title displayed to the invoking user.
type true Supported types:
  • text_input: Short text values.
  • text_area: Long text values.
  • dropdown: List of pre-determined values.
defaultValue false The initial value for this input.
description false Additional information displayed to the invoking user.
maxLength false The invoking user will receive an error if they invoke the action with a value longer than maxLength.
pattern false The invoking user will receive an error if they attempt to submit an input which does not match this regular expression.

Note: Backslashes must be escaped. \w must be written as \\w
placeholder false The input placeholder displayed to the invoking user.

Note: Only available on inputs of type ‘text_input’ and ‘text_area’.
required false The invoking user will receive an error if they invoke the action without providing a value to this input.
sensitive false Indicates the field contains a sensitive value (e.g. a password). The value will be obfuscated when executing the action and when viewing the execution history.

Note: Only avaialbe on inputs of type `text_input`.
values false The select options available to the invoking user.

Note: Only available on inputs of type ‘dropdown’.