Get Started — Publish Your Team's API

This tutorial walks through one concrete outcome: taking an API your team has built and getting it published in the portal's catalog, so consumers in your organization can discover it, read its specification, and connect it to their applications.

Before you begin, you'll need:

• A portal account with a producing role (for example the CI/CD role, or a producer account on a backend team) — see Roles and types of users if you're not sure which role you have.
• Your API's specification file (OpenAPI or similar) ready to upload.
• A backend team already set up for your API. If your team doesn't have one yet, ask a portal administrator to create it, or see Managing Your Teams.

Publish your API

1

Sign in

Open the portal address your organization gave you and complete your organization's sign-in flow (often the same account you use for work email or single sign-on). You land on the home page.

2

Select the right environment

Open the environment control in the top bar and choose the environment your API belongs to (for example the gateway your team deploys to). Everything you do next — uploading, catalog visibility — is scoped to this environment. See Environments for how these map to Apigee, Gravitee, and Azure.

3

Open APIs

Select APIs in the left sidebar to open the catalog for the selected environment.

4

Upload your specification

Use the upload / drag-and-drop area on the APIs page to add your specification file. This area is shown to producing and automation roles; if you don't see it, confirm your role with your administrator. If you already have locale overlay files, attach them in this upload — see Exposing your API. You can skip overlays on a first publish.

5

Confirm your team owns it

Once the upload completes, open the new API's product page and confirm it's assigned to your backend team. This is what lets consumers see who to contact for changes or incidents. If it isn't assigned yet, add the assignment from the product page or ask an administrator.

6

Verify it's in the catalog

Go back to APIs and confirm your product now appears in the list for this environment, with its specification viewable.

INFO

Your API is now discoverable. Consumers can open it from APIs, read the specification, and add it to one of their applications — see Consuming an API for that flow.

What's next

• Exposing your API — the shorter how-to for the next time you publish, once you've done this tutorial once.
• Managing Your Teams — add teammates to your backend team, or link it to permission groups.
• Core Concepts — how environments, platforms, permission groups, and applications fit together.
• Reference — a full map of the portal's screen areas, controls, and settings once you're exploring beyond this tutorial.