Skip to main content

List Profiles

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

Retrieves a list of existing provisioning profiles that contain your saved virtual machine configurations, ready for deployment.


Parameters​

No parameters.


Attributes​

status boolean​

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

message string​

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

profile array of objects​

An array of profile objects containing the configurations of the virtual machines saved in your profiles. For details on the attributes within the profile object, click here.

Request
curl -X GET "http://infrahub-api.nexgencloud.com/v1/core/profiles" \
  -H "accept: application/json"\
  -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "Getting profiles success.",
  "profiles": [
    {
      "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 an array of profile objects each corresponding to a 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​