Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Accessing the API server

To send web service requests to the API server, you must know the server's URL and have the appropriate permissions to access it.

URL

You or your cloud administrator can find the URL for the API server in the Configuration workspace on the Cloud Service URL field on the General tab. To learn how to access the Configuration workspace, see Setting-general-options-for-BMC-Cloud-Lifecycle-Management.

Permissions

In general, you must have cloud administrator permissions to use the API. However, users with cloud organization administrator or cloud end user permissions can use some APIs. If you are a cloud organization administrator or cloud end user, you can use the following guidelines to determine whether a particular API is available to you:

  • If you can perform an action from the BMC Cloud Lifecycle Management Tenant Administration Console or the My Cloud Services Console, you can use the corresponding API.
  • If you can see an object in the Tenant Administration Console or the My Cloud Services Console, you can perform an action on the object by using the corresponding API.

Contact your cloud administrator to obtain a user name and password for an account with cloud administrator privileges. If you already have an account, your cloud administrator can grant you cloud administrator permissions by following the steps in Updating-an-existing-user-account-with-cloud-administrator-permissions.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*