Test Environment List

Get the details of the environments for a test.

Test Environment List

curl 'https://api.runscope.com/buckets/<bucket_key>/tests/<test_id>/environments' \
				-H 'Authorization: Bearer <access_token>'

Test Environment List Response Attributes

Attributes

authobject

The authentication settings for the test environment. Basic, OAuth 1.0, and short and extended OAuth 2.0 methods are supported.
Show/Hide Basic
- passwordstring
  
  Password for this authentication
- usernamestring
  
  User name for this authentication
- auth_typestring
  
  The authorization type for this authentication. Value is basic
Show/Hide OAuth 1.0
- consumer_keystring
  
  The Consumer Key used for asking the service for authorization
- consumer_secretstring
  
  The Consumer Secret used for asking the service for authorization
- access_tokenstring
  
  The token used for accessing the resource
- token_secretstring
  
  The secret that accompanies the access token
- signature_typestring
  
  Signature type. Value can be auth_header, query, or body
- auth_typestring
  
  The authorization type for this authentication. Value is oauth_1
Show/Hide OAuth 2.0 (short)
- access_tokenstring
  
  Value of the access token
- token_locationstring
  
  Location of the token. Value can be query or auth_header
- auth_typestring
  
  The authorization type for this authentication. Value is oauth_2
Show/Hide OAuth 2.0 (extended)
- Note: Not all parameters are mandatory. Only the parameters included in the payload are saved in the test Environment or Template. Parameters not included in the payload will show as "null" in the response.
- grant_typestring
  
  OAuth 2.0 grant type. Value can be authorization_code, authorization_code_pkce, implicit, password_credentials, or client_credentials
  
  Important! For Authorization Code, Authorization Code with PKCE, and Implicit grant types, you must add or register the API Monitoring Redirect URI, https://www.runscope.com/oauth2/callback, to the third-party authorization site. See Redirect URI Registration for details.
- access_tokenstring
  
  Value of the access token
- token_locationstring
  
  Location of the token. Value can be query or auth_header
- auth_urlstring
  
  Third-party authorization URL
- access_token_urlstring
  
  URL for the access token
- client_idstring
  
  The ID of the client
- client_secretstring
  
  The client secret
- code_challenge_methodstring
  
  Method for challenging code, either plain or S256. For PKCE grant type only. Default is SHA-256
- code_verifierstring
  
  The code verifier string generated by the app, if available. For PKCE grant type only
- passwordstring
  
  Password for third-party authorization
- usernamestring
  
  User name for third-party authorization
- scopestring
  
  The OAuth 2.0 scope string, if used
- statestring
  
  The OAuth 2.0 state string, if used
- client_authenticationstring
  
  Method of client authentication, either either sent in basic_auth_header or body. Default is basic_auth_header
- auth_typestring
  
  The authorization type for this authentication. Value is oauth_2
- refresh_tokenstring
  
  Value of the refresh token
- is_auto_refresh_tokenboolean
  
  Determines whether the refresh token is auto-generated
emailsobject

The email details for sending notifications for this test
Show/Hide Child Attributes
- notify_allboolean
  
  Send an email to all team members according to the notify_on rules
- notify_onstring
  
  Upon completion of a test run Runscope will send email notifications according to the following rules:
  - all — send an email for every test run completed
  - failures — send an email for every test run that fails
  - threshold — send an email only after notify_threshold failures
  - switch — send an email only after notify_threshold failures, and then once more when it begins passing again.
- notify_thresholdnull
  
  An integer between 1 and 10 for use with the notify_on settings: threshold and switch
- recipientsarray
  
  A list of team users to recieve emails according to the other settings
  Show/Hide Child Attributes
  
  emailstring
  
  The email of the user
  
  namestring
  
  The name of the user
  
  idstring
  
  The unique identifier of the user
initial_variablesobject

An object with the keys and values being used for variables when the test begins
Show/Hide Child Attributes
- variableNamestring
  
  The key contains the variable name (i.e. variableName) and the value is the value of the variable (i.e. some value)
integrationsarray

A list of integrations to enable for test runs using this environment
namestring

The name for this environment
parent_environment_idnull

The parent environment to inherit from, applies only to test-specific environments
preserve_cookiesboolean

If this is set to true, tests using this environment will manage cookies between steps
regionsarray

A list of API Monitoring regions to execute test runs in when using this environment
retry_on_failureboolean

If this is set to true, an additional test run will be triggered immediately after a failed scheduled test run
stop_on_failureboolean

If this is set to true, test runs will stop executing after the first step that fails. All subsequent steps will be skipped
remote_agentsarray

