Skip to content

Intel AMT Domains

Create A Domain

  • Endpoint: /api/v1/admin/domains/create
  • Method Type: POST
  • Headers: X-RPS-API-Key
  • Payload:
{
    "payload": 
    { 
        "Name":"[Domain-Name]",
        "DomainSuffix":"[Domain-Suffix]",
        "ProvisioningCert":"[Your_ProvisioningCert_Text]",
        "ProvisioningCertStorageFormat":"raw",
        "ProvisioningCertPassword":"[P@ssw0rd]"
    }
}

Example

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

Example Outputs:

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

Example Outputs:

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

Domain domain12 not found

Get ALL Domains

  • Endpoint: /api/v1/admin/domains/
  • Method Type: GET
  • Headers: X-RPS-API-Key
  • Payload: Not required. No query parameter in URL retrieves all domains.

Example Outputs:

Success
[
    {
        "Name": "domain1",
        "DomainSuffix": "domain1.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: 
{
    "payload": 
    { 
        "Name":"[Domain-Name]",
        "DomainSuffix":"[Domain-Suffix]",
        "ProvisioningCert":"[Your_ProvisioningCert_Text]",
        "ProvisioningCertStorageFormat":"raw",
        "ProvisioningCertPassword":"[P@ssw0rd]"
    }
}

Example

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

Example Outputs:

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

Example Outputs:

Success

Domain domain1 successfully deleted

Failure

Domain not found.

Return to RPS Methods