Project-related operations

Learn how to do project-related operations in IBM® API Connect, including creating projects, listing projects and files, and copying APIs and products to projects. These operations are supported across different platforms and help streamline API development workflows.

The project-related operations help you manage API development projects within your IBM API Connect provider organization. You can create new projects, explore existing ones, and organize APIs and products efficiently.

  • Create a project by specifying a name, and optionally a description and tags to categorize its purpose.
  • List managed projects to view all projects in the organization, with support for pagination that uses limit and skip.
  • List files in a project to inspect the contents of a specific project, including APIs and products.

Create project

Creates a project in provider organization that API Manager manages. It takes the project name as input and creates the project. Optionally users can provide the description of the project and tags or keywords that are associated with the project as input.

Table 1. Parameters
Field name Type Required Description
Name String Yes This required field specifies the name of the project. The name must be alphanumeric and can include hyphens (-) and underscores (_).
Description (optional) String No This optional field provides a brief summary of the project’s purpose or content.
Tags (optional) String No You can add keywords in this optional field that describe the project’s focus or category.
You can use the following prompts to create a project:
Table 2. Prompts
Action Prompts Commands
Create a project 
create project using name <xyz>
create a studio project with name my-project1 that is managed by API Manager
create project using name test-project and description "some description"
create project using name test-project and description "some description" and tags tag1,tag2
create a studio project with name my-project1 that is managed by API Manager and using tags tag1,tag2,tag3
  • Create a Consumer App by title (default catalog: sandbox)
    /create_consumer_app title:test app consumer_org:test-org
  • Create a Consumer App by name to a specific catalog, for example, test 
    /create_consumer_app name:test-app consumer_org:test-org
  • Create a Consumer App by name and title to a specific catalog, for example, test 
    create_consumer_app title:test app name:test app consumer_org:test-org

List projects

List projects managed by the IBM API Connect provider organization. Limit and offset values are used to control the number of projects returned.

Table 3. Parameters
Field name Type Required Description
Limit (optional) String No Maximum number of rows to return.
Skip (optional) String No Skip this number of rows and return the remaining rows according to the limit set.
You can use the following prompts to list a project:
Table 4. Prompts
Action Prompts Commands
List a project 
list projects
list projects with limit 20
list projects with offset 5
list projects with limit 10 and offset 3
get me all the projects with limit 5 and offset
can you list the projects in API Connect provider organization using limit 50 and offset 20
list managed projects
get me all the managed projects with limit 5 and offset 1
  • Create a Consumer App by title (default catalog: sandbox)
    /create_consumer_app title:test app consumer_org:test-org
  • Create a Consumer App by name to a specific catalog, for example, test 
    /create_consumer_app name:test-app consumer_org:test-org
  • Create a Consumer App by name and title to a specific catalog, for example, test 
    create_consumer_app title:test app name:test app consumer_org:test-org

List files in project

List files in the project managed in the IBM API Connect provider organization. Limit and offset values are used to control the number of files returned. The name of the project and optionally limit and offset are provided in the input.

Table 5. Parameters
Field name Type Required Description
project_name String Yes ID or name of the project. The API Manager must manage the project.
Limit (optional) String No Maximum number of rows to return.
Skip (optional) String No Skip this number of rows and return the remaining rows according to the limit set.

You can use the following prompts to list project files:

Table 6. Prompts
Action Prompts
List project files 
list files in project <xyz>
list files in project abcd with limit 20
list files in project with name <xyz> and offset 5
list files from project with name test-project1 and using limit 10 and offset 3
get me all the files in project my-project1 with limit 15 and offset 1
can you list the files in project test1 in API Connect provider organization using limit 50 and offset 20
list managed projects
list the files in managed project weather-apis
get me all the files in managed project with name my-api-project using limit 5 and offset 1