Create Endpoint

Table 1. API:Create EndPoint
Element Description
API Create Endpoint
Description API Creates a provisioning endpoint. API is applicable for all provisioning endpoints.
Method POST
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/platforms/provisioningEndpoints
Body Parameters
{
"entitytypecode": "ARM",
"name": "ARMTEST",
"endpointtags": "aws,azure",
"armdetails": {
"subscriptionid": "12345",
"tenantid": "12345",
"nativclientid": "fdxfxfg",
"clientsecretkey": "guigui",
"regionname": "eastasia, eastus2",
"inputType": "string"
},
"gcpdetails": {
"projectid": "test_123",
"privatekey": "test_123",
"privatekeyid": "test_id",
"clientemail": "sthkxwhring",
"authuri": "stjiouring",
"tokenuri": "shitring",
"scopeurl": "jouj",
"regionname": "us-east1, europe-west1",
"inputType": "string"
},
"vmwardetails": {
"locationname": "NN",
"username": "myuser",
"password": "xxxxxx",
"templatepath": "/jdije/cjeicjei",
"url": "test",
"inputType": "string"
},
"scvmmdetails": {
"locationname": "NZ",
"version": "edwe",
"url": "strcweing",
"port": "22",
"username": "struser",
"password": "zzzzzzzz",
"domain": "xyz",
"inputType": "string"
}
}
  • Entitytypecode (Mandatory): This is provisioning platform code for which provisioning endpoint needs to be created. Possible values are ARM, AMAZN, GCP and VMWAR and Scvmm.
  • inputType(Mandatory): inputType should be “plaintext”, “secretkey” or “cyberark” .
  • for inputype “plantext” secret information (Arm-clientsecretkey,GCP- privatekeyid,AWS- password,VMWAR- password,SCVMM- password) should be plain text value which will save in HCL BigFix CLM in encrypted form.
  • For inputype “secretkey” secret information (Arm-clientsecretkey,GCP- privatekeyid,AWS- password,VMWAR- password,SCVMM- password) should be combination of secret configuration name and key created in HCL BigFix CLM through “Key Vault configuration” screen for e.g. “$testing.azurekey”
  • For inputype “cyberak” secret information (Arm-clientsecretkey,GCP- privatekeyid,AWS- password,VMWAR- password,SCVMM- password) should be cyberak configuration name created in HCL BigFix CLM through “Key Vault configuration” screen.
    For e.g. If entitytypecode is ARM, then only ARM json details require to create endpoint like "armdetails":
    {
    "subscriptionid": "12345",
    "tenantid": "12345",
    "nativclientid": "fdxfxfg",
    "inputType": "string",
    "secretKey": "string",
    "regionname": "eastasia, eastus2"
    }
Header
  • Authorization Key: The initial step that needs to be performed before consuming HCL BigFix CLM APIs is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
  • Content-type: application/json
Response
{
"endpointId": "string"
}
Response Parameters
  • endpointId