Exposing your API
This guide is for producing roles — a developer on a backend team, or an account using the CI/CD role for automated publishing. If you're looking for a full first-time walkthrough (new team, new environment, first upload), see the Publish your team's API tutorial instead. Use this page once you already know the drill and just need the steps.
Select the right environment
Open the environment control in the top bar and choose the environment your API belongs to. Uploads and catalog visibility are scoped to this environment — see Environments.
Open APIs
Select APIs in the left sidebar to open the catalog for the selected environment.
Upload the specification
Use the upload / drag-and-drop area to add your specification file (OpenAPI or similar). This area is shown to the CI/CD role and other producing accounts — whether the upload happens by hand or from a pipeline, the result is the same: a new product waiting to be claimed by a backend team.
If you have locale overlays, attach them in the same publish flow — see the next step. Skip it if you only ship the canonical spec.
Attach locale overlays (optional)
On the overlay step of the upload wizard, attach or replace a file per locale. Keep current files when you are not changing a translation. The portal blocks continue if the new version would drop a locale already published, or if a JSONPath target matches nothing in the spec. Overlay files need a required info.title.
Background: Translated specifications. Lookup: Reference — locale overlays.
Assign it to a backend team
Open the uploaded product and use Assign to backend team (or Reassign to another backend team if it's already attributed elsewhere) to select the team that owns it. This is what lets consumers see who to contact for changes or incidents — an unclaimed API is harder for consumers to trust. See Managing Your Teams if the right backend team doesn't exist yet.
Verify it's live in the catalog
Go back to APIs and confirm the product now appears in the list for this environment, with its specification viewable.
INFO
Once it's live, consumers find it from APIs, read the specification, and add it to one of their applications — see Consuming an API for that flow.
Related topics
- Publish your team's API — the full first-time tutorial this guide assumes you've already done once
- Managing Your Teams — backend teams, ownership, and membership
- Roles and types of users — producing vs. consuming roles, and the CI/CD role
- Reference — API catalog — every control on a product page
- Translated specifications
- Reference — locale overlays