The Private Location Object

All timestamps are in UNIX Epoch time.

Attributes

  • idstring

    read-only

    The harborId of the private location

  • namestring

    required

    The name of the private location

  • userIdinteger

    read-only

    The userId of the user to access the API

  • consoleXmsinteger

    The minimum memory usage for JVM Arguments. Must match engineXms

  • consoleXmxinteger

    The maximum memory usage for JVM Arguments. Must match engineXmx

  • engineXmsinteger

    The minimum memory usage for JVM Arguments. Must match consoleXms

  • engineXmxinteger

    The maximum memory usage for JVM Arguments. Must match consoleXmx

  • threadsPerEngineinteger

    required

    The maximum number of threads per instance you can run with. The max value is plan dependent or 1000 threads, whichever is the smallest

  • slotsinteger

    required

    This controls the number of "engines" that can run in one agent. If type is "large", this must be 1. If type is "small", this can vary

  • typestring

    The type of private location to create (only accepts "large" or "small"). The "large" version refers to the Dedicated engine, while the "small" version refers to a Shared engine, as explained in Creating a Private Location (help.blazemeter.com)

  • disabledboolean

    Denotes if the private location is disabled (if true) or not (if false)

  • hiddenboolean

    read-only

    Denotes if the private location is hidden or not. No longer used

  • createdinteger

    read-only

    The timestamp of when the private location was created

  • updatedinteger

    read-only

    The timestamp of when the private location was updated

  • accountIdinteger

    required

    The accountId the private location is tied to

  • shipsIdarray

    read-only

    The list of shipIds that are tied to the private location

  • workspacesIdarray

    required

    The list of workspaceIds that the private location is available in. These workspaceIds must be included in the same accountId

  • funcIdsarray

    required

    The list of functionalities that this private location will use. For Dedicated ("large") type, ONLY ONE functionality can be used, while the Shared ("small") can have one or more functionalities. Visit this link for full list of functionalities. If you are using private cloud, see this link

  • shipsarray

    read-only

    A list of ship/server objects describing the agents available in the private location

