serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
mappingIdstring(uuid)required
ID of the catalog service API mapping.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Delete API Mapping for a Service
Deletes a specific API mapping for the given service.
delete
Path Parameters
Response
Response
Catalog service API mapping was deleted successfully.
delete/catalog-services/{serviceId}/api-mappings/{mappingId}
Authentication
Path Parameters
List Service Mappings for an API
Returns a paginated collection of Service mappings for the given API.
get
Query Parameters
page[size]integer
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
page[number]integer
Determines which page of the entities to retrieve.
Example:1
sortstring
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
filterobject
Filters a collection of catalog API service mappings for a given API. Supported filter attributes are:
service_idid
* Additional properties are NOT allowed.
Show Child Parameters
Path Parameters
apiIdstring(uuid)required
ID of the API.
Response
application/json
Response
application/json
A paginated list response for a collection of catalog service API mappings.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarray[object]required
Represents an API mapping associated with a service in the catalog.
Show Child Parameters
get/apis/{apiId}/service-mappings
Authentication
Path Parameters
Query Parameters
application/json
CreateCatalogService
object * Additional properties are NOT allowed.
namestringrequired
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
display_namestringrequired
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
descriptionstring
Optionally provide a description of the Service.
<= 2048 characters
labelsobject
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
custom_fieldsobject
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
Example
CatalogServiceSuggestion
object * Additional properties are NOT allowed.
namestringrequired
The machine name of the Service that uniquely identifies it within the catalog.
Example:user-svc
display_namestringrequired
The display name of the Service.
Example:User Service
descriptionstring
Optionally provide a description of the Service.
labelsobject
Labels to facilitate grouping and tagged search.
Resolved keys must be of length 1-63 characters, and cannot start with ‘‘kong’’, ‘‘konnect’’, ‘‘mesh’’, ‘‘kic’’, or ‘’_‘’.’
Label key and value supports JQ expression syntax on discovered entity’s integration_record property.
Example:{"env":"test"}
metadataobject
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
Example
UpdateCatalogService
object * Additional properties are NOT allowed.
namestring
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
display_namestring
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
descriptionstring
Optionally provide a description of the Service.
<= 2048 characters
labelsobject
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Labels are intended to store INTERNAL metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
custom_fieldsobject
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
Example