Skip to content

Intel AMT Profiles

Create a Profile

  • Endpoint: /api/v1/admin/profiles/create
  • Method Type: POST
  • Headers: X-RPS-API-Key
  • Payload:
{
    "payload": {
        "ProfileName": "[amt-profile-name]",
        "AMTPassword": "[strong-AMT-password]", //required if GenerateRandomPassword is false
        "MEBxPassword": "[strong-MEBx-password]", //required if GenerateRandomMEBxPassword is false
        "GenerateRandomMEBxPassword": [true/false],
        "RandomMEBxPasswordLength": null, //required if GenerateRandomMEBxPassword is true
        "GenerateRandomPassword": [true/false],
        "RandomPasswordLength": null, //required if GenerateRandomPassword is true
        "CIRAConfigName": "[CIRA-config-name]",
        "Activation": "[acmactivate/ccmactivate]",
        "NetworkConfigName": "[dhcp_enabled/dhcp_disabled]"
    }
}

Example

ACM Profile using Static Passwords 

{
    "payload": {
        "profileName": "ACM-Static-profile",
        "amtPassword": "StrongP@ssw0rd",
        "mebxPassword": "StrongP@ssw0rd",
        "activation": "acmactivate",
        "ciraConfigName": "ciraconfig",
        "networkConfigName": "dhcp_enabled"
    }
}

Example

ACM Profile using Random Generated Passwords 

{
    "payload": {
        "profileName": "ACM-Random-profile",
        "generateRandomPassword": true,
        "passwordLength": 8,
        "generateRandomMEBxPassword": true,
        "mebxPasswordLength": 8,
        "activation": "acmactivate",
        "ciraConfigName": "ciraconfig",
        "networkConfigName": "dhcp_enabled"
    }
}

Example

CCM Profile using Random Generated Password 

{
    "payload": {
        "profileName": "CCM-Random-Profile",
        "generateRandomPassword": true,
        "passwordLength": 8,
        "activation": "ccmactivate",
        "ciraConfigName": "ciraconfig",
        "networkConfigName": "dhcp_enabled"
    }
}

Note

An MEBx password is not required when activating into Client Control Mode.

Outputs:

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
  • Payload: Not required. The profile to get is provided in the URL as a query parameter.

Example Outputs:

Success
{
    "ProfileName": "ccm-Profile",
    "AMTPassword": null,
    "MEBxPassword": null,
    "GenerateRandomMEBxPassword": false,
    "RandomMEBxPasswordLength": null,
    "GenerateRandomPassword": true,
    "RandomPasswordLength": 8,
    "CIRAConfigName": "ciraconfig",
    "Activation": "ccmactivate",
    "NetworkConfigName": "dhcp_enabled"
}

Note

The API will not return the AMTPassword or MEBxpassword. These must be retrieved from Vault or other storage.

Failure

Profile testProfile1 not found

Get All Profiles

  • Endpoint: /api/v1/admin/profiles/
  • Method Type: GET
  • Headers: X-RPS-API-Key
  • Payload: Not required. No query parameter in URL retrieves all profiles.
Success
[
    {
        "ProfileName": "ccm-Profile",
        "AMTPassword": null,
        "MEBxPassword": null,
        "GenerateRandomMEBxPassword": false,
        "RandomMEBxPasswordLength": null,
        "GenerateRandomPassword": true,
        "RandomPasswordLength": 8,
        "CIRAConfigName": "ciraconfig",
        "Activation": "ccmactivate",
        "NetworkConfigName": "dhcp_enabled"
    }
]
Failure

No profiles found.

Edit a Profile

  • Endpoint: /api/v1/admin/profiles/edit
  • Method Type: POST
  • Headers: X-RPS-API-Key
  • Payload:
{
    "payload": {
        "ProfileName": "[amt-profile-name]",
        "AMTPassword": "[strong-AMT-password]", //required if GenerateRandomPassword is false
        "MEBxPassword": "[strong-MEBx-password]", //required if GenerateRandomMEBxPassword is false
        "GenerateRandomMEBxPassword": [true/false],
        "RandomMEBxPasswordLength": null, //required if GenerateRandomMEBxPassword is true
        "GenerateRandomPassword": [true/false],
        "RandomPasswordLength": null, //required if GenerateRandomPassword is true
        "CIRAConfigName": "[CIRA-config-name]",
        "Activation": "[acmactivate/ccmactivate]",
        "NetworkConfigName": "[dhcp_enabled/dhcp_disabled]"
    }
}

Example

{
    "payload": {
        "profileName": "testProfile1",
        "amtPassword": "StrongP@ssw0rd",
        "mebxPassword": "StrongP@ssw0rd",
        "activation": "acmactivate",
        "ciraConfigName": "ciraconfig",
        "networkConfigName": "dhcp_enabled"
    }
}
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
  • Payload: Not required. The profile to delete is provided in the URL as a query parameter.
Success

Profile testProfile1 successfully deleted

Failure

Profile not found.

Return to RPS Methods