Skip to content

Intel AMT Profiles

Create a Profile

  • Endpoint: */api/v1/admin/profiles/create
  • Method Type: POST
  • Headers: X-RPS-API-Key
{
    "payload" :  
    {
        "profileName": "[amt-profile-name]",
        "amtPassword":"[strong-AMT-password]",
        "generateRandomPassword": "false",
        "passwordLength": 8,
        "ciraConfigName": "testconfig",
        "activation": "[acmactivate/ccmactivate]"
    }
}

Example Input:

{
    "payload":
    {
        "profileName":"testProfile1",
        "amtPassword":"STRONGPASSWORD",
        "generateRandomPassword":false,
        "passwordLength":null,
        "ciraConfigName": "testconfig",
        "activation":"ccmactivate"
    }
}
Success

Profile testProfile1 successfully inserted

Failure

Profile insertion failed for testProfile1. Profile already exists.

Failure

Referenced CIRA Config testconfig58 doesn't exist.

Get a Profile

  • Endpoint: */api/v1/admin/profiles/{profileName}
  • Method Type: GET
  • Headers: X-RPS-API-Key

Example Input:

N/A (test profile to retrieve provided in URL as query parameter)
Success
{
    "ProfileName": "testProfile1",
    "AMTPassword": null,
    "GenerateRandomPassword": false,
    "RandomPasswordLength": null,
    "ConfigurationScript": null,
    "Activation": "ccmactivate",
    "CIRAConfigName": "testconfig1"
}
Failure

Profile testProfile1 not found

Get All Profiles

  • Endpoint: */api/v1/admin/profiles/
  • Method Type: GET
  • Headers: X-RPS-API-Key
NA

Example Input:

NA (no query parameter in the URL retrieves all profiles)
Success
[
    {
        "ProfileName": "testProfile1",
        "AMTPassword": null,
        "GenerateRandomPassword": false,
        "RandomPasswordLength": null,
        "ConfigurationScript": null,
        "Activation": "ccmactivate",
        "CIRAConfigName": "testconfig1"
    }
]
Failure

No profiles found.

Edit a Profile

  • Endpoint: */api/v1/admin/profiles/edit
  • Method Type: POST
  • Headers: X-RPS-API-Key
{
    "payload" :  
    {
        "profileName": "[amt-profile-name]",
        "amtPassword":"[strong-AMT-password]",
        "generateRandomPassword": "false",
        "passwordLength": 8,
        "ciraConfigName": "testconfig",
        "activation": "[acmactivate/ccmactivate]"
    }
}

Example Input:

{
    "payload":
    {
        "profileName":"testProfile1",
        "amtPassword":"STRONGPASSWORD",
        "generateRandomPassword":false,
        "passwordLength":null,
        "ciraConfigName": "testconfig",
        "activation":"ccmactivate"
    }
}
Success

Profile testProfile1 successfully updated.

Failure

Referenced CIRA Config testconfig58 not found.

Failure

Profile testProfile11 not found

Delete a Profile

  • Endpoint: */api/v1/admin/profiles/{profileName}
  • Method Type: DELETE
  • Headers: X-RPS-API-Key
NA

Example Input:

NA (profile to delete provided as query parameter in url 'profile1')
Success

Profile testProfile1 successfully deleted

Failure

Profile not found.

Return to RPS Methods