---
title: "Konnect Service Catalog"
url: "https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-1/versions/781fdf4f-a935-4ec1-9343-3203c8afd399"
---

# Konnect Service Catalog

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Konnect Service Catalog","version":"1.3.0","description":"The platform API for Konnect Service Catalog.","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v1","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v1","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v1","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v1","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v1","description":"India Production region"},{"url":"https://sg.api.konghq.com/v1","description":"Singapore Production region"}],"paths":{"/catalog-services":{"post":{"operationId":"create-catalog-service","summary":"Create Service","description":"Creates a service.","requestBody":{"$ref":"#/components/requestBodies/CreateCatalogServiceRequest"},"responses":{"201":{"$ref":"#/components/responses/CatalogServiceResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Catalog Services"]},"get":{"operationId":"list-catalog-services","summary":"List Services","description":"Returns a paginated collection of services.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogServiceFilter"},{"$ref":"#/components/parameters/CatalogServiceSort"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogServicesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Catalog Services"]}},"/catalog-services/{id}":{"parameters":[{"name":"id","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"get":{"operationId":"fetch-catalog-service","summary":"Get a Service","description":"Fetches a service.","responses":{"200":{"$ref":"#/components/responses/CatalogServiceResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Services"]},"patch":{"operationId":"update-catalog-service","summary":"Update Service","description":"Updates a service.","requestBody":{"$ref":"#/components/requestBodies/UpdateCatalogServiceRequest"},"responses":{"200":{"$ref":"#/components/responses/CatalogServiceResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Catalog Services"]},"delete":{"operationId":"delete-catalog-service","summary":"Delete Service","description":"Deletes a service.","responses":{"204":{"description":"Service was deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Services"]}},"/integrations":{"get":{"operationId":"list-catalog-integrations","summary":"List Integrations","description":"Returns a paginated collection of all catalog integrations available to connect.\nEach integration represents a built-in connector that extends the platform's capabilities;\nenabling discovery, resource management, event ingestion, and more.\nIntegrations expose metadata that describes how they authenticate, what configuration they\nrequire, and how they interact with catalog entities like Resources and Services.\n\nCurrently, integrations are platform-defined and cannot be extend or registered by customers.\n","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogIntegrationFilter"},{"$ref":"#/components/parameters/CatalogIntegrationSort"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogIntegrationsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Catalog Integrations"]}},"/integration-instances":{"post":{"operationId":"create-integration-instance","summary":"Create Integration Instance","description":"Creates an integration instance.","requestBody":{"$ref":"#/components/requestBodies/CreateIntegrationInstanceRequest"},"responses":{"201":{"$ref":"#/components/responses/IntegrationInstanceResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Integration Instances"]},"get":{"operationId":"list-integration-instances","summary":"List Integration Instances","description":"Returns a paginated collection of integration instances.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/IntegrationInstanceFilter"},{"$ref":"#/components/parameters/IntegrationInstanceSort"}],"responses":{"200":{"$ref":"#/components/responses/ListIntegrationInstancesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Integration Instances"]}},"/integration-instances/{id}":{"parameters":[{"name":"id","in":"path","description":"The `id` of the integration instance.","required":true,"schema":{"type":"string","example":"3f51fa25-310a-421d-bd1a-007f859021a3"}}],"get":{"operationId":"fetch-integration-instance","summary":"Get an Integration Instance","description":"Fetches a integration instance.","responses":{"200":{"$ref":"#/components/responses/IntegrationInstanceResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Integration Instances"]},"patch":{"operationId":"update-integration-instance","summary":"Update Integration Instance","description":"Updates an integration instance.","requestBody":{"$ref":"#/components/requestBodies/UpdateIntegrationInstanceRequest"},"responses":{"200":{"$ref":"#/components/responses/IntegrationInstanceResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Integration Instances"]},"delete":{"operationId":"delete-integration-instance","summary":"Delete Integration Instance","description":"Deletes an integration instance.","responses":{"204":{"description":"Integration Instance was deleted successfully."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Integration Instances"]}},"/integration-instances/{integrationInstanceId}/auth-credential":{"parameters":[{"name":"integrationInstanceId","in":"path","description":"The `id` of the integration instance.","required":true,"schema":{"type":"string","example":"3f51fa25-310a-421d-bd1a-007f859021a3"}}],"post":{"operationId":"create-integration-instance-auth-credential","summary":"Create Integration Instance Auth Credential","description":"Creates an auth credential scoped to the given integration instance.\nAuth credentials are singleton resources that have a 1-to-1 relationship with\nan integration instance.\n\nAn attempt to create subsequent auth credentials for an instance will result in a 409 response.\n","requestBody":{"$ref":"#/components/requestBodies/CreateIntegrationInstanceAuthCredentialRequest"},"responses":{"201":{"$ref":"#/components/responses/IntegrationInstanceAuthCredentialResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Integration Instance Auth Credentials"]},"get":{"operationId":"get-integration-instance-auth-credential","summary":"Get Integration Instance Auth Credential","description":"Fetches the auth credential scoped to the given integration instance.","responses":{"200":{"$ref":"#/components/responses/IntegrationInstanceAuthCredentialResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Integration Instance Auth Credentials"]},"delete":{"operationId":"delete-integration-instance-auth-credential","summary":"Delete Integration Instance Auth Credential","description":"Deletes the auth credential scoped to the given integration instance.","responses":{"204":{"description":"Integration Instance Auth Credential was deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Integration Instance Auth Credentials"]}},"/integration-instances/{integrationInstanceId}/auth-config":{"parameters":[{"name":"integrationInstanceId","in":"path","description":"The `id` of the integration instance.","required":true,"schema":{"type":"string","example":"3f51fa25-310a-421d-bd1a-007f859021a3"}}],"get":{"operationId":"get-integration-instance-auth-config","summary":"Get Integration Instance Auth Config","description":"Fetches auth config scoped to the given integration instance.","responses":{"200":{"$ref":"#/components/responses/IntegrationInstanceAuthConfigResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Integration Instance Auth Config"]},"put":{"operationId":"upsert-integration-instance-auth-config","summary":"Upsert Integration Instance Auth Config","description":"Upserts auth config scoped to the given integration instance.","requestBody":{"$ref":"#/components/requestBodies/UpsertIntegrationInstanceAuthConfigRequest"},"responses":{"200":{"$ref":"#/components/responses/IntegrationInstanceAuthConfigResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Integration Instance Auth Config"]},"delete":{"operationId":"delete-integration-instance-auth-config","summary":"Delete Integration Instance Auth Config","description":"Deletes the auth config scoped to the given integration instance.","responses":{"204":{"description":"Integration Instance Auth Config was deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Integration Instance Auth Config"]}},"/resources":{"get":{"operationId":"list-resources","summary":"List Resources","description":"Returns a paginated collection of resources.","parameters":[{"$ref":"#/components/parameters/CursorPageQuery"},{"$ref":"#/components/parameters/CatalogResourceFilter"},{"$ref":"#/components/parameters/CatalogResourceSort"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogResourcesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Catalog Resources"]}},"/resources/{id}":{"parameters":[{"name":"id","in":"path","description":"The `id` of the resource.","required":true,"schema":{"type":"string","example":"AflTNLY0tTQhv2my"}}],"get":{"operationId":"fetch-resource","summary":"Get a Resource","description":"Fetches a resource by ID.","responses":{"200":{"$ref":"#/components/responses/CatalogResourceResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Resources"]}},"/integration-instances/{integrationInstanceId}/resources/{resourceId}":{"parameters":[{"name":"integrationInstanceId","in":"path","description":"The `id` of the integration instance.","required":true,"schema":{"type":"string","example":"3f51fa25-310a-421d-bd1a-007f859021a3"}},{"name":"resourceId","in":"path","description":"The `id` of the resource.","required":true,"schema":{"type":"string","example":"AflTNLY0tTQhv2my"}}],"patch":{"operationId":"update-resource","summary":"Update Resource","description":"Updates a resource.","requestBody":{"$ref":"#/components/requestBodies/UpdateCatalogResourceRequest"},"responses":{"200":{"$ref":"#/components/responses/CatalogResourceResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Resources"]}},"/resources/{id}/catalog-services":{"parameters":[{"name":"id","in":"path","description":"The `id` of the resource.","required":true,"schema":{"type":"string","example":"AflTNLY0tTQhv2my"}}],"get":{"operationId":"list-catalog-resource-services","summary":"List Resource Services","description":"Returns a paginated collection of services the given resource is mapped to.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogServiceFilter"},{"$ref":"#/components/parameters/CatalogServiceSort"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogServicesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Resource Services"]}},"/resource-mappings":{"post":{"operationId":"create-resource-mapping","summary":"Create Resource Mapping","description":"Creates a mapping between a catalog resource and service.","requestBody":{"$ref":"#/components/requestBodies/CreateCatalogResourceMappingRequest"},"responses":{"201":{"$ref":"#/components/responses/CatalogResourceMappingResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Catalog Resource Mappings"]},"get":{"operationId":"list-resource-mappings","summary":"List Resource Mappings","description":"Returns a paginated collection of catalog resource mappings.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogResourceMappingFilter"},{"$ref":"#/components/parameters/CatalogResourceMappingSort"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogResourceMappingsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Catalog Resource Mappings"]}},"/resource-mappings/{resourceMappingId}":{"parameters":[{"name":"resourceMappingId","in":"path","description":"The `id` of the resource mapping.","required":true,"schema":{"type":"string","format":"uuid","example":"d277faad-ed4e-4c56-a0fb-acce065dee34"}}],"get":{"operationId":"fetch-resource-mapping","summary":"Get a Resource Mapping","description":"Fetches a resource mapping by ID.","responses":{"200":{"$ref":"#/components/responses/CatalogResourceMappingResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Resource Mappings"]},"delete":{"operationId":"delete-resource-mapping","summary":"Delete Resource Mapping","description":"Removes an existing mapping between a catalog resource and service.","responses":{"204":{"description":"Resource Mapping was deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Resource Mappings"]}},"/catalog-services/{id}/resources":{"parameters":[{"name":"id","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"get":{"operationId":"list-catalog-service-resources","summary":"List Service Resources","description":"Returns a paginated collection of resources mapped to a service.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogResourceRefFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogServiceResourcesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service Resources"]}},"/criteria-templates":{"get":{"operationId":"list-criteria-templates","summary":"List Criteria Templates","description":"Returns a paginated collection of criteria templates.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CriteriaTemplateFilter"},{"$ref":"#/components/parameters/CriteriaTemplateSort"}],"responses":{"200":{"$ref":"#/components/responses/ListCriteriaTemplatesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Criteria Templates"]}},"/scorecard-templates":{"get":{"operationId":"list-scorecard-templates","summary":"List Scorecard Templates","description":"Returns a paginated collection of scorecard templates.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ScorecardTemplateFilter"},{"$ref":"#/components/parameters/ScorecardTemplateSort"}],"responses":{"200":{"$ref":"#/components/responses/ListScorecardTemplatesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Scorecards"]}},"/scorecards":{"post":{"operationId":"create-scorecard","summary":"Create Scorecard","description":"Creates a scorecard.","requestBody":{"$ref":"#/components/requestBodies/CreateScorecardRequest"},"responses":{"201":{"$ref":"#/components/responses/ScorecardResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Scorecards"]},"get":{"operationId":"list-scorecards","summary":"List Scorecards","description":"Returns a paginated collection of scorecards.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ScorecardFilter"},{"$ref":"#/components/parameters/ScorecardSort"}],"responses":{"200":{"$ref":"#/components/responses/ListScorecardsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Scorecards"]}},"/scorecards/{id}":{"parameters":[{"name":"id","in":"path","description":"The `id` of the scorecard.","required":true,"schema":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"}}],"get":{"operationId":"fetch-scorecard","summary":"Get a Scorecard","description":"Fetches a scorecard.","responses":{"200":{"$ref":"#/components/responses/ScorecardResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Scorecards"]},"put":{"operationId":"update-scorecard","summary":"Update Scorecard","description":"Updates a scorecard.","requestBody":{"$ref":"#/components/requestBodies/UpdateScorecardRequest"},"responses":{"200":{"$ref":"#/components/responses/ScorecardResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Scorecards"]},"delete":{"operationId":"delete-scorecard","summary":"Delete Scorecard","description":"Deletes a scorecard.","responses":{"204":{"description":"Scorecard was deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Scorecards"]}},"/scorecards/{id}/catalog-services":{"parameters":[{"name":"id","in":"path","description":"The `id` of the scorecard.","required":true,"schema":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"}}],"get":{"operationId":"list-scorecard-services","summary":"List Scorecard Services","description":"Lists services targeted by a scorecard.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ScorecardServiceFilter"},{"$ref":"#/components/parameters/ScorecardServiceSort"}],"responses":{"200":{"$ref":"#/components/responses/ListScorecardServicesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Scorecards"]}},"/scorecards/{id}/criteria":{"parameters":[{"name":"id","in":"path","description":"The `id` of the scorecard.","required":true,"schema":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"}}],"get":{"operationId":"list-scorecard-criteria","summary":"List Scorecard Criteria","description":"Lists criteria, including passing service counts, belonging to a scorecard.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ScorecardCriteriaFilter"},{"$ref":"#/components/parameters/ScorecardCriteriaSort"}],"responses":{"200":{"$ref":"#/components/responses/ListScorecardCriteriaResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Scorecards"]}},"/scorecards/{scorecardId}/criteria/{criteriaId}/catalog-services":{"parameters":[{"name":"scorecardId","in":"path","description":"The `id` of the scorecard.","required":true,"schema":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"}},{"name":"criteriaId","in":"path","description":"The `id` of the criteria.","required":true,"schema":{"type":"string","format":"uuid","example":"5c1121f9-3f3a-47c7-9bb6-c81a51128714"}}],"get":{"operationId":"list-scorecard-criteria-services","summary":"List Scorecard Criteria Services","description":"Lists services targeted by a scorecard criteria with evaluation results per-service.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ScorecardCriteriaServiceFilter"},{"$ref":"#/components/parameters/ScorecardCriteriaServiceSort"}],"responses":{"200":{"$ref":"#/components/responses/ListScorecardCriteriaServicesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Scorecards"]}},"/catalog-services/{id}/scorecards":{"parameters":[{"name":"id","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"get":{"operationId":"list-catalog-service-scorecards","summary":"List Catalog Service Scorecards","description":"Returns a paginated collection of scorecards targeting the given service.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ScorecardFilter"},{"$ref":"#/components/parameters/ScorecardSort"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogServiceScorecardsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Scorecards"]}},"/catalog-services/{serviceId}/scorecards/{scorecardId}":{"parameters":[{"name":"serviceId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}},{"name":"scorecardId","in":"path","description":"The `id` of the scorecard.","required":true,"schema":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"}}],"get":{"operationId":"fetch-catalog-service-scorecard","summary":"Get a Catalog Service Scorecard","description":"Fetches the given scorecard targeting the service.","responses":{"200":{"$ref":"#/components/responses/CatalogServiceScorecardResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Scorecards"]}},"/catalog-services/{serviceId}/api-mappings":{"parameters":[{"name":"serviceId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"get":{"operationId":"list-catalog-service-api-mappings","summary":"List API Mappings for a Service","description":"Returns a paginated collection of API mappings for the given service.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogServiceApiMappingSort"},{"$ref":"#/components/parameters/CatalogServiceApiMappingFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogServiceApiMappingsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Mappings"]},"post":{"operationId":"create-catalog-service-api-mapping","summary":"Create API Mapping for a Service","description":"Creates a new API mapping for the given service.","requestBody":{"$ref":"#/components/requestBodies/CreateCatalogServiceApiMappingBody"},"responses":{"201":{"$ref":"#/components/responses/CatalogServiceApiMappingResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Catalog Service API Mappings"]}},"/catalog-services/{serviceId}/api-mappings/{mappingId}":{"parameters":[{"name":"serviceId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}},{"name":"mappingId","in":"path","description":"ID of the catalog service API mapping.","required":true,"schema":{"type":"string","format":"uuid","example":"d277faad-ed4e-4c56-a0fb-acce065dee34"}}],"get":{"operationId":"get-catalog-service-api-mapping","summary":"Get API Mapping for a Service","description":"Returns information about a specific API mapping for the given service.","responses":{"200":{"$ref":"#/components/responses/CatalogServiceApiMappingResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Mappings"]},"delete":{"operationId":"delete-catalog-service-api-mapping","summary":"Delete API Mapping for a Service","description":"Deletes a specific API mapping for the given service.","responses":{"204":{"description":"Catalog service API mapping was deleted successfully."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Mappings"]}},"/apis/{apiId}/service-mappings":{"parameters":[{"name":"apiId","in":"path","description":"ID of the API.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"list-service-mappings-for-api","summary":"List Service Mappings for an API","description":"Returns a paginated collection of Service mappings for the given API.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogServiceApiMappingSort"},{"$ref":"#/components/parameters/CatalogApiServiceMappingFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogServiceApiMappingsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Mappings"]}}},"components":{"parameters":{"CatalogApiServiceMappingFilter":{"name":"filter","in":"query","required":false,"style":"deepObject","description":"Filters a collection of catalog API service mappings for a given API. Supported filter attributes are:\n  - `service_id`\n","schema":{"$ref":"#/components/schemas/CatalogApiServiceMappingFilterParameters"}},"CatalogIntegrationFilter":{"name":"filter","description":"Filters a collection of integrations.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CatalogIntegrationFilterParameters"}},"CatalogIntegrationSort":{"name":"sort","description":"Sorts a collection of integrations. Supported sort attributes are:\n  - `display_name`\n  - `name`\n\nDefault sort is `display_name` in ascending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"CatalogResourceFilter":{"name":"filter","description":"Filters a collection of resources.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CatalogResourceFilterParameters"}},"CatalogResourceMappingFilter":{"name":"filter","description":"Filters a collection of resource mappings.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CatalogResourceMappingFilterParameters"}},"CatalogResourceMappingSort":{"name":"sort","description":"Sorts a collection of resource mappings. Supported sort attributes are:\n  - `created_at`\n\nDefault sort is `created_at` in descending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"CatalogResourceRefFilter":{"name":"filter","description":"Filters a collection of resources.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CatalogResourceRefFilterParameters"}},"CatalogResourceSort":{"name":"sort","description":"Sorts a collection of resources. Supported sort attributes are:\n  - `created_at`\n  - `updated_at`\n\nDefault sort is `created_at` in descending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"CatalogServiceApiMappingFilter":{"name":"filter","in":"query","required":false,"style":"deepObject","description":"Filters a collection of catalog service API mappings for a given Service. Supported filter attributes are:\n  - `api_id`\n","schema":{"$ref":"#/components/schemas/CatalogServiceApiMappingFilterParameters"}},"CatalogServiceApiMappingSort":{"name":"sort","in":"query","required":false,"description":"Sorts a collection of catalog service API mappings. Supported sort attributes are:\n  - `created_at`\n  - `updated_at`\n\nDefault sort is `created_at` in descending order.\n","schema":{"$ref":"#/components/schemas/SortQuery"}},"CatalogServiceFilter":{"name":"filter","description":"Filters a collection of services.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CatalogServiceFilterParameters"}},"CatalogServiceSort":{"name":"sort","description":"Sorts a collection of services. Supported sort attributes are:\n  - `display_name`\n  - `name`\n  - `created_at`\n  - `updated_at`\n\nDefault sort is `display_name` in ascending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"CriteriaTemplateFilter":{"name":"filter","description":"Filters a collection of criteria templates.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CriteriaTemplateFilterParameters"}},"CriteriaTemplateSort":{"name":"sort","description":"Sorts a collection of criteria templates. Supported sort attributes are:\n  - `display_name`\n  - `name`\n\nDefault sort is `display_name` in ascending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"CursorPageQuery":{"name":"page","description":"Determines which page of the collection to retrieve.","required":false,"in":"query","schema":{"$ref":"#/components/schemas/CursorPageParameters"}},"IntegrationInstanceFilter":{"name":"filter","description":"Filters a collection of integration instances.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/IntegrationInstanceFilterParameters"}},"IntegrationInstanceSort":{"name":"sort","description":"Sorts a collection of integration instances. Supported sort attributes are:\n  - `display_name`\n  - `name`\n  - `created_at`\n  - `updated_at`\n  - `integration.display_name`\n\nDefault sort is `integration.display_name` in ascending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"ScorecardCriteriaFilter":{"name":"filter","description":"Filters a collection of criteria belonging to a scorecard.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/ScorecardCriteriaFilterParameters"}},"ScorecardCriteriaServiceFilter":{"name":"filter","description":"Filters a collection of services targeted by a scorecard criteria.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/ScorecardCriteriaServiceFilterParameters"}},"ScorecardCriteriaServiceSort":{"name":"sort","description":"Sorts a collection of services targeted by a scorecard criteria. Supported sort attributes are:\n  - `display_name`\n  - `name`\n  - `evaluation.is_passing`\n  - `evaluation.successfully_evaluated_at`\n  - `evaluation.attempted_at`\n\nDefault sort is `display_name` in ascending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ScorecardCriteriaSort":{"name":"sort","description":"Sorts a collection of criteria belonging to a scorecard. Supported sort attributes are:\n  - `evaluation.passing_services_count`\n\nBy default, criteria will be returned in the order that they are configured in the scorecard.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ScorecardFilter":{"name":"filter","description":"Filters a collection of scorecards.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/ScorecardFilterParameters"}},"ScorecardServiceFilter":{"name":"filter","description":"Filters a collection of services targeted by a scorecard.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/ScorecardServiceFilterParameters"}},"ScorecardServiceSort":{"name":"sort","description":"Sorts a collection of services targeted by a scorecard. Supported sort attributes are:\n  - `display_name`\n  - `name`\n  - `score.value`\n  - `score.raw_value`\n\nDefault sort is `display_name` in ascending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ScorecardSort":{"name":"sort","description":"Sorts a collection of scorecards. Supported sort attributes are:\n  - `name`\n  - `score.value`\n  - `score.raw_value`\n\nDefault sort is `name` in ascending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"ScorecardTemplateFilter":{"name":"filter","description":"Filters a collection of scorecard templates.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/ScorecardTemplateFilterParameters"}},"ScorecardTemplateSort":{"name":"sort","description":"Sorts a collection of scorecard templates. Supported sort attributes are:\n  - `display_name`\n  - `name`\n\nDefault sort is `display_name` in ascending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}}},"schemas":{"CreateCatalogService":{"type":"object","properties":{"name":{"description":"The machine name of the Service that uniquely identifies it within the catalog.\n","type":"string","example":"user-svc","maxLength":120,"minLength":1,"pattern":"^[0-9a-z.-]+$"},"display_name":{"description":"The display name of the Service.","type":"string","example":"User Service","maxLength":120,"minLength":1},"description":{"description":"Optionally provide a description of the Service.","type":"string","maxLength":2048,"nullable":true},"labels":{"$ref":"#/components/schemas/Labels"},"custom_fields":{"$ref":"#/components/schemas/CustomFields"}},"additionalProperties":false,"required":["name","display_name"]},"UpdateCatalogService":{"type":"object","properties":{"name":{"description":"The machine name of the Service that uniquely identifies it within the catalog.\n","type":"string","example":"user-svc","maxLength":120,"minLength":1,"pattern":"^[0-9a-z.-]+$"},"display_name":{"description":"The display name of the Service.","type":"string","example":"User Service","maxLength":120,"minLength":1},"description":{"description":"Optionally provide a description of the Service.","type":"string","maxLength":2048,"nullable":true},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"custom_fields":{"$ref":"#/components/schemas/CustomFields"}},"additionalProperties":false},"CatalogServiceFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"},"custom_fields":{"description":"Filter by custom fields using dot-notation to specify the custom field.\nFilter operators are dictated by the custom field type. For example:\n  - `filter[custom_fields.owner]`\n  - `filter[custom_fields.owner][neq]=kong`\n  - `filter[custom_fields.dashboard.link][contains]=https`\n","oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"},{"$ref":"#/components/schemas/BooleanFieldFilter"},{"$ref":"#/components/schemas/NumericFieldFilter"}]},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}}},"CatalogService":{"description":"The service object contains information about a Service Catalog service.","type":"object","properties":{"id":{"description":"The service ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"description":"The machine name of the Service that uniquely identifies it within the catalog.\n","type":"string","example":"user-svc","maxLength":120,"minLength":1,"pattern":"^[0-9a-z.-]+$"},"display_name":{"description":"The display name of the Service.","type":"string","example":"User Service","maxLength":120,"minLength":1},"description":{"description":"Optionally provide a description of the Service.","type":"string","maxLength":2048,"nullable":true},"custom_fields":{"$ref":"#/components/schemas/CustomFields"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","display_name","description","custom_fields","labels","created_at","updated_at"],"title":"CatalogService"},"CatalogIntegrationFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"}}},"CatalogIntegration":{"type":"object","properties":{"name":{"description":"The machine name of the integration that uniquely identifies it within the catalog.","type":"string","example":"gateway-manager","readOnly":true},"display_name":{"description":"The display name of the integration.","type":"string","example":"Gateway Manager"},"description":{"description":"The description of the integration.","type":"string"},"built_in":{"description":"Denotes whether the integration is built-in to the catalog.\nBuilt-in integrations are always connected and available by default.\n","type":"boolean","example":true,"readOnly":true},"version":{"description":"The integration version.","type":"string","example":"v1","readOnly":true},"visibility":{"description":"The visibility of the integration.","type":"string","example":"public","enum":["public","private"]},"authorization":{"$ref":"#/components/schemas/CatalogIntegrationAuthorization"},"config_schema":{"$ref":"#/components/schemas/CatalogIntegrationConfigSchema"},"resource_types":{"$ref":"#/components/schemas/CatalogIntegrationResourceTypes"},"discovery":{"$ref":"#/components/schemas/CatalogIntegrationDiscovery"},"api_spec_provider":{"$ref":"#/components/schemas/CatalogIntegrationApiSpecProvider"},"events":{"$ref":"#/components/schemas/CatalogIntegrationEvents"}},"required":["built_in","name","display_name","version","authorization","config_schema","resource_types","discovery","api_spec_provider","events","visibility"]},"CatalogIntegrationAuthorization":{"description":"Defines the authorization strategy for an integration.","anyOf":[{"type":"object","nullable":true},{"$ref":"#/components/schemas/OAuth"},{"$ref":"#/components/schemas/MultiKeyAuth"},{"$ref":"#/components/schemas/GitHubAppInstallationAuth"}],"title":"CatalogIntegrationAuthorization","x-convert-oneOf":true},"OAuth":{"description":"Defines the OAuth 2.0 authorization strategy used by an integration.\nThis schema provides all necessary information for the platform to initiate\nand manage OAuth-based authorization flows on behalf of customers.\n","type":"object","properties":{"type":{"type":"string","enum":["oauth"],"x-terraform-transform-const":true},"overridable_config":{"description":"A list of field names from the `config` object (e.g., `client_id`, `authorization_endpoint`, etc)\nthat can be overridden on a per-customer basis. When a field is listed here, the catalog allows\ncustomer-defined values to take precedence over the default configuration provided by the integration.\nThis supports flexible deployment models, including both SaaS-based and self-hosted OAuth authorization flows.\n","type":"array","items":{"type":"string","enum":["client_id","client_secret","authorization_endpoint","token_endpoint"]}},"config":{"type":"object","properties":{"grant_type":{"description":"The OAuth 2.0 grant type used for authorization (e.g., `authorization_code`).\nDetermines the flow the integration uses to request access tokens.\n","type":"string","enum":["authorization_code"]},"client_id":{"description":"The OAuth client identifier registered with the integration provider.","type":"string","example":"d745213a-b7e8-4998-abe3-41f164001970"},"authorization_endpoint":{"type":"object","properties":{"url":{"description":"The URL where users are redirected to authorize access.","type":"string","format":"uri","example":"https://identity.service.com/oauth/authorize"}},"required":["url"]},"token_endpoint":{"type":"object","properties":{"url":{"description":"The URL used to retrieve access tokens.","type":"string","format":"uri","example":"https://identity.service.com/oauth/token"}},"required":["url"]},"scope":{"description":"A list of permission scopes requested by the integration.\nDefines what level of access the token will grant.\n","type":"array","items":{"type":"string"},"example":["read","write"]},"scope_delimiter":{"description":"A string used to separate multiple scopes in the `scope` parameter.\n","type":"string","default":" "},"rolling_refresh_exp_seconds":{"description":"Number of seconds before the refresh token grant can no longer be used to mint\na new access token. Once expired clients must re-authenticate to restart the\nwindow interval.\n","type":"number","example":15780000,"nullable":true}},"required":["grant_type","client_id","authorization_endpoint","token_endpoint","scope","rolling_refresh_exp_seconds"]}},"required":["type","config"]},"MultiKeyAuth":{"description":"Defines an authentication strategy based on one or more API keys passed via HTTP headers.\nThis strategy supports integrations that require custom headers for credential-based access,\nallowing flexibility across providers with different authentication header requirements.\n","type":"object","properties":{"type":{"type":"string","enum":["multi_key_auth"],"x-terraform-transform-const":true},"config":{"type":"object","properties":{"headers":{"description":"A list of header definitions used to transmit API credentials to the integration's external API.\nEach header represents a unique key required by the provider.\n","type":"array","items":{"type":"object","title":"KeyAuthHeader","required":["name","display_name","description"],"properties":{"name":{"description":"The exact name of the HTTP request header where the credential should be inserted.","type":"string","example":"X-API-Key"},"display_name":{"description":"An optional user-friendly label for the key, used in UI forms to guide users.","type":"string","example":"API Key","nullable":true},"description":{"description":"An optional brief explanation of the purpose or usage of the key.","type":"string","nullable":true}}},"minItems":1}},"required":["headers"]}},"required":["type","config"]},"GitHubAppInstallationAuth":{"description":"Defines the GitHub App authorization strategy used by the GitHub integration.\nThis strategy enables secure access to GitHub APIs using app installation tokens.\nIt supports both API-based interactions and real-time event delivery via GitHub webhooks.\nUnlike standard OAuth flows, this strategy leverages GitHub's custom app installation flow\nand token lifecycle, making it ideal for deep, organization-level GitHub integration.\n","type":"object","properties":{"type":{"type":"string","enum":["github_app_installation"],"x-terraform-transform-const":true},"config":{"type":"object","properties":{"app_install_url":{"type":"object","additionalProperties":false,"properties":{"url":{"description":"The URL where customers are directed to install the GitHub App into their\nGitHub organization.\n","type":"string","format":"uri","example":"https://global.api.konghq.com/service-catalog-integrations/github/app/install"}},"required":["url"]},"app_manage_url":{"type":"object","additionalProperties":false,"properties":{"url":{"description":"The GitHub App management page URL where users can view, configure, or uninstall the app after installation.","type":"string","format":"uri","example":"https://global.api.konghq.com/service-catalog-integrations/github/app/manage"}},"required":["url"]},"authorize_app_installation_endpoint":{"type":"object","additionalProperties":false,"properties":{"url":{"description":"The endpoint used to link a completed GitHub App installation with a customer account in the catalog.\nThis step finalizes the integration by exchanging metadata from the GitHub installation event.\n","type":"string","format":"uri","example":"https://global.api.konghq.com/service-catalog-integrations/github/app/authorize-installation"}},"required":["url"]},"pending_app_installs_endpoint":{"type":"object","additionalProperties":false,"properties":{"url":{"description":"The endpoint used to return a list of in-progress or unlinked GitHub App installations awaiting user confirmation.\n","type":"string","format":"uri","example":"https://global.api.konghq.com/service-catalog-integrations/github/app/pending-installs"}},"required":["url"]}},"required":["app_install_url","app_manage_url","authorize_app_installation_endpoint","pending_app_installs_endpoint"]}},"required":["type","config"]},"CatalogIntegrationConfigSchema":{"description":"Defines the configuration schema for the integration.","example":{"base_url":{"type":"string","display_name":"Base URL","description":"The customer-specific API URL","required":true}},"additionalProperties":{"x-convert-oneOf":true,"anyOf":[{"type":"object","nullable":true},{"$ref":"#/components/schemas/StringConfigFieldSchema"},{"$ref":"#/components/schemas/EnumConfigFieldSchema"},{"$ref":"#/components/schemas/BooleanConfigFieldSchema"}]}},"StringConfigFieldSchema":{"description":"Defines a string value integration config field.","type":"object","properties":{"display_name":{"description":"user-friendly name of the configuration field.","type":"string"},"description":{"description":"Optional brief description of the configuration field.","type":"string"},"required":{"description":"Denotes whether the config field is a required value.","type":"boolean","default":false},"mutable_condition":{"$ref":"#/components/schemas/MutableCondition"},"type":{"description":"The field type of the config value.","type":"string","enum":["string"]},"default":{"description":"The default value for the config field.","type":"string"}},"required":["type"],"title":"StringConfigFieldSchema"},"EnumConfigFieldSchema":{"description":"Defines an enum value integration config field.","type":"object","properties":{"display_name":{"description":"user-friendly name of the configuration field.","type":"string"},"description":{"description":"Optional brief description of the configuration field.","type":"string"},"required":{"description":"Denotes whether the config field is a required value.","type":"boolean","default":false},"mutable_condition":{"$ref":"#/components/schemas/MutableCondition"},"type":{"description":"The field type of config value.","type":"string","enum":["enum"]},"choices":{"description":"List of enumerated choices that can be selected as the config field value.","type":"array","items":{"type":"object","required":["value","display_name"],"properties":{"value":{"description":"The value represented by this option.","type":"string"},"display_name":{"description":"user-friendly name of the option.","type":"string"},"description":{"description":"Optional brief description of the option.","type":"string"}}}},"default":{"description":"The default value for the config field.\nMust reference the value of an option listed in `choices`.\n","type":"string"}},"required":["type","choices"],"title":"EnumConfigFieldSchema"},"BooleanConfigFieldSchema":{"description":"Defines a boolean value integration config field.","type":"object","properties":{"display_name":{"description":"user-friendly name of the configuration field.","type":"string"},"description":{"description":"Optional brief description of the configuration field.","type":"string"},"required":{"description":"Denotes whether the config field is a required value.","type":"boolean","default":false},"mutable_condition":{"$ref":"#/components/schemas/MutableCondition"},"type":{"description":"The field type of the config value.","type":"string","enum":["boolean"]},"default":{"description":"The default value for the config field.","type":"boolean"}},"required":["type"],"title":"BooleanConfigFieldSchema"},"MutableCondition":{"description":"Defines the condition under which this configuration field is allowed to be modified.\nWhen specified, the platform will restrict updates to this field unless the integration\nmeets the given condition.\n\nFor example, setting `mutable_condition: unauthorized` means the field can only be\nchanged while the integration is in an unauthorized state.\n","type":"string","enum":["unauthorized"]},"CatalogIntegrationResourceTypes":{"description":"Defines the resource types that the integration manages within the catalog.\n\nThis schema is a key-value object where:\n  - Keys are globally unique, machine-readable identifiers for each resource type.\n  - Values are objects describing metadata about the resource type.\n\nThis declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration.\nBy registering resource types, integrations communicate the kinds of entities they will ingest and maintain,\nallowing the catalog to enforce consistency, validation, and visibility across all integrations.\n","type":"object","example":{"gateway_svc":{"display_name":"Gateway Service","schema":{"type":"simple","definition":{"control_plane_id":"string","gatway_service_id":"string"}}},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}}}},"additionalProperties":{"type":"object","title":"ResourceType","required":["schema"],"properties":{"display_name":{"description":"The user-friendly resource type name.","type":"string"},"schema":{"$ref":"#/components/schemas/SimpleSchema"}}}},"CatalogIntegrationDiscovery":{"description":"Defines how the integration participates in Discovery.\nDiscovery enables integrations to automatically ingest and update resources in the catalog.\n","type":"object","properties":{"resource_integration_data_examples":{"description":"A map of example resource `integration_data` payloads by resource type.\n\n  - Keys are the machine-readable, globally unique names of resource types registered by this integration.\n  - Values are example `integration_data` payloads.\n","type":"object","example":{"gateway_service":{"control_plane":{"id":"00000000-0000-0000-0000-000000000000","name":"dev-ext","labels":{"env":"development"}},"gateway_service":{"id":"11111111-1111-1111-1111-111111111111","name":"gateway-service","host":"konghq.com","path":"/example","type":"service","port":443,"protocol":"https","enabled":true}}},"additionalProperties":{"type":"object","additionalProperties":true,"description":"An example `integration_data` payload for the given resource type."}}},"nullable":true,"required":["resource_integration_data_examples"]},"CatalogIntegrationApiSpecProvider":{"description":"Defines how an integration behaves as a source provider of Catalog Service API specs.\nAPI specs are entities that can be attached to Catalog Services.\nWhen an integration implements this capability, it can act as a source type for API spec contents.\nIn this role, the integration becomes the source of truth for the spec.\nWhen a spec is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the spec data.\nA null value indicates the given integration does not act as a source provider of API specs.\n","type":"object","properties":{"name":{"description":"The globally unique name of the API spec provider that identifies it within the catalog.\nCorresponds to the API spec provider `type` when creating API specs.\n","type":"string","example":"konnect_api"},"display_name":{"description":"A user-friendly name for the API spec provider.","type":"string","example":"Konnect API"},"description":{"description":"An brief description of the API spec provider.","type":"string"},"config_schema":{"description":"Defines the shape of the API spec provider config.","type":"object","example":{"type":"simple","definition":{"api_id":"string"}},"properties":{"type":{"type":"string","enum":["simple"]},"definition":{"type":"object","additionalProperties":{"type":"string","enum":["string","number","boolean"]}}},"required":["type","definition"]},"resource_type":{"description":"When non-null, denotes that the API spec provider is bound to the given Resource type.\nThis means that API specs are auto-created when a Resource of the given type is mapped to a service.\nFurthermore, it couples the lifecycle of the API Spec with the given Resource mapping.\nWhen the given Resource is removed, the API spec will be deleted.\n","type":"string","nullable":true}},"nullable":true,"required":["name","display_name","description","config_schema","resource_type"]},"CatalogIntegrationEvents":{"description":"Defines the event types across all resource types belonging to the integration that will be ingested into the catalog.\n\n  - Keys are the machine-readable, globally unique names of resource types registered by this integration.\n  - Values are a map of event type definitions.\n","type":"object","example":{"gateway_svc":{"plugin_added":{"display_name":"Plugin Added","description":"Event triggered when a new plugin is added to a gateway service.","events_feed":{"enabled":true}}}},"additionalProperties":{"$ref":"#/components/schemas/IntegrationResourceEvents"},"nullable":true},"IntegrationResourceEvents":{"description":"Defines the event types for a given resource type belonging to the integration that will be ingested in the catalog.\n\n  - Keys are the machine-readable, globally unique names of resource types registered by this integration.\n  - Values are the event type definition.\n","type":"object","additionalProperties":{"$ref":"#/components/schemas/IntegrationResourceEvent"}},"IntegrationResourceEvent":{"description":"Defines a registered event type for a given resource.","type":"object","properties":{"display_name":{"description":"User-friendly display name for the event type.","type":"string"},"description":{"description":"Optional, brief description of the integration event type.","type":"string","nullable":true},"events_feed":{"type":"object","properties":{"enabled":{"description":"Whether this event type is returned by default in the Events API.","type":"boolean"}},"required":["enabled"]}},"required":["display_name","description","events_feed"]},"CreateIntegrationInstance":{"type":"object","properties":{"integration_name":{"description":"The type of integration instance to create.","type":"string","example":"aws-lambda","maxLength":120,"minLength":1,"pattern":"^[0-9a-z.-]+$"},"name":{"description":"The machine name of the integration instance that uniquely identifies it within the catalog.\n","type":"string","example":"aws-lambda-prod","maxLength":120,"minLength":1,"pattern":"^[0-9a-z.-]+$"},"display_name":{"description":"The display name of the integration instance.","type":"string","example":"AWS (prod)","maxLength":120,"minLength":1},"description":{"description":"Optionally provide a description of the integration instance.","type":"string","maxLength":2048,"nullable":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"$ref":"#/components/schemas/IntegrationInstanceConfig"}},"additionalProperties":false,"required":["integration_name","name","display_name","config"]},"UpdateIntegrationInstance":{"type":"object","properties":{"name":{"description":"The machine name of the integration instance that uniquely identifies it within the catalog.\n","type":"string","example":"aws-lambda-prod","maxLength":120,"minLength":1,"pattern":"^[0-9a-z.-]+$"},"display_name":{"description":"The display name of the integration instance.","type":"string","example":"AWS (prod)","maxLength":120,"minLength":1},"description":{"description":"Optionally provide a description of the integration instance.","type":"string","maxLength":2048,"nullable":true},"labels":{"$ref":"#/components/schemas/LabelsUpdate"},"config":{"$ref":"#/components/schemas/IntegrationInstanceConfig"}},"additionalProperties":false},"IntegrationInstanceFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"},"integration.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"authorized":{"$ref":"#/components/schemas/BooleanFieldFilter"},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}}},"IntegrationInstance":{"description":"Information about an integration instance.","type":"object","properties":{"id":{"description":"The integration instance ID.","type":"string","format":"uuid","example":"3f51fa25-310a-421d-bd1a-007f859021a3","readOnly":true},"name":{"description":"The machine name of the integration instance that uniquely identifies it within the catalog.\n","type":"string","example":"aws-lambda-prod","maxLength":120,"minLength":1,"pattern":"^[0-9a-z.-]+$"},"display_name":{"description":"The display name of the integration instance.","type":"string","example":"AWS (prod)","maxLength":120,"minLength":1},"description":{"description":"The description of the integration instance.","type":"string","maxLength":2048,"nullable":true},"integration":{"$ref":"#/components/schemas/IntegrationRefWithoutInstance"},"authorized":{"description":"Denotes whether the integration instance has been authorized within the catalog.","type":"boolean","example":true,"readOnly":true},"labels":{"$ref":"#/components/schemas/Labels"},"config":{"$ref":"#/components/schemas/IntegrationInstanceConfig"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","display_name","description","integration","authorized","config","created_at","updated_at"]},"IntegrationInstanceConfig":{"description":"JSON object representing configuration specific to the integration instance.\nThe expected schema depends on the integration type and is dynamically registered at runtime.\n","type":"object","example":{"account_region":"eu"},"default":{},"additionalProperties":true},"CreateIntegrationInstanceAuthCredential":{"oneOf":[{"$ref":"#/components/schemas/CreateOAuthCredential"},{"$ref":"#/components/schemas/CreateGitHubAppInstallationCredential"},{"$ref":"#/components/schemas/CreateMultiKeyAuthCredential"},{"$ref":"#/components/schemas/CreateAWSRoleDelegationAuthCredential"}],"title":"CreateIntegrationInstanceAuthCredential"},"IntegrationInstanceAuthCredential":{"description":"Object containing metadata for an integration instance auth credential.","oneOf":[{"$ref":"#/components/schemas/OAuthCredential"},{"$ref":"#/components/schemas/GitHubAppInstallationCredential"},{"$ref":"#/components/schemas/MultiKeyAuthCredential"},{"$ref":"#/components/schemas/AWSRoleDelegationAuthCredential"}],"title":"IntegrationInstanceAuthCredential"},"CreateOAuthCredential":{"description":"Payload used to create an `OAuth` credential for an integration instance.","type":"object","properties":{"type":{"type":"string","enum":["oauth"],"x-terraform-transform-const":true},"config":{"type":"object","additionalProperties":false,"properties":{"grant_type":{"description":"The OAuth 2.0 grant type used for authorization (e.g., `authorization_code`).","type":"string","enum":["authorization_code"]},"code":{"description":"The authorization code used to exchange for an access token with the identity server.","type":"string","example":"Yzk5ZDczMzRlNDEwY"},"redirect_uri":{"description":"The redirect URI submitted to the authorization server during the authentication request\nto retrieve the authorization code.\n","type":"string","format":"uri","example":"https://cloud.konghq.com/us/service-catalog/integrations/pagerduty/oauth"}},"required":["grant_type","code","redirect_uri"],"title":"CreateOAuthCredentialConfig"}},"additionalProperties":false,"required":["type","config"]},"CreateGitHubAppInstallationCredential":{"description":"Payload used to create an `GitHub App Installation` credential for an integration instance.","type":"object","properties":{"type":{"type":"string","enum":["github_app_installation"],"x-terraform-transform-const":true},"config":{"type":"object","additionalProperties":false,"properties":{"installation_id":{"description":"The GitHub App installation ID.","type":"string","example":"46952218"},"code":{"description":"The authorization code used to exchange for a GitHub user-scoped access token.","type":"string","example":"Yzk5ZDczMzRlNDEwY"},"app_installed_by":{"description":"The GitHub user who installed the app","type":"string"}},"required":["installation_id","code"],"title":"CreateGitHubAppInstallationCredentialConfig"}},"additionalProperties":false,"required":["type","config"]},"CreateMultiKeyAuthCredential":{"description":"Payload used to create an `Multi Key` credential for an integration instance.","type":"object","properties":{"type":{"type":"string","enum":["multi_key_auth"],"x-terraform-transform-const":true},"config":{"type":"object","additionalProperties":false,"properties":{"headers":{"description":"A list of header key/value pairs used to transmit API credentials to the integration's external API.\nHeader names are defined by the integration within its `Multi Key` authorization strategy definition.\n","type":"array","items":{"type":"object","required":["name","key"],"properties":{"name":{"description":"Name of the request header","type":"string"},"key":{"description":"The key used to populate the request header","type":"string"}}},"example":[{"name":"x-api-key","key":"9f2a3b4c8d6e7f00112233445566778899aabbccddeeff001122334455667788"}]}},"required":["headers"],"title":"CreateMultiKeyAuthCredentialConfig"}},"additionalProperties":false,"required":["type","config"],"writeOnly":true},"CreateAWSRoleDelegationAuthCredential":{"description":"Payload used to create an `AWS Role Delegation` credential for an integration instance.","type":"object","properties":{"type":{"type":"string","enum":["aws_role_delegation"]},"config":{"type":"object","additionalProperties":false,"properties":{"role_arn":{"description":"The AWS Role ARN string\n","type":"string","example":"arn:aws:iam::084735895545:role/KonnectServiceCatalogRole"}},"required":["role_arn"],"title":"CreateAWSRoleDelegationAuthCredentialConfig"}},"additionalProperties":false,"required":["type","config"]},"OAuthCredential":{"description":"Represents a credential scoped to an integration instance that supports the `OAuth` authorization strategy.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"4f535923-ec24-456c-b4e5-e67f65c8c208"},"integration_instance":{"$ref":"#/components/schemas/IntegrationInstanceRef"},"missing_permissions":{"description":"List of detected missing permissions required to enable the full functionality of the given integration instance.","type":"array","items":{"$ref":"#/components/schemas/MissingPermission"}},"tainted":{"description":"Indicates that the credential is no longer valid and must be replaced with a new valid credential.","type":"boolean","example":false},"expires_at":{"description":"Timestamp denoting when the when the credential will expire in RFC-3339 format with a \"T\" character separating date from time within the field value.\nWhen expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.\n\nA `null` value indicates no known expiration time.\n","type":"string","format":"date-time","example":"2025-04-01T07:20:50Z","nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"type":{"type":"string","enum":["oauth"],"x-terraform-transform-const":true}},"required":["id","integration_instance","missing_permissions","tainted","expires_at","created_at","type"],"title":"OAuthCredential"},"GitHubAppInstallationCredential":{"description":"Represents a credential scoped to an integration instance that supports the `GitHub App Installation` authorization strategy.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"4f535923-ec24-456c-b4e5-e67f65c8c208"},"integration_instance":{"$ref":"#/components/schemas/IntegrationInstanceRef"},"missing_permissions":{"description":"List of detected missing permissions required to enable the full functionality of the given integration instance.","type":"array","items":{"$ref":"#/components/schemas/MissingPermission"}},"tainted":{"description":"Indicates that the credential is no longer valid and must be replaced with a new valid credential.","type":"boolean","example":false},"expires_at":{"description":"Timestamp denoting when the when the credential will expire in RFC-3339 format with a \"T\" character separating date from time within the field value.\nWhen expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.\n\nA `null` value indicates no known expiration time.\n","type":"string","format":"date-time","example":"2025-04-01T07:20:50Z","nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"type":{"type":"string","enum":["github_app_installation"],"x-terraform-transform-const":true},"config":{"type":"object","properties":{"installation_id":{"description":"The GitHub App installation ID","type":"string"},"app_installed_by":{"description":"The GitHub user who installed the app.","type":"string","nullable":true}},"required":["installation_id","app_installed_by"],"title":"GitHubAppInstallationCredentialConfig"}},"required":["id","integration_instance","missing_permissions","tainted","expires_at","created_at","type","config"],"title":"GitHubAppInstallationCredential"},"MultiKeyAuthCredential":{"description":"Represents a credential scoped to an integration instance that supports the `Multi Key` authorization strategy.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"4f535923-ec24-456c-b4e5-e67f65c8c208"},"integration_instance":{"$ref":"#/components/schemas/IntegrationInstanceRef"},"missing_permissions":{"description":"List of detected missing permissions required to enable the full functionality of the given integration instance.","type":"array","items":{"$ref":"#/components/schemas/MissingPermission"}},"tainted":{"description":"Indicates that the credential is no longer valid and must be replaced with a new valid credential.","type":"boolean","example":false},"expires_at":{"description":"Timestamp denoting when the when the credential will expire in RFC-3339 format with a \"T\" character separating date from time within the field value.\nWhen expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.\n\nA `null` value indicates no known expiration time.\n","type":"string","format":"date-time","example":"2025-04-01T07:20:50Z","nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"type":{"type":"string","enum":["multi_key_auth"],"x-terraform-transform-const":true}},"required":["id","integration_instance","missing_permissions","tainted","expires_at","created_at","type"],"title":"MultiKeyAuthCredential"},"AWSRoleDelegationAuthCredential":{"description":"Represents a credential scoped to an integration instance that supports the `AWS Role Delegation` authorization strategy.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"4f535923-ec24-456c-b4e5-e67f65c8c208"},"integration_instance":{"$ref":"#/components/schemas/IntegrationInstanceRef"},"missing_permissions":{"description":"List of detected missing permissions required to enable the full functionality of the given integration instance.","type":"array","items":{"$ref":"#/components/schemas/MissingPermission"}},"tainted":{"description":"Indicates that the credential is no longer valid and must be replaced with a new valid credential.","type":"boolean","example":false},"expires_at":{"description":"Timestamp denoting when the when the credential will expire in RFC-3339 format with a \"T\" character separating date from time within the field value.\nWhen expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.\n\nA `null` value indicates no known expiration time.\n","type":"string","format":"date-time","example":"2025-04-01T07:20:50Z","nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"type":{"type":"string","enum":["aws_role_delegation"]},"config":{"type":"object","properties":{"role_arn":{"description":"The Role ARN use for AWS Assume Role.","type":"string"}},"required":["role_arn"],"title":"AWSRoleDelegationAuthCredentialConfig"}},"required":["id","integration_instance","missing_permissions","tainted","expires_at","created_at","type","config"],"title":"AWSRoleDelegationAuthCredential"},"MissingPermission":{"type":"object","properties":{"scopes":{"type":"array","items":{"type":"string","nullable":true},"example":["incident:read"]},"message":{"description":"Describes the degraded experience of the integration instance due to the missing permission.\nMay also include a message on how to resolve the missing permission.\n","type":"string"}},"required":["scopes","message"]},"UpsertIntegrationInstanceAuthConfig":{"oneOf":[{"$ref":"#/components/schemas/UpsertOAuthAuthConfig"}],"title":"UpsertIntegrationInstanceAuthConfig"},"IntegrationInstanceAuthConfig":{"oneOf":[{"$ref":"#/components/schemas/OAuthAuthConfig"}],"title":"IntegrationInstanceAuthConfig"},"UpsertOAuthAuthConfig":{"type":"object","properties":{"type":{"type":"string","enum":["oauth"],"x-terraform-transform-const":true},"client_id":{"description":"The OAuth client identifier.","type":"string","example":"d745213a-b7e8-4998-abe3-41f164001970"},"client_secret":{"description":"The OAuth client secret.","type":"string","example":"s3cr3t4p1cl13ntt0k3n1234567890abcdef","writeOnly":true},"authorization_endpoint":{"description":"The URL where users are redirected to authorize access.","type":"string","format":"uri","example":"https://identity.service.com/oauth/authorize"},"token_endpoint":{"description":"The URL used to retrieve access tokens.","type":"string","format":"uri","example":"https://identity.service.com/oauth/token"}},"additionalProperties":false,"required":["type","client_id","client_secret","authorization_endpoint","token_endpoint"],"title":"OAuth Config"},"OAuthAuthConfig":{"type":"object","properties":{"type":{"type":"string","enum":["oauth"],"x-terraform-transform-const":true},"client_id":{"description":"The OAuth client identifier.","type":"string","example":"d745213a-b7e8-4998-abe3-41f164001970"},"authorization_endpoint":{"description":"The URL where users are redirected to authorize access.","type":"string","format":"uri","example":"https://identity.service.com/oauth/authorize"},"token_endpoint":{"description":"The URL used to retrieve access tokens.","type":"string","format":"uri","example":"https://identity.service.com/oauth/token"}},"required":["type","client_id","authorization_endpoint","token_endpoint"]},"UpdateCatalogResource":{"type":"object","properties":{"archived":{"description":"Whether or not to archive the resource.\nWhen a resource is archived, all catalog service mappings will be removed.\n","type":"boolean","example":false}},"additionalProperties":false},"CatalogResourceFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"integration.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.id":{"oneOf":[{"$ref":"#/components/schemas/UuidFieldFilter"}]},"integration.instance.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"type":{"$ref":"#/components/schemas/StringFieldFilterExact"},"config":{"oneOf":[{"$ref":"#/components/schemas/CatalogResourceConfigFieldFilter"}]},"integration_data":{"oneOf":[{"$ref":"#/components/schemas/CatalogResourceIntegrationDataFieldFilter"}]},"archived":{"$ref":"#/components/schemas/BooleanFieldFilter"},"service_associations":{"$ref":"#/components/schemas/NumericFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}}},"CatalogResourceRefFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"integration.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.id":{"oneOf":[{"$ref":"#/components/schemas/UuidFieldFilter"}]},"integration.instance.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"type":{"$ref":"#/components/schemas/StringFieldFilterExact"},"config":{"oneOf":[{"$ref":"#/components/schemas/CatalogResourceConfigFieldFilter"}]},"integration_data":{"oneOf":[{"$ref":"#/components/schemas/CatalogResourceIntegrationDataFieldFilter"}]},"service_associations":{"$ref":"#/components/schemas/NumericFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}}},"CatalogResourceConfigFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"contains":{"description":"The field contains the provided value.","type":"string","example":"?filter[field_name_here][contains]=foo"},"ocontains":{"description":"The field contains any of the provided values.","type":"string","example":"?filter[field_name_here][ocontains]=foo,bar"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"additionalProperties":false,"x-examples":{"example-1":{"contains":"some-value","ocontains":"this-value,or-that-value","oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}}},"CatalogResourceIntegrationDataFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"contains":{"description":"The field contains the provided value.","type":"string","example":"?filter[field_name_here][contains]=foo"},"ocontains":{"description":"The field contains any of the provided values.","type":"string","example":"?filter[field_name_here][ocontains]=foo,bar"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"additionalProperties":false,"x-examples":{"example-1":{"contains":"some-value","ocontains":"this-value,or-that-value","oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}}},"CatalogResource":{"description":"Information about a catalog resource.","type":"object","properties":{"id":{"$ref":"#/components/schemas/CatalogResourceId"},"name":{"description":"The name of the resource.\nWill be `null` when the resource has not yet been hydrated by the integration.\n","type":"string","maxLength":255,"minLength":1,"nullable":true},"integration":{"$ref":"#/components/schemas/IntegrationRef"},"type":{"$ref":"#/components/schemas/CatalogResourceType"},"config":{"$ref":"#/components/schemas/CatalogResourceConfig"},"integration_data":{"description":"JSON object containing schemaless integration data of the resource.\nThis field is always populated by the system backing the integration.\nWhen `null`, the resource has been manually initialized via API but has\nyet to be hydrated by the integration.\n","type":"object","additionalProperties":true,"nullable":true},"archived":{"description":"Whether or not the resource has been archived.","type":"boolean","example":false},"service_associations":{"description":"The number of catalog services this resource is mapped to.","type":"number","example":2,"minimum":0,"readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","integration","type","config","integration_data","archived","service_associations","created_at","updated_at"]},"CatalogResourceId":{"description":"The resource ID.","type":"string","format":"base64url","example":"4UdXnoaDYYJsH_Ir","maxLength":16,"minLength":16},"CatalogResourceConfig":{"description":"JSON object representing the properties used to identify the resource in the third-party system.\nThe schema depends on the resource type and is dynamically registered at runtime.\n","type":"object","example":{"control_plane_id":"ccadfb0a-56cd-4f74-955d-aec1d87157c8","gateway_service_id":"94896d05-0c4d-45eb-aae3-de754885dd58"},"additionalProperties":true},"CatalogResourceType":{"description":"The resource type. Available resource types are compiled from the integrations installed within the catalog.\n","type":"string","example":"gateway_svc","maxLength":120,"minLength":1},"CreateCatalogResourceMapping":{"type":"object","properties":{"service":{"description":"The `id` or `name` of the service to map the resource to.","type":"string","example":"user-svc"},"resource":{"oneOf":[{"$ref":"#/components/schemas/CatalogResourceId"},{"$ref":"#/components/schemas/CreateCatalogResourceMappingResourceByConfig"}]}},"additionalProperties":false,"required":["service","resource"]},"CreateCatalogResourceMappingResourceByConfig":{"type":"object","properties":{"integration_instance":{"description":"The `id` or `name` of the integration instance the resource belongs to.","type":"string","example":"aws-lambda-prod"},"type":{"$ref":"#/components/schemas/CatalogResourceType"},"config":{"$ref":"#/components/schemas/CatalogResourceConfig"}},"additionalProperties":false,"required":["integration_instance","type","config"],"title":"CreateCatalogResourceMappingResourceByConfig"},"CatalogResourceMappingFilterParameters":{"type":"object","properties":{"resource.id":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilterExact"}]},"resource.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"resource.type":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"resource.config":{"oneOf":[{"$ref":"#/components/schemas/CatalogResourceConfigFieldFilter"}]},"resource.integration.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"resource.integration.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"resource.integration.instance.id":{"oneOf":[{"$ref":"#/components/schemas/UuidFieldFilter"}]},"resource.integration.instance.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"resource.integration.instance.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"service.id":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilterExact"}]},"service.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"service.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}}},"CatalogResourceMapping":{"description":"Describes a mapping between a catalog resource and a service.","type":"object","properties":{"id":{"description":"The resource mapping ID.","type":"string","format":"uuid","example":"d277faad-ed4e-4c56-a0fb-acce065dee34"},"resource":{"$ref":"#/components/schemas/CatalogResourceRef"},"service":{"$ref":"#/components/schemas/CatalogServiceRef"},"created_at":{"$ref":"#/components/schemas/CreatedAt"}},"required":["id","resource","service","created_at"]},"CriteriaTemplateFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"},"installed":{"$ref":"#/components/schemas/BooleanFieldFilter"},"integration_name":{"$ref":"#/components/schemas/StringFieldFilter"}}},"CriteriaTemplate":{"description":"Representation of a criteria template.","type":"object","properties":{"name":{"$ref":"#/components/schemas/CriteriaTemplateName"},"display_name":{"description":"The human-readable display name of the template.","type":"string"},"category":{"description":"Categorical tag for the functionality the template relates to.","type":"string","example":"Source Code Management","enum":["Source Code Management","Incident Management","Observability","Code Quality","Issue Tracking","Communications","Feature Management","Security / Vulnerability","Documentation","Catalog Management","Gateway Configuration"],"nullable":true},"template_string":{"description":"[Liquid](https://shopify.github.io/liquid/) template string used to render the criteria interpolated by parameters.","type":"string","nullable":true},"integration_name":{"description":"The catalog integration who registered the given criteria template.\nThis will be `null` when a template is always available independent of connected integrations.\n","type":"string","nullable":true},"installed":{"description":"Whether the template is available given the current state of the catalog.\nFor example, this will be `false` when the template is provided by an integrastion\nthat is not currently connected.\n","type":"boolean"},"schema":{"$ref":"#/components/schemas/CriteriaTemplateSchema"},"required_integration_capability":{"description":"Required capability from connected integrations to use this criteria template.\nApplicable for templates that are not provided by a given integration (functional\nacross integrations).\n","type":"string","enum":[null,"on_call_provider","incident_provider","pull_request_provider","workflow_provider"],"nullable":true}},"required":["name","display_name","category","template_string","integration_name","installed","schema","required_integration_capability"]},"CriteriaTemplateSchema":{"anyOf":[{"title":"EmptySchema","type":"object","nullable":true},{"type":"object","required":["type","definition"],"properties":{"type":{"type":"string","enum":["simple"]},"definition":{"type":"object","additionalProperties":{"type":"string","enum":["string","number","boolean"]}}},"title":"CriteriaTemplateSimpleSchema","description":"Defines the parameters required to evaluate the criteria using simple schema.\nSet to `null` when the given criteria does not rely on parameterization.\n"},{"type":"object","required":["type","definition"],"properties":{"type":{"type":"string","enum":["json_schema"]},"definition":{"type":"object","additionalProperties":true}},"title":"CriteriaTemplateJSONSchema","description":"Defines the parameters required to evaluate the criteria using JSON schema.\nSet to `null` when the given criteria does not rely on parameterization.\n"}],"x-convert-oneOf":true},"ScorecardTemplateFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"}}},"ScorecardTemplate":{"description":"Representation of a scorecard template.","type":"object","properties":{"name":{"$ref":"#/components/schemas/ScorecardTemplateName"},"display_name":{"type":"string","example":"Kong Best Practices"},"description":{"type":"string","example":"Best practices that we encourage users to follow when using other Konnect applications."},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/ScorecardTemplateCriteria"},"example":[{"template_name":"gateway_manager_error_rate","template_parameters":{"relative_window":"30d"},"integration":"gateway_manager","section_name":"Gateway Observability"},{"template_name":"gateway_manager_response_latency","template_parameters":{"metric":"response_latency_p95","relative_window":"30d"},"integration":"gateway_manager","section_name":"Gateway Observability"},{"template_name":"gateway_manager_has_plugin","template_parameters":{},"integration":"gateway_manager","section_name":"Plugin Management"}]}},"required":["name","display_name","description","criteria"]},"ScorecardTemplateName":{"description":"Well-known name of the template. Uniquely identifies the template.","type":"string","example":"kong_best_practices","enum":["kong_best_practices","service_documentation","service_maturity","security_and_compliance"]},"ScorecardTemplateCriteria":{"type":"object","properties":{"integration":{"description":"The integration `name` when it provides the criteria template. Otherwise `null`.","type":"string","example":null,"nullable":true},"template_name":{"$ref":"#/components/schemas/CriteriaTemplateName"},"template_parameters":{"$ref":"#/components/schemas/CriteriaParameters"},"section_name":{"description":"Organizational section that the criteria belongs to within the scorecard template.","type":"string","example":"Source Code Management","nullable":true}},"required":["integration","template_name","template_parameters","section_name"]},"CreateScorecard":{"type":"object","properties":{"name":{"description":"The human-readable name of the scorecard.","type":"string","example":"Incident Response"},"description":{"type":"string","example":"Governs key metrics pertaining to teams' incident response practices.","nullable":true},"entity_selector":{"$ref":"#/components/schemas/ScorecardEntitySelector"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/CreateScorecardCriteria"},"minItems":1},"scorecard_template":{"description":"The name of the scorecard template used to create the scorecard.\nOtherwise, `null`.\n","type":"string","example":"kong_best_practices","enum":["kong_best_practices","service_documentation","service_maturity","security_and_compliance"],"nullable":true}},"additionalProperties":false,"required":["name","description","entity_selector","criteria","scorecard_template"]},"UpdateScorecard":{"type":"object","properties":{"name":{"description":"The human-readable name of the scorecard.","type":"string","example":"Incident Response"},"description":{"type":"string","example":"Governs key metrics pertaining to teams' incident response practices.","nullable":true},"entity_selector":{"$ref":"#/components/schemas/ScorecardEntitySelector"},"criteria":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UpdateScorecardCriteria"},{"$ref":"#/components/schemas/CreateScorecardCriteria"}]},"minItems":1},"scorecard_template":{"description":"The name of the scorecard template used to create the scorecard.\nOtherwise, `null`.\n","type":"string","example":"kong_best_practices","enum":["kong_best_practices","service_documentation","service_maturity","security_and_compliance"],"nullable":true}},"additionalProperties":false,"required":["name","description","entity_selector","criteria","scorecard_template"]},"ScorecardFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"score.value":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"score.raw_value":{"oneOf":[{"$ref":"#/components/schemas/NumericFieldFilter"}]}}},"Scorecard":{"description":"Representation of a scorecard.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"},"name":{"description":"The human-readable name of the scorecard.","type":"string","example":"Incident Response"},"description":{"type":"string","example":"Governs key metrics pertaining to teams' incident response practices.","nullable":true},"score":{"$ref":"#/components/schemas/ScorecardScore"},"entity_selector":{"$ref":"#/components/schemas/ScorecardEntitySelector"},"scorecard_template":{"description":"The name of the scorecard template used to create the scorecard.\nOtherwise, `null`.\n","type":"string","example":"kong_best_practices","enum":["kong_best_practices","service_documentation","service_maturity","security_and_compliance"],"nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","description","score","entity_selector","scorecard_template","created_at","updated_at"]},"ScorecardWithCriteria":{"description":"Representation of a scorecard.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"},"name":{"description":"The human-readable name of the scorecard.","type":"string","example":"Incident Response"},"description":{"type":"string","example":"Governs key metrics pertaining to teams' incident response practices.","nullable":true},"score":{"$ref":"#/components/schemas/ScorecardScore"},"entity_selector":{"$ref":"#/components/schemas/ScorecardEntitySelector"},"scorecard_template":{"description":"The name of the scorecard template used to create the scorecard.\nOtherwise, `null`.\n","type":"string","example":"kong_best_practices","enum":["kong_best_practices","service_documentation","service_maturity","security_and_compliance"],"nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/ScorecardCriteria"}}},"required":["id","name","description","score","entity_selector","scorecard_template","created_at","updated_at","criteria"]},"CatalogServiceScorecard":{"description":"Representation of a scorecard.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"},"name":{"description":"The human-readable name of the scorecard.","type":"string","example":"Incident Response"},"description":{"type":"string","example":"Governs key metrics pertaining to teams' incident response practices.","nullable":true},"score":{"$ref":"#/components/schemas/ScorecardScore"},"entity_selector":{"$ref":"#/components/schemas/ScorecardEntitySelector"},"scorecard_template":{"description":"The name of the scorecard template used to create the scorecard.\nOtherwise, `null`.\n","type":"string","example":"kong_best_practices","enum":["kong_best_practices","service_documentation","service_maturity","security_and_compliance"],"nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/CatalogServiceScorecardCriteria"}}},"required":["id","name","description","score","entity_selector","scorecard_template","created_at","updated_at","criteria"]},"ScorecardEntitySelector":{"description":"Selector used to dynamically target catalog entities that will be\nincluded in the given scorecard's evaluated score.\n","type":"object","example":{"selector":"label","selector_parameters":{"label_key":"product_area","operator":"eq","value":"cloud_platform"}},"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ServiceSelector"}],"title":"ScorecardEntitySelector"},"ScorecardScore":{"description":"The current score for the given Scorecard.\nA `null` value indicates the scorecard has not yet been evaluated and therefore no score has been computed.\n","type":"object","properties":{"value":{"description":"The human-readable score value coverted to the Scorecard's assigned grading system.","type":"string","example":"88%"},"raw_value":{"description":"The raw, numeric score calculated during evaluation of the scorecard.\nRounded to 3 decimal places.\n","type":"number","example":87.5,"maximum":100,"minimum":0}},"nullable":true,"required":["value","raw_value"]},"ScorecardServiceFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"},"custom_fields":{"description":"Filter by custom fields using dot-notation to specify the custom field.\nFilter operators are dictated by the custom field type. For example:\n  - `filter[custom_fields.owner]`\n  - `filter[custom_fields.owner][neq]=kong`\n  - `filter[custom_fields.dashboard.link][contains]=https`\n","oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"},{"$ref":"#/components/schemas/BooleanFieldFilter"},{"$ref":"#/components/schemas/NumericFieldFilter"}]},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"score.value":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"score.raw_value":{"oneOf":[{"$ref":"#/components/schemas/NumericFieldFilter"}]}}},"ScorecardService":{"description":"Service object that includes its score for the given scorecard.","type":"object","properties":{"id":{"description":"The service ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"description":"The machine name of the Service that uniquely identifies it within the catalog.\n","type":"string","example":"user-svc","maxLength":120,"minLength":1,"pattern":"^[0-9a-z.-]+$"},"display_name":{"description":"The display name of the Service.","type":"string","example":"User Service","maxLength":120,"minLength":1},"description":{"description":"Optionally provide a description of the Service.","type":"string","maxLength":2048,"nullable":true},"custom_fields":{"$ref":"#/components/schemas/CustomFields"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"score":{"$ref":"#/components/schemas/ScorecardScore"}},"required":["id","name","display_name","description","custom_fields","labels","created_at","updated_at","score"],"title":"ScorecardService"},"ScorecardCriteriaFilterParameters":{"type":"object","properties":{"evaluation.passing_services_count":{"oneOf":[{"$ref":"#/components/schemas/NumericFieldFilter"}]}}},"ScorecardCriteriaServiceFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"},"custom_fields":{"description":"Filter by custom fields using dot-notation to specify the custom field.\nFilter operators are dictated by the custom field type. For example:\n  - `filter[custom_fields.owner]`\n  - `filter[custom_fields.owner][neq]=kong`\n  - `filter[custom_fields.dashboard.link][contains]=https`\n","oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"},{"$ref":"#/components/schemas/BooleanFieldFilter"},{"$ref":"#/components/schemas/NumericFieldFilter"}]},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"evaluation.is_passing":{"oneOf":[{"$ref":"#/components/schemas/BooleanFieldFilter"}]},"evaluation.successfully_evaluated_at":{"oneOf":[{"$ref":"#/components/schemas/DateTimeFieldFilter"}]},"evaluation.attempted_at":{"oneOf":[{"$ref":"#/components/schemas/DateTimeFieldFilter"}]}}},"CreateScorecardCriteria":{"type":"object","properties":{"name":{"type":"string","example":"Median time to merge opened PRs is less than 6 hours over the last 3 months.","maxLength":2048,"minLength":1},"enabled":{"type":"boolean","example":true},"template_name":{"$ref":"#/components/schemas/CriteriaTemplateName"},"template_parameters":{"$ref":"#/components/schemas/CriteriaParameters"},"section_name":{"description":"Organizational section name for the criteria within the scorecard.","type":"string","example":"Source Code Management","maxLength":120,"minLength":1,"nullable":true}},"additionalProperties":false,"required":["enabled","template_name","template_parameters","section_name"]},"UpdateScorecardCriteria":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"5c1121f9-3f3a-47c7-9bb6-c81a51128714"},"name":{"type":"string","example":"Median time to merge opened PRs is less than 6 hours over the last 3 months.","maxLength":2048,"minLength":1},"enabled":{"type":"boolean","example":true},"template_name":{"$ref":"#/components/schemas/CriteriaTemplateName"},"template_parameters":{"$ref":"#/components/schemas/CriteriaParameters"},"section_name":{"description":"Organizational section name for the criteria within the scorecard.","type":"string","example":"Source Code Management","maxLength":120,"minLength":1,"nullable":true}},"additionalProperties":false,"required":["id","enabled","template_name","template_parameters","section_name"]},"ScorecardCriteria":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"5c1121f9-3f3a-47c7-9bb6-c81a51128714"},"name":{"description":"Override display name for the criteria, for greater contextual clarity within a given scorecard.","type":"string","example":"Time to restore service is less than 6 hours over the last 3 months.","nullable":true},"scorecard_id":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"},"integration":{"description":"The integration `name` when it provides the criteria template. Otherwise `null`.","type":"string","example":null,"nullable":true},"enabled":{"description":"Whether the criteria is enabled for the given scorecard.","type":"boolean","example":true},"template_name":{"$ref":"#/components/schemas/CriteriaTemplateName"},"template_parameters":{"$ref":"#/components/schemas/CriteriaParameters"},"section_name":{"description":"Organizational section name for the criteria within the scorecard.","type":"string","example":"Documentation","maxLength":120,"minLength":1,"nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","scorecard_id","integration","enabled","template_name","template_parameters","section_name","created_at","updated_at"]},"CatalogServiceScorecardCriteria":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"5c1121f9-3f3a-47c7-9bb6-c81a51128714"},"name":{"description":"Override display name for the criteria, for greater contextual clarity within a given scorecard.","type":"string","example":"Time to restore service is less than 6 hours over the last 3 months.","nullable":true},"scorecard_id":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"},"integration":{"description":"The integration `name` when it provides the criteria template. Otherwise `null`.","type":"string","example":null,"nullable":true},"enabled":{"description":"Whether the criteria is enabled for the given scorecard.","type":"boolean","example":true},"template_name":{"$ref":"#/components/schemas/CriteriaTemplateName"},"template_parameters":{"$ref":"#/components/schemas/CriteriaParameters"},"section_name":{"description":"Organizational section name for the criteria within the scorecard.","type":"string","example":"Documentation","maxLength":120,"minLength":1,"nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"evaluation":{"$ref":"#/components/schemas/ScorecardCriteriaServiceEvaluation"}},"required":["id","name","scorecard_id","integration","enabled","template_name","template_parameters","section_name","created_at","updated_at","evaluation"]},"ScorecardCriteriaWithEvaluation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"5c1121f9-3f3a-47c7-9bb6-c81a51128714"},"name":{"description":"Override display name for the criteria, for greater contextual clarity within a given scorecard.","type":"string","example":"Time to restore service is less than 6 hours over the last 3 months.","nullable":true},"scorecard_id":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"},"integration":{"description":"The integration `name` when it provides the criteria template. Otherwise `null`.","type":"string","example":null,"nullable":true},"enabled":{"description":"Whether the criteria is enabled for the given scorecard.","type":"boolean","example":true},"template_name":{"$ref":"#/components/schemas/CriteriaTemplateName"},"template_parameters":{"$ref":"#/components/schemas/CriteriaParameters"},"section_name":{"description":"Organizational section name for the criteria within the scorecard.","type":"string","example":"Documentation","maxLength":120,"minLength":1,"nullable":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"evaluation":{"$ref":"#/components/schemas/ScorecardCriteriaEvaluation"}},"required":["id","name","scorecard_id","integration","enabled","template_name","template_parameters","section_name","created_at","updated_at","evaluation"]},"ScorecardCriteriaEvaluation":{"type":"object","properties":{"passing_services_count":{"description":"Number of targeted Services passing the criteria.","type":"number","example":3}},"nullable":true,"required":["passing_services_count"]},"CriteriaTemplateName":{"description":"Reference to the unique `name` of the criteria template.","type":"string","example":"time_to_merge"},"CriteriaParameters":{"description":"Input parameters for the given criteria template.\nThe available parameters, and its schema, are found on the criteria template definition via\nthe `schema` property. Criteria template definitions are determined by the `/v1/criteria-templates`\nendpoint.\n","type":"object","example":{"measure":"median","threshold":{"unit":"hours","value":6},"window":{"unit":"months","value":3}},"additionalProperties":true,"nullable":true},"ScorecardCriteriaService":{"description":"Service object that includes its evaluation result for the given scorecard criteria.","type":"object","properties":{"id":{"description":"The service ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"description":"The machine name of the Service that uniquely identifies it within the catalog.\n","type":"string","example":"user-svc","maxLength":120,"minLength":1,"pattern":"^[0-9a-z.-]+$"},"display_name":{"description":"The display name of the Service.","type":"string","example":"User Service","maxLength":120,"minLength":1},"description":{"description":"Optionally provide a description of the Service.","type":"string","maxLength":2048,"nullable":true},"custom_fields":{"$ref":"#/components/schemas/CustomFields"},"labels":{"$ref":"#/components/schemas/Labels"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"score":{"$ref":"#/components/schemas/ScorecardCriteriaServiceEvaluation"}},"required":["id","name","display_name","description","custom_fields","labels","created_at","updated_at","evaluation"],"title":"ScorecardService"},"ScorecardCriteriaServiceEvaluation":{"description":"Evaluation for a scorecard criteria relative to the given service service.\nHas a `null` value when the criteria has not yet been evaluated for the service.\n","type":"object","properties":{"is_passing":{"description":"Whether or not the service has most recently passed the criteria check.","type":"boolean"},"evaluation_context":{"$ref":"#/components/schemas/CriteriaEvaluationResultDetails"},"evaluation_error":{"description":"Details about an error that occurred during evaluation preventing computation of a pass/fail result.\nWill be `null` when no error occurred.\n","type":"object","example":null,"nullable":true,"properties":{"type":{"description":"The type of error that occurred.","type":"string","example":"integration_unauthorized"},"details":{"description":"Human-readable error message about the error.","type":"string","example":"The GitHub integration is unauthorized. Please ensure that the\nintegration is re-authorized for the criteria to be successfully evaluated.\n"}},"required":["type","details"]},"attempted_at":{"description":"The timestamp denoting the last evaluation attempt of the criteria for the service.","type":"string","format":"date-time","example":"2023-02-15T07:20:50Z"},"successfully_evaluated_at":{"description":"The timestamp denoting when the criteria was last successfully evaluated for the service.\nError states preventing the evaluation from being performed will not update this timestamp.\n","type":"string","format":"date-time","example":"2023-02-15T07:20:50Z"},"created_at":{"$ref":"#/components/schemas/CreatedAt"}},"nullable":true,"required":["is_passing","evaluation_context","evaluation_error","successfully_evaluated_at","attempted_at","created_at"]},"CriteriaEvaluationResultDetails":{"description":"Provides additional metadata about the criteria evaluation result.","type":"object","properties":{"raw_value":{"description":"Raw value of the criteria evaluation.\n\nFor example, a service may be failing the `time_to_acknowledge` criteria evaluation when\nthe the mean time-to-ack is greater than 15 minutes. This value represents the _actual_\nmean time-to-ack value for the service which if not passing could be 25 minutes.\n","oneOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"$ref":"#/components/schemas/TimeValue"},{"$ref":"#/components/schemas/CriteriaEvaluationRelationMap"},{"type":"object","additionalProperties":true},{"nullable":true}]},"display_text":{"description":"Renderable text providing human-readable context about the evaluation value.","type":"string","example":"25 minutes"}},"example":{"raw_value":{"unit":"minutes","value":25},"display_text":"25 minutes"},"nullable":true,"required":["raw_value","display_text"]},"CriteriaEvaluationRelationMap":{"type":"object","properties":{"instance":{"type":"string","enum":["criteria_result_relation_map"]},"relation":{"type":"string","example":"gateway_svc"},"map":{"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/CriteriaEvaluationRelationResult"},{"$ref":"#/components/schemas/CriteriaEvaluationErrorResult"}]}}},"required":["instance","relation","map"]},"CriteriaEvaluationRelationResult":{"type":"object","properties":{"is_passing":{"description":"Whether or not the relation has passed the criteria evaluation.","type":"boolean"},"relation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"details":{"$ref":"#/components/schemas/CriteriaEvaluationResultDetails"}},"required":["is_passing","relation","details"]},"CriteriaEvaluationErrorResult":{"type":"object","properties":{"relation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"error":{"description":"Details about an error that occurred during evaluation preventing computation of a pass/fail result.\nWill be `null` when no error occurred.\n","type":"object","example":null,"nullable":true,"properties":{"type":{"description":"The type of error that occurred.","type":"string","example":"integration_unauthorized"},"details":{"description":"Human-readable error message about the error.","type":"string","example":"The GitHub integration is unauthorized. Please ensure that the\nintegration is re-authorized for the criteria to be successfully evaluated.\n"}},"required":["type","details"]}},"required":["relation","error"]},"CustomFields":{"description":"Map of customizable, catalog-defined fields providing information about a service.\n","type":"object","example":{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}},"additionalProperties":{"x-convert-oneOf":true,"anyOf":[{"$ref":"#/components/schemas/TextCustomField"},{"$ref":"#/components/schemas/NumericCustomField"},{"$ref":"#/components/schemas/BooleanCustomField"},{"$ref":"#/components/schemas/UrlCustomField"}]}},"TextCustomField":{"type":"string","nullable":true},"NumericCustomField":{"type":"number","nullable":true},"BooleanCustomField":{"type":"boolean","nullable":true},"UrlCustomField":{"type":"object","properties":{"name":{"description":"The human-readable name of the URL link.","type":"string","example":"On-Call Dashboard"},"link":{"description":"The href value of the URL link.","type":"string","format":"uri-reference","example":"https://my-dashboard-svc.io/dashboards/1"}},"nullable":true,"required":["name","link"]},"ServiceSelector":{"oneOf":[{"$ref":"#/components/schemas/AllEntitiesSelector"},{"$ref":"#/components/schemas/ByIDsSelector"},{"$ref":"#/components/schemas/ByNameSelector"},{"$ref":"#/components/schemas/ByDisplayNameSelector"},{"$ref":"#/components/schemas/ByCustomFieldSelector"},{"$ref":"#/components/schemas/ByLabelSelector"},{"$ref":"#/components/schemas/HasLabelKeySelector"},{"$ref":"#/components/schemas/HasDocsSelector"},{"$ref":"#/components/schemas/HasApisSelector"},{"$ref":"#/components/schemas/HasResourcesSelector"}]},"AllEntitiesSelector":{"description":"Entity selector that includes all entities of the given type within the catalog.","type":"object","properties":{"selector":{"type":"string","enum":["all"]},"selector_parameters":{"type":"string","enum":[null],"nullable":true}},"required":["selector","selector_parameters"]},"ByIDsSelector":{"description":"Entity selector that includes entities contained within a list of IDs.","type":"object","properties":{"selector":{"type":"string","enum":["ids"]},"selector_parameters":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["ids"]}},"required":["selector","selector_parameters"]},"ByNameSelector":{"description":"Entity selector that includes entities by `name`.","type":"object","properties":{"selector":{"type":"string","enum":["name"]},"selector_parameters":{"$ref":"#/components/schemas/StringFieldSelectorParams"}},"required":["selector","selector_parameters"]},"ByDisplayNameSelector":{"description":"Entity selector that includes entities by `display_name`.","type":"object","properties":{"selector":{"type":"string","enum":["display_name"]},"selector_parameters":{"$ref":"#/components/schemas/StringFieldSelectorParams"}},"required":["selector","selector_parameters"]},"ByCustomFieldSelector":{"description":"Entity selector that include entities by a custom field.","type":"object","properties":{"selector":{"type":"string","enum":["custom_field"]},"selector_parameters":{"oneOf":[{"type":"object","title":"StringCustomFieldSelectorParams","required":["field","value","operator"],"properties":{"field":{"description":"Name of the custom field.","type":"string"},"value":{"type":"string"},"operator":{"$ref":"#/components/schemas/StringSelectorOperator"}}},{"type":"object","title":"NumberCustomFieldSelectorParams","required":["field","value","operator"],"properties":{"field":{"description":"Name of the custom field.","type":"string"},"value":{"type":"number"},"operator":{"$ref":"#/components/schemas/NumberSelectorOperator"}}},{"type":"object","title":"BooleanCustomFieldSelectorParams","required":["field","value","operator"],"properties":{"field":{"description":"Name of the custom field.","type":"string"},"value":{"type":"boolean"},"operator":{"$ref":"#/components/schemas/BooleanSelectorOperator"}}},{"type":"object","title":"UrlCustomFieldSelectorParams","required":["field","subfield","value","operator"],"properties":{"field":{"description":"Name of the custom field.","type":"string"},"subfield":{"description":"Specify which subfield of the `url` custom field value to use for selection.","type":"string","enum":["name","link"]},"value":{"type":"string"},"operator":{"$ref":"#/components/schemas/StringSelectorOperator"}}}]}},"required":["selector","selector_parameters"]},"ByLabelSelector":{"description":"Entity selector that includes entities by `label` value.","type":"object","properties":{"selector":{"type":"string","enum":["label"]},"selector_parameters":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/StringSelectorOperator"},"value":{"type":"string"},"label_key":{"type":"string"}},"required":["operator","value","label_key"],"title":"LabelSelectorParams"}},"required":["selector","selector_parameters"]},"HasLabelKeySelector":{"description":"Entity selector that includes entities by inclusion of a `label` key.","type":"object","properties":{"selector":{"type":"string","enum":["has_label_key"]},"selector_parameters":{"type":"object","properties":{"label_key":{"type":"string"}},"required":["label_key"],"title":"HasLabelKeySelectorParams"}},"required":["selector","selector_parameters"]},"HasDocsSelector":{"description":"Entity selector to include entities by attached documentation.","type":"object","properties":{"selector":{"type":"string","enum":["has_docs"]},"selector_parameters":{"type":"string","enum":[null],"nullable":true}},"required":["selector","selector_parameters"]},"HasApisSelector":{"description":"Entity selector that includes services by attached APIs.","type":"object","properties":{"selector":{"type":"string","enum":["api_count"]},"selector_parameters":{"$ref":"#/components/schemas/HasSelectorParams"}},"required":["selector","selector_parameters"]},"HasResourcesSelector":{"description":"Entity selector that includes services by mapped resources.","type":"object","properties":{"selector":{"type":"string","enum":["resource_count"]},"selector_parameters":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/HasRelationshipSelectorOperator"},"value":{"type":"number"},"resource_type":{"$ref":"#/components/schemas/CatalogResourceType"},"integration":{"description":"The machine name of the integration that uniquely identifies it within the catalog.","type":"string","example":"gateway-manager"}},"required":["operator","value","resource_type","integration"],"title":"HasResourcesSelectorParams"}},"required":["selector","selector_parameters"]},"StringFieldSelectorParams":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/StringSelectorOperator"},"value":{"type":"string"}},"required":["operator","value"]},"HasSelectorParams":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/HasRelationshipSelectorOperator"},"value":{"type":"number"}},"required":["operator","value"]},"StringSelectorOperator":{"type":"string","enum":["eq","contains"]},"NumberSelectorOperator":{"type":"string","enum":["eq","lt","gt"]},"BooleanSelectorOperator":{"type":"string","enum":["eq"]},"HasRelationshipSelectorOperator":{"type":"string","enum":["eq","gte","lte"]},"SimpleSchema":{"type":"object","properties":{"type":{"type":"string","enum":["simple"]},"definition":{"type":"object","additionalProperties":{"type":"string","enum":["string","number","boolean"]}}},"required":["type","definition"]},"CatalogServiceRef":{"description":"Short-hand descriptor of a catalog service.","type":"object","properties":{"id":{"description":"The service ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"name":{"description":"The machine name of the service that uniquely identifies it within the catalog.\n","type":"string","example":"user-svc"},"display_name":{"description":"The display name of the service.","type":"string","example":"User Service"}},"required":["id","name","display_name"]},"IntegrationRef":{"description":"Short-hand descriptor of an integration installed within the catalog.","type":"object","properties":{"name":{"type":"string","example":"gateway-manager"},"display_name":{"type":"string","example":"gateway-manager"},"instance":{"$ref":"#/components/schemas/IntegrationInstanceRef"}},"required":["name","display_name","instance"]},"IntegrationRefWithoutInstance":{"description":"Short-hand descriptor of an integration that omits instance metadata.","type":"object","properties":{"name":{"type":"string","example":"gateway-manager"},"display_name":{"type":"string","example":"gateway-manager"}},"required":["name","display_name"]},"IntegrationInstanceRef":{"description":"Short-hand descriptor of an integration instance.","type":"object","properties":{"id":{"description":"The integration instance ID.","type":"string","format":"uuid","example":"772b9caf-ddbc-4f4f-8aa4-8dfbbe420351"},"name":{"description":"The machine name of the integration instance that uniquely identifies it within the catalog.\n","type":"string","example":"aws-lambda-prod","pattern":"^[0-9a-z.-]+$"},"display_name":{"description":"The display name of the integration instance.","type":"string","example":"AWS (prod)"}},"required":["id","name","display_name"]},"CatalogResourceRef":{"description":"Short-hand descriptor of a catalog resource.","type":"object","properties":{"id":{"$ref":"#/components/schemas/CatalogResourceId"},"name":{"description":"The name of the resource.","type":"string","nullable":true},"integration":{"$ref":"#/components/schemas/IntegrationRef"},"type":{"$ref":"#/components/schemas/CatalogResourceType"},"config":{"$ref":"#/components/schemas/CatalogResourceConfig"}},"required":["id","name","type","config","integration"]},"TimeValue":{"description":"Represents a time value inclusive of units.","type":"object","properties":{"value":{"type":"number","example":3.25},"unit":{"type":"string","example":"hours","enum":["milliseconds","seconds","minutes","hours","days","months","years"]}},"required":["value","unit"]},"CatalogServiceApiMapping":{"description":"Represents an API mapping associated with a service in the catalog.","type":"object","properties":{"id":{"description":"The mapping ID.","type":"string","format":"uuid"},"service_id":{"description":"The ID of the service.","type":"string","format":"uuid"},"api_id":{"description":"The ID of the API.","type":"string","format":"uuid"},"created_at":{"description":"Creation timestamp.","type":"string","format":"date-time"},"updated_at":{"description":"Last update timestamp.","type":"string","format":"date-time"}},"required":["id","service_id","api_id","created_at","updated_at"]},"CatalogServiceApiMappingFilterParameters":{"type":"object","properties":{"api_id":{"$ref":"#/components/schemas/UuidFieldFilter"}},"additionalProperties":false,"title":"CatalogServiceApiMappingFilterParameters"},"CatalogApiServiceMappingFilterParameters":{"type":"object","properties":{"service_id":{"$ref":"#/components/schemas/UuidFieldFilter"}},"additionalProperties":false,"title":"CatalogApiServiceMappingFilterParameters"},"UuidFieldFilter":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"additionalProperties":false,"x-examples":{"example-1":{"oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}}},"StringFieldFilter":{"oneOf":[{"title":"Filter by operator","description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`","x-examples":{"example-1":{"contains":"some-value","ocontains":"this-value,or-that-value","oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}},"properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"contains":{"description":"The field contains the provided value.","type":"string","example":"?filter[field_name_here][contains]=foo"},"ocontains":{"description":"The field contains any of the provided values.","type":"string","example":"?filter[field_name_here][ocontains]=foo,bar"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"type":"object","additionalProperties":false},{"title":"Filter by exact string match","type":"string","description":"The field exactly matches the provided value.","example":"?filter[title]=foo"}]},"BooleanFieldFilter":{"description":"Filter by a boolean value (true/false).","type":"boolean","title":"BooleanFieldFilter","x-examples":{"example-1":true}},"NumericFieldFilter":{"description":"Filter by a numeric value.","oneOf":[{"type":"number","description":"Value strictly equals the given numeric value.","example":21},{"type":"object","title":"NumericFieldEqualsFilter","additionalProperties":false,"properties":{"eq":{"description":"Value strictly equals the given numeric value.","type":"number","example":3.14}},"required":["eq"]},{"type":"object","title":"NumericFieldLTFilter","additionalProperties":false,"properties":{"lt":{"description":"Value is less than the given numeric value.","type":"number","example":10}},"required":["lt"]},{"type":"object","title":"NumericFieldLTEFilter","additionalProperties":false,"properties":{"lte":{"description":"Value is less than or equal to the given numeric value.","type":"number","example":10}},"required":["lte"]},{"type":"object","title":"NumericFieldGTFilter","additionalProperties":false,"properties":{"gt":{"description":"Value is greater than the given numeric value.","type":"number","example":1.85}},"required":["gt"]},{"type":"object","title":"NumericFieldGTEFilter","additionalProperties":false,"properties":{"gte":{"description":"Value is greater than or equal to the given numeric value.","type":"number","example":1.85}},"required":["gte"]}],"x-examples":{"numeric_field_1":11,"numeric_field_2":{"eq":11},"numeric_field_3":{"lt":15.85},"numeric_field_4":{"lte":15.85},"numeric_field_5":{"gt":3.14},"numeric_field_6":{"gte":3.14}}},"LabelsFieldFilter":{"allOf":[{"title":"LabelsFieldFilter","description":"Filters on the resource's `labels` field. Filters must use dot-notation to identify\nthe label key that will be used to filter the results. For example:\n  - `filter[labels.owner]`\n  - `filter[labels.owner][neq]=kong`\n  - `filter[labels.env]=dev`\n  - `filter[labels.env][ocontains]=dev,test`\n"},{"$ref":"#/components/schemas/StringFieldFilter"}]},"DateTimeFieldFilter":{"description":"Filters on the given datetime (RFC-3339) field value.","oneOf":[{"type":"string","title":"DateTimeFieldImplicitEqualsFilter","format":"date-time","description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","example":"2022-03-30T07:20:50Z"},{"type":"object","title":"DateTimeFieldEqualsFilter","additionalProperties":false,"properties":{"eq":{"description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["eq"]},{"type":"object","title":"DateTimeFieldLTFilter","additionalProperties":false,"properties":{"lt":{"description":"Value is less than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lt"]},{"type":"object","title":"DateTimeFieldLTEFilter","additionalProperties":false,"properties":{"lte":{"description":"Value is less than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lte"]},{"type":"object","title":"DateTimeFieldGTFilter","additionalProperties":false,"properties":{"gt":{"description":"Value is greater than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gt"]},{"type":"object","title":"DateTimeFieldGTEFilter","additionalProperties":false,"properties":{"gte":{"description":"Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gte"]}],"title":"DateTimeFieldFilter","x-examples":{"datetime_field_1":"2022-03-30T07:20:50Z","datetime_field_2":{"eq":"2022-03-30T07:20:50Z"},"datetime_field_3":{"lt":"2022-03-30T07:20:50Z"},"datetime_field_4":{"lte":"2022-03-30T07:20:50Z"},"datetime_field_5":{"gt":"2022-03-30T07:20:50Z"},"datetime_field_6":{"gte":"2022-03-30T07:20:50Z"}}},"SortQuery":{"description":"The `asc` suffix is optional as the default sort order is ascending.\nThe `desc` suffix is used to specify a descending order.\nMultiple sort attributes may be provided via a comma separated list.\nJSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').\n","type":"string","example":"created_at desc","title":"SortQuery"},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"Labels":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"title":"Labels"},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"LabelsUpdate":{"description":"Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. \n\nLabels are intended to store **INTERNAL** metadata.\n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63,"nullable":true},"maxProperties":50,"nullable":true,"writeOnly":true},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"CursorPageParameters":{"type":"object","properties":{"size":{"description":"The number of items included per page.","type":"integer","example":10},"after":{"description":"Cursor param specifying the page (i.e. the next page) of data returned.","type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"},"before":{"description":"Cursor param specifying the page (i.e. the previous page) of data returned.","type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}}},"StringFieldFilterExact":{"description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`","type":"object","properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"additionalProperties":false,"x-examples":{"example-1":{"oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}}},"CursorMetaPage":{"type":"object","properties":{"first":{"description":"URI to the first page","type":"string","format":"path"},"last":{"description":"URI to the last page","type":"string","format":"path"},"next":{"description":"URI to the next page","type":"string","format":"path","nullable":true},"previous":{"description":"URI to the previous page","type":"string","format":"path","nullable":true},"size":{"description":"Requested page size","type":"number","example":10}},"required":["size","next","previous"]},"CursorMeta":{"description":"Pagination metadata.","type":"object","properties":{"page":{"$ref":"#/components/schemas/CursorMetaPage"}},"required":["page"]}},"examples":{"SampleServiceCreatePayload":{"value":{"name":"sample-service","display_name":"Sample Service","description":"This is a sample service","custom_fields":{"owner":"John Appleseed","cost_center":"Research and Development","product_manager":"Jane","jira_project":{"name":"Sample Jira Project","link":"https://my-company.atlassian.net/jira/software/c/projects/SAMPLE"},"dashboard":{"name":"Sample Dashboard","link":"https://my-company.dashboards.com/sample-dashboard"},"git_repo":{"name":"Sample Project","link":"https://github.com/MyCompany/SampleProject"},"slack_channel":{"name":"My Company Channel","link":"https://my-company.slack.com/archives/C000AAAAAAA"}},"labels":{"env":"test"}}},"SampleServicePatchDescriptionPayload":{"value":{"description":"This is a sample service"}},"SampleServiceResponse":{"value":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"sample-service","display_name":"Sample Service","description":"This is a sample service","custom_fields":{"owner":"John Appleseed","cost_center":"Research and Development","product_manager":"Jane","jira_project":{"name":"Sample Jira Project","link":"https://my-company.atlassian.net/jira/software/c/projects/SAMPLE"},"dashboard":{"name":"Sample Dashboard","link":"https://my-company.dashboards.com/sample-dashboard"},"git_repo":{"name":"Sample Project","link":"https://github.com/MyCompany/SampleProject"},"slack_channel":{"name":"My Company Channel","link":"https://my-company.slack.com/archives/C000AAAAAAA"}},"labels":{"env":"test"},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}},"SampleServiceListResponse":{"value":{"data":[{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"sample-service","display_name":"Sample Service","description":"This is a sample service","custom_fields":{"owner":"John Appleseed","cost_center":"Research and Development","product_manager":"Jane","jira_project":{"name":"Sample Jira Project","link":"https://my-company.atlassian.net/jira/software/c/projects/SAMPLE"},"dashboard":{"name":"Sample Dashboard","link":"https://my-company.dashboards.com/sample-dashboard"},"git_repo":{"name":"Sample Project","link":"https://github.com/MyCompany/SampleProject"},"slack_channel":{"name":"My Company Channel","link":"https://my-company.slack.com/archives/C000AAAAAAA"}},"labels":{"env":"test"},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"BuiltInIntegrationsListResponse":{"value":{"data":[{"name":"gateway-manager","display_name":"Gateway Manager","description":"Map Gateway Services from Konnect Gateway Manager to visualize services across multiple control planes.","built_in":true,"version":"v1","authorization":null,"config_schema":{},"visibility":"public","resource_types":{"gateway_svc":{"display_name":"Gateway Service","schema":{"type":"simple","definition":{"control_plane_id":"string","gateway_service_id":"string"}}}},"discovery":{"resource_integration_data_examples":{"gateway_svc":{"control_plane":{"id":"00000000-0000-0000-0000-000000000000","name":"control-plane-name","labels":{"env":"development"}},"gateway_service":{"id":"11111111-1111-1111-1111-111111111111","host":"konghq.com","name":"gateway-service","path":"/example","port":443,"tags":["env:development"],"type":"service","enabled":true,"protocol":"https","cluster_id":"22222222-2222-2222-2222-222222222222","created_at":1577854800,"updated_at":1577854800}}},"ingestion":{"transport":{"type":"kafka"},"scheduler_opt_out":false}},"api_spec_provider":null,"events":{"gateway_svc":{"plugin.added":{"display_name":"Plugin Added","description":"Plugin affecting a gateway service has been added.","events_feed":{"enabled":true}},"plugin.removed":{"display_name":"Plugin Removed","description":"Plugin affecting a gateway service has been removed.","events_feed":{"enabled":true}},"plugin.updated":{"display_name":"Plugin Updated","description":"Plugin affecting a gateway service has been updated.","events_feed":{"enabled":true}}}}},{"name":"analytics","display_name":"Konnect Analytics","description":"Map Reports from Konnect Analytics to monitor the performance and health of your Konnect entities.","built_in":true,"version":"v1","authorization":null,"config_schema":{},"visibility":"public","resource_types":{"report":{"display_name":"Report","schema":{"type":"simple","definition":{"report_id":"string"}}}},"discovery":{"resource_integration_data_examples":{"report":{"id":"312b3c02-8bcc-4945-a4a0-0bed2a55febb","name":"API Responses by Status Code","created_at":"2024-01-01T17:00:00.000Z","created_by":"47b4b910-8c0b-4c20-a5e7-723d45aecbc9","updated_at":"2024-04-15T17:00:00.000Z","description":"API responses by status code"}}},"api_spec_provider":null,"events":null},{"name":"mesh-manager","display_name":"Mesh Manager","description":"Map Mesh Services from Konnect Mesh Manager to visualize how configuration and policies are distributed across mesh deployments in multiple zones.","built_in":true,"version":"v1","authorization":null,"config_schema":{},"visibility":"public","resource_types":{"service_insight":{"display_name":"Mesh Service Insight","schema":{"type":"simple","definition":{"mesh_name":"string","mesh_service_name":"string","global_control_plane_id":"string"}}}},"discovery":{"resource_integration_data_examples":{"service_insight":{"global_control_plane":{"id":"00000000-0000-0000-0000-000000000000","name":"control-plane-name","labels":{"env":"development"}},"mesh_service_insight":{"mesh":"default","name":"service_insight_name","zones":["zone1","zone2"],"status":"online","dataplanes":{"total":2,"online":1,"offline":1}}}}},"api_spec_provider":null,"events":null}],"meta":{"page":{"total":3,"size":100,"number":1}}}},"SampleInstanceCreateAzureDevopsPayload":{"value":{"integration_name":"azure-devops","name":"azure-devops","display_name":"Azure DevOps","description":"Expand Konnect Service Catalog functionality by importing repositories from Azure DevOps.","config":{"organization":"organization_name"}}},"SampleInstanceCreateSonarQubePayload":{"value":{"integration_name":"sonarqube","name":"sonarqube","display_name":"SonarQube","description":"View SonarQube Projects directly in Catalog, giving teams a seamless view of code quality and security insights alongside their services.","config":{}}},"SampleInstanceCreateAzureApiManagementPayload":{"value":{"integration_name":"azure-api-management","name":"azure-api-management","display_name":"Azure API Management","description":"Expand Service Catalog functionality with Azure to visualize API Management services and their APIs.","config":{"subscription_id":"00000000-0000-0000-0000-000000000000"}}},"SampleInstanceCreateDynatracePayload":{"value":{"integration_name":"dynatrace","name":"dynatrace","display_name":"Dynatrace","description":"Ingest SLOs from your Dynatrace environment for a unified view of service health and reliability.","config":{"base_url":"https://id.live.dynatrace.com"}}},"SampleInstanceCreateTraceablePayload":{"value":{"integration_name":"traceable","name":"traceable","display_name":"Traceable","description":"Secure and manage services identified by Traceable through API traffic analysis across your application landscape.","config":{"include_inactive":false}}},"SampleInstanceCreateSlackPayload":{"value":{"integration_name":"slack","name":"slack","display_name":"Slack","description":"Expand Konnect Service Catalog functionality with features from Slack.","config":{}}},"SampleInstanceCreatePagerDutyPayload":{"value":{"integration_name":"pagerduty","name":"pagerduty","display_name":"PagerDuty","description":"Visualize incidents, responsible teams, and on-call engineers through PagerDuty services.","config":{"service_region":"us"}}},"SampleInstanceCreateGitlabPayload":{"value":{"integration_name":"gitlab","name":"gitlab-self-managed","display_name":"GitLab (Self Managed)","description":"Expand Service Catalog functionality with GitLab to view your repository's recent merge requests, contributors, and programming languages.","config":{"base_url":"https://gitlab.my-company.com/api/v4"}}},"SampleInstanceCreateGithubPayload":{"value":{"integration_name":"github","name":"github","display_name":"Github","description":"Sync with GitHub to view repository details, including recent pull requests, contributors, and programming languages.","config":{}}},"SampleInstanceCreateDatadogPayload":{"value":{"integration_name":"datadog","name":"datadog","display_name":"Datadog","description":"Gain visibility into your infrastructure with Datadog dashboards and monitors that are relevant to your services.","config":{"datadog_region":"US_1","datadog_webhook_name":"konnect-service-catalog"}}},"SampleInstanceCreateSwaggerHubPayload":{"value":{"integration_name":"swaggerhub","name":"swaggerhub-internal","display_name":"SwaggerHub (Internal)","description":"Swaggerhub account which hosts internal APIs only.","config":{}}},"SampleInstanceUpdateSwaggerHubPayload":{"value":{"name":"swaggerhub-internal","display_name":"SwaggerHub (Internal)","description":"Swaggerhub account which hosts internal APIs only.","config":{}}},"SampleInstanceSwaggerHubResponse":{"value":{"id":"e0f2388b-2efe-42a3-a9e4-86f12d3e8c77","integration":{"name":"swaggerhub","display_name":"SwaggerHub"},"name":"swaggerhub-internal","display_name":"SwaggerHub (Internal)","description":"Swaggerhub account which hosts internal APIs only.","config":{},"authorized":false,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}},"SampleListInstancesResponse":{"value":{"data":[{"id":"e0f2388b-2efe-42a3-a9e4-86f12d3e8c77","integration":{"name":"swaggerhub","display_name":"SwaggerHub"},"name":"swaggerhub-internal","display_name":"SwaggerHub (Internal)","description":"Swaggerhub account which hosts internal APIs only.","authorized":false,"config":{},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"},{"id":"da715411-0393-4dc7-b711-33250e7658f3","integration":{"name":"gateway-manager","display_name":"Gateway Manager"},"name":"gateway-manager","display_name":"Gateway Manager","description":"Map Gateway Services from Konnect Gateway Manager to visualize services across multiple control planes.","authorized":true,"config":{},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"},{"id":"5581996c-c350-4092-8c71-53f73677ea39","integration":{"name":"analytics","display_name":"Konnect Analytics"},"name":"analytics","display_name":"Konnect Analytics","description":"Map Reports from Konnect Analytics to monitor the performance and health of your Konnect entities.","authorized":true,"config":{},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"},{"id":"c48f3903-c27b-4ffb-aed7-422a911452de","integration":{"name":"mesh-manager","display_name":"Mesh Manager"},"name":"mesh-manager","display_name":"Mesh Manager","description":"Map Mesh Services from Konnect Mesh Manager to visualize how configuration and policies are distributed across mesh deployments in multiple zones.","authorized":true,"config":{},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}],"meta":{"page":{"total":4,"size":100,"number":1}}}},"SampleCreateTraceableMultiKeyAuthPayload":{"value":{"type":"multi_key_auth","config":{"headers":[{"name":"authorization","key":"platform-api-token"}]}}},"SampleCreateDatadogMultiKeyAuthPayload":{"value":{"type":"multi_key_auth","config":{"headers":[{"name":"DD-API-KEY","key":"datadaog-api-key"},{"name":"DD-APPLICATION-KEY","key":"datadaog-application-key"}]}}},"SampleCreateSwaggerHubMultiKeyAuthPayload":{"value":{"type":"multi_key_auth","config":{"headers":[{"name":"authorization","key":"swaggerhub-api-key"}]}}},"SampleCreateSwaggerHubMultiKeyAuthResponse":{"value":{"id":"4f535923-ec24-456c-b4e5-e67f65c8c208","type":"multi_key_auth","missing_permissions":[],"tainted":false,"expires_at":null,"created_at":"2022-11-04T20:10:06.927Z","integration_instance":{"id":"e0f2388b-2efe-42a3-a9e4-86f12d3e8c77","name":"swaggerhub-internal","display_name":"SwaggerHub (Internal)"}}},"SampleCreateAWSRoleDelegationAuthPayload":{"value":{"type":"aws_role_delegation","config":{"role_arn":"arn:aws:iam::084735895545:role/KonnectServiceCatalogRole"}}},"SampleCreateAWSRoleDelegationAuthResponse":{"value":{"id":"4f535923-ec24-456c-b4e5-e67f65c8c208","type":"aws_role_delegation","missing_permissions":[],"tainted":false,"expires_at":null,"created_at":"2022-11-04T20:10:06.927Z","integration_instance":{"id":"e0f2388b-2efe-42a3-a9e4-86f12d3e8c77","name":"swaggerhub-internal","display_name":"SwaggerHub (Internal)"},"config":{"role_arn":"arn:aws:iam::084735895545:role/KonnectServiceCatalogRole"}}},"SampleCreateDynatraceMultiKeyAuthPayload":{"value":{"type":"multi_key_auth","config":{"headers":[{"name":"authorization","key":"dynatrace-api-key"}]}}},"SampleCreateDynatraceMultiKeyAuthResponse":{"value":{"id":"88c58c29-ff7d-4913-b3d7-8affc279dd56","type":"multi_key_auth","missing_permissions":[],"tainted":false,"expires_at":null,"created_at":"2022-11-04T20:10:06.927Z","integration_instance":{"id":"70ecc595-4280-4872-8b80-87b2e57dba3f","name":"dynatrace","display_name":"Dynatrace"}}},"SampleCreateAzureDevopsMultiKeyAuthPayload":{"value":{"type":"multi_key_auth","config":{"headers":[{"name":"authorization","key":"azure-devops-personal-access-token"}]}}},"SampleCreateAzureDevopsMultiKeyAuthResponse":{"value":{"id":"7c91b6d3-8e2f-4e2a-9a53-f3b47eac912b","type":"multi_key_auth","missing_permissions":[],"tainted":false,"expires_at":null,"created_at":"2024-07-18T15:42:29.314Z","integration_instance":{"id":"b4f3d2c9-7a25-43bb-8c47-d7bfa2f91a8e","name":"azure-devops","display_name":"Azure DevOps"}}},"SampleCreateSonarQubeMultiKeyAuthPayload":{"value":{"type":"multi_key_auth","config":{"headers":[{"name":"authorization","key":"sonarqube-api-key"}]}}},"SampleCreateSonarQubeMultiKeyAuthResponse":{"value":{"id":"1a048e2f-bb24-49b9-bcb3-8a4855cb4d44","type":"multi_key_auth","missing_permissions":[],"tainted":false,"expires_at":null,"created_at":"2022-11-04T20:10:06.927Z","integration_instance":{"id":"f0f2725e-051d-48fd-a63f-e1e76d5fec34","name":"sonarqube","display_name":"SonarQube"}}},"AzureApiManagementAuthConfigResponse":{"value":{"id":"2b7e1516-28ae-4d6c-8c2f-1e2b3c4d5e6f","type":"oauth","missing_permissions":[],"tainted":false,"expires_at":null,"created_at":"2022-11-04T20:10:06.927Z","integration_instance":{"id":"3c9e2f1a-4b5d-6e7f-8a9b-0c1d2e3f4a5b","name":"azure-api-management","display_name":"Azure API Management"}}},"GitLabSelfManagedAuthConfigPayload":{"value":{"type":"oauth","client_id":"767b05381bc6a4bbffb4473e06bec7ecf009d0c16afb7214acda33026b6af089","client_secret":"gloas-0bf0372129935e5f7cecbaba259336617c8fe9243f3adb0d6562775ebac21086","authorization_endpoint":"http://gitlab.my-company.com/oauth/authorize","token_endpoint":"http://gitlab.my-company.com/oauth/token"}},"GitLabSelfManagedAuthConfigResponse":{"value":{"type":"oauth","client_id":"767b05381bc6a4bbffb4473e06bec7ecf009d0c16afb7214acda33026b6af089","authorization_endpoint":"http://gitlab.my-company.com/oauth/authorize","token_endpoint":"http://gitlab.my-company.com/oauth/token"}},"ResourceInitializeResponse":{"value":{"id":"1Kff05PZlexINWmG","name":null,"integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"da715411-0393-4dc7-b711-33250e7658f3","name":"gateway-manager","display_name":"Gateway Manager"}},"type":"gateway_svc","config":{"control_plane_id":"ea270fcd-afb4-4209-a3d0-d4151364816d","gateway_service_id":"f84b2edb-aef7-4486-af7d-8829a428e94c"},"integration_data":null,"archived":false,"service_associations":0,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}},"ResourceFetchGwsResponse":{"value":{"id":"rQIGLHo1vhgy5VYb","name":"my-gateway-service","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"da715411-0393-4dc7-b711-33250e7658f3","name":"gateway-manager","display_name":"Gateway Manager"}},"type":"gateway_svc","config":{"control_plane_id":"028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e","gateway_service_id":"dbba7bb2-eded-4668-b662-b8bb57684baf"},"integration_data":{"control_plane":{"id":"028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e","name":"serverless-default","config":{"auth_type":"pinned_client_certs","proxy_urls":[],"cluster_type":"CLUSTER_TYPE_SERVERLESS","cloud_gateway":false,"telemetry_endpoint":"https://26e2775daa.us.tp0.my-company.com","control_plane_endpoint":"https://26e2775daa.us.cp0.my-company.com"},"labels":{},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","description":"This is your serverless gateway control plane. It is the easiest way to get started with the Konnect Gateway."},"gateway_service":{"id":"dbba7bb2-eded-4668-b662-b8bb57684baf","url":"","host":"cloud.my-company.com","name":"my-gateway-service","path":"/us/gateway-manager/028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e/gateway-services/create","port":443,"tags":[],"enabled":true,"retries":5,"protocol":"https","created_at":1751465789148,"tls_verify":null,"updated_at":null,"read_timeout":60000,"write_timeout":60000,"connect_timeout":60000,"tls_verify_depth":null}},"archived":false,"service_associations":0,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}},"ResourcesListResponse":{"value":{"data":[{"id":"rQIGLHo1vhgy5VYb","name":"my-gateway-service","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"da715411-0393-4dc7-b711-33250e7658f3","name":"gateway-manager","display_name":"Gateway Manager"}},"type":"gateway_svc","config":{"control_plane_id":"028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e","gateway_service_id":"dbba7bb2-eded-4668-b662-b8bb57684baf"},"integration_data":{"control_plane":{"id":"028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e","name":"serverless-default","config":{"auth_type":"pinned_client_certs","proxy_urls":[],"cluster_type":"CLUSTER_TYPE_SERVERLESS","cloud_gateway":false,"telemetry_endpoint":"https://26e2775daa.us.tp0.my-company.com","control_plane_endpoint":"https://26e2775daa.us.cp0.my-company.com"},"labels":{},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","description":"This is your serverless gateway control plane. It is the easiest way to get started with the Konnect Gateway."},"gateway_service":{"id":"dbba7bb2-eded-4668-b662-b8bb57684baf","url":"","host":"cloud.my-company.com","name":"my-gateway-service","path":"/us/gateway-manager/028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e/gateway-services/create","port":443,"tags":[],"enabled":true,"retries":5,"protocol":"https","created_at":1751465789148,"tls_verify":null,"updated_at":null,"read_timeout":60000,"write_timeout":60000,"connect_timeout":60000,"tls_verify_depth":null}},"archived":false,"service_associations":0,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"},{"id":"99cNJnEmixifUUpt","name":"Sample API 1.0.0","integration":{"name":"swaggerhub","display_name":"SwaggerHub","instance":{"id":"e0f2388b-2efe-42a3-a9e4-86f12d3e8c77","name":"swaggerhub-internal","display_name":"SwaggerHub (Internal)"}},"binding":"swaggerhub_api_version","type":"swaggerhub_api_version","config":{"api":"Sample","owner":"api-owner","version":"1.0.0"},"integration_data":{"name":"Sample","tags":[],"owner":"api-owner","version":"1.0.0","properties":{"url":"https://api.swaggerhub.com/apis/api-owner/Sample/1.0.0","X-Private":"false","X-Version":"1.0.0","X-CreateBy":"","X-Modified":"2025-04-28T20:57:03Z","X-Versions":"1.0.0","X-Published":"false","X-OASVersion":"3.0.0","X-Notifications":"true"},"description":"The API for a sample project"},"archived":false,"service_associations":0,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}],"meta":{"page":{"size":2,"next":"/servicehub/v1/resources?page[size]=2&page[after]=CChwKiIxLSBscUg9KisFRwtOBVVBQ1pTPh8kIhVWHGwmFkA1ERxaLlMuRSEDf3sBcBRmfmJ6ZmZyEH98UGpsdFQEQBhiDW9DC10qTyYuAhhCbHhRWjIRHFo3QCZVNgN_e1IzRXF_cDoqODQhbHFIbzl8M34tYBJrQCkCA2Y7DWUaKQ","previous":null,"first":"/servicehub/v1/resources?page[size]=2"}}}},"ResourceArchivePayload":{"value":{"archived":true}},"CreateMappingByResourceIDPayload":{"value":{"service":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","resource":"rQIGLHo1vhgy5VYb"}},"CreateMappingByResourceConfigPayload":{"value":{"service":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","resource":{"integration_instance":"da715411-0393-4dc7-b711-33250e7658f3","type":"gateway_svc","config":{"control_plane_id":"028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e","gateway_service_id":"dbba7bb2-eded-4668-b662-b8bb57684baf"}}}},"ResourceMappingResponse":{"value":{"id":"b1460dbc-1490-42ae-b9cf-b2fe479ebde5","resource":{"id":"rQIGLHo1vhgy5VYb","name":"my-gateway-service","type":"gateway_svc","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"da715411-0393-4dc7-b711-33250e7658f3","name":"gateway-manager","display_name":"Gateway Manager"}},"config":{"control_plane_id":"028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e","gateway_service_id":"dbba7bb2-eded-4668-b662-b8bb57684baf"}},"service":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"sample-service","display_name":"Sample Service"},"created_at":"2022-11-04T20:10:06.927Z"}},"ResourceMappingListResponse":{"value":{"data":[{"id":"b1460dbc-1490-42ae-b9cf-b2fe479ebde5","resource":{"id":"rQIGLHo1vhgy5VYb","name":"my-gateway-service","type":"gateway_svc","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"da715411-0393-4dc7-b711-33250e7658f3","name":"gateway-manager","display_name":"Gateway Manager"}},"config":{"control_plane_id":"028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e","gateway_service_id":"dbba7bb2-eded-4668-b662-b8bb57684baf"}},"service":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"sample-service","display_name":"Sample Service"},"created_at":"2022-11-04T20:10:06.927Z"}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"ServiceResourcesResponse":{"value":{"data":[{"id":"rQIGLHo1vhgy5VYb","name":"my-gateway-service","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"da715411-0393-4dc7-b711-33250e7658f3","name":"gateway-manager","display_name":"Gateway Manager"}},"type":"gateway_svc","config":{"control_plane_id":"028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e","gateway_service_id":"dbba7bb2-eded-4668-b662-b8bb57684baf"},"integration_data":{"control_plane":{"id":"028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e","name":"serverless-default","config":{"auth_type":"pinned_client_certs","proxy_urls":[],"cluster_type":"CLUSTER_TYPE_SERVERLESS","cloud_gateway":false,"telemetry_endpoint":"https://26e2775daa.us.tp0.my-company.com","control_plane_endpoint":"https://26e2775daa.us.cp0.my-company.com"},"labels":{},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","description":"This is your serverless gateway control plane. It is the easiest way to get started with the Konnect Gateway."},"gateway_service":{"id":"dbba7bb2-eded-4668-b662-b8bb57684baf","url":"","host":"cloud.my-company.com","name":"my-gateway-service","path":"/us/gateway-manager/028bcd27-e0f7-46bd-ad9f-e7a6dd7d5a8e/gateway-services/create","port":443,"tags":[],"enabled":true,"retries":5,"protocol":"https","created_at":1751465789148,"tls_verify":null,"updated_at":null,"read_timeout":60000,"write_timeout":60000,"connect_timeout":60000,"tls_verify_depth":null}},"archived":false,"service_associations":0,"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}],"meta":{"page":{"number":1,"size":100,"total":1}}}},"ListCriteriaTemplatesResponse":{"value":{"data":[{"name":"gateway_manager_error_rate","display_name":"Gateway Service Error Rate","category":"Observability","template_string":"Error rate is lower than {{ threshold }}% over {{ relative_window }}","installed":true,"integration_name":"gateway-manager","schema":{"type":"json_schema","definition":{"type":"object","required":["threshold","relative_window"],"properties":{"threshold":{"type":"number","maximum":100,"minimum":0},"relative_window":{"enum":["15m","1h","6h","12h","24h","7d","current_week","previous_week","30d","current_month","previous_month"],"type":"string"}}}},"required_integration_capability":null},{"name":"on_call_engineer_assigned","display_name":"On Call Engineer Assigned","category":"Incident Management","template_string":"Has an on call engineer assigned to the service","installed":true,"integration_name":null,"schema":null,"required_integration_capability":"on_call_provider"}],"meta":{"page":{"total":2,"size":100,"number":1}}}},"ListScorecardTemplatesResponse":{"value":{"data":[{"name":"kong_best_practices","display_name":"Kong Best Practices","description":"Best practices that we encourage users to follow when using other Konnect applications.","criteria":[{"template_name":"gateway_manager_error_rate","template_parameters":{"relative_window":"30d"},"integration":"gateway_manager","section_name":"Gateway Observability"},{"template_name":"gateway_manager_response_latency","template_parameters":{"metric":"response_latency_p95","relative_window":"30d"},"integration":"gateway_manager","section_name":"Gateway Observability"},{"template_name":"gateway_manager_has_plugin","template_parameters":{},"integration":"gateway_manager","section_name":"Plugin Enforcement"}]},{"name":"service_documentation","display_name":"Service Documentation","description":"Ensures that your services are well-documented with ownership information, documentation files, and API specs.","criteria":[{"template_name":"has_service_docs","template_parameters":{"min_docs":1},"integration":null,"section_name":"Service Documentation"},{"template_name":"has_api_specs","template_parameters":{"min_specs":1},"integration":null,"section_name":"API Documentation"},{"template_name":"lint_api_specs","template_parameters":{"rulesets":["oas:recommended"],"include_warnings":false},"integration":null,"section_name":"API Documentation"}]}],"meta":{"page":{"total":2,"size":100,"number":1}}}},"CreateScorecardPayload":{"value":{"name":"Kong Best Practices","description":"Best practices that we encourage users to follow when using other Konnect applications.","scorecard_template":"kong_best_practices","criteria":[{"enabled":true,"template_name":"gateway_manager_error_rate","template_parameters":{"relative_window":"30d","threshold":10},"section_name":"Gateway Observability"},{"enabled":true,"template_name":"gateway_manager_response_latency","template_parameters":{"metric":"response_latency_p95","relative_window":"30d","threshold":30},"section_name":"Gateway Observability"},{"enabled":true,"template_name":"gateway_manager_has_plugin","template_parameters":{"category":"Authentication"},"section_name":"Plugin Enforcement"}],"entity_selector":{"selector":"all","selector_parameters":null}}},"UpdateScorecardPayload":{"value":{"name":"Kong Best Practices","description":"Best practices that we encourage users to follow when using other Konnect applications.","scorecard_template":"kong_best_practices","criteria":[{"enabled":true,"template_name":"gateway_manager_error_rate","template_parameters":{"relative_window":"30d","threshold":10},"section_name":"Gateway Observability"},{"enabled":true,"template_name":"gateway_manager_response_latency","template_parameters":{"metric":"response_latency_p95","relative_window":"30d","threshold":30},"section_name":"Gateway Observability"},{"enabled":true,"template_name":"gateway_manager_has_plugin","template_parameters":{"category":"Authentication"},"section_name":"Plugin Enforcement"}],"entity_selector":{"selector":"all","selector_parameters":null}}},"FetchScorecardResponse":{"value":{"id":"4e74159d-3d56-435a-920e-6ddb9ffce829","name":"Kong Best Practices","description":"Best practices that we encourage users to follow when using other Konnect applications.","score":null,"entity_selector":{"selector":"all","selector_parameters":null},"scorecard_template":"kong_best_practices","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","criteria":[{"id":"be228fb7-c492-4d5f-b933-6666a33373a8","name":null,"scorecard_id":"4e74159d-3d56-435a-920e-6ddb9ffce829","integration":"gateway-manager","enabled":true,"template_name":"gateway_manager_error_rate","template_parameters":{"threshold":10,"relative_window":"30d"},"section_name":"Gateway Observability","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"},{"id":"5ea2ec85-73a1-46ed-9c2c-6f2b7a66c716","name":null,"scorecard_id":"4e74159d-3d56-435a-920e-6ddb9ffce829","integration":"gateway-manager","enabled":true,"template_name":"gateway_manager_response_latency","template_parameters":{"metric":"response_latency_p95","threshold":30,"relative_window":"30d"},"section_name":"Gateway Observability","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"},{"id":"ff262fb9-2493-4c8a-9288-211ce0802be6","name":null,"scorecard_id":"4e74159d-3d56-435a-920e-6ddb9ffce829","integration":"gateway-manager","enabled":true,"template_name":"gateway_manager_has_plugin","template_parameters":{"category":"Authentication"},"section_name":"Plugin Enforcement","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}]}},"ListScorecardResponse":{"value":{"data":[{"id":"4e74159d-3d56-435a-920e-6ddb9ffce829","name":"Kong Best Practices","description":"Best practices that we encourage users to follow when using other Konnect applications.","score":{"value":"67%","raw_value":66.667},"entity_selector":{"selector":"all","selector_parameters":null},"scorecard_template":"kong_best_practices","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"ListScorecardServicesResponse":{"value":{"data":[{"id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","name":"sample-service","description":"This is a sample service","display_name":"Sample Service","labels":{"env":"test"},"resources":[{"integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"da715411-0393-4dc7-b711-33250e7658f3","name":"gateway-manager","display_name":"Gateway Manager"}},"id":"rQIGLHo1vhgy5VYb"}],"custom_fields":{"owner":"John Appleseed","cost_center":"Research and Development","product_manager":"Jane","jira_project":{"name":"Sample Jira Project","link":"https://my-company.atlassian.net/jira/software/c/projects/SAMPLE"},"dashboard":{"name":"Sample Dashboard","link":"https://my-company.dashboards.com/sample-dashboard"},"git_repo":{"name":"Sample Project","link":"https://github.com/MyCompany/SampleProject"},"slack_channel":{"name":"My Company Channel","link":"https://my-company.slack.com/archives/C000AAAAAAA"}},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","score":{"value":"67%","raw_value":66.667}}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"ListScorecardCriteriaResponse":{"value":{"data":[{"id":"be228fb7-c492-4d5f-b933-6666a33373a8","name":null,"scorecard_id":"4e74159d-3d56-435a-920e-6ddb9ffce829","integration":"gateway-manager","enabled":true,"template_name":"gateway_manager_error_rate","template_parameters":{"threshold":10,"relative_window":"30d"},"section_name":"Gateway Observability","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","evaluation":{"num_services_passing":1,"passing_services_count":1}},{"id":"5ea2ec85-73a1-46ed-9c2c-6f2b7a66c716","name":null,"scorecard_id":"4e74159d-3d56-435a-920e-6ddb9ffce829","integration":"gateway-manager","enabled":true,"template_name":"gateway_manager_response_latency","template_parameters":{"metric":"response_latency_p95","threshold":30,"relative_window":"30d"},"section_name":"Gateway Observability","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","evaluation":{"num_services_passing":1,"passing_services_count":1}},{"id":"ff262fb9-2493-4c8a-9288-211ce0802be6","name":null,"scorecard_id":"4e74159d-3d56-435a-920e-6ddb9ffce829","integration":"gateway-manager","enabled":true,"template_name":"gateway_manager_has_plugin","template_parameters":{"category":"Authentication"},"section_name":"Plugin Enforcement","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","evaluation":{"num_services_passing":0,"passing_services_count":0}}],"meta":{"page":{"total":3,"size":100,"number":1}}}},"ListScorecardCriteriaServicesResponse":{"value":{"data":[{"id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","name":"sample-service","description":"This is a sample service","display_name":"Sample Service","labels":{"env":"test"},"resources":[{"integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"da715411-0393-4dc7-b711-33250e7658f3","name":"gateway-manager","display_name":"Gateway Manager"}},"id":"rQIGLHo1vhgy5VYb"}],"custom_fields":{"owner":"John Appleseed","cost_center":"Research and Development","product_manager":"Jane","jira_project":{"name":"Sample Jira Project","link":"https://my-company.atlassian.net/jira/software/c/projects/SAMPLE"},"dashboard":{"name":"Sample Dashboard","link":"https://my-company.dashboards.com/sample-dashboard"},"git_repo":{"name":"Sample Project","link":"https://github.com/MyCompany/SampleProject"},"slack_channel":{"name":"My Company Channel","link":"https://my-company.slack.com/archives/C000AAAAAAA"}},"created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","evaluation":{"is_passing":true,"evaluation_context":{"raw_value":{"map":{"rQIGLHo1vhgy5VYb":{"details":{"raw_value":0,"display_text":"0%"},"relation":{"id":"rQIGLHo1vhgy5VYb","name":"my-gateway-service"},"is_passing":true}},"instance":"criteria_result_relation_map","relation":"resource"},"display_text":"1 out of 1 gateway services passing error rate check"},"evaluation_error":null,"successfully_evaluated_at":"2025-07-02T15:48:07.665Z","attempted_at":"2025-07-02T15:48:07.663Z","created_at":"2025-07-02T15:20:07.262Z"}}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"ListServiceScorecardsResponse":{"value":{"data":[{"id":"4e74159d-3d56-435a-920e-6ddb9ffce829","name":"Kong Best Practices","description":"Best practices that we encourage users to follow when using other Konnect applications.","score":{"value":"67%","raw_value":66.667},"entity_selector":{"selector":"all","selector_parameters":null},"scorecard_template":"kong_best_practices","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z"}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"FetchServiceScorecardResponse":{"value":{"id":"4e74159d-3d56-435a-920e-6ddb9ffce829","name":"Kong Best Practices","description":"Best practices that we encourage users to follow when using other Konnect applications.","score":{"value":"67%","raw_value":66.667},"entity_selector":{"selector":"all","selector_parameters":null},"scorecard_template":"kong_best_practices","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","criteria":[{"id":"be228fb7-c492-4d5f-b933-6666a33373a8","scorecard_id":"4e74159d-3d56-435a-920e-6ddb9ffce829","integration":"gateway-manager","enabled":true,"template_name":"gateway_manager_error_rate","template_parameters":{"threshold":10,"relative_window":"30d"},"section_name":"Gateway Observability","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","evaluation":{"is_passing":true,"evaluation_context":{"raw_value":{"map":{"rQIGLHo1vhgy5VYb":{"details":{"raw_value":0,"display_text":"0%"},"relation":{"id":"rQIGLHo1vhgy5VYb","name":"my-gateway-service"},"is_passing":true}},"instance":"criteria_result_relation_map","relation":"resource"},"display_text":"1 out of 1 gateway services passing error rate check"},"evaluation_error":null,"successfully_evaluated_at":"2025-07-02T16:02:04.894Z","attempted_at":"2025-07-02T16:02:04.892Z","created_at":"2025-07-02T15:20:07.262Z"}},{"id":"5ea2ec85-73a1-46ed-9c2c-6f2b7a66c716","scorecard_id":"4e74159d-3d56-435a-920e-6ddb9ffce829","integration":"gateway-manager","enabled":true,"template_name":"gateway_manager_response_latency","template_parameters":{"metric":"response_latency_p95","threshold":30,"relative_window":"30d"},"section_name":"Gateway Observability","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","evaluation":{"is_passing":true,"evaluation_context":{"raw_value":{"map":{"rQIGLHo1vhgy5VYb":{"details":{"raw_value":null,"display_text":"No data"},"relation":{"id":"rQIGLHo1vhgy5VYb","name":"my-gateway-service"},"is_passing":true}},"instance":"criteria_result_relation_map","relation":"resource"},"display_text":"1 out of 1 gateway services passing latency check"},"evaluation_error":null,"successfully_evaluated_at":"2025-07-02T16:02:04.780Z","attempted_at":"2025-07-02T16:02:04.779Z","created_at":"2025-07-02T15:20:05.965Z"}},{"id":"ff262fb9-2493-4c8a-9288-211ce0802be6","scorecard_id":"4e74159d-3d56-435a-920e-6ddb9ffce829","integration":"gateway-manager","enabled":true,"template_name":"gateway_manager_has_plugin","template_parameters":{"category":"Authentication"},"section_name":"Plugin Enforcement","created_at":"2022-11-04T20:10:06.927Z","updated_at":"2022-11-04T20:10:06.927Z","evaluation":{"is_passing":false,"evaluation_context":{"raw_value":{"map":{"rQIGLHo1vhgy5VYb":{"details":{"raw_value":0,"display_text":"0 plugins installed"},"relation":{"id":"rQIGLHo1vhgy5VYb","name":"my-gateway-service"},"is_passing":false}},"instance":"criteria_result_relation_map","relation":"resource"},"display_text":"0 out of 1 gateway services passing plugin check"},"evaluation_error":null,"successfully_evaluated_at":"2025-07-02T16:02:04.839Z","attempted_at":"2025-07-02T16:02:04.839Z","created_at":"2025-07-02T15:20:05.786Z"}}]}},"SampleServiceApiMappingResponse":{"value":{"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","api_id":"e0928050-20d0-448f-947d-624d9901947e","created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z"}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"CreateCatalogServiceRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogService"},"examples":{"Service":{"$ref":"#/components/examples/SampleServiceCreatePayload"}}}}},"UpdateCatalogServiceRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogService"},"examples":{"Service":{"$ref":"#/components/examples/SampleServicePatchDescriptionPayload"}}}}},"CreateIntegrationInstanceRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationInstance"},"examples":{"SwaggerHub":{"$ref":"#/components/examples/SampleInstanceCreateSwaggerHubPayload"},"Datadog":{"$ref":"#/components/examples/SampleInstanceCreateDatadogPayload"},"Github":{"$ref":"#/components/examples/SampleInstanceCreateGithubPayload"},"Gitlab":{"$ref":"#/components/examples/SampleInstanceCreateGitlabPayload"},"PagerDuty":{"$ref":"#/components/examples/SampleInstanceCreatePagerDutyPayload"},"Slack":{"$ref":"#/components/examples/SampleInstanceCreateSlackPayload"},"Traceable":{"$ref":"#/components/examples/SampleInstanceCreateTraceablePayload"},"Dynatrace":{"$ref":"#/components/examples/SampleInstanceCreateDynatracePayload"},"SonarQube":{"$ref":"#/components/examples/SampleInstanceCreateSonarQubePayload"},"AzureApiManagement":{"$ref":"#/components/examples/SampleInstanceCreateAzureApiManagementPayload"},"AzureDevops":{"$ref":"#/components/examples/SampleInstanceCreateAzureDevopsPayload"}}}}},"UpdateIntegrationInstanceRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationInstance"},"examples":{"SwaggerHub":{"$ref":"#/components/examples/SampleInstanceUpdateSwaggerHubPayload"}}}}},"CreateIntegrationInstanceAuthCredentialRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationInstanceAuthCredential"},"examples":{"SwaggerHub":{"$ref":"#/components/examples/SampleCreateSwaggerHubMultiKeyAuthPayload"},"Datadog":{"$ref":"#/components/examples/SampleCreateDatadogMultiKeyAuthPayload"},"Traceable":{"$ref":"#/components/examples/SampleCreateTraceableMultiKeyAuthPayload"},"AwsApiGateway":{"$ref":"#/components/examples/SampleCreateAWSRoleDelegationAuthPayload"},"Dynatrace":{"$ref":"#/components/examples/SampleCreateDynatraceMultiKeyAuthPayload"},"SonarQube":{"$ref":"#/components/examples/SampleCreateSonarQubeMultiKeyAuthPayload"},"azureDevops":{"$ref":"#/components/examples/SampleCreateAzureDevopsMultiKeyAuthPayload"}}}}},"UpsertIntegrationInstanceAuthConfigRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertIntegrationInstanceAuthConfig"},"examples":{"GitLab Self Managed":{"$ref":"#/components/examples/GitLabSelfManagedAuthConfigPayload"}}}}},"UpdateCatalogResourceRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogResource"},"examples":{"Unarchive":{"$ref":"#/components/examples/ResourceArchivePayload"}}}}},"CreateCatalogResourceMappingRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogResourceMapping"},"examples":{"Resource ID":{"$ref":"#/components/examples/CreateMappingByResourceIDPayload"},"Resource Config":{"$ref":"#/components/examples/CreateMappingByResourceConfigPayload"}}}}},"CreateScorecardRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateScorecard"},"examples":{"Scorecard":{"$ref":"#/components/examples/CreateScorecardPayload"}}}}},"UpdateScorecardRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScorecard"},"examples":{"Scorecard":{"$ref":"#/components/examples/UpdateScorecardPayload"}}}}},"CreateCatalogServiceApiMappingBody":{"description":"Request body schema for creating a new API mapping for catalog service.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"api_id":{"description":"The ID of the API Entity to map.","type":"string","format":"uuid"}},"additionalProperties":false,"required":["api_id"]}}}}},"responses":{"CatalogServiceResponse":{"description":"A response containing a single service object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogService"},"examples":{"Service":{"$ref":"#/components/examples/SampleServiceResponse"}}}}},"ListCatalogServicesResponse":{"description":"A paginated list response for a collection of services.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogService"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Services":{"$ref":"#/components/examples/SampleServiceListResponse"}}}}},"ListCatalogIntegrationsResponse":{"description":"A paginated list response for a collection of integrations.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogIntegration"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Built-In Integrations":{"$ref":"#/components/examples/BuiltInIntegrationsListResponse"}}}}},"IntegrationInstanceResponse":{"description":"A response containing a single integration instance object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstance"},"examples":{"SwaggerHub":{"$ref":"#/components/examples/SampleInstanceSwaggerHubResponse"}}}}},"ListIntegrationInstancesResponse":{"description":"A paginated list response for a collection of integration instances.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationInstance"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Integration Instances":{"$ref":"#/components/examples/SampleListInstancesResponse"}}}}},"CatalogResourceMappingResponse":{"description":"A response containing a single catalog resource mapping.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResourceMapping"},"examples":{"Resource Mapping":{"$ref":"#/components/examples/ResourceMappingResponse"}}}}},"ListCatalogResourceMappingsResponse":{"description":"A paginated list response for a collection of catalog resource mappings.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogResourceMapping"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Resource Mappings":{"$ref":"#/components/examples/ResourceMappingListResponse"}}}}},"IntegrationInstanceAuthCredentialResponse":{"description":"A response containing an integration instance auth credential.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstanceAuthCredential"},"examples":{"SwaggerHub":{"$ref":"#/components/examples/SampleCreateSwaggerHubMultiKeyAuthResponse"},"AwsApiGateway":{"$ref":"#/components/examples/SampleCreateAWSRoleDelegationAuthResponse"},"Dynatrace":{"$ref":"#/components/examples/SampleCreateDynatraceMultiKeyAuthResponse"},"SonarQube":{"$ref":"#/components/examples/SampleCreateSonarQubeMultiKeyAuthResponse"},"AzureApiManagement":{"$ref":"#/components/examples/AzureApiManagementAuthConfigResponse"},"azureDevops":{"$ref":"#/components/examples/SampleCreateAzureDevopsMultiKeyAuthResponse"}}}}},"IntegrationInstanceAuthConfigResponse":{"description":"A response containing integration instance auth config.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationInstanceAuthConfig"},"examples":{"GitLab Self Managed":{"$ref":"#/components/examples/GitLabSelfManagedAuthConfigResponse"}}}}},"ListCatalogResourcesResponse":{"description":"A paginated list response for a collection of resources.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogResource"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Resources":{"$ref":"#/components/examples/ResourcesListResponse"}}}}},"ListCatalogServiceResourcesResponse":{"description":"A paginated list response for a collection of resources mapped to a service.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogResource"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Service Resources":{"$ref":"#/components/examples/ServiceResourcesResponse"}}}}},"CatalogResourceResponse":{"description":"A response containing a single resource object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResource"},"examples":{"Resource":{"$ref":"#/components/examples/ResourceFetchGwsResponse"},"Initialized Resource":{"$ref":"#/components/examples/ResourceInitializeResponse"}}}}},"ListCriteriaTemplatesResponse":{"description":"A paginated list response for a collection of criteria templates.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaTemplate"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Criteria Templates":{"$ref":"#/components/examples/ListCriteriaTemplatesResponse"}}}}},"ListScorecardTemplatesResponse":{"description":"A paginated list response for a collection of scorecard templates.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ScorecardTemplate"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Scorecard Templates":{"$ref":"#/components/examples/ListScorecardTemplatesResponse"}}}}},"ListScorecardsResponse":{"description":"A paginated list response for a collection of scorecards.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Scorecard"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Scorecards":{"$ref":"#/components/examples/ListScorecardResponse"}}}}},"ScorecardResponse":{"description":"A response containing a single scorecard.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScorecardWithCriteria"},"examples":{"Scorecard":{"$ref":"#/components/examples/FetchScorecardResponse"}}}}},"ListScorecardCriteriaResponse":{"description":"A paginated list response for a collection of criteria belonging to a scorecard.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ScorecardCriteriaWithEvaluation"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Scorecard Criteria":{"$ref":"#/components/examples/ListScorecardCriteriaResponse"}}}}},"ListCatalogServiceScorecardsResponse":{"description":"A paginated list response for a collection of scorecards targeting a service.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Scorecard"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Service Scorecards":{"$ref":"#/components/examples/ListServiceScorecardsResponse"}}}}},"CatalogServiceScorecardResponse":{"description":"A response containing a scorecard targeting a service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogServiceScorecard"},"examples":{"Service Scorecard":{"$ref":"#/components/examples/FetchServiceScorecardResponse"}}}}},"ListScorecardServicesResponse":{"description":"A paginated list response for a collection of services targeted by a scorecard.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ScorecardService"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Scorecard Services":{"$ref":"#/components/examples/ListScorecardServicesResponse"}}}}},"ListScorecardCriteriaServicesResponse":{"description":"A paginated list response for a collection of services targeted by a scorecard criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ScorecardCriteriaService"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Scorecard Criteria Services":{"$ref":"#/components/examples/ListScorecardCriteriaServicesResponse"}}}}},"CatalogServiceApiMappingResponse":{"description":"A response containing a single catalog service API mapping.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogServiceApiMapping"},"examples":{"Service API Mapping":{"$ref":"#/components/examples/SampleServiceApiMappingResponse"}}}}},"ListCatalogServiceApiMappingsResponse":{"description":"A paginated list response for a collection of catalog service API mappings.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogServiceApiMapping"}}},"additionalProperties":false,"required":["meta","data"]}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"securitySchemes":{"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"}}},"tags":[{"name":"Catalog Services","description":"Create and maintain a centralized catalog of all services running in your organization.\nAdd custom fields and map resources from across your organization to provide a 360-degree overview of your services.\n\nCustom fields allow you to surface key information such as:\n- `Owner`: The person or team responsible for the service\n- `Product Manager`: The person assigned to guide the service's direction for customer success\n- `Jira Project`: The Jira project which represents past, present and future work for the service\n\nResources are discovered from the integrations you use within your organization to create, operate and manage your services.\nMapping the resources relevant to your service will provide a rich view of the service's communication channels, dependencies and more.\nTypes of resources which you can map to a service include:\n- `Code Repositories:` The software project(s) that make up the service\n- `Monitors and Dashboards:` Tools providing visibility into the health and performance of the service\n- `Communication Channels`: Virtual spaces where questions and concerns can be raised about the service\n- `Incident Management Resources`: Alerts setup within your incident management platform to notify individuals regarding issues with the service\n"},{"name":"Catalog Integrations","description":"Integrations are applications, either Konnect-internal or external, which extend the functionality of the Service Catalog.\nInstall and authorize an integration to discover the resources across your organization which support your services.\nMap relevant resources to your services to provide a rich view of cataloged services.\nTo set up and view a list of all the integrations we support please view our [documentation](https://developer.konghq.com/service-catalog/integrations/).\n"},{"name":"Integration Instances","description":"An integration instance represents a specific account of the integration which contains the resources used to manage and support your services.\nSome integrations provide configuration options to customize how it should behave once authorized (see the integration's manifest for details).\nKonnect-internal integrations are built-in and do not need to be installed.\n\nOnce an integration instance is created, authorize the instance to allow the Service Catalog to discover its resources.\nNote that deleting an integration instance is a **destructive** operation.\nWhen an integration instance is deleted, all its resources and mappings will be deleted from the service catalog.\nIn cases where the integration instance's credentials need to be updated, you may re-authorize the instance to retain all currently discovered resources and mappings.\nTo set up and view a list of all the integrations we support, please view our [documentation](https://developer.konghq.com/service-catalog/integrations/).\n"},{"name":"Integration Instance Auth Credentials","description":"Represents the credentials use to authorize an integration instance.\nYou will want to configure the integration instance settings and authorization configuration before authorizing the instance.\nThis will inform the authorization process on how to reach and authorize the account.\nOnce the integration instance is authorized, the system will automatically discover all the relevant resources from the account.\nThe integration instance's auth credentials can be removed or updated while retaining all resources which have already been discovered.\n"},{"name":"Integration Instance Auth Config","description":"A integration instance may need to be provided with an auth config before authorizing the instance.\nTypically an auth config will be required when authorizing against a integration which is hosted within your organization.\nThe integration instance's auth config will inform how the Service Catalog will authorize the integration instance.\nNote that updating the auth config for an instance which is already authorized will **remove the existing credential**, requiring you to re-authorize the instance.\n"},{"name":"Catalog Resources","description":"Resources are entities discovered from integration instances and are intended to be mapped to the relevant services in the catalog.\nOnce a resource has been mapped to a service, a rich view of this resource will be displayed when viewing your service.\n\nAny resources which you would like to ignore and hide can be archived.\nNote that archiving a resource will **remove** any mappings it has to services in the catalog.\n\nYou can create Resources using only the properties required to identify the resource in the third-party system.\nAdditional data will be hydrated if the integration that the Resource is linked to has been provided with authentication credentials.\nResources which have not yet been hydrated may still be mapped to a Catalog Service.\n"},{"name":"Catalog Resource Mappings","description":"Resource mappings represent the link between a resource and a service.\nOnce a resource is mapped to a service, a rich view of the resource will be presented on the service page.\nA resource may be mapped to multiple services, but it cannot be mapped to the same service twice.\nIf a resource mapped to a service is later archived, the resource mapping will be deleted.\n"},{"name":"Catalog Service Resources","description":"Represents all the resources mapped to a specific service.\n"},{"name":"Catalog Resource Services","description":"Represents all the services mapped to a specific resource.\n"},{"name":"Criteria Templates","description":"Several criteria templates are provided to help ensure your services adhere to industry best practices.\nA criteria template is a collection of criteria grouped together to target various categories.\n\nCriteria may require a specific type of integration be installed and authorized.\nFor example, criteria which evaluates the operation performance across incident management may require a integration related to incident management to be installed and authorized.\nLearn more about scorecards by visiting our [documentation](https://developer.konghq.com/service-catalog/scorecards/).\n"},{"name":"Scorecards","description":"A scorecard helps you evaluate services based on its criteria.\nScorecards help you detect issues, like whether there are services in the catalog that don't have an on-call engineer assigned, or if you have GitHub repositories with stale pull requests that aren't getting reviewed or closed.\nFrom the scorecard, you can view details on either a per-service or per-criteria basis.\nLearn more about scorecards by visiting our [documentation](https://developer.konghq.com/service-catalog/scorecards/).\n"},{"name":"Catalog Service API Mappings","description":"Service API mappings represent the link between Service and API entities.\nOnce an API is mapped to a Service, a rich view of the linked APIs will be presented on the APIs tab of the Catalog Service.\nSimilarly, Services mapped to an API will be listed on the API overview page under Catalog.\nAn API may be mapped to multiple services, but it cannot be mapped to the same service twice.\nIf a mapped API is unlinked from a Service, the mapping will be deleted.\n"}],"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
