Create management profile

This endpoint is used to create a management profile.

Leave Feedback

URL

POST https://{api/v2}/api/v2/tenants/{tenantId}/managementProfiles

Sample URLs

https://{api/v2}/api/v2/tenants/client_69900/managementProfiles

Parameters

FieldData TypeDescription
typeStringThe management profile type. An example is: Agent.
nameStringThe management profile name.
deviceStringThe device details, applicable only for the agent management profile.
  • Device ID
  • Name
descriptionString(Optional) Summary describing the management profile.

Status code

200 OK

Sample request

This is a sample request for an agent profile:

{
	"name" : "Agent Profile",
	"description" : "Management Profile for Agent",
	"type" : "Agent",
	"device" : {
		"id" : "014ec656-8dfa-404c-8269-015a96faa9b8"
	}
}

This is a sample request for a gateway profile:

{
	"name" : "Gateway Profile",
	"description" : "Management Profile for Gateway",
	"type" : "Gateway"
}

Sample response

This is a sample response for an agent profile:

{
	"id" : 78,
	"name" : "Agent Profile",
	"description" : "Management Profile for Agent",
	"type" : "Agent",
	"status" : "DOWN",
	"createdDate" : "2016-06-22T09:57:09+0000",
	"device" : {
		"id" : "014ec656-8dfa-404c-8269-015a96faa9b8",
		"generalInfo" : {
			"ipAddresses" : "172.28.2.138",
			"hostName" : "SJLPT177"
		},
		"clientUniqueId" : "client_69900",
		"type" : "DEVICE"
	}
}

This is a sample response for a gateway profile:

{
	"id" : 77,
	"name" : "Gateway Profile",
	"description" : "Management profile for Gateway",
	"type" : "Gateway",
	"createdDate" : "2016-06-22T09:31:38+0000",
	"tunnelType" : "SSHD",
	"registered" : false,
	"activationToken" : "6d8e4cc4-0be4-4706-bc1f-7e7e37a10b54"
}