Ensure that you have required permissions to create new APIs.
Note: Only users with VMware BMA account can access the API.


  1. In the APIS window, click Create API.

  2. Enter the name for the API.
  3. In General Settings, enter the following details:
    1. Select the worker group from the drop-down menu.
    2. Enter the description.
  4. In Authentications, select the authentication service for the API from the drop-down menu.
    1. Select VMware from the Authentication drop-down menu to allow only logged in VMware Bare Metal Automation users to access the API.
      • To allow only the logged-in user to access the API, select Myself.
      • To allow everyone in VMware BMA to access the API, select Everyone in VMware.
      • To allow specific users and roles to access the API, select VMware Users and Roles.

        Enter the user name and role and click the Add user and Add role respectively.

        Administrator users get automatic suggestions when searching for users and roles if VMware Users and Roles option is selected.

        To indicate whether the users and roles exist and whether they are active, the user names appear in different color according to the user and role.

        Non-administrator users can also add any user or role, and automatic suggestion appears only for roles.
    2. Select Anonymous from the Authentication drop-down menu to allow everyone to access the API.

      In this, no authentication is performed for the access permissions.

    3. Select Api Keys from the Authentication drop-down menu to allow only people with a link and a specific API key to access the API.
      To use API keys for authentication, you must add an API key. For more information, see API.
      1. Click the Add API key.
      2. Enter the API name and click the save icon.
    4. Select Workflow from the Authentication drop-down menu to select an endpoint and a stage pair on which an existing deployment is based. This pair can then start a workflow which defines who can access the API.
      Note: You must first create an API using any of the above three authetications to use the workflow authentication. After creating an API, you can edit the API to apply workflow authentication. For more information on editing an API, see Edit API topic.
  5. In Advanced settings, specify the following details.
    1. From Flow should run drop-down menu, select if the workflow should run as synchronous or asynchronous.
    2. From Run real time drop-down menu, select whether the workflow should run with logs or in real-time.
    3. From Statistics as part of result drop-down menu, select whether to include or not include statistics.
    4. In Response timeout (in ms), enter the response timeout in milliseconds.
    5. In Message timeout (in ms), enter the message timeout in milliseconds.
    6. In Error code, enter the status code of the error generated after the timeout.
      Note: You must enter a status code between 100 and 599.
    7. To allow API requests for deployed API endpoints to be logged, select Enable API request logging check box. This allows understanding the actions taken by the gateway.
  6. Click Create.
    The API is generated and you are navigated to Workflow Deployments to manage the API and use it in the deployment of a workflow.