**The Private Location Object

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": "5b0323b3c648be3b4c7b23c8",
        "name": "Example Private Location",
        "userId": 123456,
        "consoleXms": 1024,
        "consoleXmx": 4096,
        "engineXms": 1024,
        "engineXmx": 4096,
        "threadsPerEngine": 1000,
        "slots": 1,
        "type": "large",
        "disabled": false,
        "hidden": false,
        "created": 1526932403,
        "updated": 1593104036,
        "accountId": 123456,
        "shipsId": [
            {
                "$oid": "5dd841d46c6cd5b0064fa941"
            }
        ],
        "workspacesId": [
            123456,
            234567,
            345678,
            456789,
            567890
        ],
        "funcIds": [
            "performance",
            "functionalApi",
            "proxyRecorder",
            "mockServices",
            "functionalGui",
            "firefox:default",
            "chrome:default"
        ],
        "ships": [
            {
                "id": "5dd841d46c6cd5b0064fa941",
                "name": "Example Agent",
                "address": "172.31.9.152",
                "publicIpAddress": "104.197.80.57",
                "disabled": false,
                "state": "idle",
                "lastHeartBeat": 1593113786,
                "lastCommandOutput": "",
                "isLocked": false,
                "installedVersion": "3.5.14",
                "hostInfo": {
                    "diskSpace": {
                        "/tmp": {
                            "present": true,
                            "freeSpace": 20941426688,
                            "freePercent": 50.399999999999999
                        }
                    },
                    "platform": [
                        "linux",
                        "linux-x86_64"
                    ],
                    "containerManager": {
                        "type": "DockerManager",
                        "usingDockerRegistry": true,
                        "info": {
                            "operatingSystem": "Ubuntu 16.04.5 LTS",
                            "operatingSystemType": "linux",
                            "memory": 8364474368,
                            "cpus": 2,
                            "dockerRootDir": "/var/lib/docker",
                            "dockerVersion": "18.09.1",
                            "images": [
                                {
                                    "Containers": -1,
                                    "Created": 1592135649,
                                    "Id": "sha256:51742f8148452b6a430d36f2e48d282e1d14adc21f816abb8d807989e1d6a116",
                                    "Labels": null,
                                    "ParentId": "",
                                    "RepoDigests": null,
                                    "RepoTags": [
                                        "taurus-cloud:1.20.51",
                                        "taurus-cloud:latest"
                                    ],
                                    "SharedSize": -1,
                                    "Size": 6057428244,
                                    "VirtualSize": 6057428244
                                },
                                {
                                    "Containers": -1,
                                    "Created": 1591189045,
                                    "Id": "sha256:b2437a3424f204ced0d50248d0730bd77d91524e2c25b607b1a86ac7a9f3714d",
                                    "Labels": null,
                                    "ParentId": "",
                                    "RepoDigests": [
                                        "gcr.io/verdant-bulwark-278/blazemeter/crane@sha256:4db1384498f8004c769ecf5e1ab263a6b1a3d3901301ac96c3f56f2503730080"
                                    ],
                                    "RepoTags": [
                                        "blazemeter/crane:3.5.14",
                                        "blazemeter/crane:latest",
                                        "gcr.io/verdant-bulwark-278/blazemeter/crane:3.5.14"
                                    ],
                                    "SharedSize": -1,
                                    "Size": 52096988,
                                    "VirtualSize": 52096988
                                },
                                {
                                    "Containers": -1,
                                    "Created": 1590781539,
                                    "Id": "sha256:b599a4dff82d23ee0105080a783e5cc9d1eff950eb22f9e9a16c6b14f7ecae7d",
                                    "Labels": null,
                                    "ParentId": "",
                                    "RepoDigests": [
                                        "gcr.io/verdant-bulwark-278/blazemeter/service-mock@sha256:937312834575c484fab2d73c7f4608809e9acd118fe6e7ab5646697f6b85c3c2"
                                    ],
                                    "RepoTags": [
                                        "blazemeter/service-mock:3.6.0",
                                        "blazemeter/service-mock:latest",
                                        "gcr.io/verdant-bulwark-278/blazemeter/service-mock:3.6.0"
                                    ],
                                    "SharedSize": -1,
                                    "Size": 372896323,
                                    "VirtualSize": 372896323
                                },
                                {
                                    "Containers": -1,
                                    "Created": 1590781538,
                                    "Id": "sha256:5e37add71f0f3a48527c46a08278b3b17530443e2b7ff8426b50340c6a7ed6bd",
                                    "Labels": null,
                                    "ParentId": "",
                                    "RepoDigests": [
                                        "gcr.io/verdant-bulwark-278/blazemeter/sv-bridge@sha256:34d5c73460a4de7aa7d5f97aab2671ac0b18abdbc7f1a75bc11696a40acd4530"
                                    ],
                                    "RepoTags": [
                                        "blazemeter/sv-bridge:3.6.0",
                                        "blazemeter/sv-bridge:latest",
                                        "gcr.io/verdant-bulwark-278/blazemeter/sv-bridge:3.6.0"
                                    ],
                                    "SharedSize": -1,
                                    "Size": 349876453,
                                    "VirtualSize": 349876453
                                },
                                {
                                    "Containers": -1,
                                    "Created": 1589900192,
                                    "Id": "sha256:2d59cc77c273988b10f90eb62d2cee5fec0d7ac40f307e11093bfd2dd0828be1",
                                    "Labels": null,
                                    "ParentId": "",
                                    "RepoDigests": [
                                        "gcr.io/verdant-bulwark-278/blazemeter/apm@sha256:5949ff7b8f820555f912a21fdc0eef96146e7e1b19c43d9290646ad3db91abb8"
                                    ],
                                    "RepoTags": [
                                        "apm-image:1.4.7",
                                        "apm-image:latest",
                                        "gcr.io/verdant-bulwark-278/blazemeter/apm:1.4.7"
                                    ],
                                    "SharedSize": -1,
                                    "Size": 357829202,
                                    "VirtualSize": 357829202
                                },
                                {
                                    "Containers": -1,
                                    "Created": 1589893087,
                                    "Id": "sha256:44d6f361eef7b27849186dac0680783b9870017f353700b1e8379eb20046640b",
                                    "Labels": null,
                                    "ParentId": "",
                                    "RepoDigests": [
                                        "gcr.io/verdant-bulwark-278/blazemeter/proxy-recorder@sha256:19921c689a689f4de8860e8ff2f61a4c6ccbb8fd552f3fceab3cdf34138fb6e1"
                                    ],
                                    "RepoTags": [
                                        "blazemeter/proxy-recorder:1.11.7",
                                        "blazemeter/proxy-recorder:latest",
                                        "gcr.io/verdant-bulwark-278/blazemeter/proxy-recorder:1.11.7"
                                    ],
                                    "SharedSize": -1,
                                    "Size": 879555522,
                                    "VirtualSize": 879555522
                                },
                                {
                                    "Containers": -1,
                                    "Created": 1583919985,
                                    "Id": "sha256:e61377ea370bc7a01ac1547cc34c1afb7ba88e04c8a8d2c8fa13b808b2c225d7",
                                    "Labels": null,
                                    "ParentId": "",
                                    "RepoDigests": null,
                                    "RepoTags": [
                                        "blazemeter:1.4.1-92",
                                        "blazemeter:latest"
                                    ],
                                    "SharedSize": -1,
                                    "Size": 5579810429,
                                    "VirtualSize": 5579810429
                                }
                            ]
                        }
                    }
                },
                "isAutoUpdate": true,
                "hasJetlag": true,
                "hasJetpack": true,
                "useMasterFiles": true,
                "uptime": 18661425,
                "portRange": "5000-5556",
                "baseUrl": "https://a.blazemeter.com",
                "hasProxy": false,
                "verifySSL": true,
                "created": 1574453716,
                "updated": 1593113786,
                "updaterStatus": {
                    "status": "success",
                    "lastUpdateCheck": 1593112089,
                    "nextUpdateCheck": 1593115689
                },
                "ts": 1593113786
            }
        ]
    },
    "request_id": "5ef4fcbdb6300"
}