NAV Navbar
Home Functional Performance Mock Services API Monitoring
cURL
  • Introduction
  • Accounts
  • Workspaces
  • Projects
  • Tests
  • Test Suites
  • Test Runs
  • Test Results
  • Shared Folders
  • Test Scheduler
  • Private Locations
  • Appendix
  • Introduction

    Welcome to the Functional section of the BlazeMeter API reference! This section will cover the APIs used for creating, updating, and running Functional tests, as well as getting the functional test results, handling shared folders, and scheduling tests to run those tests.

    This API reference uses the following conventions for your convenience:

    Overview

    Your Account provides access to different levels of the API:

    The following figure illustrates the relationship between the levels.

    Basics

    Request Format

    All requests to the API are sent over HTTPS and use the following base URL:

    https://a.blazemeter.com/api/v4

    Response Format

    {
      "limit": ...,
      "skip": ...,
      "total": ...,
      "hidden": ...,
      "api_version": ...,
      "error": {...} or null,
      "result": {...} or [...]
    }
    

    Responses are returned as JSON data in the format shown to the right. A description of the attributes can be found below:

    Attributes

    Reading the Attribute Tables

    Below is a list of the various tags that are present in the attribute tables and what they represent:

    Attribute Tag Description

    required

    This indicates that this attribute is required for any POST requests

    read-only

    This indicates that this attribute is not edittable (either through POST, PATCH, or PUT)

    Result List Only

    Indicates that this attribute appears for APIs that return lists

    Multi Test Only

    Indicates that this attribute is used for multi test or collection object only

    Test Only

    Indicates that this attribute is used for test object only

    Shared Type Only

    Indicates that this attribute is only available to Shared private location type

    Legacy Only

    Indicates that this attribute is only available for legacy BlazeMeter users

    Exclusive

    Indicates that this attribute cannot be used in conjunction with another Exclusive attribute

    Authorization Using Basic Authentication

    Authorization

    curl 'https://a.blazemeter.com/api/v4/user' \
        --user 'api_key_id:api_key_secret'
    

    Response 200 OK

    {
      "api_version": 4,
      "error": null,
      "result": {
        "id": 123456,
        "email": "my.name@my_email.com",
        "access": 1522676762,
        "login": 1521724222,
        "firstName": "my",
        "lastName": "name",
        "timezone": 0,
        "enabled": true,
        "roles": [
          "user",
          "new-billing",
          "authenticated"
        ]
        }
      }
    }
    

    API Explorer: /user

    To use the BlazeMeter API, pass your BlazeMeter API key using Basic Authentication (Basic Auth) credentials. These credentials contain a Key ID and a Secret Key:

    id:secret

    For example: f817e22f1526b048799f75da:7641251982b983cfd92b5a25fa97cd3ee9e21920f21d8b14cd705831826935723f3033f0

    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. In the code sample, replace 'api_key_id:api_key_secret' with your credentials.

    Create the API Key

    Use the linked BlazeMeter article to create your API key.

    Accounts

    This section goes over how to handle account administration and see what functionalities you have access to.

    To run these APIs, you will need the accountId for the account you are wanting to look into, and your user will need to have account admin access to run these APIs.

    Add User to Account

    Add User to Account

    curl 'https://a.blazemeter.com/api/v4/accounts/123456/invitations' \
        -X POST \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"invitations":[{"inviteeEmail":"myName@myDomain.com","attachAutomatically":true,"accountRoles":["standard"],"workspacesId":[123456],"workspacesRoles":["tester"]}]}'
    

    API Explorer: /accounts/{accountId}/invitations

    To add a user, you need the accountId of the account you want to add the user to and use an API key that has account admin access. For the sample code on the right, accountId 123456 has added user myName@myDomain.com to the account automatically (skipping the invitation link process). To add a user to your account, replace the accountId 123456 with the accountId of your account, the workspaceId attribute with the workspaceId of your workspace. This user will be given the account role of Standard and the workspace role of Tester.

    Add User to Account Request Attributes

    The following JSON sample provides a more readable version of the content contained in the above curl example. This example represents the attributes and values contained in the -d flag of the curl example.

    Add User to Account Add User to Account POST Body (JSON)

    {
      "invitations": [
        {
          "inviteeEmail": "myName@myDomain.com",
          "attachAutomatically": true,
          "accountRoles": [
            "standard"
          ],
          "workspacesId": [
            123456
          ],
          "workspacesRoles": [
            "tester"
          ]
        }
      ]
    }
    

    Attributes

    Add User to Account Response Attributes

    Response 201 Created

    {
        "api_version": 4,
        "error": null,
        "result": [
            {
                "id": "5dc096abb7103a3c3f284b15",
                "inviteeEmail": "myName@myDomain.com",
                "token": "E0SC2x7U54bn",
                "accountRoles": [
                    "standard"
                ],
                "workspacesRoles": [
                    "tester"
                ],
                "attachAutomatically": true,
                "created": 1572902571,
                "updated": 1572902571,
                "accountId": 123456,
                "inviteeUserId": 234567,
                "invitedById": 123456,
                "workspacesId": [
                    123456
                ],
                "accountName": "My Account",
                "acceptUrl": "https://a.blazemeter.com/api/v4/accounts/123456/invitations/5dc096abb7103a3c3f284b15/accept/E0SC2x7U54bn",
                "rejectUrl": "https://a.blazemeter.com/api/v4/accounts/123456/invitations/5dc096abb7103a3c3f284b15/reject/E0SC2x7U54bn",
                "invitingEmail": "adminUser@myDomain.com",
                "invitingName": "Admin User"
            }
        ],
        "request_id": "5dc096ab2c16d"
    }
    

    Attributes

    List Account Invitations

    List Account Invitations

    curl 'https://a.blazemeter.com/api/v4/accounts/123456/invitations' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /accounts/{accountId}/invitations

    To list the account invitations, you need the accountId of the account you want to get the list of invitations and use an API key that has account admin access. For the sample code on the right, a list of invitations for accountId 123456 is provided. To get a list of invitations for your account, replace the accountId 123456 with the accountId of your account.

    Add User to Account Response Attributes

    Response 200 OK

    {
        "limit": 10,
        "skip": 0,
        "total": 1,
        "hidden": 0,
        "api_version": 4,
        "error": null,
        "result": [{
            "id": "5eea89603e7ad67f5d35cbf7",
            "inviteeEmail": "travis.lloyd+test@broadcom.com",
            "token": "4p8M0gseEpHr",
            "accountRoles": [
                "standard"
            ],
            "workspacesRoles": [
                "tester"
            ],
            "attachAutomatically": false,
            "created": 1592428896,
            "updated": 1592428896,
            "accountName": "Travis's Account",
            "acceptUrl": "https://a.blazemeter.com/api/v4/accounts/130010/invitations/5eea89603e7ad67f5d35cbf7/accept/4p8M0gseEpHr",
            "rejectUrl": "https://a.blazemeter.com/api/v4/accounts/130010/invitations/5eea89603e7ad67f5d35cbf7/reject/4p8M0gseEpHr",
            "invitingEmail": "travis.lloyd@broadcom.com",
            "invitingName": "Travis Lloyd",
            "workspaceNames": [
                "Default workspace"
            ]
        }],
        "request_id": "5eea8978ea87b"
    }
    

    Attributes

    Account User List

    Account User List

    curl 'https://a.blazemeter.com/api/v4/accounts/123456/users' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /accounts/{accountId}/users

    To return a list of the account users, an accountId is required. The sample code returns a list of users within accountId of 123456. Use the actual ID value for the account to return the list of the users in your account.

    Account User List Parameters

    Parameters


    Also see: Pagination

    Account User List Response Attributes

    Response 200 OK

    {
        "limit": 10,
        "skip": 0,
        "total": 2,
        "hidden": 0,
        "api_version": 4,
        "error": null,
        "result": [
            {
                "id": 123456,
                "email": "owner@myDomain.com",
                "displayName": "Owner Name",
                "firstName": "Owner",
                "lastName": "Name",
                "login": 1573145246,
                "access": 1573227166,
                "roles": [
                    "admin",
                    "owner"
                ],
                "enabled": true,
                "lastAccess": 1573227166
            },
            {
                "id": 234567,
                "email": "standard@myDomain.com",
                "displayName": "Standard Name",
                "firstName": "Standard",
                "lastName": "Name",
                "login": 1506347921,
                "access": 1520965347,
                "roles": [
                    "standard"
                ],
                "enabled": false,
                "lastAccess": 1520965347,
                "type": "account"
            }
        ],
        "request_id": "5dc58b956e81b"
    }
    

    Attributes

    Update Account User

    Update Account User

    curl 'https://a.blazemeter.com/api/v4/accounts/123456/users/123456' \
        -X PUT \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"roles":["user_manager"],"enabled": false}'
    

    API Explorer: /accounts/{accountId}/users/{userId}

    To change a user's account role or disable or enable a user, an accountId and userId are required. The sample code changes the userId of 123456 account role within accountId of 123456 to user_manager and disables the user in the account. Use the actual ID value for the account and user you are wanting to change.

    Update Account User Request Attributes

    The following JSON sample provides a more readable version of the content contained in the above curl example. This example represents the attributes and values contained in the -d flag of the curl example.

    Update Account User Update Account User PUT Body (JSON)

    {
      "roles": [
        "user_manager"
        ],
      "enabled": false
    }
    

    Attributes

    Update Account User Response Attributes

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 123456,
            "roles": [
                "user_manager"
            ],
            "enabled": false,
            "lastAccess": 1573229467,
            "type": "account",
            "displayName": "My Name",
            "login": 1573145246,
            "email": "my.name@domain.com"
        },
        "request_id": "5dc5939bd8286"
    }
    

    For a breakdown of the response attributes, see the Add User to Account Response Attributes section.

    Account Engine Utilization Report

    Account Engine Utilization Report

    curl 'https://a.blazemeter.com/api/v4/accounts/123456/utilization-report' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /accounts/{accountId}/utilization-report

    To the engine utilizataion report for your account, you need the accountId of the account to get the engine utilizataion report and use an API key that has account admin access. For the sample code on the right, a the engine utilizataion report for accountId 123456 is provided. To get the engine utilizataion report for your account, replace the accountId 123456 with the accountId of your account.

    Account Engine Utilization Report Response Attributes

    Response 200 OK

    {
      "api_version": 4,
      "error": null,
      "result": {
        "workspaces": [
          {
            "id": 123456,
            "name": "Default workspace"
          }
        ],
        "locations": {
          "us-west1-a": {
            "id": "us-west1-a",
            "name": "US West (Oregon, Google)",
            "engines": 1
          },
          "harbor-5b0323b3c648be3b4c7b23c8": {
            "id": "harbor-5b0323b3c648be3b4c7b23c8",
            "name": "Example Private Location",
            "engines": 1
          },
          "us-east1-b": {
            "id": "us-east1-b",
            "name": "US East (South Carolina, Google)",
            "engines": 1
          }
        }
      },
      "request_id": "5eeb989011d5f"
    }
    

    Attributes

    Account Functionalities List

    Account Functionalities List

    curl 'https://a.blazemeter.com/api/v4/accounts/123456/functionalities' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /accounts/{accountId}/fucntionalities

    To return a list of the account functionalities supported, an accountId is required. The sample code returns a list of functionalities within accountId of 123456. Use the actual ID value for the account to return the list of functionalities in your account.

    Account Functionalities List Response Attributes

    Response 200 OK

    
    {
        "api_version": 4,
        "error": null,
        "result": {
            "additionalSpace": 50,
            "functionalities": [
                {
                    "funcId": "performance",
                    "size": 5,
                    "displayName": "Performance"
                },
                {
                    "funcId": "functionalApi",
                    "size": 0,
                    "displayName": "API Testing"
                },
                {
                    "funcId": "proxyRecorder",
                    "size": 1,
                    "displayName": "Proxy Recorder"
                },
                {
                    "funcId": "mockServices",
                    "size": 1,
                    "displayName": "Mock Services"
                },
                {
                    "funcId": "functionalGui",
                    "size": 0,
                    "displayName": "GUI Functional",
                    "subFunctionalities": [
                        {
                            "id": "firefox:76",
                            "size": 2,
                            "displayName": "Firefox 76",
                            "default": false
                        },
                        {
                            "id": "firefox:75",
                            "size": 2,
                            "displayName": "Firefox 75",
                            "default": false
                        },
                        {
                            "id": "firefox:74",
                            "size": 2,
                            "displayName": "Firefox 74",
                            "default": false
                        },
                        {
                            "id": "firefox:73",
                            "size": 2,
                            "displayName": "Firefox 73",
                            "default": false
                        },
                        {
                            "id": "firefox:72",
                            "size": 2,
                            "displayName": "Firefox 72",
                            "default": false
                        },
                        {
                            "id": "firefox:71",
                            "size": 2,
                            "displayName": "Firefox 71",
                            "default": false
                        },
                        {
                            "id": "firefox:70",
                            "size": 2,
                            "displayName": "Firefox 70",
                            "default": false
                        },
                        {
                            "id": "firefox:69",
                            "size": 2,
                            "displayName": "Firefox 69",
                            "default": false
                        },
                        {
                            "id": "firefox:68",
                            "size": 2,
                            "displayName": "Firefox 68",
                            "default": false
                        },
                        {
                            "id": "firefox:67",
                            "size": 2,
                            "displayName": "Firefox 67",
                            "default": false
                        },
                        {
                            "id": "firefox:66",
                            "size": 2,
                            "displayName": "Firefox 66",
                            "default": false
                        },
                        {
                            "id": "firefox:65",
                            "size": 2,
                            "displayName": "Firefox 65",
                            "default": true
                        },
                        {
                            "id": "firefox:64",
                            "size": 2,
                            "displayName": "Firefox 64",
                            "default": false
                        },
                        {
                            "id": "firefox:63",
                            "size": 2,
                            "displayName": "Firefox 63",
                            "default": false
                        },
                        {
                            "id": "firefox:62",
                            "size": 2,
                            "displayName": "Firefox 62",
                            "default": false
                        },
                        {
                            "id": "firefox:61",
                            "size": 2,
                            "displayName": "Firefox 61",
                            "default": false
                        },
                        {
                            "id": "firefox:60",
                            "size": 2,
                            "displayName": "Firefox 60",
                            "default": false
                        },
                        {
                            "id": "firefox:59",
                            "size": 2,
                            "displayName": "Firefox 59",
                            "default": false
                        },
                        {
                            "id": "chrome:81",
                            "size": 2,
                            "displayName": "Chrome 81",
                            "default": false
                        },
                        {
                            "id": "chrome:80",
                            "size": 2,
                            "displayName": "Chrome 80",
                            "default": false
                        },
                        {
                            "id": "chrome:79",
                            "size": 2,
                            "displayName": "Chrome 79",
                            "default": false
                        },
                        {
                            "id": "chrome:78",
                            "size": 2,
                            "displayName": "Chrome 78",
                            "default": false
                        },
                        {
                            "id": "chrome:77",
                            "size": 2,
                            "displayName": "Chrome 77",
                            "default": false
                        },
                        {
                            "id": "chrome:76",
                            "size": 2,
                            "displayName": "Chrome 76",
                            "default": false
                        },
                        {
                            "id": "chrome:75",
                            "size": 2,
                            "displayName": "Chrome 75",
                            "default": false
                        },
                        {
                            "id": "chrome:74",
                            "size": 2,
                            "displayName": "Chrome 74",
                            "default": false
                        },
                        {
                            "id": "chrome:73",
                            "size": 2,
                            "displayName": "Chrome 73",
                            "default": false
                        },
                        {
                            "id": "chrome:72",
                            "size": 2,
                            "displayName": "Chrome 72",
                            "default": false
                        },
                        {
                            "id": "chrome:71",
                            "size": 2,
                            "displayName": "Chrome 71",
                            "default": false
                        },
                        {
                            "id": "chrome:70",
                            "size": 2,
                            "displayName": "Chrome 70",
                            "default": false
                        },
                        {
                            "id": "chrome:69",
                            "size": 2,
                            "displayName": "Chrome 69",
                            "default": true
                        },
                        {
                            "id": "chrome:68",
                            "size": 2,
                            "displayName": "Chrome 68",
                            "default": false
                        },
                        {
                            "id": "chrome:67",
                            "size": 2,
                            "displayName": "Chrome 67",
                            "default": false
                        },
                        {
                            "id": "chrome:66",
                            "size": 2,
                            "displayName": "Chrome 66",
                            "default": false
                        },
                        {
                            "id": "chrome:65",
                            "size": 2,
                            "displayName": "Chrome 65",
                            "default": false
                        },
                        {
                            "id": "firefox:default",
                            "size": 2,
                            "displayName": "Firefox Default",
                            "default": true
                        },
                        {
                            "id": "chrome:default",
                            "size": 2,
                            "displayName": "Chrome Default",
                            "default": true
                        }
                    ]
                },
                {
                    "funcId": "sv-bridge",
                    "size": 1,
                    "displayName": "Service Virtualization Bridge"
                }
            ]
        },
        "request_id": "5ee7b73b003a6"
    }
    

    Attributes

    Workspaces

    This section goes over how to handle workspace administration (i.e. changing user roles, enabling/disabling users, etc.) for your BlazeMeter workspace.

    To run these APIs, you will need the workspaceId for the workspace you are wanting to handle the administration, and your user will need to have workspace manager access to run these APIs.

    The Workspace Object

    The Workspace Object

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 123456,
            "name": "Default workspace",
            "userId": 123456,
            "created": 1488987561,
            "updated": 1573503519,
            "enabled": true,
            "dedicatedIpsEnabled": true,
            "privateLocationsEnabled": true,
            "owner": {
                "id": 123456,
                "email": "my.user@myDomain.com",
                "displayName": "My User"
            },
            "membersCount": 7,
            "allowance": {
                "amount": 17678,
                "type": "credits"
            },
            "accountId": 123456,
            "locations": [
                {
                    "id": "harbor-5591335d8588531f5cde3a04",
                    "title": "Sandbox",
                    "name": "Sandbox",
                    "provider": "Sandbox",
                    "limits": {
                        "threadsPerEngine": 20,
                        "concurrency": 20,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": true,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-east4-a",
                    "title": "US East (Virginia, Google)",
                    "name": "US East (Virginia)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-east1-b",
                    "title": "US East (South Carolina, Google)",
                    "name": "US East (South Carolina)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-west1-a",
                    "title": "US West (Oregon, Google)",
                    "name": "US West (Oregon)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-central1-a",
                    "title": "US Central (Iowa, Google)",
                    "name": "US Central (Iowa)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "northamerica-northeast1-a",
                    "title": "Canada East (Montreal, Google)",
                    "name": "Canada East (Montreal)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "europe-west2-a",
                    "title": "EU West (London, Google)",
                    "name": "EU West (London)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "europe-west3-a",
                    "title": "EU West (Frankfurt, Google)",
                    "name": "EU West (Frankfurt)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "europe-west1-b",
                    "title": "EU West (Belgium, Google)",
                    "name": "EU West (Belgium)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "europe-west4-b",
                    "title": "EU West (Netherlands, Google)",
                    "name": "EU West (Netherlands)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-east1-a",
                    "title": "Asia East (Taiwan, Google)",
                    "name": "Asia East (Taiwan)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-northeast1-a",
                    "title": "Asia Northeast (Japan, Google)",
                    "name": "Asia Northeast (Japan)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-southeast1-a",
                    "title": "Asia Southeast (Singapore, Google)",
                    "name": "Asia Southeast (Singapore)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-south1-a",
                    "title": "Asia South (Mumbai, Google)",
                    "name": "Asia South (Mumbai)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "australia-southeast1-a",
                    "title": "Australia (Sydney, Google)",
                    "name": "Australia (Sydney)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "southamerica-east1-a",
                    "title": "Brazil (Sao Paulo, Google)",
                    "name": "Brazil (Sao Paulo)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-northeast2-a",
                    "title": "Japan (Osaka, Google)",
                    "name": "Japan (Osaka)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-west2-a",
                    "title": "US West (California, Google)",
                    "name": "US West (California)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-east-1",
                    "title": "US East (Virginia, AWS)",
                    "name": "US East (Virginia)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-east-2",
                    "title": "US East (Ohio, AWS)",
                    "name": "US East (Ohio)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-west-1",
                    "title": "US West (N.California, AWS)",
                    "name": "US West (N.California)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-west-2",
                    "title": "US West (Oregon, AWS)",
                    "name": "US West (Oregon)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ca-central-1",
                    "title": "Canada (Central, AWS)",
                    "name": "Canada (Central)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "eu-west-1",
                    "title": "EU West (Ireland, AWS)",
                    "name": "EU West (Ireland)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "eu-west-2",
                    "title": "EU West (London, AWS)",
                    "name": "EU West (London)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "eu-west-3",
                    "title": "EU West (Paris, AWS)",
                    "name": "EU West (Paris)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "eu-central-1",
                    "title": "EU Central (Frankfurt, AWS)",
                    "name": "EU Central (Frankfurt)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-northeast-1",
                    "title": "Asia Pacific (Tokyo, AWS)",
                    "name": "Asia Pacific (Tokyo)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-south-1",
                    "title": "Asia Pacific (Mumbai, AWS)",
                    "name": "Asia Pacific (Mumbai)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-northeast-2",
                    "title": "Asia Pacific (Seoul, AWS)",
                    "name": "Asia Pacific (Seoul)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-southeast-1",
                    "title": "Asia Pacific (Singapore, AWS)",
                    "name": "Asia Pacific (Singapore)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-southeast-2",
                    "title": "Australia (Sydney, AWS)",
                    "name": "Australia (Sydney)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "sa-east-1",
                    "title": "South America (Sao Paulo, AWS)",
                    "name": "South America (Sao Paulo)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-us-1",
                    "title": "US East (Virginia, Azure)",
                    "name": "US East (Virginia)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-us-2",
                    "title": "US East 2 (Virginia, Azure)",
                    "name": "US East 2 (Virginia)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-west-us-1",
                    "title": "US West (California, Azure)",
                    "name": "US West (California)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-west-us-2",
                    "title": "US West 2 (Washington, Azure)",
                    "name": "US West 2 (US West 2)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-us-west-central",
                    "title": "US West Central (Wyoming, Azure)",
                    "name": "US West Central (US West Central)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-us-1",
                    "title": "US Central (Iowa, Azure)",
                    "name": "US Central (Iowa)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-north-central-us-1",
                    "title": "US North Central (Illinois, Azure)",
                    "name": "US North Central (Illinois)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-south-central-us-1",
                    "title": "US South Central (Texas, Azure)",
                    "name": "US South Central (Texas)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-ca",
                    "title": "Canada East (Quebec City, Azure)",
                    "name": "Canada East (Quebec City)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-ca",
                    "title": "Canada Central (Toronto, Azure)",
                    "name": "Canada Central (Toronto)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-west-europe-1",
                    "title": "EU West (Netherlands, Azure)",
                    "name": "EU West (Netherlands)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-north-europe-1",
                    "title": "EU North (Ireland, Azure)",
                    "name": "EU North (Ireland)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-eu-west-3",
                    "title": "UK West (Cardiff, Azure)",
                    "name": "UK West (Cardiff)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-eu-west-2",
                    "title": "UK South (London, Azure)",
                    "name": "UK South (London)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-japan-east-1",
                    "title": "Japan East (Tokyo, Azure)",
                    "name": "Japan East (Tokyo, Saitama)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-japan-west-1",
                    "title": "Japan West (Osaka, Azure)",
                    "name": "Japan West (Osaka)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-ap-northeast-1",
                    "title": "Korea Central (Seoul, Azure)",
                    "name": "Korea Central (Seoul)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-ap-northeast-2",
                    "title": "Korea South (Busan, Azure)",
                    "name": "Korea South (Busan)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-asia-1",
                    "title": "East Asia (Hong Kong, Azure)",
                    "name": "East Asia (Hong Kong)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-southeast-asia-1",
                    "title": "Southeast Asia (Singapore, Azure)",
                    "name": "Southeast Asia (Singapore)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-asia-1",
                    "title": "Central India (Pune, Azure)",
                    "name": "Central India (Pune)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-asia-2",
                    "title": "West India (Mumbai, Azure)",
                    "name": "West India (Mumbai)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-asia-3",
                    "title": "South India (Chennai, Azure)",
                    "name": "South India (Chennai)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-au-1",
                    "title": "Australia East (New South Wales, Azure)",
                    "name": "Australia East (New South Wales)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-southeast-au-1",
                    "title": "Australia Southeast (Victoria, Azure)",
                    "name": "Australia Southeast (Victoria)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-brazil-south-1",
                    "title": "Brazil South (Sao Paulo, Azure)",
                    "name": "Brazil South (Sao Paulo)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-58d3b97ff132adc0347b23c6",
                    "title": "Functional Testing Default Location",
                    "name": "Functional Testing Default Location",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59464ffd67f3bf63cb7b23c9",
                    "title": "US East (S. Carolina) - Functional Test",
                    "name": "US East (S. Carolina) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59465fcde4d6a240d97b23c6",
                    "title": "US West (Los Angeles) - Functional Test",
                    "name": "US West (Los Angeles) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-594662d6e6e960aedb7b23c7",
                    "title": "US West (Oregon) - Functional Test",
                    "name": "US West (Oregon) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5946677fe4d6a21adb7b23c8",
                    "title": "Canada (Montreal) - Functional Test",
                    "name": "Canada (Montreal) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59466cb1e4d6a296e37b23c8",
                    "title": "EU West (Belgium) - Functional Test",
                    "name": "EU West (Belgium) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59466f1b67f3bfebe27b23c7",
                    "title": "EU West (Frankfurt) - Functional Test",
                    "name": "EU West (Frankfurt) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5946708a65e00138e57b23c6",
                    "title": "EU West (London) - Functional Test",
                    "name": "EU West (London) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59467342e4d6a205e67b23c6",
                    "title": "Asia Pacific (Singapore) - Functional Test",
                    "name": "Asia Pacific (Singapore) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5946756fe4d6a204e37b23c6",
                    "title": "Australia (Sydney) - Functional Test",
                    "name": "Australia (Sydney) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5946770be6e960e5e57b23cf",
                    "title": "Asia Pacific (Seoul) - Functional Test",
                    "name": "Asia Pacific (Seoul) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5b0323b3c648be3b4c7b23c8",
                    "title": "Example Private Location",
                    "name": "Example Private Location",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5b0f166208e9cb973d7b23c8",
                    "title": "Recreate Issues",
                    "name": "Recreate Issues",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5b77157469770195257b23c6",
                    "title": "Staging Env ONLY",
                    "name": "Staging Env ONLY",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5b86c7f5e86da28c337b23c6",
                    "title": "Customer Reproduction",
                    "name": "Customer Reproduction",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5b87fb556b8abfea7d7b23ca",
                    "title": "Console-Engine Communication",
                    "name": "Console-Engine Communication",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5c8973ed0568ed07f368e1f7",
                    "title": "CI-Test",
                    "name": "CI-Test",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5c94ea930b63ac5fb64ab073",
                    "title": "Kubernetes Instance",
                    "name": "Kubernetes Instance",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d23ad18d6baf85cdc41e686",
                    "title": "Keybank Kube Test",
                    "name": "Keybank Kube Test",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2cecc61391a8f318703bd5",
                    "title": "New K8s",
                    "name": "New K8s",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": false,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e4f9ef54f63a700650266",
                    "title": "argaerg",
                    "name": "argaerg",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5d2e4fbb611274a61b066a93",
                    "title": "10+ Agents",
                    "name": "10+ Agents",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e50105b444da11c733e24",
                    "title": "aergaesrgsegrt",
                    "name": "aergaesrgsegrt",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e5019265d90a75c668184",
                    "title": "fjhm,ghj,ghk,g,",
                    "name": "fjhm,ghj,ghk,g,",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e501faef4bda5292a90e3",
                    "title": ",fhj,ghjk,ghj,",
                    "name": ",fhj,ghjk,ghj,",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e502649f49db05b1b127b",
                    "title": "sdfghsdrygthsdrgyt",
                    "name": "sdfghsdrygthsdrgyt",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e502d5b444d9e20588a14",
                    "title": "gnthmfthnmghm",
                    "name": "gnthmfthnmghm",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5e0e68b9568b27689176f3b4",
                    "title": "Shared",
                    "name": "Shared",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5e7e5a9d28320500d25dc3f3",
                    "title": "Docker 13.1 :(",
                    "name": "Docker 13.1 :(",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5e866d5f63d06209a46e9425",
                    "title": "GUI Functional Location",
                    "name": "GUI Functional Location",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5ab3c64ec8589f914c7b25db",
                    "title": "US East (Virginia) - Functional GUI Test",
                    "name": "US East (Virginia) - Functional GUI Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5d25f94f9950ce73cd105f53",
                    "title": "EU West (London) - Functional GUI Test",
                    "name": "EU West (London) - Functional GUI Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5d25f95f206f10730f21f1b4",
                    "title": "US West (Oregon) - Functional GUI Test",
                    "name": "US West (Oregon) - Functional GUI Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                }
            ],
            "activeMember": {
                "id": 123456,
                "email": "my.user@myDomain.com",
                "displayName": "My User",
                "roles": [
                    "manager"
                ],
                "enabled": true,
                "access": 1592422761
            }
        },
        "request_id": "5eea716988414"
    }
    

    Attributes

    Create a Workspace

    Create a Workspace

    curl 'https://a.blazemeter.com/api/v4/workspaces/' \
        -X POST \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"dedicatedIpsEnabled": true, "enabled": true, "name": "New Workspace", "privateLocationsEnabled": true, "accountId": 123456}'
    

    API Explorer: /workspaces

    To create a workspace:

    1. Create the workspace object with a POST to the workspaces endpoint (see sample code).
    2. Capture the workspaceId returned as id from the response.

    Create a Workspace Request Attributes

    The following JSON sample provides a more readable version of the content contained in the above curl example. This example represents the attributes and values contained in the -d flag of the curl example.

    Create a Project Create a Project POST Body (JSON)

    {
      "dedicatedIpsEnabled": true,
      "enabled": true,
      "name": "New Workspace",
      "privateLocationsEnabled": true,
      "accountId": 123456
    }
    

    Attributes

    Create a Workspace Response Attributes

    Response 201 Created

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 123456,
            "name": "V4 Create Test Through API",
            "userId": 123456,
            "description": "A description",
            "created": 1488987563,
            "updated": 1488987563,
            "workspaceId": 123456,
            "testsCount": 388
        }
    }
    

    See The Workspace Object for the details on the response attributes.

    Workspaces List

    Workspaces List

    curl 'https://a.blazemeter.com/api/v4/workspaces?accountId=123456' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /workspaces

    To return a list of the workspaces, an accountId is required. The sample code returns a list of workspaces within accountId of 123456. Use the actual ID value for the account to return the list of the workspaces in your account.

    Workspace List Parameters

    Parameters


    Also see: Pagination and Sorting

    Workspaces List Response Attributes

    Response 200 OK

    {
        "limit": 10,
        "skip": 0,
        "total": 2,
        "hidden": 0,
        "api_version": 4,
        "error": null,
        "result": [
            {
                "id": 234567,
                "name": "Another Workspace",
                "userId": 123456,
                "created": 1544563474,
                "updated": 1544563474,
                "enabled": true,
                "dedicatedIpsEnabled": true,
                "privateLocationsEnabled": true,
                "owner": {
                    "id": 123456,
                    "email": "my.user@myDomain.com",
                    "displayName": "My User"
                },
                "membersCount": 1,
                "allowance": {
                    "amount": 17568,
                    "type": "credits"
                },
                "accountId": 123456
            },
            {
                "id": 123456,
                "name": "Default workspace",
                "userId": 123456,
                "created": 1488987561,
                "updated": 1572904019,
                "enabled": true,
                "dedicatedIpsEnabled": true,
                "privateLocationsEnabled": true,
                "owner": {
                    "id": 123456,
                    "email": "my.user@myDomain.com",
                    "displayName": "My User"
                },
                "membersCount": 6,
                "allowance": {
                    "amount": 17568,
                    "type": "credits"
                },
                "accountId": 123456
            }
        ],
        "request_id": "5dc5bb21cda8d"
    }
    

    To see a breakdown of the attributes, please see The Workspace Object section.

    Workspace Details

    Workspace Details

    curl 'https://a.blazemeter.com/api/v4/projects/123456' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /workspaces/{workspaceId}

    To return the details of a workspace, a workspaceId is required. The sample code returns the details of the workspace with workspaceId of 123456. Use the actual ID value for the workspace to return the detail of your workspace.

    Workspace Details Response Attributes

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 123456,
            "name": "Default workspace",
            "userId": 123456,
            "created": 1488987561,
            "updated": 1573503519,
            "enabled": true,
            "dedicatedIpsEnabled": true,
            "privateLocationsEnabled": true,
            "owner": {
                "id": 123456,
                "email": "my.user@myDomain.com",
                "displayName": "My User"
            },
            "membersCount": 7,
            "allowance": {
                "amount": 17678,
                "type": "credits"
            },
            "accountId": 123456,
            "locations": [
                {
                    "id": "harbor-5591335d8588531f5cde3a04",
                    "title": "Sandbox",
                    "name": "Sandbox",
                    "provider": "Sandbox",
                    "limits": {
                        "threadsPerEngine": 20,
                        "concurrency": 20,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": true,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-east4-a",
                    "title": "US East (Virginia, Google)",
                    "name": "US East (Virginia)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-east1-b",
                    "title": "US East (South Carolina, Google)",
                    "name": "US East (South Carolina)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-west1-a",
                    "title": "US West (Oregon, Google)",
                    "name": "US West (Oregon)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-central1-a",
                    "title": "US Central (Iowa, Google)",
                    "name": "US Central (Iowa)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "northamerica-northeast1-a",
                    "title": "Canada East (Montreal, Google)",
                    "name": "Canada East (Montreal)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "europe-west2-a",
                    "title": "EU West (London, Google)",
                    "name": "EU West (London)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "europe-west3-a",
                    "title": "EU West (Frankfurt, Google)",
                    "name": "EU West (Frankfurt)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "europe-west1-b",
                    "title": "EU West (Belgium, Google)",
                    "name": "EU West (Belgium)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "europe-west4-b",
                    "title": "EU West (Netherlands, Google)",
                    "name": "EU West (Netherlands)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-east1-a",
                    "title": "Asia East (Taiwan, Google)",
                    "name": "Asia East (Taiwan)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-northeast1-a",
                    "title": "Asia Northeast (Japan, Google)",
                    "name": "Asia Northeast (Japan)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-southeast1-a",
                    "title": "Asia Southeast (Singapore, Google)",
                    "name": "Asia Southeast (Singapore)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-south1-a",
                    "title": "Asia South (Mumbai, Google)",
                    "name": "Asia South (Mumbai)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "australia-southeast1-a",
                    "title": "Australia (Sydney, Google)",
                    "name": "Australia (Sydney)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "southamerica-east1-a",
                    "title": "Brazil (Sao Paulo, Google)",
                    "name": "Brazil (Sao Paulo)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "asia-northeast2-a",
                    "title": "Japan (Osaka, Google)",
                    "name": "Japan (Osaka)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-west2-a",
                    "title": "US West (California, Google)",
                    "name": "US West (California)",
                    "provider": "Google Cloud Platform",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-east-1",
                    "title": "US East (Virginia, AWS)",
                    "name": "US East (Virginia)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-east-2",
                    "title": "US East (Ohio, AWS)",
                    "name": "US East (Ohio)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-west-1",
                    "title": "US West (N.California, AWS)",
                    "name": "US West (N.California)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "us-west-2",
                    "title": "US West (Oregon, AWS)",
                    "name": "US West (Oregon)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ca-central-1",
                    "title": "Canada (Central, AWS)",
                    "name": "Canada (Central)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "eu-west-1",
                    "title": "EU West (Ireland, AWS)",
                    "name": "EU West (Ireland)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "eu-west-2",
                    "title": "EU West (London, AWS)",
                    "name": "EU West (London)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "eu-west-3",
                    "title": "EU West (Paris, AWS)",
                    "name": "EU West (Paris)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "eu-central-1",
                    "title": "EU Central (Frankfurt, AWS)",
                    "name": "EU Central (Frankfurt)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-northeast-1",
                    "title": "Asia Pacific (Tokyo, AWS)",
                    "name": "Asia Pacific (Tokyo)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-south-1",
                    "title": "Asia Pacific (Mumbai, AWS)",
                    "name": "Asia Pacific (Mumbai)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-northeast-2",
                    "title": "Asia Pacific (Seoul, AWS)",
                    "name": "Asia Pacific (Seoul)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-southeast-1",
                    "title": "Asia Pacific (Singapore, AWS)",
                    "name": "Asia Pacific (Singapore)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "ap-southeast-2",
                    "title": "Australia (Sydney, AWS)",
                    "name": "Australia (Sydney)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "sa-east-1",
                    "title": "South America (Sao Paulo, AWS)",
                    "name": "South America (Sao Paulo)",
                    "provider": "Amazon Web Services",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-us-1",
                    "title": "US East (Virginia, Azure)",
                    "name": "US East (Virginia)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-us-2",
                    "title": "US East 2 (Virginia, Azure)",
                    "name": "US East 2 (Virginia)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-west-us-1",
                    "title": "US West (California, Azure)",
                    "name": "US West (California)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-west-us-2",
                    "title": "US West 2 (Washington, Azure)",
                    "name": "US West 2 (US West 2)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-us-west-central",
                    "title": "US West Central (Wyoming, Azure)",
                    "name": "US West Central (US West Central)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-us-1",
                    "title": "US Central (Iowa, Azure)",
                    "name": "US Central (Iowa)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-north-central-us-1",
                    "title": "US North Central (Illinois, Azure)",
                    "name": "US North Central (Illinois)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-south-central-us-1",
                    "title": "US South Central (Texas, Azure)",
                    "name": "US South Central (Texas)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-ca",
                    "title": "Canada East (Quebec City, Azure)",
                    "name": "Canada East (Quebec City)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-ca",
                    "title": "Canada Central (Toronto, Azure)",
                    "name": "Canada Central (Toronto)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-west-europe-1",
                    "title": "EU West (Netherlands, Azure)",
                    "name": "EU West (Netherlands)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-north-europe-1",
                    "title": "EU North (Ireland, Azure)",
                    "name": "EU North (Ireland)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-eu-west-3",
                    "title": "UK West (Cardiff, Azure)",
                    "name": "UK West (Cardiff)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-eu-west-2",
                    "title": "UK South (London, Azure)",
                    "name": "UK South (London)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-japan-east-1",
                    "title": "Japan East (Tokyo, Azure)",
                    "name": "Japan East (Tokyo, Saitama)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-japan-west-1",
                    "title": "Japan West (Osaka, Azure)",
                    "name": "Japan West (Osaka)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-ap-northeast-1",
                    "title": "Korea Central (Seoul, Azure)",
                    "name": "Korea Central (Seoul)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-ap-northeast-2",
                    "title": "Korea South (Busan, Azure)",
                    "name": "Korea South (Busan)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-asia-1",
                    "title": "East Asia (Hong Kong, Azure)",
                    "name": "East Asia (Hong Kong)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-southeast-asia-1",
                    "title": "Southeast Asia (Singapore, Azure)",
                    "name": "Southeast Asia (Singapore)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-asia-1",
                    "title": "Central India (Pune, Azure)",
                    "name": "Central India (Pune)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-asia-2",
                    "title": "West India (Mumbai, Azure)",
                    "name": "West India (Mumbai)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-central-asia-3",
                    "title": "South India (Chennai, Azure)",
                    "name": "South India (Chennai)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-east-au-1",
                    "title": "Australia East (New South Wales, Azure)",
                    "name": "Australia East (New South Wales)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-southeast-au-1",
                    "title": "Australia Southeast (Victoria, Azure)",
                    "name": "Australia Southeast (Victoria)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "azure-brazil-south-1",
                    "title": "Brazil South (Sao Paulo, Azure)",
                    "name": "Brazil South (Sao Paulo)",
                    "provider": "Microsoft Azure",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 500000,
                        "engines": 1000,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-58d3b97ff132adc0347b23c6",
                    "title": "Functional Testing Default Location",
                    "name": "Functional Testing Default Location",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59464ffd67f3bf63cb7b23c9",
                    "title": "US East (S. Carolina) - Functional Test",
                    "name": "US East (S. Carolina) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59465fcde4d6a240d97b23c6",
                    "title": "US West (Los Angeles) - Functional Test",
                    "name": "US West (Los Angeles) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-594662d6e6e960aedb7b23c7",
                    "title": "US West (Oregon) - Functional Test",
                    "name": "US West (Oregon) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5946677fe4d6a21adb7b23c8",
                    "title": "Canada (Montreal) - Functional Test",
                    "name": "Canada (Montreal) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59466cb1e4d6a296e37b23c8",
                    "title": "EU West (Belgium) - Functional Test",
                    "name": "EU West (Belgium) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59466f1b67f3bfebe27b23c7",
                    "title": "EU West (Frankfurt) - Functional Test",
                    "name": "EU West (Frankfurt) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5946708a65e00138e57b23c6",
                    "title": "EU West (London) - Functional Test",
                    "name": "EU West (London) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-59467342e4d6a205e67b23c6",
                    "title": "Asia Pacific (Singapore) - Functional Test",
                    "name": "Asia Pacific (Singapore) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5946756fe4d6a204e37b23c6",
                    "title": "Australia (Sydney) - Functional Test",
                    "name": "Australia (Sydney) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5946770be6e960e5e57b23cf",
                    "title": "Asia Pacific (Seoul) - Functional Test",
                    "name": "Asia Pacific (Seoul) - Functional Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": true,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5b0323b3c648be3b4c7b23c8",
                    "title": "Example Private Location",
                    "name": "Example Private Location",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5b0f166208e9cb973d7b23c8",
                    "title": "Recreate Issues",
                    "name": "Recreate Issues",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5b77157469770195257b23c6",
                    "title": "Staging Env ONLY",
                    "name": "Staging Env ONLY",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5b86c7f5e86da28c337b23c6",
                    "title": "Customer Reproduction",
                    "name": "Customer Reproduction",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5b87fb556b8abfea7d7b23ca",
                    "title": "Console-Engine Communication",
                    "name": "Console-Engine Communication",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5c8973ed0568ed07f368e1f7",
                    "title": "CI-Test",
                    "name": "CI-Test",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5c94ea930b63ac5fb64ab073",
                    "title": "Kubernetes Instance",
                    "name": "Kubernetes Instance",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d23ad18d6baf85cdc41e686",
                    "title": "Keybank Kube Test",
                    "name": "Keybank Kube Test",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2cecc61391a8f318703bd5",
                    "title": "New K8s",
                    "name": "New K8s",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": false,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e4f9ef54f63a700650266",
                    "title": "argaerg",
                    "name": "argaerg",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": false,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5d2e4fbb611274a61b066a93",
                    "title": "10+ Agents",
                    "name": "10+ Agents",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e50105b444da11c733e24",
                    "title": "aergaesrgsegrt",
                    "name": "aergaesrgsegrt",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e5019265d90a75c668184",
                    "title": "fjhm,ghj,ghk,g,",
                    "name": "fjhm,ghj,ghk,g,",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e501faef4bda5292a90e3",
                    "title": ",fhj,ghjk,ghj,",
                    "name": ",fhj,ghjk,ghj,",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e502649f49db05b1b127b",
                    "title": "sdfghsdrygthsdrgyt",
                    "name": "sdfghsdrygthsdrgyt",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5d2e502d5b444d9e20588a14",
                    "title": "gnthmfthnmghm",
                    "name": "gnthmfthnmghm",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 1000,
                        "concurrency": 1000,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": true,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5e0e68b9568b27689176f3b4",
                    "title": "Shared",
                    "name": "Shared",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": true,
                        "functional": false,
                        "grid": true,
                        "serviceMock": true
                    }
                },
                {
                    "id": "harbor-5e7e5a9d28320500d25dc3f3",
                    "title": "Docker 13.1 :(",
                    "name": "Docker 13.1 :(",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5e866d5f63d06209a46e9425",
                    "title": "GUI Functional Location",
                    "name": "GUI Functional Location",
                    "provider": "Private Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5ab3c64ec8589f914c7b25db",
                    "title": "US East (Virginia) - Functional GUI Test",
                    "name": "US East (Virginia) - Functional GUI Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5d25f94f9950ce73cd105f53",
                    "title": "EU West (London) - Functional GUI Test",
                    "name": "EU West (London) - Functional GUI Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                },
                {
                    "id": "harbor-5d25f95f206f10730f21f1b4",
                    "title": "US West (Oregon) - Functional GUI Test",
                    "name": "US West (Oregon) - Functional GUI Test",
                    "provider": "Public Locations",
                    "limits": {
                        "threadsPerEngine": 300,
                        "concurrency": 300,
                        "engines": 0,
                        "duration": 712
                    },
                    "capabilities": {
                        "dedicatedIps": false,
                        "isPrivileged": true
                    },
                    "sandbox": false,
                    "purposes": {
                        "load": false,
                        "functional": false,
                        "grid": true,
                        "serviceMock": false
                    }
                }
            ],
            "activeMember": {
                "id": 123456,
                "email": "my.user@myDomain.com",
                "displayName": "My User",
                "roles": [
                    "manager"
                ],
                "enabled": true,
                "access": 1592422761
            }
        },
        "request_id": "5eea716988414"
    }
    

    See The Workspace Object for the details on the response attributes.

    Add User to Workspace

    Add User to Workspace

    curl 'https://a.blazemeter.com/api/v4/workspaces/123456/users' \
        -X POST \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"usersIds":[352749],"roles": ["manager"]}'
    

    API Explorer: /workspaces/{workspaceId}/users

    To add a user to a workspace, you need the workspaceId of the workspace you want to add the user to and use an API key that has account admin access or a workspace manager role. For the sample code on the right, workspaceId 123456 has added user myName@myDomain.com to the workspace with the workspace manager role.

    Add User to Workspace Request Attributes

    The following JSON sample provides a more readable version of the content contained in the above curl example. This example represents the attributes and values contained in the -d flag of the curl example.

    Add User to Workspace Add User to Workspace POST Body (JSON)

    {
        "usersIds": [
            352749
        ],
        "roles": [
            "manager"
        ]
    }
    

    Attributes

    Add User to Workspace Response Attributes

    Response 201 Created

    {
        "api_version": 4,
        "error": null,
        "result": [
            {
                "id": 123456,
                "roles": [
                    "manager"
                ],
                "enabled": true,
                "lastAccess": 1573503678,
                "type": "workspace",
                "memberId": {
                    "$oid": "5dc9c2be4b5cab1c82345bb3"
                },
                "displayName": "Standard Manager",
                "firstName": "Standard",
                "lastName": "Manager",
                "login": 1570322423,
                "email": "myName@myDomain.com",
                "access": 1573503678
            }
        ],
        "request_id": "5dc9c2be0ae5a"
    }
    

    Attributes

    Workspace User List

    Workspace User List

    curl 'https://a.blazemeter.com/api/v4/workspaces/123456/users' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /workspaces/{workspaceId}/users

    To return a list of the workspace users, a workspaceId is required. The sample code returns a list of workspace users within workspaceId of 123456. Use the actual ID value for the workspace to return the list of the workspace users in your workspace.

    Workspace User List Parameters

    Parameters


    Also see: Pagination

    Workspace User List Response Attributes

    Response 200 OK

    {
        "limit": 10,
        "skip": 0,
        "total": 2,
        "hidden": 0,
        "api_version": 4,
        "error": null,
        "result": [
            {
                "id": 123456,
                "email": "adminUser@myDomain.com",
                "displayName": "Admin User",
                "firstName": "Admin",
                "lastName": "User",
                "login": 1573488679,
                "access": 1573501903,
                "roles": [
                    "manager"
                ],
                "enabled": true,
                "lastAccess": 1573501903
            },
            {
                "id": 234567,
                "email": "standardUser@myDomain.com",
                "displayName": "Standard User",
                "firstName": "Standard",
                "lastName": "User",
                "login": 1506347921,
                "access": 1516906397,
                "roles": [
                    "tester"
                ],
                "enabled": false,
                "lastAccess": 1516906397,
                "type": "workspace"
            }
        ],
        "request_id": "5dc9bdef0a561"
    }
    

    Attributes

    Update Workspace User

    Update Workspace User

    curl 'https://a.blazemeter.com/api/v4/workspaces/123456/users/123456' \
        -X PUT \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"roles":["viewer"],"enabled": false}'
    

    API Explorer: /workspaces/{workspaceId}/users/{userId}

    To change a user's workspace role and disable or enable an user in the workspace, a workspaceId and an userId are required. The sample code changes the workspace role of userId of 123456 within workspaceId of 123456 to viewer and disables the user. Use the actual ID value for the workspace and user you are wanting to change.

    Update Workspace User Request Attributes

    The following JSON sample provides a more readable version of the content contained in the above curl example. This example represents the attributes and values contained in the -d flag of the curl example.

    Update Workspace User Update Workspace User PUT Body (JSON)

    {
      "roles": [
        "viewer"
        ],
      "enabled": false
    }
    

    Attributes

    Update Workspace User Response Attributes

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 123456,
            "roles": [
                "viewer"
            ],
            "enabled": false,
            "lastAccess": 1573506574,
            "type": "workspace",
            "displayName": "Viewer User",
            "login": 1562944843,
            "email": "viwerUser@myDomain.com"
        },
        "request_id": "5dc9ce0e3076d"
    }
    

    For a breakdown of the response attributes, see the Add User to Workspace Response Attributes section.

    Projects

    This section goes over how to handle project administration (i.e. creating a project, deleting a project, etc.) for your BlazeMeter project.

    To run many of these APIs, you will need the projectId for the project you are wanting to handle.

    The Project Object

    The Project Object

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 123456,
            "name": "Default project",
            "userId": 123456,
            "description": null,
            "created": 1488987563,
            "updated": 1488987563,
            "workspaceId": 123456,
            "testsCount": 417
        },
        "request_id": "5eea8ecd9eace"
    }
    

    Attributes

    Create a Project

    Create a Project

    curl 'https://a.blazemeter.com/api/v4/projects' \
        -X POST \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"name": "V4 Create Test Through API", "description": "A description", "workspaceId": 123456}'
    

    API Explorer: /projects

    To create a project:

    1. Create the project object with a POST to the projects endpoint (see sample code).
    2. Capture the projectId returned as id from the response.

    Create a Project Request Attributes

    The following JSON sample provides a more readable version of the content contained in the above curl example. This example represents the attributes and values contained in the -d flag of the curl example.

    Create a Project Create a Project POST Body (JSON)

    {
        "name": "V4 Create Test Through API",
        "description": "A description",
        "workspaceId": 123456
    }
    

    Attributes

    Create a Project Response Attributes

    Response 201 Created

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 123456,
            "name": "V4 Create Test Through API",
            "userId": 123456,
            "description": "A description",
            "created": 1488987563,
            "updated": 1488987563,
            "workspaceId": 123456,
            "testsCount": 388
        }
    }
    

    See The Project Object for the details on the response attributes.

    Projects List

    Projects List

    curl 'https://a.blazemeter.com/api/v4/projects?workspaceId=123456' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /projects

    To return a list of the projects, a workspaceId or an accountId is required. The sample code returns a list of projects within workspaceId of 123456. Use the actual ID value for the workspace to return the list of the projects in your workspace.

    Projects List Parameters

    Parameters


    Also see: Pagination and Sorting

    Projects List Response Attributes

    Response 200 OK

    {
        "limit": 10,
        "skip": 0,
        "total": 2,
        "hidden": 0,
        "api_version": 4,
        "error": null,
        "result": [
            {
                "id": 234567,
                "name": "New Project",
                "userId": 234567,
                "description": "Tests using new project",
                "created": 1489672823,
                "updated": 1489672823,
                "workspaceId": 123456,
                "testsCount": 126
            },
            {
                "id": 123456,
                "name": "Default project",
                "userId": 123456,
                "description": null,
                "created": 1488987563,
                "updated": 1488987563,
                "workspaceId": 123456,
                "testsCount": 388
            }
        ],
        "request_id": "5dc9d8bd366b4"
    }
    

    See The Project Object for the details on the response attributes.

    Project Details

    Project Details

    curl 'https://a.blazemeter.com/api/v4/projects/123456' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /projects/{projectId}

    To return the details of a project, a projectId is required. The sample code returns the details of the project with projectId of 123456. Use the actual ID value for the project to return the detail of your project.

    Project Details Response Attributes

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 167798,
            "name": "Default project",
            "userId": 344260,
            "description": null,
            "created": 1488987563,
            "updated": 1488987563,
            "workspaceId": 123429
        },
        "request_id": "5eea991e547ca"
    }
    

    See The Project Object for the details on the response attributes.

    Update a Project

    Update a Project

    curl 'https://a.blazemeter.com/api/v4/projects/123456' \
        -X PATCH \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"name":"New Test Name For API"}'
    

    API Explorer: /projects/{projectId}

    To update a project, use PATCH to change the provided configuration for a given project (you need to know the projectId). The sample code updates a test with an ID of 123456 (the 123456 is contained in the URL) with a new test name New Test Name For API, a new description of This is my description, and a new workspaceId of 234567.

    If you do not know the projectId of the project to update, use List Projects to return a list of your created projects.

    Update a Project Request Attributes

    Update a Project Update a Project Sample PATCH Body (JSON)

    {
        "name": "New Test Name For API",
        "description": "This is my description",
        "workspaceId": 234567
    }
    

    Attributes

    Update a Project Response Attributes

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 123456,
            "name": "New Test Name For API",
            "userId": 123456,
            "description": "This is my description",
            "created": 1488987563,
            "updated": 1488987563,
            "workspaceId": 234567,
            "testsCount": 388
        }
    }
    

    See The Project Object for the details on the response attributes.

    Delete a Project

    Delete a Project

    curl 'https://a.blazemeter.com/api/v4/projects/123456' \
        -X DELETE \
        --user 'api_key_id:api_key_secret'
    

    Response 204 No content

    API Explorer: /projects/{projectId}

    To delete a project, DELETE its ID (you need to know the projectId). The sample code deletes a project with an ID of 123456. Use the projectId of the actual project to delete in place of the 123456.

    If you do not know the ID of the project to delete, use the List Projects section to return a list of your created projects.

    Delete a Project Parameters

    Parameters

    Tests

    When you create a test, you are creating a test object configured with specific parameters.

    Once you have created a test and have uploaded any required files, you can start the test, which will create a master for control and reporting.

    You will also need the location ID to point your test configuration to the correct location(s) you want your test to run in.

    As we are heavily integrated with Taurus, the test override configurations will display similarly to the Taurus execution section. If you are familiar with the YAML or JSON formatting of these configuration files, you can easily translate that knowledge to our API configurations.

    The Test Object

    The API Functional Test Object

    The API Functional Test Object

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 1234567,
            "isNewTest": true,
            "name": "API Functional Test",
            "description": "This test uses every API Functional test configuration we have.",
            "userId": 123456,
            "creatorClientId": "api",
            "overrideExecutions": [{
                "executor": "",
                "holdFor": "19m",
                "rampUp": "1m",
                "concurrency": 20,
                "locations": {
                    "us-east4-a": 20
                },
                "locationsPercents": {
                    "us-east4-a": 100
                },
                "steps": 0
            }],
            "executions": [{
                "concurrency": 20,
                "holdFor": "19m",
                "rampUp": "1m",
                "steps": 0,
                "locations": {
                    "us-east4-a": 20
                },
                "locationsPercents": {
                    "us-east4-a": 100
                },
                "scenario": "default-scenario-1234567"
            }],
            "shouldSendReportEmail": true,
            "dependencies": {
                "services": [{
                    "service": "BlazeDemo",
                    "mock-service": "Entries Mock Service",
                    "mock-service-template": "Blazedemo Entries Template"
                }]
            },
            "created": 1592489620,
            "updated": 1592489637,
            "projectId": 123456,
            "lastUpdatedById": 123456,
            "configuration": {
                "type": "functionalApi",
                "canControlRampup": false,
                "targetThreads": 500,
                "enableHostsOverride": true,
                "enableMockServices": true,
                "scriptType": "",
                "threads": 500,
                "filename": "demoblaze.yml",
                "testMode": "script",
                "extraSlots": 0,
                "plugins": {
                    "hosts": [{
                        "hostname": "my.domain.com",
                        "ip": "10.10.10.10"
                    }],
                    "sharedFolders": [
                        "5e5552e75eed7c2c531142c5"
                    ],
                    "jmeter": {
                        "version": "auto"
                    }
                }
            }
        },
        "request_id": "5eeb77024fe58"
    }
    

    Attributes

    The GUI Functional Test Object

    The GUI Functional Test Object

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 1234567,
            "isNewTest": true,
            "name": "GUI Functional Test",
            "description": "This test uses every GUI Functional test configuration we have.",
            "userId": 123456,
            "creatorClientId": "gui",
            "overrideExecutions": [{
                    "executor": "selenium",
                    "scenario": "default-scenario",
                    "locations": {
                        "harbor-5ab3c64ec8589f914c7b25db": 1
                    },
                    "capabilities": {
                        "browserName": "chrome",
                        "browserVersion": "69",
                        "blazemeter_videoEnabled": true
                    }
                },
                {
                    "executor": "selenium",
                    "scenario": "default-scenario",
                    "locations": {
                        "harbor-5ab3c64ec8589f914c7b25db": 1
                    },
                    "capabilities": {
                        "browserName": "firefox",
                        "browserVersion": "65",
                        "blazemeter_videoEnabled": true
                    }
                }
            ],
            "executions": [{
                    "iterations": 1,
                    "locationsWeighted": true,
                    "executor": "selenium",
                    "capabilities": {
                        "browserName": "chrome",
                        "browserVersion": "69",
                        "blazemeter_videoEnabled": true
                    },
                    "scenario": "demoblaze-Selenium",
                    "locations": {
                        "harbor-5ab3c64ec8589f914c7b25db": 1
                    },
                    "concurrency": 1
                },
                {
                    "iterations": 1,
                    "locationsWeighted": true,
                    "executor": "selenium",
                    "capabilities": {
                        "browserName": "firefox",
                        "browserVersion": "65",
                        "blazemeter_videoEnabled": true
                    },
                    "scenario": "demoblaze-Selenium",
                    "locations": {
                        "harbor-5ab3c64ec8589f914c7b25db": 1
                    },
                    "concurrency": 1
                }
            ],
            "shouldSendReportEmail": false,
            "dependencies": {
                "services": [{
                    "service": "BlazeDemo",
                    "mock-service": "Entries Mock Service",
                    "mock-service-template": "Blazedemo Entries Template"
                }]
            },
            "created": 1592488617,
            "updated": 1592489934,
            "projectId": 123456,
            "lastUpdatedById": 123456,
            "configuration": {
                "type": "functionalGui",
                "dedicatedIpsEnabled": false,
                "canControlRampup": false,
                "targetThreads": 0,
                "enableMockServices": true,
                "scriptType": "taurus",
                "filename": "demoblaze--Selenium.yaml",
                "testMode": "script",
                "extraSlots": 0,
                "plugins": {
                    "sharedFolders": [
                        "5e5552e75eed7c2c531142c5"
                    ]
                }
            }
        },
        "request_id": "5eeb77dd31348"
    }
    

    Attributes

    Create a Test

    API Explorer: /tests

    To create a test:

    1. Create the test object with a POST to the test endpoint (see sample API Funtional and GUI Functional).
    2. Capture the testId returned as id from the response.

    For a full breakdown of the API Functional test, see The API Functional Test Object for more details. For a full breakdown of the GUI Functional test, see The GUI Functional Test Object.

    Create an API Functional Test Request Attributes

    Create an API Functional Test

    curl 'https://a.blazemeter.com/api/v4/tests' \
        -X POST \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"name":"API Created API Functional Test","projectId":123456,"isNewTest":true,"shouldSendReportEmail":false,"configuration":{"type":"functionalApi","filename":"MyTest.jmx"},"overrideExecutions":[{"iterations":1}]}'
    

    The following JSON sample provides a more readable version of the content contained in the above curl example. This example represents the attributes and values contained in the -d flag of the curl example.

    Create a Test Create an API Functional Test POST Body (JSON)

    {
        "name": "API Created API Functional Test",
        "projectId": 123456,
        "isNewTest": true,
        "shouldSendReportEmail": false,
        "configuration": {
            "type": "functionalApi",
            "filename": "MyTest.jmx"
        },
        "overrideExecutions": [
            {
                "iterations": 1
            }
        ]
    }
    

    Attributes

    Create an API Functional Test Response Attributes

    Response 201 Created

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 1234567,
            "name": "API Created API Functional Test",
            "isNewTest": true,
            "userId": 123456,
            "created": 1577382114,
            "updated": 1577382115,
            "creatorClientId": "api",
            "overrideExecutions": [
                {
                    "iterations": 1
                }
            ],
            "executions": [
                {
                    "iterations": 1,
                    "scenario": "default-scenario"
                }
            ],
            "shouldSendReportEmail": false,
            "projectId": 123456,
            "lastUpdatedById": 123456,
            "configuration": {
                "type": "functionalApi",
                "filename":"MyTest.jmx",
                "canControlRampup": false,
                "targetThreads": 0
            }
        },
        "request_id": "5e04f0e2d830d"
    }
    

    For the full details of all the attributes for the API Functional Test, you can visit The API Functional Test Object.

    Create a GUI Functional Test Request Attributes

    Create a GUI Functional Test

    curl 'https://a.blazemeter.com/api/v4/tests' \
        -X POST \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"name":"API Created GUI Functional Test","projectId":429821,"isNewTest":true,"shouldSendReportEmail":false,"configuration":{"type":"functionalGui","testMode":"script"},"overrideExecutions":[{"iterations":1}]}'
    

    The following JSON sample provides a more readable version of the content contained in the above curl example. This example represents the attributes and values contained in the -d flag of the curl example.

    Create a Test Create a GUI Functional Test POST Body (JSON)

    {
        "name": "API Created GUI Functional Test",
        "projectId": 429821,
        "isNewTest": true,
        "shouldSendReportEmail": false,
        "configuration": {
            "type": "functionalGui"
        },
        "overrideExecutions": [
            {
                "iterations": 1
            }
        ]
    }
    

    Attributes

    Create a GUI Functional Test Response Attributes

    Response 201 Created

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 1234567,
            "name": "API Created GUI Functional Test",
            "isNewTest": true,
            "userId": 123456,
            "created": 1577463923,
            "updated": 1577463923,
            "creatorClientId": "api",
            "overrideExecutions": [
                {
                    "iterations": 1
                }
            ],
            "executions": [],
            "shouldSendReportEmail": false,
            "projectId": 123456,
            "lastUpdatedById": 123456,
            "configuration": {
                "type": "functionalGui",
                "filename": "MyTest.jmx",
                "canControlRampup": false,
                "targetThreads": 0
            }
        },
        "request_id": "5e063072e1786"
    }
    

    For the full details of all the attributes for the GUI Functional Test, you can visit The GUI Functional Test Object.

    Upload or Update Asset Files

    Upload or Update Asset Files

    curl 'https://a.blazemeter.com/api/v4/tests/1234567/files' \
        -X POST \
        -F 'file=@/my/path/to/MyTest.jmx' \
        --user 'api_key_id:api_key_secret'
    

    Response 201 Created

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 1234567,
            "isNewTest": true,
            "name": "API Created API Functional Test",
            "userId": 123456,
            "creatorClientId": "api",
            "overrideExecutions": [
                {
                    "iterations": 1
                }
            ],
            "executions": [
                {
                    "iterations": 1,
                    "scenario": "default-scenario"
                }
            ],
            "shouldSendReportEmail": false,
            "dependencies": [],
            "created": 1577382114,
            "updated": 1577382115,
            "configuration": {
                "type": "functionalApi",
                "filename": "MyTest.jmx",
                "canControlRampup": false,
                "targetThreads": 0
            }
        },
        "request_id": "5e04f59830bd2"
    }
    

    API Explorer: /tests/{testId}/files

    To upload a file asset to a test, POST the file to the testId of the test.

    The sample code uploads a file (@/my/path/to/MyTest.jmx) to a test with an ID of 1234567. Replace @/my/path/to/MyText.jmx with the actual path and file name and 1234567 with your testId.

    To update the contents of an uploaded file, repeat the same operation (upload the updated file using the same file name).

    File Naming Requirements

    Make sure your file names:

    For example: The file name my_file_no_4.csv – is good. The file name m$ file& – is bad.

    Limitations on File Content

    BlazeMeter cannot read files containing non-ASCII characters. You must remove all non-ASCII characters from your files before uploading and starting a test.

    File Size

    BlazeMeter has a file size limit of 50 MB per file that can be uploaded. You can upload multiple files of up to 50 MB each, as needed.

    Impact of Uploaded Files on Start Time

    The number and size of uploaded test file assets impacts the start time of the test:

    List Test Files

    List Test Files

    curl 'https://a.blazemeter.com/api/v4/tests/1234567/files' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /tests/{testId}/files

    To return a list of files in a test, a testId is required. The sample code returns a list of files for the test with testId of 1234567. Use the actual ID values for the test to return the list of its files.

    List Test Files Parameters

    Parameters

    List Test Files Response Attributes

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": [
            {
                "lastModified": 1592485932,
                "name": "demoblaze.yml",
                "size": 146,
                "link": "https://storage.blazemeter.com/blazemeter-gcp/users/123456/tests/1234567/data/demoblaze.yml?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=GOOG1EE7F7ZECFQG2AMFT47JPCFCTXTGEW52TQE7AA2Y6DS4SCW37UO4ZSCNI%2F20200620%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200620T140803Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Signature=2d0d117c03e873ec6c3359807b21c4ae27b3cf8e55aabeb37d912d3177791ba4",
                "linkExpire": 1592748483
            }
        ],
        "request_id": "5eee18439c6ed"
    }
    

    Attributes

    Delete Asset Files

    Delete a File

    curl 'https://a.blazemeter.com/api/v4/tests/1234567/delete-file' \
        -X POST \
        -H "Content-Type: application/json" \
        --user 'api_key_id:api_key_secret' \
        -d '{"fileName":"MyTest.jmx"}'
    

    Delete a File Delete a File Sample POST Body (JSON)

    {
        "fileName": "MyTest.jmx"
    }
    

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": true
    }
    

    API Explorer: /tests/{testId}/delete-file

    To delete an uploaded file from a created test, you need to know the testId and the filename. The sample code deletes the file (MyTest.jmx) from the test with an ID of 1234567. Replace MyTest.jmx with the actual file name and 1234567 with your testId.

    Validate a File

    Validate a File

    curl 'https://a.blazemeter.com/api/v4/tests/1234567/validate' \
        -X POST \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"files": [{"fileName": "DemoBlaze-Selenium-.yaml"}]}'
    

    API Explorer: /tests/{testId}/validate

    To validate a JMeter or Taurus YAML file, use POST to run a validation for the given file (you need to know the testId). The sample code validates the file DemoBlaze-Selenium-.yaml in a test with an ID of 1234567 (the 1234567 is contained in the URL).

    Validate a File Request Attributes

    Validate a File Validate a File POST Body (JSON)

    {
        "files": [
            {
                "fileName": "DemoBlaze-Selenium-.yaml"
            }
        ]
    }
    

    Attributes

    Validate a File Response Attributes

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": {
            "success": true,
            "files": {
                "DemoBlaze-Selenium-.yaml": true
            }
        },
        "request_id": "5e0a5729d60c5"
    }
    

    Attributes

    Check File Validation

    Check File Validation

    curl 'https://a.blazemeter.com/api/v4/tests/1234567/validations' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /tests/{testId}/validations

    To get the status of the test file validations, use GET to pull the validation list for a given test (you need to know the testId). The sample code gets the file validations for a test with a test ID of 1234567 (the 1234567 is contained in the URL).

    Check File Validation Response Attributes

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": [
            {
                "status": 100,
                "timestamp": 1577735981,
                "fileName": "DemoBlaze-Selenium-.yaml",
                "errors": [],
                "warnings": [
                    "Please note: Some executions in your script did not configure a concurrency; they will run with 1 concurrent user",
                    "Please note: Some executions in your script will run according to your plan's duration limitation (execution #1)",
                    "Please note: Some executions in your script did not configure locations, and will run from the default location"
                ],
                "dependencies": [],
                "totalDuration": 0,
                "totalConcurrency": 0,
                "lastContainerName": "7554662-torero-5e0a572a0c82a",
                "lastContainerCommand": "files_validation",
                "executions": [
                    {
                        "iterations": 1,
                        "locationsWeighted": true,
                        "executor": "selenium",
                        "capabilities": {
                            "browserName": "chrome"
                        },
                        "scenario": "DemoBlaze-Selenium"
                    }
                ],
                "dedicatedIps": false,
                "delayedStart": false,
                "splitCsv": false,
                "commandsExecutionIndex": {
                    "files_validation": 2
                },
                "isInlineScenarioExists": false,
                "hasUltimateThreadGroup": false,
                "hasMultipleThreadGroups": false,
                "globalLocations": [],
                "created": 1577464134,
                "updated": 1577735981,
                "isMultiLocation": false,
                "fileWarnings": [],
                "totalLoadGenerators": 1
            }
        ],
        "request_id": "5e0a5899ee0e0"
    }
    

    Attributes

    Update a Test

    Update a Test

    curl 'https://a.blazemeter.com/api/v4/tests/1234567' \
        -X PUT \
        -H 'Content-Type: application/json' \
        --user 'api_key_id:api_key_secret' \
        -d '{"configuration":{"filename":"MyTest.jmx"}}'
    

    API Explorer: /tests/{testId}

    To update a test, use PUT to change the provided configuration for a given test (you need to know the testId). The sample code updates a test with an ID of 1234567 (the 1234567 is contained in the URL) with the new configuration of using the MyTest.jmx script.

    If you do not know the testId of the test to update, use List Tests to return a list of your created tests.

    See The API Functional Test Object and The GUI Functional Test Object for parameters that you can modify.

    Update a Test Request Attributes

    Update a Test Update a Test PUT Body (JSON)

    {
      "configuration": {
        "filename": "MyTest.jmx"
        }
      }
    }
    

    Attributes

    Update Test Response Attributes

    Response 200 OK

    {
        "api_version": 4,
        "error": null,
        "result": {
            "id": 1234567,
            "isNewTest": true,
            "name": "API Created API Functional Test",
            "userId": 123456,
            "creatorClientId": "api",
            "overrideExecutions": [
                {
                    "iterations": 1
                }
            ],
            "executions": [
                {
                    "iterations": 1,
                    "scenario": "default-scenario-7552536"
                }
            ],
            "shouldSendReportEmail": false,
            "dependencies": [],
            "created": 1577382114,
            "updated": 1577389061,
            "projectId": 123456,
            "lastUpdatedById": 123456,
            "configuration": {
                "type": "functionalApi",
                "canControlRampup": false,
                "targetThreads": 0,
                "scriptType": "jmeter",
                "filename": "MyTest.jmx",
                "testMode": "script",
                "plugins": {
                    "jmeter": {
                        "version": "auto"
                    }
                }
            }
        },
        "request_id": "5e050c057ae17",
        "test": {
            "id": 1234567,
            "isNewTest": true,
            "name": "API Created API Functional Test",
            "userId": 123456,
            "creatorClientId": "api",
            "overrideExecutions": [
                {
                    "iterations": 1
                }
            ],
            "executions": [
                {
                    "iterations": 1,
                    "scenario": "default-scenario-7552536"
                }
            ],
            "shouldSendReportEmail": false,
            "dependencies": [],
            "created": 1577382114,
            "updated": 1577389061,
            "projectId": 123456,
            "lastUpdatedById": 123456,
            "configuration": {
                "type": "functionalApi",
                "canControlRampup": false,
                "targetThreads": 0,
                "scriptType": "jmeter",
                "filename": "MyTest.jmx",
                "testMode": "script",
                "plugins": {
                    "jmeter": {
                        "version": "auto"
                    }
                }
            }
        }
    }
    

    See the The Test Object response attributes for a detailed breakdown of the response attributes.

    List Tests

    List Tests

    curl 'https://a.blazemeter.com/api/v4/tests?workspaceId=123456&type=functionalApi' \
        --user 'api_key_id:api_key_secret'
    

    API Explorer: /tests

    To return a list of created functional tests, a projectId or a workspaceId and a type attribute is required. The sample code returns a list for items with a workspaceId of 123456 and a type of functionalApi. Use the actual ID values for the project or workspace and one of the type values (can be functionalApi (API Functional tests) or functionalGui (GUI Functional tests)) to return the list of its tests. Use the actual ID values for the project or workspace and type value to return the list of its tests.

    You can return a list specifying either a projectId, a workspaceId, or both and a type. The returned list contains each test's testId (shows up as id in the response) and configuration.

    List Tests Parameters

    Parameters


    Also see: Pagination and Sorting

    List Tests Response Attributes

    Response 200 OK

    {
        "limit": 10,
        "skip": 0,
        "total": 47,
        "hidden": 0,
        "api_version": 4,
        "error": null,
        "result": [
            {
                "id": 1234567,
                "name": "API Created API Functional Test",
                "isNewTest": true,
                "userId": 123456,
                "created": 1577382114,
                "updated": 1577389061,
                "creatorClientId": "api",
                "overrideExecutions": [
                    {
                        "iterations": 1
                    }
                ],
                "executions": [
                    {
                        "iterations": 1,
                        "scenario": "default-scenario-1234567"
                    }
                ],
                "shouldSendReportEmail": false,
                "projectId": 123456,
                "lastUpdatedById": 123456,
                "configuration": {
                    "type": "functionalApi",
                    "canControlRampup": false,
                    "targetThreads": 0,
                    "scriptType": "jmeter",
                    "filename": "MyTest.jmx",
                    "testMode": "script",
                    "plugins": {
                        "jmeter": {
                            "version": "auto"
                        }
                    }
                }
            },
            {
                "id": 2345678,
                "name": "December_26_11:36 AM - API Functional Test",
                "isNewTest": true,
                "userId": 123456,
                "created": 1577381775,
                "updated": 1577383294,
                "creatorClientId": "gui",
                "overrideExecutions": [
                    {
                        "executor": "jmeter",
                        "holdFor": "19m",
                        "rampUp": "1m",
                        "concurrency": 20,
                        "locations": {
                            "us-east4-a": 20
                        },
                        "locationsPercents": {
                            "us-east4-a": 100
                        },
                        "steps": 0
                    }
                ],
                "executions": [
                    {
                        "concurrency": 20,
                        "holdFor": "19m",
                        "rampUp": "1m",
                        "steps": 0,
                        "locations": {
                            "us-east4-a": 20
                        },
                        "locationsPercents": {
                            "us-east4-a": 100
                        },
                        "executor": "jmeter",
                        "scenario": "default-scenario-2345678"
                    }
                ],
                "shouldSendReportEmail": false,
                "projectId": 123456,
                "lastUpdatedById": 123456,
                "configuration": {
                    "type": "functionalApi",
                    "dedicatedIpsEnabled": false,
                    "canControlRampup": false,
                    "targetThreads": 500,
                    "scriptType": "jmeter",
                    "threads": 500,
                    "filename": "DemoBlaze.jmx",
                    "testMode": "script",
                    "plugins": {
                        "jmeter": {
                            "version": "auto"
                        }
                    }
                }
            }
            ...
        ]
    }
    

    For the all the supported attributes, see the The API Functional Test Object and The GUI Functional Test Object.

    Test Details

    Test Details

    curl 'https://a.blazemeter.com/api/v4/tests/1