Adding and Deleting APIs and Domains From Projects

Last modified on October 14, 2021

A project is a group of an organization’s APIs and domains. A single API or domain can belong to multiple projects.

Add to a new project

Applies to: Organization owners

See Creating Projects.

Add to an existing project

When creating APIs or domains

Applies to: Organization owners, Designers with Create permissions

SwaggerHub On-Premise note: Requires v. 1.23 or later.

When you create, import, or fork definitions into an organization, you have the option to add this definition to an existing project:

Project list

Click the image to enlarge it.

Via project settings

Applies to: Organization owners

  1. Select the project in the SwaggerHub sidebar, then click  Settings next to the project name.

    Note: In earlier versions of SwaggerHub On-Premise, the button is located at the top right of the project page.
    Opening project settings in SwaggerHub
  2. Use the search box to find the API or domain you want to add, and click it in the list to add it.

    The list displays the APIs and domains owned by your organization. If you do not see an API or domain in the drop-down list, you may need to transfer the ownership to your organization.
    Adding APIs and domains to a project in SwaggerHub

    Click the image to enlarge it.

Via editor

Applies to: Organization owners, Designers with Create permissions

SwaggerHub On-Premise note: Requires v. 1.23 or later.

  1. Open an organization-owned API or domain in the SwaggerHub editor.

  2. Click the API or domain name to open the Info panel.

    Opening the Info panel
  3. Click  Manage Owner & Project.

    Manage Owner & Project
  4. Select the project to which you want to add this API or domain. The list contains the projects that you are a member of.

    Assign Project
  5. Select the Yes, I want to proceed check box.

  6. Click Save.

Note: If the current API or domain is already part of another project, it will remain in that project as well.

Access permissions

Project members automatically get View access to all APIs and domains (public or private) in that project. Note that Designers do not get Edit permissions automatically by virtue of their organization role. To give your Designers Edit permissions, add them as collaborators to the APIs and domains in the project.

Delete APIs and domains from a project

Applies to: Organization owners

  1. Open the project setting page (see above).

  2. Click next to the API or domain you want to delete from the project:

    Deleting APIs and domains from SwaggerHub projects

    Click the image to enlarge it.

Note: This does not delete the actual API or domain. See Deleting APIs to learn how to delete APIs and domains from SwaggerHub.

See Also

Projects

Highlight search results