Get the configuration of a test scenario

Retrieves the configuration of a test scenario

GET /manage/scenarios/{scenarioId}/config

URI Parameters

Name In Required Type Description

scenarioId

path

True

string

Version 4 UUID of the test scenario

Responses

Name Type Description

200 OK

ScenarioConfig

Object containing the configuration of the test scenario

404 Not Found

Null

New test scenarios do not have a configuration before the first configuration update

Produces

  • application/json

Security

Every request requires a JWT access token for authentication in the Authorisation HTTP header. Please see the API authentication page for details about how to get a JWT token.

Authorization: Bearer {JWT_TOKEN}

Roles

  • Wenenu Owner

  • Wenenu Contributor

  • Wenenu Reader

Sample request

GET https://wenenu.com/manage/scenarios/8a444458-3fc2-4019-94c0-5c1bd973d2d5/config HTTP/1.1
Authorization: Bearer {jwt_token}

Sample Response

Status code: 200

{
  "variables": [
    {
      "variable": "ssh-pwd",
      "value": "PTpUCvMIB3u1rgOCsGfx",
      "secret": false
    },
    {
      "variable": "db-pwd",
      "value": "AVeryHardToGuessOne100",
      "secret": false
    }
  ],
  "steps": [
    {
      "displayName": "Checking web health",
      "type": "http",
      "id": "2498f0fb-15ae-4528-827f-7f1917fabdb0",
      "host": "web1.example.com",
      "port": 443,
      "protocol": "https",
      "disableCertCheck": true,
      "method": "post",
      "endpoint": "/health",
      "body": "{type: \"full\"}",
      "headers": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "agent": {
        "type": "standard",
        "id": "162dff466f92c372005cf7055d006b77ac377e01c60ae59f942d74680f2496d1"
      }
    },
    {
      "displayName": "DB integrity check",
      "type": "ssh",
      "id": "5a7a08e0-e0cc-432b-9c4a-6d11895cf9bc",
      "host": "db1.example.com",
      "port": 22,
      "username": "testuser",
      "password": "testpassword",
      "command": "/bin/integrity-check.sh",
      "key": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFc==",
      "agent": {
        "type": "standard",
        "id": "162dff466f92c372005cf7055d006b77ac377e01c60ae59f942d74680f2496d1"
      }
    }
  ]
}

Definitions

ScenarioConfig

Name Type Required Description

variables

ConfigVariable[]

True

List of the variabled of the test scenario, length 0-200

steps

TestStepConfig[]
All of :
StartAsrStepConfig
StopAsrStepConfig
HttpStepConfig
SshStepConfig
DbStepConfig
PscoreStepConfig
BashStepConfig
DotnetcoreStepConfig
PhpStepConfig
PythonStepConfig
NodejsStepConfig

True

List of step objects of the test scenario, length 1-200

ConfigVariable

Name Type Required Description

variable

string

True

Name of the variable, alphanumeric with underscores and dashes, must start with a letter, regex pattern ^[a-zA-Z][a-zA-Z0-9_-]*$, length 1-64

value

string

True

Value of the variable, length 0-5120

secret

boolean

True

True if the variable is secret

StartAsrStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'asr'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

endStepId

string

True

Version 4 unique identifier of step that stops the ASR recovery plan

serviceConnectorId

string

True

Wenenu identifier of the Azure Service Principal service connector that is used to communicate with the Azure API

recoveryPlanId

string

True

Azure identifier of the ASR recovery plan that will be started in test failover mode, length 1-1024

vnetId

string

True

Azure identifier of the virtual network that will be the target for the recovery plan, length 1-1024

recoveryPointType

string

True

The recovery point type that will be used to start the recovery plan, possible values are Latest, LatestProcessed and LatestApplicationConsistent

subnetIds

string[]

True

List of the Azure subnet identifiers of the target virtual network in which Wenenu will place a test agent, max items 20, length of items 1-1024

StopAsrStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'stopasr'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

startStepId

string

True

Version 4 unique identifier of step that starts the ASR recovery plan

HttpStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'http'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

