Visibility in the Catalog
Last updated
Last updated
You have several options to determine the visibility of your service, and of individual plans. This article explains these settings, and gives you a checklist to help your service appear publicly in the Catalog.
This toggle on each Service card under Services, defines globally whether the service can appear in the Catalog.
You can additionally toggle the visibility of individual Plans in the Plans section of the Service Configuration.
This option can be used to retire plans without ending the existing subscriptions. Hidden plans will not appear to any consumer (irrespective of permissions), and cannot be subscribed to. Existing subscription to the plan will keep working.
Visible plans will adhere to the permissions shown in the next step.
On individual Plans, you can define who is allowed to see them (and hence, subscribe).
You can use "Selected Workspaces" to offer tailored pricing, limits, or even custom API backend, to specific customers. It is also well suited for test plans (limiting to your own workspace).
"All Workspaces" will display the plan in the public catalog. For more info, see Add a Plan.
In order to appear in the public catalog
a Service must be set to Visible, and
at least one Plan - must be set to Visible, and - must be permissioned to All Workspaces.
If switched off, the service is accessible only via direct link. The direct link can be found by opening the description page with the button . Anyone with this link can access the service page. For more info, see Add a Service.