A list of remote agents to execute test runs in when using this environment
Show/Hide Child Attributes
- namestring
  
  The name of the remote agent
- uuidstring
  
  The unique identifier for the remote agent
scriptstring

The initial script to run before starting tests using this environment
test_idstring

The test this environment is associated with, applies only to test-specific environments
idstring

The unique ID for this environment
verify_sslboolean

If this is set to false, tests using this environment won't verify SSL certificates
client_certificatestring

Client certificate text available to be used in request authentication. PEM-encoded
webhooksarray

A list of URL's to send results to when test runs using this environment finish

Response200 OK

{
    "auth": {
        "password": "password",
        "username": "username",
        "auth_type": "basic"
    },
    "emails": {
        "notify_all": false,
        "notify_on": "all",
        "notify_threshold": null,
        "recipients": [
            {
                "email": "grace@example.com",
                "name": "Grace Hopper",
                "id": "4ee15ecc-7fe1-43cb-aa12-ef50420f2cf9"
            }
        ]
    },
    "initial_variables": {
        "my_variable": "some value",
        "one more": "values"
    },
    "integrations": [],
    "name": "Remote Settings",
    "parent_environment_id": null,
    "preserve_cookies": false,
    "regions": [
        "us1",
        "jp1"
    ],
    "retry_on_failure": false,
    "stop_on_failure": false,
    "remote_agents": [
        {
            "name": "my-local-machine.runscope.com",
            "uuid": "141d4dbc-1e41-401e-8067-6df18501e9ed"
        }
    ],
    "script": "var a = \"asdf\";\nlog(\"OK\");",
    "test_id": null,
    "id": "f8007150-0052-482c-9d52-c3ea4042e0f5",
    "verify_ssl": true,
    "client_certificate": "",
    "webhooks": [
        "http://api.example.com/webhook_reciever",
        "https://yourapihere.com/post"
    ]
}

Test Environment List

Test Environment List Response Attributes

Attributes

`auth`object

`emails`object

`initial_variables`object

`integrations`array

`name`string

`parent_environment_id`null

`preserve_cookies`boolean

`regions`array

`retry_on_failure`boolean

`stop_on_failure`boolean

`remote_agents`array

`script`string

`test_id`string

`id`string

`verify_ssl`boolean

`client_certificate`string

`webhooks`array

Test Environment List

Test Environment List Response Attributes

Attributes

authobject

passwordstring

usernamestring

auth_typestring

consumer_keystring

consumer_secretstring

access_tokenstring

token_secretstring

signature_typestring

auth_typestring

access_tokenstring

token_locationstring

auth_typestring

grant_typestring

access_tokenstring

token_locationstring

auth_urlstring

access_token_urlstring

client_idstring

client_secretstring

code_challenge_methodstring

code_verifierstring

passwordstring

usernamestring

scopestring

statestring

client_authenticationstring

auth_typestring

refresh_tokenstring

is_auto_refresh_tokenboolean

emailsobject

notify_allboolean

notify_onstring

notify_thresholdnull

recipientsarray

emailstring

namestring

idstring

initial_variablesobject

variableNamestring

integrationsarray

namestring

parent_environment_idnull

preserve_cookiesboolean

regionsarray

retry_on_failureboolean

stop_on_failureboolean

remote_agentsarray

namestring

uuidstring

scriptstring

test_idstring

idstring

verify_sslboolean

client_certificatestring

webhooksarray

`auth`object

`password`string

`username`string

`auth_type`string

`consumer_key`string

`consumer_secret`string

`access_token`string

`token_secret`string

`signature_type`string

`auth_type`string

`access_token`string

`token_location`string

`auth_type`string

`grant_type`string

`access_token`string

`token_location`string

`auth_url`string

`access_token_url`string

`client_id`string

`client_secret`string

`code_challenge_method`string

`code_verifier`string

`password`string

`username`string

`scope`string

`state`string

`client_authentication`string

`auth_type`string

`refresh_token`string

`is_auto_refresh_token`boolean

`emails`object

`notify_all`boolean

`notify_on`string

`notify_threshold`null

`recipients`array

`email`string

`name`string

`id`string

`initial_variables`object

`variableName`string

`integrations`array

`name`string

`parent_environment_id`null

`preserve_cookies`boolean

`regions`array

`retry_on_failure`boolean

`stop_on_failure`boolean

`remote_agents`array

`name`string

`uuid`string

`script`string

`test_id`string

`id`string

`verify_ssl`boolean

`client_certificate`string

`webhooks`array