Update a Private Location

API Explorer: /private-locations/{harborId}

To update a private location, you will need to know the harborId. The sample code updates a private location with a harborId of 5b0323b3c648be3b4c7b23c8 with a new private location name My Private Location. To use this API, replace the harborId of 5b0323b3c648be3b4c7b23c8 with your harborId and change the name attribute a name of your choosing.

If you do not know the harborId of the private location to delete, use List Private Locations to return a list of your created private locations.

Update a Private Location 

curl 'https://a.blazemeter.com/api/v4/private-locations/5b0323b3c648be3b4c7b23c8' \
	-X PATCH \
	-H 'Content-Type: application/json' \
	--user 'api_key_id:api_key_secret' \
	-d '{"name":"My Private Location"}'

Update a Private Location Request Attributes

Attributes

  • namestring

    The name of the private location

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

Update a Private LocationUpdate a Private Location PATCH Body (JSON) 

{
  "name":"My Private Location"
}

Update a Private Location Response Attributes

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

Response201 Created 

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": "5d1641a21726d36d4632fd34",
        "name": "My Private Location",
        "userId": 123456,
        "consoleXms": 1024,
        "consoleXmx": 4096,
        "engineXms": 1024,
        "engineXmx": 4096,
        "threadsPerEngine": 1000,
        "slots": 1,
        "type": "large",
        "funcIds": [
            "performance"
        ],
        "hidden": false,
        "overrideCPU": 2,
        "overrideMemory": 4096,
        "created": 1561739682,
        "updated": 1561739682,
        "accountId": 123456,
        "workspacesId": [
            123456
        ],
        "ships": []
    },
    "request_id": "5d1641a1c3fd1"
}