Create Credentials

Create new credentials which will be used by APM integrations. Credential settings differ according to the integration type and can be found by calling /credentials/credentialsSettings.

Create a Credential Attributes

Attributes

typestring
required

The integration to authenticate, for example: datadog or appdynamics
namestring
required

The credential name, for example: user1. Credentials attributes will depend on the type of APM you are setting up.
credentialsarray
required

List of credential details
Show/Hide Child Attributes for Datadog
- apmUrlstring
  required
  
  The URL of the APM.
- ddApiKeystring
  required
  
  Your Datadog API key.
- ddAppKeystring
  required
  
  Your Datadog application key.
- harborIdstring
  
  The Harbor ID of your private location.
workspaceIdstring
required

The ID of the workspace

Create Credentials

curl 'https://a.blazemeter.com/api/v4/credentials/credentialsCreateCredentials' \
    -X POST \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{"type":"datadog","name":"user1","credentials":{"apmUrl":"https://api.datadoghq.eu/","ddApiKey":"Ub1IMY8v+xpAsojiyR/IO/VH0pF6ix6+jw+QzgnTia0=","ddAppKey":"myApp","harborId":"61dd5d7e74f49724b10b68d9"},"workspaceId":1234567}'

Create a Credential
Create a Credential for APM Integration Body (JSON)

{
  "type": "dataDog",
  "name": "user1",
  "credentials": {
      "apmUrl": "https://api.datadoghq.eu/",
      "ddApiKey": "Ub1IMY8v+xpAsojiyR/IO/VH0pF6ix6+jw+QzgnTia0=",
      "ddAppKey": "myApp", 
      "harborId": "61dd5d7e74f49724b10b68d9"
      },
  "workspaceId": 1234567
}

Create APM Profile

Create a profile for each APM integration.

Create APM Profile

curl 'https://a.blazemeter.com/api/v4/credentials/credentialsCreateCredentials' \
    -X POST \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{"name":"Test","profile":{"credentialsId":"abcde12345","integrationMode":"BZM_TO_APM","tags":["test"],"metrics":[]},"type":"dataDog","workspaceId":123456}'

Add APM Profile to Your Test

APM profiles are defined under configuration.plugins field in The Test Object. Update or create a test to add the profile to your test.

Add Profile to Test

curl 'https://a.blazemeter.com/api/v4/tests' \
    -X PUT \
    -H 'Content-Type: application/json' \
    --user 'api_key_id:api_key_secret' \
    -d '{"id":199364,"isNewTest":true,"lastRunTime":1712661930,"name":"Untitled test April_09_1:24 PM","userId":48458,"creatorClientId":"gui","overrideExecutions":[{"concurrency":20,"executor":"taurus","holdFor":"4m","locations":{"us-east4-a":20},"locationsPercents":{"us-east4-a":100},"rampUp":"1m","steps":0}],"executions":[{"concurrency":20,"usersNotConfigured":false,"holdFor":"4m","durationIsNotConfigured":false,"iterationAndDurationDisabled":false,"rampUp":"1m","steps":0,"locations":{"us-east4-a":20},"locationsPercents":{"us-east4-a":100},"scenario":"default-scenario-199364"}],"hasThreadGroupsToOverride":false,"hasNonRegularThreadGroup":false,"shouldSendReportEmail":true,"dependencies":{"data":{"schema":"http://blazemeter.com/blazedata/schema","id":"datamodels/testParameters","title":"Test Parameters","description":"","kind":"tdm","type":"object","entities":{"test":{"title":"test","type":"object","properties":{"variableName1":{"type":"string"},"variableName2":{"type":"string"}},"requirements":{"variableName1":"valueOfCSV(\"Test Data May-13-09-26-55.csv\", \"variableName1\")","variableName2":"valueOfCSV(\"Test Data May-13-09-26-55.csv\", \"variableName2\")"},"targets":{"defaultCsv":{"type":"csv","file":"test.csv","isHeadless":false}},"datasources":[{"id":{"fileName":"Test Data May-13-09-26-55.csv"},"type":"csv","name":"Test Data May-13-09-26-55.csv","loop":false}]}}}},"shouldRemoveJmeter":true,"lastRatioEffectingChange":1715585248,"lastRatioEffectingMTChange":1715585248,"created":1712661867,"updated":1715591102,"projectId":53960,"lastUpdatedById":48458,"configuration":{"type":"taurus","dedicatedIpsEnabled":false,"canControlRampup":false,"targetThreads":50,"executionType":"taurusCloud","enableFailureCriteria":false,"enableMockServices":false,"enableTestData":true,"enableLoadConfiguration":true,"scriptType":"taurus","threads":50,"filename":"blazemeter_url_test_script.yaml","testMode":"http","extraSlots":0,"plugins":{"jmeter":{"version":"5.5","consoleArgs":"","enginesArgs":""},"thresholds":{"thresholds":[],"ignoreRampup":false,"fromTaurus":false},"dynaTraceV2":{"enabled":false,"method":"headers","profiles":[],"profilesId":null},"dataDog":{"profiles":["abcde12345"],"enabled":true}}},"testChanges":{"script":{"0":[1712662131],"5":[1715585248]},"dependencies":[[1715585244]]},"subscribers":[48458],"revisionTimestamp":1715591595577}'

