Manage Site

Updates and gets site details, and deletes a site.

Gets site details.

Path Parameters

  • siteIdstringrequired

    Site uuid

  • clientIdstringrequired

    Describes the clientId of the tenant

Responses

  • idinteger

  • namestring

    Site name.

  • clientIdinteger

  • mspIdinteger

  • parentobject

    (Optional) Parent site. Required if creating a sub-site under a parent site:

  • descriptionstring

    (Optional) Summary of the site.

  • addressstring

    (Optional) Site address.

  • statestring

    (Optional) Site state.

  • citystring

    (Optional) Site city.

  • countrystring

  • zipstring

    (Optional) Zip code.

  • primaryContactobject

  • phoneNumberstring

    (Optional) Site phone number for communication.

  • phoneExtensionstring

    (Optional) Site phone extension number.

  • filterCriteriaobject

  • devicesarray

  • resourcesarray

Response Samples

{
  "id": 1139,
  "name": "TestSite",
  "clientId": 4,
  "mspId": 3,
  "description": "",
  "address": "",
  "city": "",
  "state": "",
  "country": "United States",
  "zip": "",
  "devices": [
    {
      "uniqueId": "1875653f-c5b7-40dd-998e-54b6fb25b422",
      "hostName": "",
      "ipAddress": "",
      "type": "DEVICE",
      "aliasName": "",
      "resourceName": "DOT-D1-SCCM-01_Old TEST",
      "resourceType": "Windows"
    },
    {
      "uniqueId": "31321789-ef92-41cd-bc96-01cc7bd38e1e",
      "hostName": "",
      "ipAddress": "",
      "type": "DEVICE",
      "aliasName": "",
      "resourceName": "DOT-TEST-NET",
      "resourceType": "Server"
    }
  ],
  "resources": [
    {
      "id": "1875653f-c5b7-40dd-998e-54b6fb25b422",
      "name": "DOT-D1-SCCM-01_Old TEST",
      "ipAddress": "",
      "type": "Windows",
      "metaData": {},
      "resourceType": "Windows",
      "hostName": "",
      "resourceName": "DOT-D1-SCCM-01_Old TEST",
      "aliasName": ""
    },
    {
      "id": "31321789-ef92-41cd-bc96-01cc7bd38e1e",
      "name": "DOT-TEST-NET",
      "ipAddress": "",
      "type": "Server",
      "metaData": {},
      "resourceType": "Server",
      "hostName": "",
      "resourceName": "DOT-TEST-NET",
      "aliasName": ""
    }
  ],
  "filterCriteria": {
    "id": 1320,
    "uid": "POLICY-c8e77000-9401-406b-8a1a-914cc00283c5",
    "name": "policy",
    "matchType": "ALL",
    "rules": [
      {
        "id": 215,
        "key": "Name",
        "operator": "Contains",
        "value": "test",
        "resourceType": "DEVICE"
      }
    ]
  }
}

Updates site details.

Path Parameters

  • siteIdstringrequired

    Site uuid

  • clientIdstringrequired

    Describes the clientId of the tenant

Request Body

application/json

  • idinteger

  • namestring

    Site name.

  • clientIdinteger

  • mspIdinteger

  • parentobject

    (Optional) Parent site. Required if creating a sub-site under a parent site:

  • descriptionstring

    (Optional) Summary of the site.

  • addressstring

    (Optional) Site address.

  • statestring

    (Optional) Site state.

  • citystring

    (Optional) Site city.

  • countrystring

  • zipstring

    (Optional) Zip code.

  • primaryContactobject

  • phoneNumberstring

    (Optional) Site phone number for communication.

  • phoneExtensionstring

    (Optional) Site phone extension number.

  • filterCriteriaobject

  • devicesarray

  • resourcesarray

Loading Examples...

Responses

  • idinteger

  • namestring

    Site name.

  • clientIdinteger

  • mspIdinteger

  • parentobject

    (Optional) Parent site. Required if creating a sub-site under a parent site:

  • descriptionstring

    (Optional) Summary of the site.

  • addressstring

    (Optional) Site address.

  • statestring

    (Optional) Site state.

  • citystring

    (Optional) Site city.

  • countrystring

  • zipstring

    (Optional) Zip code.

  • primaryContactobject

  • phoneNumberstring

    (Optional) Site phone number for communication.

  • phoneExtensionstring

    (Optional) Site phone extension number.

  • filterCriteriaobject

  • devicesarray

  • resourcesarray

Response Samples

{
  "id": 31,
  "name": "SJ-North-East",
  "parent": {
    "id": 4,
    "name": "OPSRAMP-BMVR",
    "description": "Resource in East",
    "address": "Bheemavaram"
  },
  "description": "Datacenter at SJ East",
  "address": "4th Cross, Blue Valley",
  "city": "San Jose",
  "state": "California",
  "country": "USA",
  "zip": "94088",
  "phoneNumber": "5232324543",
  "phoneExtension": "1",
  "primaryContact": {
    "id": "USR0000000014",
    "loginName": "InsLab@myorganization.com",
    "lastName": "Lab",
    "firstName": "Ins",
    "email": "inslab@gamil.com",
    "phoneNumber": "8096250653"
  },
  "resources": [
    {
      "id": "b7001583-db6a-4c7c-b4df-ab1ba6505d60",
      "name": "DESKTOP-V5DV65M",
      "ipAddress": "192.168.56.1",
      "type": "DEVICE"
    },
    {
      "id": "19a49e09-da18-4d91-92b7-01d6858ec2cf",
      "name": "opsrampdev",
      "ipAddress": "10.0.4.15",
      "type": "DEVICE"
    },
    {
      "id": "ad0a218d-7512-435c-9b58-614470ee8658",
      "name": "WORK-PC",
      "ipAddress": "192.168.126.1",
      "type": "DEVICE"
    }
  ],
  "filterCriteria": {
    "id": 70,
    "matchType": "ANY",
    "rules": [
      {
        "id": 223,
        "key": "Name",
        "operator": "Contains",
        "value": "HYD",
        "resourceType": "DEVICE"
      },
      {
        "id": 224,
        "key": "Name",
        "operator": "Regex",
        "value": ".*VM.*",
        "resourceType": "LOAD_BALANCER"
      },
      {
        "id": 225,
        "key": "Agent Installed",
        "operator": "Is",
        "value": "TRUE",
        "resourceType": "DEVICE"
      }
    ]
  }
}

Deletes a site.

Path Parameters

  • siteIdstringrequired

    Site uuid

  • clientIdstringrequired

    Describes the clientId of the tenant

Responses

200OK