agent

Agent

True

Defines the agent that will execute the test step

host

string

True

Host of HTTP request, length 1-512

port

integer

True

Port of the HTTP request, 1-65535

protocol

string

True

Protocol of the HTTP request, possible values are 'http' and 'https'

disableCertCheck

boolean

False

If true, SSL certificate won’t be checked in the case of an HTTPS request

method

string

True

Method of the HTTP request, possible values are 'get', 'post', 'put', 'delete' and 'options'

endpoint

string

True

The endpoint of the HTTP request, length 1-512

body

string

True

Body of the HTTP request, length 0-4096

headers

HttpHeader[]

True

List of header objects, the defined headers will be sent with the HTTP request, items 0-40

HttpHeader

Name Type Required Description

key

string

True

Name of the http header, length 1-128, regex pattern ^[#!$%&'*+.`|^a-zA-Z0-9_-]*$

value

integer

True

Value of the http header, length 0-1024

SshStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'ssh'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

agent

Agent

True

Defines the agent that will execute the test step

host

string

True

Host of the SSH connection, length 1-512

port

integer

True

Port of the SSH connection, 1-65535

username

string

True

The username of the SSH connection, length 1-256

password

string

True

The password of the user or the SSH key, length 0-256

command

string

True

Command that will be executed on the host, length 0-512

key

string

True

BASE64 encoded SSH key that is used for the connection, length 0-5120

DbStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'db'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

agent

Agent

True

Defines the agent that will execute the test step

serverType

string

True

Type of the database server, possible values are 'mysql', 'postgresql', 'mssql' and 'oracle'

host

string

True

Host of the database server, length 1-512

port

integer

True

Port of the database server, 1-65535

dbName

string

True

Name of the database to connect to, length 0-256

dbUser

string

True

Username that is used for the connection, length 1-256

dbPassword

string

True

Password that is used for the connection, length 1-512

sql

string

True

SQL statement that is executed on the database server, , length 0-2048

PscoreStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'pscore'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

agent

Agent

True

Defines the agent that will execute the test step

version

string

True

Version of PowerShell Core that executes the script, possible values are '6' and '7'

code

string

True

Arbitrary code that gets executed, length 0-10240

BashStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'bash'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

agent

Agent

True

Defines the agent that will execute the test step

code

string

True

Arbitrary shell script that gets executed, length 0-10240

DotnetcoreStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'dotnetcore'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

agent

Agent

True

Defines the agent that will execute the test step

version

string

True

Version of .NET Core that executes the program, possible value is '3.1.x'

code

string

True

Arbitrary .NET program that gets executed, length 0-10240

PhpStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'php'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

agent

Agent

True

Defines the agent that will execute the test step

version

string

True

Version of PHP that executes the code, possible values are '5.6.x' and '7.4.x'

code

string

True

Arbitrary PHP code that gets executed, length 0-10240

PythonStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'python'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

agent

Agent

True

Defines the agent that will execute the test step

version

string

True

Version of Python that executes the code, possible values are '2.7.x' and '3.8.x'

code

string

True

Arbitrary Python code that gets executed, length 0-10240

NodejsStepConfig

Name Type Required Description

displayName

string

True

Display name of the test step, length 1-64

type

string

True

Type of the test step, must be 'nodejs'

id

string

True

Version 4 UUID of the test step, must be unique within a scenario configuration

agent

Agent

True

Defines the agent that will execute the test step

version

string

True

Version of NodeJS that executes the code, possible values are '8.17.x', '10.16.x' and '12.14.x'

code

string

True

Arbitrary Javascript code that gets executed, length 0-10240

Agent

Name Type Required Description

type

string

True

The type of the executing agent, possible values are
'standard' for self hosted agent,
'asr' for agents started by an Azure Site Recovery test step

id

string

True

Lenght 1-1024, Wenenu id of the test agent for 'standard' type, Azure subnet id in which the agent is started for 'asr' type

startStepId

string

False

The version 4 UUID of the Azure Site Recovery step that starts the agent, required for 'asr' type