Endpoint
/api/v2/tenants/{tenantId}/sites
Path Parameters
tenantId
string

Describes the client ID of the tenant

address
string

(Optional) Site address.

city
string

(Optional) Site city.

clientId
integer

country
string

description
string

(Optional) Summary of the site.

devices
array

devices.aliasName
devices.hostName
devices.ipAddress
devices.resourceName
devices.resourceType
devices.type
devices.uniqueId
filterCriteria
object

filterCriteria.actions
- Supported actions - ASSIGN MONITORINGTEMPLATE - ASSIGN KNOWLEDGEARTICLE - Assign Availability Rule - ASSIGN CUSTOMATTRIBUTES - Assign Jobs - ASSIGN CREDENTIALSET - Supported values for items for given action - For Assign Availability Rule , item value is AND - For ASSIGN CUSTOMATTRIBUTES, item value is tagName[value='tagValue'] - For all others this is number in string eg "12345" - Scenarios for Custom attributes item values in response payload - New TagName : New Tag created with given Name and Tag Value, and Assigned. - Id of New Tag Value added to response - Old TagName and New Tag Value : New Tag Value added to Tag and Assigned - Id of New Tag Value added to response. - Old TagName and Old TagValue : Both the details are verfied and Assigned - Id of TagValue added to Response
filterCriteria.executionOrder
filterCriteria.id
filterCriteria.matchType
(Optional) The type of match: -To match all the filter conditions, provide matchType: ALL. - To match any one of the filter conditions, provide matchType: ANY.
filterCriteria.name
Name of the policy.
filterCriteria.resourceType
Type of resource. Example: DEVICE, VOLUME, VPN, XENSERVER
filterCriteria.rules
(Optional) Filter devices with specific attributes: - Attribute name of device. Example: Name, Operating System. Attribute names change with device types. - Matching parameter. Supported operators are: Equals, Contains, Not Contains, Starts with, Ends with, Regex. Learn more about Regex. - Type of resource
id
integer

mspId
integer

name
string

Site name.

parent
object

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

parent.address
parent.description
parent.id
Parent site id
parent.name
Parent site name
phoneExtension
string

(Optional) Site phone extension number.

phoneNumber
string

(Optional) Site phone number for communication.

primaryContact
object

primaryContact.changePassword
primaryContact.email
primaryContact.firstName
primaryContact.id
primaryContact.lastName
primaryContact.loginName
primaryContact.phoneNumber
resources
array

resources.aliasName
resources.hostName
resources.id
resources.ipAddress
resources.metaData
resources.name
resources.resourceName
resources.resourceType
resources.type
state
string

(Optional) Site state.

zip
string

(Optional) Zip code.

{
  "address": "5th Avenue, Park street",
  "city": "San Jose",
  "country": "USA",
  "description": "Resources in north east zone",
  "filterCriteria": {
    "matchType": "ANY",
    "rules": [
      {
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "SJ"
      },
      {
        "key": "Name",
        "operator": "Regex",
        "resourceType": "LOAD_BALANCER",
        "value": "VM"
      },
      {
        "key": "Agent Installed",
        "operator": "Is",
        "resourceType": "DEVICE",
        "value": "TRUE"
      }
    ]
  },
  "name": "SJ-North_EAST",
  "parent": {
    "id": 4,
    "name": "SJ-East"
  },
  "phoneExtension": "1",
  "phoneNumber": "406-232-1234",
  "primaryContact": {
    "id": "USR0000000014",
    "loginName": "InsLab@organization.com"
  },
  "resources": [
    {
      "id": "ad0a218d-7512-435c-9b58-614470ee8658"
    },
    {
      "id": "b7001583-db6a-4c7c-b4df-ab1ba6505d60"
    }
  ],
  "state": "California",
  "zip": "94088"
}

Responses

OK

address
string

(Optional) Site address.

city
string

(Optional) Site city.

clientId
integer

country
string

description
string

(Optional) Summary of the site.

devices
array

devices.aliasName
devices.hostName
devices.ipAddress
devices.resourceName
devices.resourceType
devices.type
devices.uniqueId
filterCriteria
object

