Endpoint
/api/v2/tenants/{tenantId}/managementProfiles/{profileId}
Path Parameters
tenantId
string

Describes the uuid of the tenant

profileId
string

Describes the uuid of the assgined mangement profile

Responses

OK

Endpoint
/api/v2/tenants/{tenantId}/managementProfiles/{profileId}
Path Parameters
tenantId
string

Describes the uuid of the tenant

profileId
string

Describes the uuid of the assgined mangement profile

Responses

OK

createdDate
string

description
string

device
object

device.clientUniqueId
device.generalInfo
device.id
device.type
id
integer

name
string

registered
boolean

services
array

services.name
services.string
softwareVersion
string

status
string

statusUpdatedDate
string

tunnelType
string

type
string

uuId
string

{
  "createdDate": "2016-06-22T07:24:14+0000",
  "description": "Agent Management Profile",
  "device": {
    "clientUniqueId": "client_69900",
    "generalInfo": {
      "hostName": "SJLPT159",
      "ipAddresses": "172.28.2.233"
    },
    "id": "96dd7237-a0cf-40b7-ac5f-56b1bd5221d7",
    "type": "DEVICE"
  },
  "id": 75,
  "name": "Agent Profile",
  "status": "DOWN",
  "type": "Agent"
}
{
  "createdDate": "2021-05-23T09:07:46+0000",
  "description": "ManagementProfile",
  "device": {
    "generalInfo": {
      "hostName": "host",
      "ipAddresses": "172.26.111.114"
    },
    "id": "ef9ac394-d1e4-49f4-8b30-386c5c562f03",
    "uniqueId": "ef9ac394-d1e4-49f4-8b30-386c5c562f03"
  },
  "id": 10813,
  "name": "Local_Gateway",
  "registered": true,
  "services": [
    {
      "name": "sipAgent",
      "status": true
    },
    {
      "name": "syntheticsAgent",
      "status": true
    }
  ],
  "softwareVersion": "9.0.0",
  "status": "UP",
  "statusUpdatedDate": "2021-05-24T13:02:51+0000",
  "tunnelType": "TLS",
  "type": "Gateway",
  "uuId": "45b163a1-69ec-4b2d-9b07-d3b79f5276c5"
}
{
  "activationToken": "0ebaa078-cea2-4a66-a5b8-360bc8274c30",
  "createdDate": "2021-05-24T14:13:15+0000",
  "description": "",
  "id": 10823,
  "name": "Testing",
  "registered": false,
  "tunnelType": "TLS",
  "type": "Gateway"
}
{
  "createdDate": "2021-05-23T09:07:46+0000",
  "description": "ManagementProfile",
  "device": {
    "generalInfo": {
      "hostName": "host",
      "ipAddresses": "172.26.111.114"
    },
    "id": "ef9ac394-d1e4-49f4-8b30-386c5c562f03",
    "uniqueId": "ef9ac394-d1e4-49f4-8b30-386c5c562f03"
  },
  "id": 10813,
  "name": "Local_Gateway",
  "registered": true,
  "services": [
    {
      "name": "sipAgent",
      "status": true
    },
    {
      "name": "syntheticsAgent",
      "status": true
    }
  ],
  "softwareVersion": "9.0.0",
  "status": "UP",
  "statusUpdatedDate": "2021-05-24T13:02:51+0000",
  "tunnelType": "TLS",
  "type": "Gateway",
  "uuId": "45b163a1-69ec-4b2d-9b07-d3b79f5276c5"
}
Endpoint
/api/v2/tenants/{tenantId}/managementProfiles/{profileId}
Path Parameters
tenantId
string

Describes the uuid of the tenant

profileId
string

Describes the uuid of the assgined mangement profile

description
string

Summary describing the management profile.

device
object

The device details, applicable only for the agent management profile.

device.id
name
string

The management profile name.

services
array

services.name
services.status
type
string

{
  "description": "ManagementProfile",
  "name": "Local_Gateway",
  "services": [
    {
      "name": "sipAgent",
      "status": "true"
    },
    {
      "name": "syntheticsAgent",
      "status": "false"
    }
  ],
  "type": "Gateway"
}
{
  "description": "Agent Management Profile",
  "device": {
    "id": "014ec656-8dfa-404c-8269-015a96faa9b8"
  },
  "name": "LB02 Agent Profile",
  "type": "Agent"
}
{
  "description": "Gateway Management Profile",
  "name": "LB01 Gateway Profile",
  "type": "Gateway"
}

Responses

OK

activationToken
string

createdDate
string

description
string

device
object

device.clientUniqueId
device.generalInfo
device.id
device.type
id
integer

name
string

registered
boolean

services
array

services.name
services.status
status
string

tunnelType
string

type
string

{
  "createdDate": "2020-09-24T06:18:29+0000",
  "description": "ManagementProfile",
  "device": {
    "generalInfo": {
      "hostName": "08002765289F.localdomain.com",
      "ipAddresses": "10.0.3.15"
    },
    "id": "f837225c-6dad-4824-971b-11fbbddb3339",
    "uniqueId": "f837225c-6dad-4824-971b-11fbbddb3339"
  },
  "id": 12,
  "name": "Local_Gateway",
  "registered": true,
  "services": [
    {
      "name": "sipAgent",
      "status": "sipAgent disable request initiated"
    },
    {
      "name": "syntheticsAgent",
      "status": "syntheticsAgent enable request initiated"
    }
  ],
  "softwareVersion": "7.0.0",
  "status": "UP",
  "statusUpdatedDate": "2020-10-12T16:50:37+0000",
  "tunnelType": "TLS",
  "type": "Gateway",
  "uuId": "747aed37-ba61-4423-8500-929951d7397b"
}
{
  "createdDate": "2016-06-22T09:57:09+0000",
  "description": "Agent Management Profile",
  "device": {
    "clientUniqueId": "client_69900",
    "generalInfo": {
      "hostName": "SJLPT177",
      "ipAddresses": "172.28.2.138"
    },
    "id": "014ec656-8dfa-404c-8269-015a96faa9b8",
    "type": "DEVICE"
  },
  "id": 78,
  "name": "LB02 Agent Profile",
  "status": "DOWN",
  "type": "Agent"
}
{
  "activationToken": "6d8e4cc4-0be4-4706-bc1f-7e7e37a10b54",
  "createdDate": "2016-06-22T09:31:38+0000",
  "description": "Gateway Management Profile",
  "id": 77,
  "name": "LB01 Gateway Profile",
  "registered": false,
  "tunnelType": "SSHD",
  "type": "Gateway"
}

Unprocessable Entity (SIP Agent and SyntheticAgent are already disabled/enabled)