List Private Locations
API Explorer: /private-locations
To return a list of created private locations, an accountId or a workspaceId is required. The sample code returns a list of private locations within an accountId of 123456 and a workspaceId of 123456. Use the actual ID values for the account or workspace to return the list of its private locations.
The response shown contains one private location. Additional private locations for the specified criteria would be contained after the
5db9c5640634d626d0665efc listing.You can return a list specifying either a accountId, a workspaceId, or both. The returned list contains each private location's harborId (shows up as id in the response) and configuration.
List Private Locations Parameters
Parameters
-
accountIdintegerrequired
The
accountIdyou want to use to get the list of private locations -
workspaceIdintegerrequired
The
workspaceIdyou want to use to get the list of private locations -
types[]stringFilters the returned agent list to specific private location types. The following values are possible values:
small- This type references the Shared private location typelarge- This type references the Dedicated private location type
Also see: Pagination and Sorting
List Private Locations
curl 'https://a.blazemeter.com/api/v4/private-locations?accountId=123429&workspaceId=123456' \
--user 'api_key_id:api_key_secret'
List Private Locations Response Attributes
To see a breakdown of the attributes, please see The Private Location Object section.
Response200 OK
{
"limit": 10,
"skip": 0,
"total": 2,
"hidden": 0,
"api_version": 4,
"error": null,
"result": [
{
"id": "5db9c5640634d626d0665efc",
"name": "Example Private Location",
"userId": 123456,
"consoleXms": 1024,
"consoleXmx": 4096,
"engineXms": 1024,
"engineXmx": 4096,
"threadsPerEngine": 300,
"slots": 5,
"type": "small",
"funcIds": [
"performance",
"functionalApi",
"proxyRecorder",
"mockServices",
"functionalGui",
"firefox:65",
"firefox:64",
"firefox:63",
"firefox:62",
"firefox:61",
"firefox:60",
"firefox:59",
"chrome:69",
"chrome:68",
"chrome:67",
"chrome:66",
"chrome:65"
],
"hidden": false,
"disabled": false,
"created": 1572455780,
"updated": 1572539142,
"accountId": 123456,
"shipsId": [
{
"$oid": "5db9c5ad71996f2cd40898b3"
},
{
"$oid": "5dbb081245137a19771c8253"
}
],
"workspacesId": [
123456
],
"ships": [
{
"id": "5db9c5ad71996f2cd40898b3",
"name": "New Agent",
"address": "10.123.1.123",
"publicIpAddress": "35.234.234.123",
"state": "idle",
"lastHeartBeat": 1572539183,
"lastCommandOutput": "",
"isLocked": false,
"installedVersion": "3.1.17-1526",
"hostInfo": {
"diskSpace": {
"/tmp": {
"present": true,
"freeSpace": 70527119360
},
"/var/lib/docker": {
"present": false
},
"/home/blazemeter": {
"present": true,
"freeSpace": 70527119360
}
},
"containerManager": {
"type": "DockerManager",
"usingDockerRegistry": false,
"info": {
"operatingSystem": "Ubuntu 16.04.6 LTS",
"operatingSystemType": "linux",
"memory": 7836102656,
"cpus": 2,
"dockerRootDir": "/var/lib/docker",
"dockerVersion": "19.03.4",
"images": [
{
"Containers": -1,
"Created": 1572528902,
"Id": "sha256:2c5bf36dbce6ee135018cf6464c8d279d19e6c58b599c0996fa8743e871eaee9",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/service-mock:0.2.4-11",
"blazemeter/service-mock:latest"
],
"SharedSize": -1,
"Size": 164849267,
"VirtualSize": 164849267
},
{
"Containers": -1,
"Created": 1572456591,
"Id": "sha256:2f483a78ff30833b3041ff0bc153d44e22fa32d399ee52c17039e0173ee0aab5",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/crane:3.1.17-1526",
"blazemeter/crane:latest"
],
"SharedSize": -1,
"Size": 140327991,
"VirtualSize": 140327991
},
{
"Containers": -1,
"Created": 1572456586,
"Id": "sha256:9196998214abb796f7087746246135d17b076ea877fd10882ee379d3591e27e5",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/chrome_65.0.3325.181:2.1.0-266",
"blazemeter/charmander/chrome_65.0.3325.181:latest"
],
"SharedSize": -1,
"Size": 1456486511,
"VirtualSize": 1456486511
},
{
"Containers": -1,
"Created": 1572456554,
"Id": "sha256:3d18e73cb7b0ff57095e5445ec16a75b668c822e86c1ea286b4f5681c6a395cf",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter:1.4.1-92",
"blazemeter:latest"
],
"SharedSize": -1,
"Size": 5579810429,
"VirtualSize": 5579810429
},
{
"Containers": -1,
"Created": 1572456436,
"Id": "sha256:c4eb412e5798c44da65ecb3158be3542e33cab266289e0294bbf7ec8802d65d8",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/firefox_60.0.2:2.1.0-266",
"blazemeter/charmander/firefox_60.0.2:latest"
],
"SharedSize": -1,
"Size": 1414052702,
"VirtualSize": 1414052702
},
{
"Containers": -1,
"Created": 1572456406,
"Id": "sha256:f2b81d8b717f86bf43d0292f7799cc66c6961a34406bf0a8c2486dad9c270ee0",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/proxy-recorder:1.10.1-850",
"blazemeter/proxy-recorder:latest"
],
"SharedSize": -1,
"Size": 599224295,
"VirtualSize": 599224295
},
{
"Containers": -1,
"Created": 1572456392,
"Id": "sha256:956e58859917127603d91b6a0a41033e203bf8a67f8287b9f348f32c1ddc4da6",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/firefox_61.0.2:2.1.0-266",
"blazemeter/charmander/firefox_61.0.2:latest"
],
"SharedSize": -1,
"Size": 1411259801,
"VirtualSize": 1411259801
},
{
"Containers": -1,
"Created": 1572456361,
"Id": "sha256:229f8d1f721a87f879ab2914b601661ccdf54e6cf199545be2ae7906989d5aea",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/firefox_62.0.3:2.1.0-266",
"blazemeter/charmander/firefox_62.0.3:latest"
],
"SharedSize": -1,
"Size": 1414549206,
"VirtualSize": 1414549206
},
{
"Containers": -1,
"Created": 1572456328,
"Id": "sha256:4b972899d53e4e810fc405995584a1eb492f06630e001b343db07e2e1b73f598",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/chrome_69.0.3497.92:2.1.0-266",
"blazemeter/charmander/chrome_69.0.3497.92:latest"
],
"SharedSize": -1,
"Size": 1467895980,
"VirtualSize": 1467895980
},
{
"Containers": -1,
"Created": 1572456295,
"Id": "sha256:3499ac54e173d86a670678f6c939d50db95f7a9acc408408d35dbf3571755c43",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"apm-image:1.3.0-826",
"apm-image:latest"
],
"SharedSize": -1,
"Size": 349033017,
"VirtualSize": 349033017
},
{
"Containers": -1,
"Created": 1572456287,
"Id": "sha256:741a0dfb03a60b2a92c7919ad2917061a81b0ce18f80b205458f1305cda2ef66",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/firefox_59.0.3:2.1.0-266",
"blazemeter/charmander/firefox_59.0.3:latest"
],
"SharedSize": -1,
"Size": 1417551431,
"VirtualSize": 1417551431
},
{
"Containers": -1,
"Created": 1572456254,
"Id": "sha256:7acc33b007cdfa24b43f9b472ce8609edac67bd0489d1c65ae4d4c60df5873cc",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/chrome_66.0.3359.181:2.1.0-266",
"blazemeter/charmander/chrome_66.0.3359.181:latest"
],
"SharedSize": -1,
"Size": 1456797479,
"VirtualSize": 1456797479
},
{
"Containers": -1,
"Created": 1572456220,
"Id": "sha256:fc74752e5c679ea92c9c8debb8a51fc25950535fab78ae9ae7494dbc80aa2e56",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"taurus-cloud:1.17.5-1053",
"taurus-cloud:latest"
],
"SharedSize": -1,
"Size": 5116339960,
"VirtualSize": 5116339960
},
{
"Containers": -1,
"Created": 1572456106,
"Id": "sha256:5cc41950e3e7151227ba092c99461ddac2c0775159c4c71169bf3327b410af88",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/chrome_68.0.3440.84:2.1.0-266",
"blazemeter/charmander/chrome_68.0.3440.84:latest"
],
"SharedSize": -1,
"Size": 1463143595,
"VirtualSize": 1463143595
},
{
"Containers": -1,
"Created": 1572456072,
"Id": "sha256:50ec6f7ad24d01e9e181314951f72b945483cfb89720174682eb93a3c500f59e",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/chrome_67.0.3396.79:2.1.0-266",
"blazemeter/charmander/chrome_67.0.3396.79:latest"
],
"SharedSize": -1,
"Size": 1457708938,
"VirtualSize": 1457708938
},
{
"Containers": -1,
"Created": 1572456036,
"Id": "sha256:80bd52151d5cd55cf1cd8bd64e6d959195a2759734eef3aab3aa9965963adc50",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/firefox_65.0.2:2.1.0-266",
"blazemeter/charmander/firefox_65.0.2:latest"
],
"SharedSize": -1,
"Size": 1450140743,
"VirtualSize": 1450140743
},
{
"Containers": -1,
"Created": 1572456004,
"Id": "sha256:162a133de9627a628b231349e28d341d4c36a466be76c5ab0e91555997b1ffe7",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/firefox_63.0.1:2.1.0-266",
"blazemeter/charmander/firefox_63.0.1:latest"
],
"SharedSize": -1,
"Size": 1419334668,
"VirtualSize": 1419334668
},
{
"Containers": -1,
"Created": 1572455968,
"Id": "sha256:e579437c8f0c793f5af786a24c9e53409da0a03b34ebef4f902a2d299e1b8e0a",
"Labels": null,
"ParentId": "",
"RepoDigests": null,
"RepoTags": [
"blazemeter/charmander/firefox_64.0.2:2.1.0-266",
"blazemeter/charmander/firefox_64.0.2:latest"
],
"SharedSize": -1,
"Size": 1439905832,
"VirtualSize": 1439905832
}
]
}
}
},
"isAutoUpdate": true,
"hasJetlag": true,
"hasJetpack": true,
"useMasterFiles": true,
"uptime": 616003,
"baseUrl": "https://a.blazemeter.com",
"hasProxy": false,
"verifySSL": true,
"created": 1572455853,
"updated": 1572539183,
"updaterStatus": {
"status": "success",
"lastUpdateCheck": 1572536148,
"nextUpdateCheck": 1572539748,
"lastUpdate": 1572528902
},
"ts": 1572539183
}
]
}
],
"request_id": "5dbb0b48f06fa"
}