Skip to content

feat(portal): Upload API/package image #4856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cloudjumpercat wants to merge 4 commits into
base: main
Choose a base branch
from
+16 −0
Open

feat(portal): Upload API/package image #4856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50b1609
Add content for uploading image
cloudjumpercat Apr 14, 2026
5b4872b
fix that it's only edit flows that allow you to upload an image
cloudjumpercat Apr 14, 2026
572b6e5
Apply suggestions from code review
cloudjumpercat Apr 15, 2026
af649b6
fix steps so they're numbered
cloudjumpercat Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions app/catalog/api-packaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,9 @@ To package APIs with Dev Portal, you need:

Your operations should now be autogenerated based on how your OpenAPI spec maps to your Routes.

After you've created an API package, you can edit it to upload an image for the package that will display in Dev Portals where the package is published.
The image must be a PNG, JPG, or SVG image under 500 KB that’s no larger than 350 × 350 pixels.

### Publish packages to Dev Portal

1. In {{site.konnect_short_name}}, click **Catalog**.
Expand Down
13 changes: 13 additions & 0 deletions app/catalog/apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,19 @@ Based on this data, you get the following generated URLs:
* Generated URL for `about` page: `/apis/routes-v3/docs/about`
* Generated URL for `info` page: `/apis/routes-v3/docs/about/info`

## API image

You can upload an image for your API.
The image is displayed as an icon for your API in any [Dev Portal](/dev-portal/) where the API is published.
The image must be a PNG, JPG, or SVG image under 500 KB that’s no larger than 350 × 350 pixels.

To upload an API image, do the following:
1. In the {{site.konnect_short_name}} sidebar, click **{{site.konnect_catalog}}**.
1. In the {{site.konnect_catalog}} sidebar, click **[APIs](https://cloud.konghq.com/apis)**.
1. Click the API you want to add the image to.
1. From the action menu, select "Edit".
1. Click **Upload image** and upload an image.

## Allow developers to consume your API

You can link to a {{site.konnect_short_name}} [Gateway Service](/gateway/entities/service/) to allow developers to create applications and generate credentials or API keys. This is available to data planes running {{site.base_gateway}} 3.6 or later.
Expand Down
Loading