Skip to content

Intel AMT Domains

Create A Domain

  • Endpoint: */api/v1/admin/domains/create
  • Method Type: POST
  • Headers: X-RPS-API-Key
{
    "payload": 
    { 
        "Name":"domain1",
        "DomainSuffix":"d1.com",
        "ProvisioningCert":"[Your_ProvisioningCert_Text]", //Can this be a directory path for the api call or has to be flat text like DX1?
        "ProvisioningCertStorageFormat":"raw",
        "ProvisioningCertPassword":"[P@ssw0rd]"
    }
}

Example Input: 

{
    "payload": 
    { 
        "Name":"amtDomain",
        "DomainSuffix":"amtDomain.com",
        "ProvisioningCert":"[Your_ProvisioningCert_Text]", //Can this be a directory path for the api call or has to be flat text like DX1?
        "ProvisioningCertStorageFormat":"raw",
        "ProvisioningCertPassword":"P@ssw0rd"
    }
}

Success

Domain amtDomain successfully inserted

Failure

Duplicate Domain. Domain already exists.

Get a Domain

  • Endpoint: */api/v1/admin/domains/{domainName}
  • Method Type: GET
  • Headers: X-RPS-API-Key
input domain1 provided in the URL

Example output:

Success
{
    "Name": "domain1",
    "DomainSuffix": "vprodemo.com",
    "ProvisioningCert": null,
    "ProvisioningCertStorageFormat": "string",
    "ProvisioningCertPassword": null
}
Failure

Domain not found

Get ALL Domains

  • Endpoint: */api/v1/admin/domains/
  • Method Type: GET
  • Headers: X-RPS-API-Key
input  provided in the URL

Example output:

Success
[
    {
        "Name": "domain1",
        "DomainSuffix": "vprodemo.com",
        "ProvisioningCert": null,
        "ProvisioningCertStorageFormat": "string",
        "ProvisioningCertPassword": null
    }
]
Failure

Domains not found

Edit A Domain

  • Endpoint: */api/v1/admin/domains/edit
  • Method Type: POST
  • Headers: X-RPS-API-Key
{
    "payload": 
    { 
        "Name":"domain1",
        "DomainSuffix":"d1.com",
        "ProvisioningCert":"[Your_ProvisioningCert_Text]", 
        "ProvisioningCertStorageFormat":"raw",
        "ProvisioningCertPassword":"[P@ssw0rd]"
    }
}

Example Input: 

{
    "payload": 
    { 
        "Name":"amtDomain",
        "DomainSuffix":"amtDomain.com",
        "ProvisioningCert":"[Your_ProvisioningCert_Text]", 
        "ProvisioningCertStorageFormat":"raw",
        "ProvisioningCertPassword":"P@ssw0rd"
    }
}

Success

Domain amtDomain successfully updated

Failure

Domain domain1 not found

Delete a Domain

  • Endpoint: */api/v1/admin/domains/{domainName}
  • Method Type: DELETE
  • Headers: X-RPS-API-Key

Example Input:

Success

Domain domain1 successfully deleted

Failure

Domain not found.

Return to RPS Methods