NAV Navbar
Home Functional Performance Mock Services API Monitoring
cURL
  • Introduction
  • Mock Service Service REST API
  • Tag REST API
  • Transaction API
  • Mock Service REST API
  • MAR Mock Service REST API
  • Mock Service Assets
  • Mock Service Template REST API
  • Mock Service Location REST API
  • Mock Service Log REST API
  • Appendix
  • Introduction

    Welcome to the Mock Services section of the BlazeMeter API Reference! This reference provides information on accessing our API endpoints to automate the creation of mock services and transactions for your services.

    After verifying your application server is functioning as expected, you're ready to move on to simulating some tests. BlazeMeter CT's Mock Services allow you to test even when you don't have access to a full test environment. You can run a mock service to deploy transactions, which are typically a subset of transactions in a particular service. Once a mock service is created and running, you can associate it to your test, embed it in your test scripts, or provide it during test execution.

    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 components.

    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.

    Mock Service Service REST API

    Create a Service

    To create a Service in your Workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your workspace.

    The response contains a Service identifier that you should note down. You will need the serviceID when you want to configure, deploy, or delete this Service later.

    Minimum Parameters for Creating a Service

    Create a Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/services' \
        -X POST \
        -H 'accept: */*' \
        -H 'authorization: Basic Aa1Bb2Cc3Dd4Ee5Ff6Gg7Hh8Ii9Jj0Aa1Bb2Cc3Dd4Ee5Ff6' \
        -H 'Content-Type: application/json' \
        -d '{ "description": "This service handles foo.", "name": "My Foo Service"}'
    

    The following parameters are the base parameters required to create Service.

    Create a Service Request Attributes

    Create a Service Minimum Configuration Sample POST Body (JSON)

    {
      "description": "This service handles foo.",
      "name": "My Foo Service"
    }
    

    Response 201 Created

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 1645,
        "name": "My Foo Service",
        "description": "This service handles foo.",
        "created": 1563897852,
        "updated": 1563897852,
        "createdBy": "someone@example.com",
        "updatedBy": "someone@example.com"
      },
      "requestId": "ec0e40cf720bdbc4"
    }
    

    Attributes

    Get All Services

    To get all Services of a Workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    Minimum Parameters for getting all Services

    Get All Services Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/services?limit=5&skip=0&sort=name' \
        -X GET  \
        -H 'accept: */*' \
        -H 'authorization: Basic Aa1Bb2Cc3Dd4Ee5Ff6Gg7Hh8Ii9Jj0Aa1Bb2Cc3Dd4Ee5Ff6'
    

    The following parameters are the base parameters required to get all Services.

    Get All Services Request Attributes

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": [
        {
          "id": 1619,
          "name": "Some Service",
          "description": null,
          "created": 1563893805,
          "updated": 1563893805,
          "createdBy": "someone@example.com",
          "updatedBy": "someone@example.com"
        },
        {
          "id": 1618,
          "name": "Some other Service",
          "description": "A service that serves as an example",
          "created": 1563893804,
          "updated": 1563893804,
          "createdBy": "someone@example.com",
          "updatedBy": "someone@example.com"
        }
      ],
      "requestId": null,
      "limit": 5,
      "skip": 0,
      "total": 2
    }
    

    Attributes

    Get Service by ID

    To get a Service of your Workspace, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    Minimum Parameters for Getting a Service by its ID

    Get a Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/services/123' \
        -X GET \
        -H 'accept: */*' \
        -H 'authorization: Basic Aa1Bb2Cc3Dd4Ee5Ff6Gg7Hh8Ii9Jj0Aa1Bb2Cc3Dd4Ee5Ff6'
    

    The following parameters are the base parameters required to get a Service by its ID.

    Get a Service Request Attributes

    Response 201 Created

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 123,
        "name": "My Foo Service",
        "description": "This service handles foo.",
        "created": 1563897852,
        "updated": 1563897852,
        "createdBy": "someone@example.com",
        "updatedBy": "someone@example.com"
      },
      "requestId": "d1cfe5c67b2ed26f"
    }
    

    Attributes

    Update a Service

    To update the name and description of an existing Service in your Workspace, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    Minimum Parameters for Updating a Service

    Update a Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/services/123' \
        -X PUT \
        -H 'accept: */*' \
        -H 'authorization: Basic Aa1Bb2Cc3Dd4Ee5Ff6Gg7Hh8Ii9Jj0Aa1Bb2Cc3Dd4Ee5Ff6' \
        -H "Content-Type: application/json" \
        -d '{ "description": "A service that handles foo", "id": 1645, "name": "My foo service"}'
    

    The following parameters are the base parameters required to update a Service.

    Update a Service Request Attributes

    Response 201 Created

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 123,
        "name": "My Foo Service",
        "description": "This service handles foo.",
        "created": 1563897852,
        "updated": 1563897852,
        "createdBy": "someone@example.com",
        "updatedBy": "someone@example.com"
      },
      "requestId": "d1cfe5c67b2ed26f"
    }
    

    Attributes

    Tag REST API

    You can categorize Transactions and Services by applying Tags of your choice. These tags are available in searches and filters.

    Tag names can be provided in two ways:

    New tags are created if they are used in requests and do not exist yet.

    Create a Tag

    You can use tags when you search and filter Transactions or Services. The creation response contains a tag identifier that you should note down. You will need the tagID when you want to configure, deploy, or delete this tag later.

    New tags are also created if they are used in requests and do not exist yet.

    Minimum Parameters for creating a tag

    Create a Tag Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/tags' \
       -X POST \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' \
       -d '{ "description": "payment service category", "name": "pay"}'
    

    The following parameters are the base parameters required to create a tag.

    Create a Tag Request Attributes

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 888,
        "name": "pay",
        "description": "payment service category",
        "created": 1564147307,
        "updated": 1564147307,
        "createdBy": "somebody@example.com",
        "updatedBy": "somebody@example.com"
      },
      "requestId": "acb25df0e22ec097"
    }
    

    Attributes

    Get All Tags

    You can use tags when you search and filter Transactions or Services.

    Minimum Parameters for getting all tags

    Get All Tags Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/tags?limit=10&skip=0&sort=name' \
       -X GET \
       -H 'accept: */*'
    

    The following parameters are the base parameters required to get all tags.

    Get All Tags Request Attributes

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": [
        {
          "id": 163,
          "name": "prod",
          "description": null,
          "created": 1563893805,
          "updated": 1563893805,
          "createdBy": "somebody@example.com",
          "updatedBy": "somebody@example.com"
        },
        {
          "id": 162,
          "name": "test",
          "description": null,
          "created": 1563893805,
          "updated": 1563893805,
          "createdBy": "somebody@example.com",
          "updatedBy": "somebody@example.com"
        },
        {
          "id": 203,
          "name": "dev",
          "description": "tag description",
          "created": 1563980513,
          "updated": 1563980513,
          "createdBy": "somebody@example.com",
          "updatedBy": "somebody@example.com"
        }
      ],
      "requestId": null,
      "limit": 10,
      "skip": 0,
      "total": 3
    }
    

    Attributes

    Get Tag by ID

    To get a tag, you need to know either the tag identifier or its name. The sample code uses a tagId of 888. Use the actual ID values of your tag.

    Minimum Parameters for Getting a Tag by ID

    Get Tag by ID Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/tags/888' \
        -X GET \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to get a tag by its ID.

    Get Tag by ID Request Attributes

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 888,
        "name": "pay",
        "description": "payment service category",
        "created": 1563980513,
        "updated": 1563980513,
        "createdBy": "somebody@example.com",
        "updatedBy": "somebody@example.com"
      },
      "requestId": "ee47a7b219e3a9e5"
    }
    

    Attributes

    Get Tag by Name

    To get a tag, you need to know either the tag name or its identifier. The sample code uses a name of pay. Use the actual name of your tag.

    Minimum Parameters for Getting a Tag by Name

    Get Tag by Name Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/tags/name/pay' \
        -X GET \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to get a tag by its name.

    Get Tag by Name Request Attributes

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 288,
        "name": "pay",
        "description": "payment service category",
        "created": 1564147307,
        "updated": 1564147307,
        "createdBy": "somebody@example.com",
        "updatedBy": "somebody@example.com"
      },
      "requestId": "ee47a7b219e3a9e5"
    }
    

    Attributes

    Update a Tag

    To update the name or description of an existing tag, you need to know the tag identifier. The sample code uses a tagId of 888. Use the actual ID value of your tag.

    Minimum Parameters for Updating a Tag

    Update a Tag Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/tags/888' \
       -X PUT \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' \
       -d '{ "description": "task tracker", "id": 888, "name": "tasks"}'
    

    The following parameters are the base parameters required to update a tag.

    Update a Tag Request Attributes

    Response 201 Created

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-26T13:42:48.750Z",
        "createdBy": "somebody@example.com",
        "description": "task tracker",
        "id": 888,
        "name": "tasks",
        "updated": "2019-07-26T13:42:48.750Z",
        "updatedBy": "somebody@example.com"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Delete Tag

    To delete a tag, you need to know the tag identifier. The sample code uses a tagId of 888. Use the actual ID value of your tag.

    Minimum Parameters for Deleting a Tag

    Delete a Tag Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/tags/888' \
        -X DELETE \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to delete a tag.

    Delete a Tag Request Attributes

    Response 200 OK

    {
    }
    

    Attributes

    Transaction API

    A Transaction is a request/response pair that is associated with a given Service. A Transaction contains one or more request patterns and hard-coded responses. You typically create a custom catalog of mock Transactions for each Service. When you create a Mock Service, you assign Transactions from your catalog to the Mock Service.

    Transaction Types (DSL)

    The dsl is the object that stores properties of Transactions. Supported dsl type keys are GENERIC_DSL, CODESV_DSL, WIREMOCK_DSL, HAR_DSL, SWAGGER2_DSL, SWAGGER3_DSL, TAURUS_RECORDING, RR_PAIR. For more information, see Adding Transactions.

    The easiest way to create a valid dsl for an API call is to create a Transaction in the web interface and copy and paste the response.

    Create Transaction

    To create a Transaction, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    The response contains an identifier that you should note down. You will need this transactionID when you want to configure, deploy, or delete this Transaction later.

    Minimum Parameters for creating a Transaction

    Create a Transaction Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/26208/transactions?serviceId=1645' \
      -X POST \
      -H 'accept: */*' \
      -H 'Content-Type: application/json' \
      -d '{ "transactions": \
          [ \
             { \
                "name": "Transaction from API", \
                "description": "Transaction created by API", \
                "tags": [ "my_tag" ], \
                "dsl": { \
                   "priority": 0, \
                   "requestDsl": { \
                      "method": "POST", \
                      "url": { \
                         "key": "url", \
                         "matcherName": "equals_url", \
                         "matchingValue": "http://www.example.com" \
                      }, \
                      "headers": [ \
                         { \
                            "key": "header1", \
                            "matcherName": "contains", \
                            "matchingValue": "value1" \
                         } \
                      ], \
                      "queryParams": [ \
                         { \
                            "key": "q1", \
                            "matcherName": "contains", \
                            "matchingValue": "q_value1" \
                         } \
                      ], \
                      "cookies": [ \
                         { \
                            "key": "cookie1", \
                            "matcherName": "contains", \
                            "matchingValue": "c_value1" \
                         } \
                      ], \
                      "credentials": { \
                         "username": "joe user",
                         "password": "p455w0rd" \
                      }, \
                      "body": [ \
                         { \
                            "matcherName": "matches_json", \
                            "matchingValue": "JFsnbWVudSddWydpZCdd" \
                         } \
                      ] \
                   }, \
                   "responseDsl": { \
                      "status": 200, \
                      "statusMessage": "HTTP/1.1 200 OK", \
                      "headers": [ \
                         { \
                            "name": "Content-Type", \
                            "value": "text/plain; charset=UTF-8" \
                         } \
                      ], \
                      "binary": false, \
                      "content": "SGVsbG8gd29ybGQhCg==", \
                      "charset": "UTF-8" \
                   } \
                } \
             } \
          ] \
    }' 
    

    The following parameters are the base parameters required to create a Transaction.

    Create a Transaction Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "description": "string",
        "dsl": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "id": 0,
        "link": "string",
        "name": "string",
        "serviceId": 0,
        "serviceName": "string",
        "tags": [
          "string"
        ]
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Create Transaction From Sources

    To create a Transaction from a source file, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    The creation response contains an identifier that you should note down. You will need the transactionID when you want to configure, deploy, or delete this Transaction later.

    Minimum Parameters for creating a Transaction

    Create a Transaction Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions' \
       -X POST \
       -H 'accept: */*' \
       -H 'Content-Type: multipart/form-data' \
       -F 'serviceId=123' \
       -F 'verbose=true'
    

    The following parameters are the base parameters required to create a Transaction.

    Create a Transaction Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": [
        {
          "description": "string",
          "dsl": {
              "priority": 1,
              "requestDsl": {
                "method": "GET",
                "host": "http://miurl.com.ec",
                "path": "",
                "url": {
                  "key": "url",
                  "matcherName": "equals_url",
                  "matchingValue": "miurl.com.ec"
                },
                "headers": [],
                "queryParams": [],
                "cookies": [],
                "credentials": {},
                "body": []
              },
              "responseDsl": {
                "status": 200,
                "statusMessage": "OK",
                "proxyUrl": "",
                "headers": [],
                "binary": false,
                "contentType": "json",
                "content": "",
                "charset": "UTF-8"
              }
            } ,
          "id": 0,
          "link": "string",
          "name": "string",
          "serviceId": 123,
          "serviceName": "string",
          "tags": [
            "string"
          ]
        }
      ],
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Import Transactions

    Use this API to upload files of Transactions to lists of generic DSLs that can be used in BlazeMeter. Supported file formats are .json, .yml, .yaml, .har, .zip.

    Minimum Parameters for Importing Transactions

    Import Transactions Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/transactions/convert?verbose=true' \
       -X POST \
       -H 'accept: */*' \
       -H 'Content-Type: multipart/form-data' \
       -F 'file=@my-swagger.json;type=text/json'
    

    The following parameters are the base parameters required to import Transactions.

    Import Transactions Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": [
        {
          "nativeId": "string",
          "priority": 0,
          "requestDsl": {
            "body": [
              {
                "key": "string",
                "matcherName": "string",
                "matchingValue": "string"
              }
            ],
            "cookies": [
              {
                "key": "string",
                "matcherName": "string",
                "matchingValue": "string"
              }
            ],
            "credentials": {
              "password": "string",
              "username": "string"
            },
            "headers": [
              {
                "key": "string",
                "matcherName": "string",
                "matchingValue": "string"
              }
            ],
            "host": "string",
            "method": "string",
            "path": "string",
            "queryParams": [
              {
                "key": "string",
                "matcherName": "string",
                "matchingValue": "string"
              }
            ],
            "url": {
              "key": "string",
              "matcherName": "string",
              "matchingValue": "string"
            }
          },
          "responseDsl": {
            "binary": true,
            "charset": "string",
            "content": "string",
            "contentType": "JSON",
            "headers": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "proxyUrl": "string",
            "status": 0,
            "statusMessage": "string"
          }
        }
      ],
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Get Transaction

    To get a Transaction, you need to know your Workspace identifier and the Transaction identifier. The sample code uses a transactionId of 77 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for getting a Transaction

    Get a Transaction Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions/77' \
        -X GET \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to get a Transaction.

    Get a Transaction Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "description": "string",
        "dsl": {
              "priority": 1,
              "requestDsl": {
                "method": "GET",
                "host": "http://miurl.com.ec",
                "path": "",
                "url": {
                  "key": "url",
                  "matcherName": "equals_url",
                  "matchingValue": "miurl.com.ec"
                },
                "headers": [],
                "queryParams": [],
                "cookies": [],
                "credentials": {},
                "body": []
              },
              "responseDsl": {
                "status": 200,
                "statusMessage": "OK",
                "proxyUrl": "",
                "headers": [],
                "binary": false,
                "contentType": "json",
                "content": "",
                "charset": "UTF-8"
              }
            } ,
        "id": 0,
        "link": "string",
        "name": "string",
        "serviceId": 0,
        "serviceName": "string",
        "tags": [
          "string"
        ]
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Get All Transactions

    To get all Transactions within a Service, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    You can filter Transactions by a (sub)string, Transaction name, Service Mock identifier, workspaceId, custom Tags, or Transaction type (dsl).

    Minimum Parameters for getting all Transactions

    Get All Transactions Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions?serviceId=123' \
        -X GET \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to get all Transactions.

    Get All Transactions Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": [
        {
          "description": "string",
          "dsl": {
              "priority": 1,
              "requestDsl": {
                "method": "GET",
                "host": "http://miurl.com.ec",
                "path": "",
                "url": {
                  "key": "url",
                  "matcherName": "equals_url",
                  "matchingValue": "miurl.com.ec"
                },
                "headers": [],
                "queryParams": [],
                "cookies": [],
                "credentials": {},
                "body": []
              },
              "responseDsl": {
                "status": 200,
                "statusMessage": "OK",
                "proxyUrl": "",
                "headers": [],
                "binary": false,
                "contentType": "json",
                "content": "",
                "charset": "UTF-8"
              }
            } ,
          "id": 0,
          "link": "string",
          "name": "string",
          "serviceId": 123,
          "serviceName": "string",
          "tags": [
            "string"
          ]
        }
      ],
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Perform Bulk Operation Over Transactions

    To perform a bulk delete or tag operation over several Transactions in a Workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    Minimum Parameters for bulk operations

    Bulk Operations Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions' \
      -X PATCH \
      -H 'accept: */*' \
      -H 'Content-Type: application/json' \
      -d '{ "action": "DELETE", "tags": [ "some_category" ], "transactions": [ 0 ]}'
    

    The following parameters are the base parameters required to perform bulk operations.

    Bulk Operations Request Attributes

    Response 200 OK

    {
      "body": {},
      "statusCode": "100 CONTINUE",
      "statusCodeValue": 0
    }
    

    Attributes

    Update Transaction

    To update an existing Transaction in your Workspace, you need to know your Workspace identifier and the Transaction identifier. The sample code uses a transactionId of 77 and a workspaceId of 123456. Use the actual ID values of your workspace and Transaction.

    Minimum Parameters for Updating a Transaction

    The following parameters are the base parameters required to update a Transaction.

    Update a Transaction Request Attributes

    Update a Transaction Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions/77' \
       -X PUT \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' \
       -d '{ "description": "string",
             "dsl": { \
                    "priority": 1, \
                    "requestDsl": { \
                      "method": "GET", \
                      "host": "http://miurl.com.ec", \
                      "path": "", \
                      "url": { \
                        "key": "url", \
                        "matcherName": "equals_url", \
                        "matchingValue": "miurl.com.ec" \
                      }, \
                      "headers": [], \
                      "queryParams": [], \
                      "cookies": [], \
                      "credentials": {}, \
                      "body": [] \
                    }, \
                    "responseDsl": { \
                      "status": 200, \
                      "statusMessage": "OK", \
                      "proxyUrl": "", \
                      "headers": [], \
                      "binary": false, \
                      "contentType": "json", \
                      "content": "", \
                      "charset": "UTF-8" \
                    } \
                  } \
             "id": 0, \
             "link": "string", \
             "name": "string", \
             "serviceId": 0, \
             "serviceName": "string", \
             "tags": [ "string" ]
           }'
    

    Response 201 Created

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-24T16:07:03.541Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "mockServiceTransactions": [
          0
        ],
        "updated": "2019-07-24T16:07:03.541Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Delete Transaction

    To delete a Transaction, you need to know the Transaction identifier and your Workspace identifier. The sample code uses a transactionId of 888 and a workspaceId of 123456. Use the actual ID value of your Transaction.

    Minimum Parameters for Deleting a Transaction

    Delete a Transaction Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/transactions/77' \
        -X DELETE \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to delete a Transaction.

    Delete a Transaction Request Attributes

    Response 200 OK

    {
      "body": {},
      "statusCode": "100 CONTINUE",
      "statusCodeValue": 0
    }
    

    Attributes

    Get All Conflicting Transactions

    To get all conflicting Transactions from a Service, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    Minimum Parameters for getting all conflicting Transactions

    Get All Conflicting Transactions Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com//api/v1/workspaces/123456/transactions/conflicts' \
        -X GET \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to get all conflicting Transactions.

    Get All Conflicting Transactions Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "additionalProp1": [
          {
            "description": "string",
            "dsl": {
              "priority": 1,
              "requestDsl": {
                "method": "GET",
                "host": "http://miurl.com.ec",
                "path": "",
                "url": {
                  "key": "url",
                  "matcherName": "equals_url",
                  "matchingValue": "miurl.com.ec"
                },
                "headers": [],
                "queryParams": [],
                "cookies": [],
                "credentials": {},
                "body": []
              },
              "responseDsl": {
                "status": 200,
                "statusMessage": "OK",
                "proxyUrl": "",
                "headers": [],
                "binary": false,
                "contentType": "json",
                "content": "",
                "charset": "UTF-8"
              }
            } ,
            "id": 0,
            "link": "string",
            "name": "string",
            "serviceId": 0,
            "serviceName": "string",
            "tags": [
              "string"
            ]
          }
        ],
        "additionalProp2": [
          {
            "description": "string",
            "dsl": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "id": 0,
            "link": "string",
            "name": "string",
            "serviceId": 0,
            "serviceName": "string",
            "tags": [
              "string"
            ]
          }
        ],
        "additionalProp3": [
          {
            "description": "string",
            "dsl": {
              "array": true,
              "bigDecimal": true,
              "bigInteger": true,
              "binary": true,
              "boolean": true,
              "containerNode": true,
              "double": true,
              "float": true,
              "floatingPointNumber": true,
              "int": true,
              "integralNumber": true,
              "long": true,
              "missingNode": true,
              "nodeType": "ARRAY",
              "null": true,
              "number": true,
              "object": true,
              "pojo": true,
              "short": true,
              "textual": true,
              "valueNode": true
            },
            "id": 0,
            "link": "string",
            "name": "string",
            "serviceId": 123,
            "serviceName": "string",
            "tags": [
              "string"
            ]
          }
        ]
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Mock Service REST API

    You can create a Mock Service that stands in for a live service for testing purposes.

    Create Mock Services

    To create a Mock Service in your workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    The response contains a Mock Service identifier that you should note down. You will need this mockServiceID when you want to configure, deploy, or delete this Mock Service later.

    Minimum Parameters for creating a Mock Service

    Create a Mock Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks' \
      -X POST \
      -H 'accept: application/json;charset=UTF-8' \
      -H 'Content-Type: application/json' \
      -d '{ "description": "string", \
            "endpointPreference": "string", \
            "harborId": "string", \
            "id": 0,\
            "type": "TRANSACTIONAL",\
            "liveSystemHost": "string", \
            "liveSystemPort": 0, \
            "name": "string", \
            "noMatchingRequestPreference": "string", \
            "noMatchingRequestTxnId": 0, \
            "serviceId": 123, \
            "shipId": "string", \
            "thinkTime": 0, \
            "mockServiceTransactions": [ {"txnId":1, "priority":9} ]}'
    

    The following parameters are the base parameters required to create a Mock Service.

    Create a Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "errors": [
        {
          "code": "string",
          "message": "string",
          "severity": "WARN"
        }
      ],
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2020-06-17T13:04:42.949Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "isNew": true,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "mockServiceTransactions": [
          {
            "priority": 0,
            "txnId": 0
          }
        ],
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "replicas": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "type": "TRANSACTIONAL",
        "updated": "2020-06-17T13:04:42.949Z",
        "updatedBy": "string",
        "updatedDate": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Get All Mock Services

    To get all Mock Services, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    You can filter by workspaceId and serviceId.

    Minimum Parameters for getting all Mock Services

    Get All Mock Services Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/26208/service-mocks?serviceId=123' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'authorization: Basic Aa1Bb2Cc3Dd4Ee5Ff6Gg7Hh8Ii9Jj0Aa1Bb2Cc3Dd4Ee5Ff6'
    

    The following parameters are the base parameters required to get all Mock Services.

    Get All Mock Services Request Attributes

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": [
        {
          "id": 1619,
          "name": "Some Service",
          "description": null,
          "created": 1563893805,
          "updated": 1563893805,
          "createdBy": "someone@example.com",
          "updatedBy": "someone@example.com"
        },
        {
          "id": 1618,
          "name": "Some other Service",
          "description": "A service that serves as an example",
          "created": 1563893804,
          "updated": 1563893804,
          "createdBy": "someone@example.com",
          "updatedBy": "someone@example.com"
        }
      ],
      "requestId": null,
      "limit": 5,
      "skip": 0,
      "total": 2
    }
    

    Attributes

    Get Mock Service

    To get a Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Getting a Mock Service

    Get Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to get a Mock Service.

    Get Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-24T16:06:01.427Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "mockServiceTransactions": [
          0
        ],
        "updated": "2019-07-24T16:06:01.427Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Update a Mock Service

    To update an existing Mock Service in your Workspace, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Updating a Mock Service

    Update a Mock Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X PUT \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d '{ "description": "string", \
              "endpointPreference": "string", \
              "harborId": "string", \
              "id": 0, \
              "liveSystemHost": "string", \
              "liveSystemPort": 0, \
              "name": "string", \
              "noMatchingRequestPreference": "string", \
              "noMatchingRequestTxnId": 0, \
              "serviceId": 0, \
              "shipId": "string", \
              "thinkTime": 0, \
              "mockServiceTransactions": [ 0 ]}'
    

    The following parameters are the base parameters required to update a Mock Service.

    Update a Mock Service Request Attributes

    Response 201 Created

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-24T16:07:03.541Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "mockServiceTransactions": [
          0
        ],
        "updated": "2019-07-24T16:07:03.541Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Delete Mock Services

    To delete a Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Deleting a Mock Service

    Delete Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X DELETE \
        -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to delete a Mock Service.

    Delete Mock Service Request Attributes

    Response 200 OK

    {
      "body": {},
      "statusCode": "100 CONTINUE",
      "statusCodeValue": 0
    }
    

    Attributes

    Update Mock Service Properties

    To update properties of an existing Mock Service in your Workspace, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Updating Mock Service Properties

    Update a Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X PATCH \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d '{ "description": "string", \
              "endpointPreference": "string", \
              "harborId": "string", \
              "name": "string", \
              "serviceId": 0, \
              "shipId": "string", \
              "status": "STOPPED", \
              "mockServiceTransactions": [ 0 ]\
            }'
    

    The following parameters are the base parameters required to update Mock Service properties.

    Update Mock Service Properties Request Attributes

    Response 201 Created

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-24T16:21:44.603Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "endpointPreference": "string",
        "harborId": "string",
        "httpEndpoint": "string",
        "httpsEndpoint": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "shipId": "string",
        "status": "STOPPED",
        "thinkTime": 0,
        "mockServiceTransactions": [
          0
        ],
        "updated": "2019-07-24T16:21:44.603Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Deploy Mock Services

    Use this request to deploy a container based on the Mock Service if it has not already been deployed.

    To deploy a Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Deploying a Mock Service

    Deploy Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/deploy' \
      -X GET \
      -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to deploy a Mock Service.

    Deploy Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "trackingId": "string",
        "trackingUrl": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Change the Status of a Mock Service

    To change the status of a Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Submit the status value in the body. The status of a Mock Service is one of the following: STOPPED, RUNNING, CONFIGURING, FAILED (Service Mock initialization failed).

    Minimum Parameters for Stopping a Mock Service

    Stop Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/status' \
        -X POST \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d 'STOPPED'
    

    The following parameters are the base parameters required to stop a Mock Service.

    Stop Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": true,
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Configure and Deploy Mock Services

    To configure or deploy Mock Services, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    Minimum Parameters for Configuring/Deploying Mocks

    Configure/deploy Mocks Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/configure' \
        -X POST \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d '{ "dependencies": \
                { "services": \
                    [ { "service": "PayPal", \
                        "mock-service": "PPRunner", \
                        "transactions": \
                            [ "getAccounts", "getBalances", "createAccount" ] \
                      }, \
                      { "service": "WesternUnion", \
                        "mock-service": "WURunner", \
                        "transaction-filter": \
                            { "tags": \
                                [ "dev", "stage" ] \
                            } \
                      }, \
                      { "service": "Facebook", \
                        "mock-service": "FBRunner", \
                        "mock-service-template": "FBRunnerTemplate" \
                      } \
                    ] \
                } \
            }'
    

    The following parameters are the base parameters required to configure/deploy Mock Services.

    Configure/Deploy Mocks Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "trackingId": "string",
        "trackingUrl": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Configure or Reconfigure Mock Services

    To configure or reconfigure an existing Mock Service, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Configuring a Mock Service

    Configure Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/configure' \
      -X GET \
      -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to configure a Mock Service.

    Configure Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "trackingId": "string",
        "trackingUrl": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Verify Taurus Configuration Dependencies

    To validate Taurus configuration dependencies, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    Minimum Parameters for Validation

    Validate Mock Services Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/validate' \
        -X POST \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d '{ "dependencies": \
                { "services": \
                    [ { "service": "PayPal", \
                        "mock-service": "PPRunner", \
                        "transactions": \
                            [ "getAccounts", "getBalances", "createAccount" ] \
                      }, \
                      { "service": "WesternUnion", \
                        "mock-service": "WURunner", \
                        "transaction-filter": \
                            { "tags": \
                                [ "dev", "stage" ] \
                            } \
                      }, \
                      { "service": "Facebook", \
                        "mock-service": "FBRunner", \
                        "mock-service-template": "FBRunnerTemplate" \
                      } \
                    ] \
                } \
            }'
    

    The following parameters are the base parameters required to validate Mock Services.

    Validate Mock Services Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "dependencies": {
          "array": true,
          "bigDecimal": true,
          "bigInteger": true,
          "binary": true,
          "boolean": true,
          "containerNode": true,
          "double": true,
          "float": true,
          "floatingPointNumber": true,
          "int": true,
          "integralNumber": true,
          "long": true,
          "missingNode": true,
          "nodeType": "ARRAY",
          "null": true,
          "number": true,
          "object": true,
          "pojo": true,
          "short": true,
          "textual": true,
          "valueNode": true
        },
        "errors": [
          "string"
        ],
        "warnings": [
          "string"
        ]
      },
      "skip": 0,
      "total": 0
    }
    

    Attribute Description
    workspaceId

    string

    The Workspace identifier.

    required

    MAR Mock Service REST API

    A MAR Mock Service is the same as a transactional mock service, just with additional parameters. You can create a MAR file-based MAR Mock Service that stands in for a live service for testing purposes. MAR files are portable copies of virtual services that are proprietary to Service Virtualization.

    In order to use a MAR Mock Service, you must upload a MAR file asset to the Asset Catalog. For more information, see MAR Mock Service Assets.

    Create MAR Mock Services

    A MAR Mock Service is the same as a transactional mock service, just with additional parameters. To create a MAR Mock Service in your workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    The response contains a Mock Service identifier that you should note down. You will need this mockServiceID when you want to configure, deploy, or delete this MAR Mock Service later.

    Required request body fields for MAR mock services:

    Minimum Parameters for creating a MAR Mock Service

    Create a MAR Mock Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks' \
      -X POST \
      -H 'accept: application/json;charset=UTF-8' \
      -H 'Content-Type: application/json' \
      -d '{  "serviceId": 8019,
             "name": "MAR-MS",
             "description": "MAR mock service created using API",
             "bridgeId": 456,
             "registryId": 307,
             "vseId": 647,
             "thinkTime": 100,
             "capacity": 1,
             "replicas": 1,
             "groupTag": "",
             "type": "SV",
             "assetId": 1846
      }'
    

    The following parameters are the base parameters required to create a MAR Mock Service.

    Create a MAR Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 18407,
        "serviceId": 8019,
        "serviceName": "Default Service",
        "name": "MAR-MS",
        "type": "SV",
        "description": "MAR mock service created using API",
        "harborId": null,
        "shipId": null,
        "endpointPreference": "HTTPS",
        "liveSystemHost": null,
        "liveSystemPort": null,
        "thinkTime": 100,
        "noMatchingRequestPreference": "return404",
        "noMatchingRequestTxnId": null,
        "replicas": null,
        "mockServiceTransactions": [
        ],
        "created": 1591893042,
        "updated": 1591893042,
        "createdBy": "john.doe@abc.com",
        "updatedBy": "john.doe@abc.com",
        "status": "STOPPED",
        "httpEndpoint": null,
        "httpsEndpoint": null,
        "bridgeId": 456,
        "registryId": 307,
        "vseId": 647,
        "capacity": 1,
        "groupTag": "",
        "assetId": 1846,
        "svMessage": null,
        "svEndpoint": null,
        "registryUrl": null,
        "svVseName": null,
        "svVseId": null,
        "marFileId": null,
        "isNew": true,
        "createdDate": "June 11, 2020",
        "updatedDate": "June 11, 2020"
      },
      "requestId": "5f787f0c9d58382e"
    }
    
    

    Attributes

    Get MAR Mock Service

    A MAR Mock Service is the same as a transactional mock service, just with additional parameters. To get a MAR Mock Service, you need to know your Workspace identifier and the MAR Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and MAR Mock Service.

    Minimum Parameters for Getting a MAR Mock Service

    Get MAR Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to get a MAR Mock Service.

    Get MAR Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 18407,
        "serviceId": 8019,
        "serviceName": "Default Service",
        "name": "MAR-MS",
        "type": "SV",
        "description": "MAR mock service created using API",
        "harborId": null,
        "shipId": null,
        "endpointPreference": "HTTPS",
        "liveSystemHost": null,
        "liveSystemPort": null,
        "thinkTime": 100,
        "noMatchingRequestPreference": "return404",
        "noMatchingRequestTxnId": null,
        "replicas": null,
        "mockServiceTransactions": [
        ],
        "created": 1591893353,
        "updated": 1591893353,
        "createdBy": "john.doe@abc.com",
        "updatedBy": "john.doe@abc.com",
        "status": "STOPPED",
        "httpEndpoint": null,
        "httpsEndpoint": null,
        "bridgeId": 456,
        "registryId": 307,
        "vseId": 647,
        "capacity": 1,
        "groupTag": "",
        "assetId": 1846,
        "svMessage": null,
        "svEndpoint": null,
        "registryUrl": null,
        "svVseName": null,
        "svVseId": null,
        "marFileId": null,
        "isNew": true,
        "updatedDate": "June 11, 2020",
        "createdDate": "June 11, 2020"
      },
      "requestId": "189da42c3d02c282"
    }
    

    Attributes

    Update a MAR Mock Service

    A MAR Mock Service is the same as a transactional mock service, just with additional parameters. To update an existing MAR Mock Service in your Workspace, you need to know your Workspace identifier and the MAR Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and MAR Mock Service.

    Minimum Parameters for Updating a MAR Mock Service

    Update a MAR Mock Service Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X PUT \
        -H 'accept: application/json;charset=UTF-8' \
        -H 'Content-Type: application/json' \
        -d '{ 
              "name": "MAR-MS",
              "description": "Updating VSE ID",
              "bridgeId": 456,
              "registr-yId": 307,
              "vseId": 646,
              "type": "SV",
              "assetId": 1846,
              "endpointPreference" : "HTTP"
            }'
    

    The following parameters are the base parameters required to update a MAR Mock Service.

    Update a MAR Mock Service Request Attributes

    Response 201 Created

    {
      "apiVersion": 1,
      "error": null,
      "result": {
        "id": 1234,
        "serviceId": 8019,
        "serviceName": "Default Service",
        "name": "MAR-MS",
        "type": "SV",
        "description": "Updating VSE ID",
        "harborId": null,
        "shipId": null,
        "endpointPreference": "HTTP",
        "liveSystemHost": null,
        "liveSystemPort": null,
        "thinkTime": null,
        "noMatchingRequestPreference": null,
        "noMatchingRequestTxnId": null,
        "replicas": null,
        "mockServiceTransactions": [
        ],
        "created": 1591895083,
        "updated": 1591895356,
        "createdBy": "john.doe@abc.com",
        "updatedBy": "john.doe@abc.com",
        "status": "STOPPED",
        "httpEndpoint": null,
        "httpsEndpoint": null,
        "bridgeId": 456,
        "registryId": 307,
        "vseId": 646,
        "capacity": null,
        "groupTag": null,
        "assetId": 1846,
        "svMessage": null,
        "svEndpoint": null,
        "registryUrl": null,
        "svVseName": null,
        "svVseId": null,
        "marFileId": null,
        "isNew": true,
        "createdDate": "June 11, 2020",
        "updatedDate": "June 11, 2020"
      },
      "requestId": "5f93ff0d86dd29e1"
    }
    
    

    Attributes

    Deploy MAR Mock Services

    A MAR Mock Service is the same as a transactional mock service, just with additional parameters. Use this request to deploy a container based on the MAR Mock Service if it has not already been deployed.

    To deploy a MAR Mock Service, you need to know your Workspace identifier and the MAR Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and MAR Mock Service.

    Minimum Parameters for Deploying a MAR Mock Service

    Deploy MAR Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/deploy' \
      -X GET \
      -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to deploy a MAR Mock Service.

    Deploy MAR Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion" : 1,
      "error" : null,
      "result" : {
        "trackingId" : "a5d55807-1280-47ff-b036-28c16d1b69fe",
        "status" : "RUNNING",
        "errors" : [ ],
        "warnings" : [ ],
        "trackingUrl" : "/api/v1/trackings/a5d55807-1280-47ff-b036-28c16d1b69fe",
        "data" : {
          "dataType" : "CONFIGURATION",
          "values" : [ 8102 ]
        },
        "created" : 1591898836,
        "createdBy" : null,
        "updated" : 1591898836,
        "updatedBy" : "john.doe@abc.com",
        "ended" : null
      },
      "requestId" : "3a6c97c66c1abdf3"
    }
    
    

    Attributes

    Configure or Reconfigure MAR Mock Services

    A MAR Mock Service is the same as a transactional mock service, just with additional parameters. To configure or reconfigure an existing MAR Mock Service, you need to know your Workspace identifier and the MAR Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and MAR Mock Service.

    Minimum Parameters for Configuring a MAR Mock Service

    Configure MAR Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/configure' \
      -X GET \
      -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to configure a MAR Mock Service.

    Configure MAR Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion" : 1,
      "error" : null,
      "result" : {
        "trackingId" : "93853573-6560-4e3c-9ff8-03fe4cc450ac",
        "status" : "RUNNING",
        "errors" : [ ],
        "warnings" : [ ],
        "trackingUrl" : "/api/v1/trackings/93853573-6560-4e3c-9ff8-03fe4cc450ac",
        "data" : {
          "dataType" : "CONFIGURATION",
          "values" : [ 8102 ]
        },
        "created" : 1591899111,
        "createdBy" : null,
        "updated" : 1591899111,
        "updatedBy" : "john.doe@abc.com",
        "ended" : null
      },
      "requestId" : "f7af567b5b689dbb"
    }
    
    

    Attributes

    Stop MAR Mock Services

    A MAR Mock Service is the same as a transactional mock service, just with additional parameters. To stop a MAR Mock Service, you need to know your Workspace identifier and the MAR Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and MAR Mock Service.

    Minimum Parameters for Stopping a MAR Mock Service

    Stop MAR Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/stop' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to stop a MAR Mock Service.

    Stop MAR Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion" : 1,
      "error" : null,
      "result" : {
        "trackingId" : "3f637a96-dccc-4759-957f-b4849c95301d",
        "status" : "RUNNING",
        "errors" : [ ],
        "warnings" : [ ],
        "trackingUrl" : "/api/v1/trackings/3f637a96-dccc-4759-957f-b4849c95301d",
        "data" : {
          "dataType" : "CONFIGURATION",
          "values" : [ 8102 ]
        },
        "created" : 1591899378,
        "createdBy" : null,
        "updated" : 1591899378,
        "updatedBy" : "john.doe@abc.com",
        "ended" : null
      },
      "requestId" : "f13e55e71bc3f16a"
    }
    
    

    Attributes

    Delete MAR Mock Services

    A MAR Mock Service is the same as a transactional mock service, just with additional parameters. To delete a MAR Mock Service, you need to know your Workspace identifier and the MAR Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and MAR Mock Service.

    Minimum Parameters for Deleting a MAR Mock Service

    Delete MAR Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234' \
        -X DELETE \
        -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to delete a MAR Mock Service.

    Delete MAR Mock Service Request Attributes

    Response 204

    The call returns response code 204 without any response content.

    Attributes

    Mock Service Assets

    This API lets you import and manage MAR file assets in your Asset Catalog. A MAR file is a downloadable version of a virtual service from Service Virtualization Enterprise Edition that you can load into BlazeMeter and deploy as a Mock Service.

    Create an Asset

    Minimum Parameters for Creating an Asset

    Create an Asset Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/assets' \
       -X POST \
       -H 'accept: */*' \
       -H 'Content-Type: multipart/form-data' \
       -d '{ "filename": "my-file.mar", "folderId": "string", "serviceId": 123}'
    

    The following parameters are the base parameters required to create an asset.

    Create an Asset Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2020-02-21T15:22:11.712Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "fileId": "string",
        "folderId": "string",
        "id": 0,
        "name": "string",
        "primaryMetadata": {},
        "secondaryMetadata": {},
        "serviceId": 123,
        "serviceName": "string",
        "tags": [
          "string1;string2"
        ],
        "type": "MAR",
        "updated": "2020-02-21T15:22:11.713Z",
        "updatedBy": "string",
        "updatedDate": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Delete an Asset

    You use this API to delete a MAR asset of a Mock Service.

    Minimum Parameters for deleting an asset

    Delete an Asset Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/assets/98765' \
       -X DELETE \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' 
    

    The following parameters are the base parameters required to delete an asset.

    Delete an Asset Request Attributes

    Response 200 OK

    {
      "body": {},
      "statusCode": "100 CONTINUE",
      "statusCodeValue": 0
    }
    

    Attributes

    Download Assets

    This API is used to download a MAR asset. The response will be a url of the asset which can be downloaded separately.

    Minimum Parameters for downloading assets

    Downloading Assets Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/assets/98765/download' \
       -X GET \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' 
    

    The following parameters are the base parameters required to dowload assets.

    Download Assets Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": "string",
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Get an Asset

    This API is used to retrieve the details about a single asset (a MAR file). The workspace id and assetId are part of the endpoint and are mandatory.

    Minimum Parameters for Getting an Asset

    Get an Asset Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/assets/98765' \
       -X GET \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' \
       -d '{ "description": "payment service category", "name": "pay"}'
    

    The following parameters are the base parameters required to get an asset.

    Get an Asset Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2020-02-21T16:30:42.424Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "fileId": "string",
        "folderId": "string",
        "id": 0,
        "name": "string",
        "primaryMetadata": {},
        "secondaryMetadata": {},
        "serviceId": 0,
        "serviceName": "string",
        "tags": [
          "string"
        ],
        "type": "MAR",
        "updated": "2020-02-21T16:30:42.424Z",
        "updatedBy": "string",
        "updatedDate": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Get All Assets

    Retrieves all assets (MAR files) present in a workspace. This API can also filter the list by service id. Workspace Id is mandatory.

    Minimum Parameters for Getting All Assets

    Get All Assets Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/assets' \
       -X GET \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' \
       -d '{ "workspaceId": 123456}'
    

    The following parameters are the base parameters required to get all assets.

    Get All Assets Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": [
        {
          "created": "2020-02-21T15:17:41.805Z",
          "createdBy": "string",
          "createdDate": "string",
          "description": "string",
          "fileId": "string",
          "folderId": "string",
          "id": 0,
          "name": "string",
          "primaryMetadata": {},
          "secondaryMetadata": {},
          "serviceId": 0,
          "serviceName": "string",
          "tags": [
            "string"
          ],
          "type": "MAR",
          "updated": "2020-02-21T15:17:41.805Z",
          "updatedBy": "string",
          "updatedDate": "string"
        }
      ],
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Update an Asset

    This API is used to update the properties of an asset.

    Minimum Parameters for Updating Assets

    Update an Asset Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/assets/98765' \
       -X PATCH \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' \
       -d '{      "description": "my updated description", \
              "primaryMetadata": "string", \
            "secondaryMetadata": "string", \
                    "serviceId": 123, \
                         "tags": [ "string" ]}'
    

    The following parameters are the base parameters required to update an asset.

    Update an Asset Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2020-02-21T16:43:46.055Z",
        "createdBy": "string",
        "createdDate": "string",
        "description": "string",
        "fileId": "string",
        "folderId": "string",
        "id": 0,
        "name": "string",
        "primaryMetadata": {},
        "secondaryMetadata": {},
        "serviceId": 0,
        "serviceName": "string",
        "tags": [
          "string"
        ],
        "type": "MAR",
        "updated": "2020-02-21T16:43:46.055Z",
        "updatedBy": "string",
        "updatedDate": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Validate Asset Name

    This API can be used to validate the name of the asset to see if it is unique for a service. To determine uniqueness, the asset catalog considers the service id and name.

    Minimum Parameters for Validating an Asset Name

    Validate an Asset Name Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/assets/validate-name' \
       -X POST \
       -H 'accept: */*' \
       -H 'Content-Type: application/json' \
       -d '{ "idToIgnore": 0, "name": "string", "serviceId": 0}'
    

    The following parameters are the base parameters required to validate an asset name.

    Validate Asset Name Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": true,
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Mock Service Template REST API

    Create Mock Service Template

    To create a Mock Service templates, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    The response contains a template identifier that you should note down. You will need the ID when you want to configure, deploy, or delete this template later.

    Minimum Parameters for creating a Mock Service template

    Create Mock Service Templates Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates?serviceId=123' \
        -X POST \
        -H 'accept: */*' \
        -H 'Content-Type: application/json' \
        -d '{ "created": "2019-07-25T13:20:53.808Z",  \
              "createdBy": "string",  \
              "description": "string",  \
              "liveSystemHost": "string",  \
              "liveSystemPort": 0,  \
              "name": "string",  \
              "noMatchingRequestPreference": "string",  \
              "noMatchingRequestTxnId": 0,  \
              "thinkTime": 0,  \
              "mockServiceTransactions": [ 0 ],  \
              "updated": "2019-07-25T13:20:53.808Z",  \
              "updatedBy": "string" \
            }''
    

    The following parameters are the base parameters required to create a Mock Service template.

    Create Mock Service Template Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-25T13:25:10.373Z",
        "createdBy": "string",
        "description": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "thinkTime": 0,
        "mockServiceTransactions": [
          0
        ],
        "updated": "2019-07-25T13:25:10.373Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Get All Mock Service Templates

    To get all Mock Service templates, you need to know your Workspace identifier and the Service identifier. The sample code uses a serviceId of 123 and a workspaceId of 123456. Use the actual ID values of your Workspace and Service.

    You can filter templates by workspaceId.

    Minimum Parameters for getting all Mock Service templates

    Get All Mock Templates Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates?serviceId=123' \
        -X GET  \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to get all Mock Service templates.

    Get All Mock Service Templates Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": [
        {
          "created": "2019-07-25T13:25:10.347Z",
          "createdBy": "string",
          "description": "string",
          "id": 0,
          "liveSystemHost": "string",
          "liveSystemPort": 0,
          "name": "string",
          "noMatchingRequestPreference": "string",
          "noMatchingRequestTxnId": 0,
          "serviceId": 0,
          "serviceName": "string",
          "thinkTime": 0,
          "mockServiceTransactions": [
            0
          ],
          "updated": "2019-07-25T13:25:10.347Z",
          "updatedBy": "string"
        }
      ],
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Get Mock Service Template

    To get a Mock Service template, you need to know your Workspace identifier and the Mock Service Template identifier. The sample code uses a serviceMockTemplateId of 8 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for getting a Mock Service template

    Get a Mock Service Template Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates/8' \
        -X GET \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to get a Mock Service template.

    Get a Mock Service Template Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-25T13:36:44.158Z",
        "createdBy": "string",
        "description": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "thinkTime": 0,
        "mockServiceTransactions": [
          0
        ],
        "updated": "2019-07-25T13:36:44.158Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Update Mock Service Template

    To update a Mock Service template, you need to know your Workspace identifier and the Mock Service Template identifier. The sample code uses a serviceMockTemplateId of 8 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for updating a Mock Service template

    Update Mock Service Templates Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates/8' \
        -X PUT \
        -H 'Content-Type: application/json' \
        -d '{ "created": "2019-07-25T13:41:28.547Z", \
              "createdBy": "string", \
              "description": "string", \
              "liveSystemHost": "string", \
              "liveSystemPort": 0, \
              "name": "string", \
              "noMatchingRequestPreference": "string", \
              "noMatchingRequestTxnId": 0, \
              "thinkTime": 0, \
              "mockServiceTransactions": [ 0 ], \
              "updated": "2019-07-25T13:41:28.547Z", \
              "updatedBy": "string" \
            }'
    

    The following parameters are the base parameters required to update Mock Service templates.

    Update Mock Service Template Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-25T13:45:01.191Z",
        "createdBy": "string",
        "description": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "thinkTime": 0,
        "mockServiceTransactions": [
          0
        ],
        "updated": "2019-07-25T13:45:01.191Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Delete Mock Service Template

    To delete a Mock Service template, you need to know your Workspace identifier and the Mock Service Template identifier. The sample code uses a serviceMockTemplateId of 8 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for deleting a Mock Service template

    Delete a Mock Service Template Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates/8' \
        -X DELETE \
        -H 'accept: */*'
    

    The following parameters are the base parameters required to delete a Mock Service template.

    Delete a Mock Service Template Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Update Mock Service Template Properties

    To update the properties of a Mock Service template, you need to know your Workspace identifier and the Mock Service Template identifier. The sample code uses a serviceMockTemplateId of 8 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service template.

    Minimum Parameters for updating a Mock Service template

    Update Mock Service Templates Minimum Configuration Sample

    
    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mock-templates/8' \
        -X PATCH \
        -H 'accept: */*' \
        -H 'Content-Type: application/json' \
        -d '{ "description": "string", \
              "location": "string", \
              "name": "string",\
              "mockServiceTransactions": [ 0 ] \
            }'
    

    The following parameters are the base parameters required to update Mock Service templates.

    Update Mock Service Template Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "created": "2019-07-25T13:51:48.016Z",
        "createdBy": "string",
        "description": "string",
        "id": 0,
        "liveSystemHost": "string",
        "liveSystemPort": 0,
        "name": "string",
        "noMatchingRequestPreference": "string",
        "noMatchingRequestTxnId": 0,
        "serviceId": 0,
        "serviceName": "string",
        "thinkTime": 0,
        "mockServiceTransactions": [
          0
        ],
        "updated": "2019-07-25T13:51:48.016Z",
        "updatedBy": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Mock Service Location REST API

    You can label Workspaces with a unique identifier for a cloud location or a private location, for example "cloud", "us-east-1", or "London".

    Get Location of a Workspace

    To get the location of your Workspace, you need to know your Workspace identifier. The sample code uses a workspaceId of 123456. Use the actual ID value of your Workspace.

    This call returns the Location identifier of your workspace.

    Minimum Parameters for Getting the Location of a Workspace

    Get Location Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/locations' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8'
    

    The following parameters are the base parameters required to get the location.

    Get Location Request Attributes

    Response 200 OK

    {
        "apiVersion": 1,
        "error": null,
        "result": [
          {
            "shipId": "1234567890abcd1234567890",
            "shipName": "Test Agent",
            "harborId": "0987654321abcd0987654321",
            "harborName": "My Private Location",
            "provider": "Private Locations"
          }
        ],
        "requestId": "12345abcdef67890"
    }
    

    Attributes

    Mock Service Log REST API

    Get a Log File of a Mock Service

    To get a log snapshot of all instances (replicas) of a Mock Service either as JSON or a GZIP file, you need to know the Log identifier, your Workspace identifier and the Mock Service identifier. The sample code uses a a logId of 42, a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Requesting a Log File of a Mock Service

    The following parameters are the base parameters required to request a log file of a Mock Service.

    Log File of Mock Service Request Attributes

    Request Log File of Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com//api/v1/workspaces/{workspaceId}/service-mocks/{serviceMockId}/log' \
        -X GET \
        -H 'accept: application/json;charset=UTF-8'
    

    Response 200 OK

    {}
    

    Attributes

    Refresh the Logs of a Mock Service

    To refresh the log of a Mock Service in the asset catalog, you need to know your Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    The request returns the logId.

    The API call refreshes the logs from all ServiceMock instances (replicas).

    Minimum Parameters for Requesting a Log of a Mock Service

    Request Log of Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/log/refresh   ' \
        -X POST \
        -H 'accept: */*' \
        -H 'Content-Type: application/json' \
        -d '0'
    

    The following parameters are the base parameters required to request a Log of a Mock Service.

    Mock Service Logs Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": {
        "log": "string",
        "logId": 0,
        "serviceMockId": 1234,
        "trackingId": "string"
      },
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Update the Log Snapshot of a Mock Service

    To update a log snapshot of a Mock Service and save it to the asset catalog, you need to know the Log identifier, Workspace identifier and the Mock Service identifier. The sample code uses a serviceMockId of 1234 and a workspaceId of 123456. Use the actual ID values of your Workspace and Mock Service.

    Minimum Parameters for Updating the Log of a Mock Service

    Update Log of Mock Service Minimum Configuration Sample

    curl 'https://mock.blazemeter.com/api/v1/workspaces/123456/service-mocks/1234/log/42' \
        -X PUT \
        -H 'accept: */*' \
        -H 'Content-Type: application/json' \
        -d 'string'
    

    The following parameters are the base parameters required to update the log of a Mock Service.

    Update Log of Mock Service Request Attributes

    Response 200 OK

    {
      "apiVersion": 0,
      "error": "string",
      "limit": 0,
      "link": "string",
      "requestId": "string",
      "result": true,
      "skip": 0,
      "total": 0
    }
    

    Attributes

    Appendix

    This section contains additional details you may find useful as you progress in your use of the BlazeMeter Mock Service API beyond typical use cases.

    Glossary

    This section covers the various terms that are used throughout the Mock Service APIs.

    DSL

    The dsl is the object that stores properties of Transactions.

    There are multiple sources we support and convert to DSL format to use them as request/response transactions:

    Supported dsl type keys are:

    For more information, see Adding Transactions.

    This appendix shows how to configure a dsl manually. The easiest way to create a valid dsl for an API call is to create a Transaction in the web interface and copy and paste the response.

    Create a dsl object Example

    Create a dsl object Minimum Configuration Sample

    {
      "priority": 0,
      "requestDsl": {
        "method": "POST",    
        "url": {
          "key": "url",
          "matcherName": "equals_url",
          "matchingValue": "http://www.example.com"
        },
        "headers": [
          {
            "key": "header1",
            "matcherName": "contains",
            "matchingValue": "value1"
          },
          {
            "key": "header2",
            "matcherName": "matches",
            "matchingValue": "value2"
          },
          {
            "key": "header3",
            "matcherName": "equals",
            "matchingValue": "value3"
          },
          {
            "key": "header4",
            "matcherName": "not_matches",
            "matchingValue": "value4"
          },
          {
            "key": "header5",
            "matcherName": "equals_insensitive",
            "matchingValue": "value5"
          },
          {
            "key": "header6",
            "matcherName": "absent",
            "matchingValue": "header6"
          }
        ],
        "queryParams": [
          {
            "key": "q1",
            "matcherName": "contains",
            "matchingValue": "q_value1"
          },
          {
            "key": "q2",
            "matcherName": "matches",
            "matchingValue": "q_value2"
          },
          {
            "key": "q3",
            "matcherName": "equals",
            "matchingValue": "q_value3"
          },
          {
            "key": "q4",
            "matcherName": "not_matches",
            "matchingValue": "q_value4"
          },
          {
            "key": "q5",
            "matcherName": "equals_insensitive",
            "matchingValue": "q_value5"
          },
          {
            "key": "q6",
            "matcherName": "absent",
            "matchingValue": "q6"
          }
        ],
        "cookies": [
          {
            "key": "cookie1",
            "matcherName": "contains",
            "matchingValue": "c_value1"
          },
          {
            "key": "cookie2",
            "matcherName": "matches",
            "matchingValue": "c_value2"
          },
          {
            "key": "cookie3",
            "matcherName": "equals",
            "matchingValue": "c_value3"
          },
          {
            "key": "cookie4",
            "matcherName": "not_matches",
            "matchingValue": "c_value4"
          },
          {
            "key": "cookie5",
            "matcherName": "equals_insensitive",
            "matchingValue": "c_value5"
          },
          {
            "key": "cookie6",
            "matcherName": "absent",
            "matchingValue": "cookie6"
          }
        ],
        "credentials": {
          "username": "joe user",
          "password": "p455w0rd"
        },
        "body": [
          {
            "matcherName": "matches_json",
            "matchingValue": "JFsnbWVudSddWydpZCdd"
          }
        ]
      },
      "responseDsl": {
        "status": 200,
        "statusMessage": "HTTP/1.1 200 OK",
        "headers": [
          {
            "name": "Content-Type",
            "value": "text/plain; charset=UTF-8"
          }
        ],
        "binary": false,
        "content": "ZXhhbXBsZSBwb3N0IHJlc3BvbnNl",
        "charset": "UTF-8"
      }
    }
    

    To create a dsl manually, use the following format:

    Attributes

    Location ID

    This is the unique identifier for a cloud location or a private location. It is used in the following APIs:

    It is found in the response of the following APIs:

    For another method for finding this value, see Get the Location Name.

    Log ID

    This is the unique identifier of a log. It is used in the following APIs:

    It is found in the response of the following APIs:

    Mock Service ID

    It is found in the response of the following APIs:

    Mock Service Template ID

    This is the unique identifier of a Template. It is used in the following APIs:

    It is found in the response of the following APIs:

    Service ID

    This is the unique identifier of a Service. It is used in the following APIs:

    It is found in the response of the following APIs:

    Tag ID

    This is the unique identifier of a tag. It is used in the following APIs:

    It is found in the response of the following APIs:

    Taurus UUID

    Transaction ID

    This is the unique identifier of a Transaction. It is used in the following APIs:

    It is found in the response of the following APIs:

    Workspace ID

    This is the unique identifier that identifies a Workspace. It is used in the following APIs:

    It is found in the response of the following APIs:

    For another method for finding this value, see Get Your Workspace ID.