filterCriteria.actions
- Supported actions - ASSIGN MONITORINGTEMPLATE - ASSIGN KNOWLEDGEARTICLE - Assign Availability Rule - ASSIGN CUSTOMATTRIBUTES - Assign Jobs - ASSIGN CREDENTIALSET - Supported values for items for given action - For Assign Availability Rule , item value is AND - For ASSIGN CUSTOMATTRIBUTES, item value is tagName[value='tagValue'] - For all others this is number in string eg "12345" - Scenarios for Custom attributes item values in response payload - New TagName : New Tag created with given Name and Tag Value, and Assigned. - Id of New Tag Value added to response - Old TagName and New Tag Value : New Tag Value added to Tag and Assigned - Id of New Tag Value added to response. - Old TagName and Old TagValue : Both the details are verfied and Assigned - Id of TagValue added to Response
filterCriteria.executionOrder
filterCriteria.id
filterCriteria.matchType
(Optional) The type of match: -To match all the filter conditions, provide matchType: ALL. - To match any one of the filter conditions, provide matchType: ANY.
filterCriteria.name
Name of the policy.
filterCriteria.resourceType
Type of resource. Example: DEVICE, VOLUME, VPN, XENSERVER
filterCriteria.rules
(Optional) Filter devices with specific attributes: - Attribute name of device. Example: Name, Operating System. Attribute names change with device types. - Matching parameter. Supported operators are: Equals, Contains, Not Contains, Starts with, Ends with, Regex. Learn more about Regex. - Type of resource
id
integer

mspId
integer

name
string

Site name.

parent
object

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

parent.address
parent.description
parent.id
Parent site id
parent.name
Parent site name
phoneExtension
string

(Optional) Site phone extension number.

phoneNumber
string

(Optional) Site phone number for communication.

primaryContact
object

primaryContact.changePassword
primaryContact.email
primaryContact.firstName
primaryContact.id
primaryContact.lastName
primaryContact.loginName
primaryContact.phoneNumber
resources
array

resources.aliasName
resources.hostName
resources.id
resources.ipAddress
resources.metaData
resources.name
resources.resourceName
resources.resourceType
resources.type
state
string

(Optional) Site state.

zip
string

(Optional) Zip code.

{
  "address": "5th Avenue, Park street",
  "city": "San Jose",
  "country": "USA",
  "description": "Resources in north east zone",
  "filterCriteria": {
    "id": 70,
    "matchType": "ANY",
    "rules": [
      {
        "id": 223,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "SJ"
      },
      {
        "id": 224,
        "key": "Name",
        "operator": "Regex",
        "resourceType": "LOAD_BALANCER",
        "value": ".*VM.*"
      },
      {
        "id": 225,
        "key": "Agent Installed",
        "operator": "Is",
        "resourceType": "DEVICE",
        "value": "TRUE"
      }
    ]
  },
  "id": 31,
  "name": "SJ-North_EAST",
  "parent": {
    "address": "Parkway",
    "description": "Resources in east zone",
    "id": 4,
    "name": "SJ-East"
  },
  "phoneExtension": "1",
  "phoneNumber": "406-232-1234",
  "primaryContact": {
    "email": "john.smith@gamil.com",
    "firstName": "Ins",
    "id": "USR0000000014",
    "lastName": "Lab",
    "loginName": "InsLab@organization.com",
    "phoneNumber": "406-625-1234"
  },
  "resources": [
    {
      "id": "b7001583-db6a-4c7c-b4df-ab1ba6505d60",
      "ipAddress": "192.168.56.1",
      "name": "DESKTOP-V5DV65M",
      "type": "DEVICE"
    },
    {
      "id": "19a49e09-da18-4d91-92b7-01d6858ec2cf",
      "ipAddress": "10.0.4.15",
      "name": "Windows",
      "type": "DEVICE"
    },
    {
      "id": "ad0a218d-7512-435c-9b58-614470ee8658",
      "ipAddress": "192.168.126.1",
      "name": "WORK-PC",
      "type": "DEVICE"
    }
  ],
  "state": "california",
  "zip": "94088"
}