Add a product to an existing provider in CAPI

  • Release version: Australia
  • Updated March 12, 2026
  • 2 minutes to read

    • The Cloud Provisioning and Governance Cloud API (CAPI) offers many providers, such as AWS and Azure, and products, such as EC2 instances. However, you can add products to existing providers for new types of cloud resources.

    Before you begin

    • Role required: admin
    • Review Default CAPI APIs and make sure the provider and product that you want to create are not already provided.
    • Familiarize yourself with the cloud provider API so that you know how to create REST calls to the provider. If you are not familiar with the headers, authentication requirements, endpoint, and data that you can pass into the provider API, you cannot build your own CAPI components.

    About this task

    This topic provides general instructions for extending an existing cloud provider, product, and resource type.

    Procedure

    1. In your instance (not in the Cloud Admin Portal), enter the following text into the application filter:

      sn_capi_product.list

      Opening the list of CAPI products

    2. Press ENTER.

      The list of products that belong to all providers appears. You can filter the list to verify that the product you want to create is not already provided.

    3. Click New and then enter a name and choose one of the existing service categories that is most appropriate.
    4. Click Submit.

      The list of products appears again.

    5. Find the product that you created, and then double-click the empty cell in the Provider column.

      Double click the empty cell

    6. Add the correct provider.
    7. Add a unique provider name: Double-click the cell in the Provider Name field and then change the name.

      The system can auto-generate a provider name for you, but you should modify it to avoid conflicts with existing provider names.

    8. In the Cloud Admin Portal, navigate to Design > Cloud API.
    9. Click the tile for the provider to which you added the new product.
    10. Verify that your product is in the Cloud Products related list.
    11. Click the information icon (Information icon) for the cloud product, and then click Open Record.
    12. In the Cloud Resource Types related list, click New and then fill in the form.
      Field Description
      Name A unique and descriptive name.
      Product The Cloud Product for which you're creating the Resource type. Select from the lookup list or create new.
      CI Class A CMDB table you need to associate with the resource type. If you do not see the correct CMDB table, see Create a CI class for a virtual cloud resource for instructions on how to create one.
      Pattern The pattern that is used to discover the resource type. Select from the Discovery patterns lookup list or create a new pattern.
      Dependency Sequence The order in which resource type is provisioned or discovered.

      Specify the order based on inter-dependencies of resources. For example, if you have a network and a subnet that you want to discover or create, specify a higher order for network than subnet, so that discovery or creation of resources is performed logically and sequentially.

      A new resource type

    13. Click Submit.

    What to do next

    Create a CI class for a virtual cloud resource if necessary, or Create or extend a CAPI interface