Using the REST API

If your user account is able to use OCI CLI on the target Private Cloud Appliance, then you can also use the Compute Enclave API. Specifically, ensure that you have completed the following steps:

  1. Get the appliance domain name and the name of the tenancy where you will be working.

  2. Ensure the tenancy administrator has created a user account for you.

  3. Get the username and temporary password for your user account, and use those credentials to log in to the Web UI.

    You will be prompted to set a permanent password.

  4. Navigate to the details page of your user account and upload your public API key.

    See Generating an API Key Pair and Adding an API Public Key to a User Profile. Your API key pair must be in PEM format.

  5. Ensure the tenancy administrator has added your user to one or more user groups that grant you the authorizations that you require.

Use your preferred software development kit to manage Private Cloud Appliance resources by using REST API. See Software Development Kits and Command Line Interface.

For Compute Enclave API paths and parameters, see REST API for Oracle Private Cloud Appliance Compute Enclave.