Get API Mapping for a Service
Returns information about a specific API mapping for the given service.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the catalog service API mapping.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Response
application/json
Response
A response containing a single catalog service API mapping.
CatalogServiceApiMapping
Represents an API mapping associated with a service in the catalog.
The mapping ID.
The ID of the service.
The ID of the API.
Creation timestamp.
Last update timestamp.
Authentication
Path Parameters
Delete API Mapping for a Service
Deletes a specific API mapping for the given service.
Path Parameters
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ID of the catalog service API mapping.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Response
Response
Catalog service API mapping was deleted successfully.
Authentication
Path Parameters
List Service Mappings for an API
Returns a paginated collection of Service mappings for the given API.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
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
Filters a collection of catalog API service mappings for a given API. Supported filter attributes are:
service_id
Show Child Parameters
Path Parameters
ID of the API.
Response
application/json
Response
A paginated list response for a collection of catalog service API mappings.
returns the pagination information
Show Child Parameters
Represents an API mapping associated with a service in the catalog.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
CreateCatalogService
objectThe machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
Optionally provide a description of the Service.
<= 2048 characters
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"}
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"}}
UpdateCatalogService
objectThe machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
Optionally provide a description of the Service.
<= 2048 characters
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"}
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"}}