You use the Project APIs to manage projects that can be used in any of the vRealize Automation component services. In addition to basic operations such as creating, updating, or deleting projects, you can use the Project APIs to modify principals assigned to a project or modify a project cost.

To access the Swagger documentation for the Projects API, see https://<vRA-FQDN>/project/api/swagger/swagger-ui.html.

Prerequisites for Project Management

All project management tasks share the following common prerequisites:

  • Verify that you are at least an organization member in VMware vRealize Automation with an administrator service role.
  • Verify that you have an active access token. See Getting Your Authentication Token.
  • Verify that the URL variable is assigned.
    url='https://appliance.domain.com'
  • Verify that the API version variable is assigned to a date as in the following example.
    api_version='2019-01-15'

    If you do not assign a value to the apiVersion variable, the Project API behavior will default to the API version with the value 2019-01-15.

Any additional prerequisites are specified with the individual tasks.