IBM API Connect Catalog Settings API
The Catalog Settings API from IBM API Connect — 45 operation(s) for catalog settings.
Operations 88
GET
/catalogs/{org}/{catalog}/settings/notification-style/consumer
Notification Styles get operations
#
PUT
/catalogs/{org}/{catalog}/settings/notification-style/consumer
Notification Styles update operations
#
GET
/catalogs/{org}/{catalog}/settings/allowed-product-publish-validations
List of allowed product publish validations
#
GET
/catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}
Returns a configured gateway service
#
DELETE
/catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}
Deletes a configured gateway service
#
GET
/catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/download-logs
Get the Configured Gateway Service download logs
#
GET
/catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}
Returns a catalog user registry
#
DELETE
/catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}
Deletes a catalog user registry
#
DELETE
/catalogs/{org}/{catalog}/configured-api-user-registries
Clears API user registries from a catalog
#
GET
/catalogs/{org}/{catalog}/configured-api-user-registries/{configured-api-user-registry}
Returnns an API user registry
#
DELETE
/catalogs/{org}/{catalog}/configured-api-user-registries/{configured-api-user-registry}
Deletes an API user registry
#
POST
/catalogs/{org}/{catalog}/configured-tls-client-profiles
Creates a configured TLS client profile
#
GET
/catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}
Lists TLS client profiles
#
DELETE
/catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}
Clears TLS client profiles
#
GET
/catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-id}
Returns a TLS client profile
#
DELETE
/catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-id}
Deletes a TLS client profile
#
GET
/catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}
Returns a TLS client profile
#
DELETE
/catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}
Delete a Configured TLS Client Profile
#
GET
/catalogs/{org}/{catalog}/configured-billings/{configured-billing}
Get the Configured Billing object by name or id
#
DELETE
/catalogs/{org}/{catalog}/configured-billings/{configured-billing}
Delete the Configured Billing object by name or id
#
DELETE
/catalogs/{org}/{catalog}/configured-jwt-providers
Clear the Configured Jwt Provider objects
#
GET
/catalogs/{org}/{catalog}/configured-jwt-providers/{configured-jwt-provider}
Get the Configured Jwt Provider object by name or id
#
DELETE
/catalogs/{org}/{catalog}/configured-jwt-providers/{configured-jwt-provider}
Delete the Configured Jwt Provider object by name or id
#
GET
/catalogs/{org}/{catalog}/configured-oauth-providers/{configured-oauth-provider}
Returns a configured OAuth provider
#
DELETE
/catalogs/{org}/{catalog}/configured-oauth-providers/{configured-oauth-provider}
Deletes a configured OAuth provider
#
POST
/catalogs/{org}/{catalog}/configured-portal-services
Create a Configured Portal Service object
#
GET
/catalogs/{org}/{catalog}/configured-portal-services
List the Configured Portal Service objects
#
DELETE
/catalogs/{org}/{catalog}/configured-portal-services
Clear the Configured Portal Service objects
#
GET
/catalogs/{org}/{catalog}/configured-portal-services/{configured-portal-service}
Get the Configured Portal Service object by name or id
#
DELETE
/catalogs/{org}/{catalog}/configured-portal-services/{configured-portal-service}
Delete the Configured Portal Service object by name or id
#
POST
/catalogs/{org}/{catalog}/configured-programming-packages
Create a Configured Programming Package object
#
GET
/catalogs/{org}/{catalog}/configured-programming-packages
List all Configured Programming Package objects in all collections
#
DELETE
/catalogs/{org}/{catalog}/configured-programming-packages
Clear all Configured Programming Package objects in all collections
#
GET
/catalogs/{org}/{catalog}/configured-programming-packages/{configured-programming-package-name}
List the Configured Programming Package objects
#
DELETE
/catalogs/{org}/{catalog}/configured-programming-packages/{configured-programming-package-name}
Clear the Configured Programming Package objects
#
GET
/catalogs/{org}/{catalog}/configured-programming-packages/{configured-programming-package-id}
Get the Configured Programming Package object by id
#
DELETE
/catalogs/{org}/{catalog}/configured-programming-packages/{configured-programming-package-id}
Delete the Configured Programming Package object by id
#
GET
/catalogs/{org}/{catalog}/configured-programming-packages/{configured-programming-package-name}/{configured-programming-package-version}
Get the Configured Programming Package object by name and version
#
DELETE
/catalogs/{org}/{catalog}/configured-programming-packages/{configured-programming-package-name}/{configured-programming-package-version}
Delete a Configured Programming Package
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates
Lists catalog notification templates
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/catalog
Lists catalog notification templates
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}
Returns a catalog notification template
#
PATCH
/catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}
Updates a catalog notification template
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}/notification-languages
List the Notification language objects
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}/notification-languages/{notification-language}
Get the Notification template language by name or id
#
PATCH
/catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}/notification-languages/{notification-language}
Update the Notification template language object
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/space
Lists space notification templates
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}
Returns a space notification template
#
PATCH
/catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}
Updates a space notification template
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}/notification-languages
List the Notification language objects
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}/notification-languages/{notification-language}
Get the Notification template language by name or id
#
PATCH
/catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}/notification-languages/{notification-language}
Update the Notification template language object
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/consumer
Lists consumer notification templates
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}
Returns a consumer notification template
#
PATCH
/catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}
Updates a consumer notification template
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}/notification-languages
List the Notification language objects
#
GET
/catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}/notification-languages/{notification-language}
Get the Notification template language by name or id
#
PATCH
/catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}/notification-languages/{notification-language}
Update the Notification template language object
#
GET
/catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}
Returns a consumer organization role default
#
Documentation
📖
Documentation
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
GettingStarted
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
Authentication
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cli-managing-platform-rest-api-keys