Endpoint
/api/v2/tenants/{tenantId}/managementProfiles/search

Sample URLs

  • https://{api-url}/api/v2/tenants/client_69900/managementProfiles/search?pageNo=1&pageSize=10&isDescendingOrder=true&sort

Path Parameters
tenantId
string

Describes the uuid of the tenant

Query Parameters
id
string

The management profile uuid.

name
string

The management profile name.

type
boolean

The management profile type. An example is: { Agent | Gateway }

startCreationDate
string

Search for the management profile created within a certain duration. Start indicates the from date. An example is: 2016-06-10T10:40:20 0000 (GMT).

endCreationDate
string

Search for the management profile created within a certain duration. End indicates the to date. An Example is: 2016-06-20T10:40:20 0000 (GMT).

Responses

OK

descendingOrder
boolean

nextPage
boolean

nextPageNo
integer

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.activationToken
results.createdDate
results.description
results.device
results.id
results.name
results.registered
results.services
results.softwareVersion
results.status
results.statusUpdatedDate
results.tunnelType
results.type
results.uuId
totalPages
integer

totalResults
integer

{
  "descendingOrder": true,
  "nextPage": false,
  "nextPageNo": 0,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 10,
  "previousPageNo": 0,
  "results": [
    {
      "activationToken": "423e2e3c-a300-4218-a69c-9e3d8c3c3c63",
      "createdDate": "2016-06-22T07:34:40+0000",
      "description": "Gateway Management Profile_LB1",
      "id": 76,
      "name": "LB1 Gateway Profile",
      "registered": false,
      "tunnelType": "SSHD",
      "type": "Gateway"
    },
    {
      "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": "2016-06-14T06:57:46+0000",
      "description": "Gateway Management Profile",
      "device": {
        "generalInfo": {
          "hostName": "172.30.31.137",
          "ipAddresses": "172.30.31.137"
        },
        "id": "fbfe0ecd-8200-4cbf-a13c-f309f341a8c8"
      },
      "id": 74,
      "name": "Gateway Profile",
      "registered": true,
      "softwareVersion": "1.4.3",
      "status": "DOWN",
      "statusUpdatedDate": "2016-06-20T06:54:46+0000",
      "tunnelType": "SSHD",
      "type": "Gateway",
      "uuId": "d004de59-3e72-4c9a-82d7-df3f27f5a7aa"
    },
    {
      "createdDate": "2016-06-02T00:27:53+0000",
      "description": "Default Management Profile",
      "device": {
        "generalInfo": {
          "hostName": "172.30.32.110",
          "ipAddresses": "172.30.32.110"
        },
        "id": "cbee0ecd-5200-3fbf-f13c-c309f341a8c8"
      },
      "id": 37,
      "name": "Default",
      "registered": true,
      "softwareVersion": "1.4.3",
      "status": "DOWN",
      "statusUpdatedDate": "2016-06-12T06:54:46+0000",
      "tunnelType": "SSHD",
      "type": "Gateway",
      "uuId": "95dd2fc2-4d13-11e3-8623-005056910D5D"
    }
  ],
  "totalPages": 1,
  "totalResults": 4
}
{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 10,
  "previousPageNo": 0,
  "results": [
    {
      "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"
    },
    {
      "createdDate": "2021-05-20T09:02:37+0000",
      "description": "testing",
      "device": {
        "generalInfo": {
          "hostName": "host",
          "ipAddresses": "172.26.111.114"
        },
        "id": "ef9ac394-d1e4-49f4-8b30-386c5c562f03",
        "uniqueId": "ef9ac394-d1e4-49f4-8b30-386c5c562f03"
      },
      "id": 10693,
      "name": "Test ",
      "registered": true,
      "services": [
        {
          "name": "sipAgent",
          "status": "false"
        },
        {
          "name": "syntheticsAgent",
          "status": "true"
        }
      ],
      "softwareVersion": "9.0.0",
      "status": "DOWN",
      "statusUpdatedDate": "2021-05-22T16:53:51+0000",
      "tunnelType": "TLS",
      "type": "Gateway",
      "uuId": "bddea263-90a5-4024-abe0-3ad09f3c945c"
    },
    {
      "createdDate": "2021-04-07T07:31:26+0000",
      "description": "",
      "device": {
        "generalInfo": {
          "hostName": "host",
          "ipAddresses": "172.26.111.200"
        },
        "id": "c8e19c6b-8bcd-4783-b3e3-e03f248776ad",
        "uniqueId": "c8e19c6b-8bcd-4783-b3e3-e03f248776ad"
      },
      "id": 9323,
      "name": "Testing 9.0.0",
      "registered": true,
      "services": [
        {
          "name": "sipAgent",
          "status": "false"
        },
        {
          "name": "syntheticsAgent",
          "status": "false"
        }
      ],
      "softwareVersion": "9.0.0",
      "status": "UP",
      "statusUpdatedDate": "2021-05-24T13:02:03+0000",
      "tunnelType": "TLS",
      "type": "Gateway",
      "uuId": "99d5217d-a67f-4b06-bcda-34113a8a855a"
    }
  ],
  "totalPages": 1,
  "totalResults": 3
}
{
  "descendingOrder": true,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 10,
  "previousPageNo": 0,
  "results": [
    {
      "id": 10823,
      "name": "Testing"
    },
    {
      "id": 10813,
      "name": "Local_Gateway",
      "services": [
        {
          "name": "sipAgent",
          "status": "true"
        },
        {
          "name": "syntheticsAgent",
          "status": "true"
        }
      ]
    },
    {
      "id": 10693,
      "name": "Test ",
      "services": [
        {
          "name": "sipAgent",
          "status": "false"
        },
        {
          "name": "syntheticsAgent",
          "status": "true"
        }
      ]
    },
    {
      "id": 9323,
      "name": "Testing 9.0.0",
      "services": [
        {
          "name": "sipAgent",
          "status": "false"
        },
        {
          "name": "syntheticsAgent",
          "status": "false"
        }
      ]
    }
  ],
  "totalPages": 1,
  "totalResults": 4
}

Unprocessable Entity