Remote Provisioning (RPS) API#

Open AMT Cloud Toolkit supports RPS API methods for domains, CIRA configuration, wireless, profiles, and version information.

Download the Remote Provisioning (RPS) API in OpenAPI YAML format

GET /v1/projects/{projectName}/dm/amt/admin/domains#

Get All Domains

Retrieves all of the domain configuration profiles stored in the database. Will not return the provisioning certificate or certificate password to protect the privacy of these assets.

Parameters:

  • projectName (string) – unique projectName for the resource

Query Parameters:

  • $skip (integer) – The number of items to skip before starting to collect the result set

  • $top (integer) – The numbers of items to return

  • $count (boolean) – The total number of domains

Status Codes:
PATCH /v1/projects/{projectName}/dm/amt/admin/domains#

Update Domain Suffix

Edits an existing domain configuration profile.

The profileName field can not be changed.

Version must be provided to ensure the correct profile is edited.

The provisioning certificate and certificate password are stored in a secrets manager and are only used when required during activation. Provisioning certificate must be a base64 string of the Personal Information Exchange (PFX) certificate that includes the entire certificate chain and private key.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
POST /v1/projects/{projectName}/dm/amt/admin/domains#

Create Domain

Creates a new domain configuration profile to the database. The provisioning certificate and certificate password are stored in a secrets manager and are only used when required during activation.

Parameters:

  • projectName (string) – unique projectName for the resource

Status Codes:
DELETE /v1/projects/{projectName}/dm/amt/admin/domains/{profileName}#

Remove Domain

Removes the specific domain configuration profile

Parameters:

  • profileName (string) – Name of domain profile to remove

  • projectName (string) – unique projectName for the resource

Status Codes:
GET /v1/projects/{projectName}/dm/amt/admin/domains/{profileName}#

Get Domain

Retrieves the specific domain configuration profile.

Parameters:

  • profileName (string) – Name of domain profile to return

  • projectName (string) – unique projectName for the resource

Status Codes: