Skip to main content

Retrieve Profile Details

GET https://infrahub-api.nexgencloud.com/v1/core/profiles/{id}​

Retrieves the details of an existing provisioning profile containing the saved configuration of a virtual machine, ready for deployment. Include the profile ID in the path to retrieve the details.


Path parameters​

id integer   Required​

The unique identifier of the profile for which to retrieve details.


Attributes​

status boolean​

Specifies the status of the profile retrieval. true indicates success, while false indicates an error.

message string​

A message describing the success or failure of the request to retrieve the details of a profile.

profile object​

The profile object containing the configuration of the virtual machine saved in your profile. For details on the attributes within the profile object, click here.

Request
curl -X GET "http://infrahub-api.nexgencloud.com/v1/core/profiles/{id}" \
  -H "accept: application/json"\
  -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "Getting profile detail success.",
  "profile": {
    "id": 15,
    "name": "profile-1",
    "description": "This is an example profile.",
    "data": "{\"environment_name\": \"Test-env\", \"image_name\": \"CentOS 9\", \"volume_name\": \"\", \"create_bootable_volume\": \"false\", \"flavor_name\": \"n1-cpu-medium\", \"key_name\": \"key pair -1\", \"user_data\": \"\", \"callback_url\": \"\", \"assign_floating_ip\": \"false\", \"count\": \"1\"}",
    "created_at": "2023-09-01T16:10:47"
  }
}

Returns​

The response includes the status of the request, a description of the status, and the retrieved profile object containing the saved virtual machine configuration. This profile object contains the ID, profile name, and description (if provided). Additionally, within the profile, the data object contains the virtual machine configuration saved as a profile. For more details about the fields within the data object, click here.


Back to top​