Add Profile to Test
Add Profile to Test PUT Body (JSON)

{
      "id": 199364,
        "isNewTest": true,
        "lastRunTime": 1712661930,
        "name": "Untitled test April_09_1:24 PM",
        "userId": 48458,
        "creatorClientId": "gui",
        "overrideExecutions": [
            {
                "concurrency": 20,
                "executor": "taurus",
                "holdFor": "4m",
                "locations": {
                    "us-east4-a": 20
                },
                "locationsPercents": {
                    "us-east4-a": 100
                },
                "rampUp": "1m",
                "steps": 0
            }
        ],
        "executions": [
            {
                "concurrency": 20,
                "usersNotConfigured": false,
                "holdFor": "4m",
                "durationIsNotConfigured": false,
                "iterationAndDurationDisabled": false,
                "rampUp": "1m",
                "steps": 0,
                "locations": {
                    "us-east4-a": 20
                },
                "locationsPercents": {
                    "us-east4-a": 100
                },
                "scenario": "default-scenario-199364"
            }
        ],
        "hasThreadGroupsToOverride": false,
        "hasNonRegularThreadGroup": false,
        "shouldSendReportEmail": true,
        "dependencies": {
            "data": {
                "schema": "http://blazemeter.com/blazedata/schema",
                "id": "datamodels/testParameters",
                "title": "Test Parameters",
                "description": "",
                "kind": "tdm",
                "type": "object",
                "entities": {
                    "test": {
                        "title": "test",
                        "type": "object",
                        "properties": {
                            "variableName1": {
                                "type": "string"
                            },
                            "variableName2": {
                                "type": "string"
                            }
                        },
                        "requirements": {
                            "variableName1": "valueOfCSV(\"Test Data May-13-09-26-55.csv\", \"variableName1\")",
                            "variableName2": "valueOfCSV(\"Test Data May-13-09-26-55.csv\", \"variableName2\")"
                        },
                        "targets": {
                            "defaultCsv": {
                                "type": "csv",
                                "file": "test.csv",
                                "isHeadless": false
                            }
                        },
                        "datasources": [
                            {
                                "id": {
                                    "fileName": "Test Data May-13-09-26-55.csv"
                                },
                                "type": "csv",
                                "name": "Test Data May-13-09-26-55.csv",
                                "loop": false
                            }
                        ]
                    }
                }
            }
        },
        "shouldRemoveJmeter": true,
        "lastRatioEffectingChange": 1715585248,
        "lastRatioEffectingMTChange": 1715585248,
        "created": 1712661867,
        "updated": 1715591102,
        "projectId": 53960,
        "lastUpdatedById": 48458,
        "configuration": {
            "type": "taurus",
            "dedicatedIpsEnabled": false,
            "canControlRampup": false,
            "targetThreads": 50,
            "executionType": "taurusCloud",
            "enableFailureCriteria": false,
            "enableMockServices": false,
            "enableTestData": true,
            "enableLoadConfiguration": true,
            "scriptType": "taurus",
            "threads": 50,
            "filename": "blazemeter_url_test_script.yaml",
            "testMode": "http",
            "extraSlots": 0,
            "plugins": {
                "jmeter": {
                    "version": "5.5",
                    "consoleArgs": "",
                    "enginesArgs": ""
                },
                "thresholds": {
                    "thresholds": [],
                    "ignoreRampup": false,
                    "fromTaurus": false
                },
                "dataDog": {
                    "profiles": [
                        "6641d870de1012607302101b"
                    ],
                    "enabled": true
                }
            }
        },
        "testChanges": {
            "script": {
                "0": [
                    1712662131
                ],
                "5": [
                    1715585248
                ]
            },
            "dependencies": [
                [
                    1715585244
                ]
            ]
        },
        "subscribers": [
            48458
        ],
        "revisionTimestamp": 1715591595577
}