---
title: "Konnect Service Catalog"
url: "https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-dev-1/versions/d755cd20-1635-4c78-a12c-5f42a75fa20d"
---

# 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/{id}/api-specs":{"parameters":[{"name":"id","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"post":{"operationId":"create-catalog-service-api-spec","summary":"Create API spec","description":"Creates an API spec associated to the given service.","requestBody":{"$ref":"#/components/requestBodies/CreateCatalogServiceApiRequest"},"responses":{"201":{"$ref":"#/components/responses/CatalogServiceApiSpecResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Specs"]},"get":{"operationId":"list-catalog-service-api-specs","summary":"List Catalog Service API Specs","description":"Returns a paginated collection of API Specs for the given service.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogServiceApiSpecFilter"},{"$ref":"#/components/parameters/CatalogServiceApiSpecSort"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogServiceApiSpecsResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Specs"]}},"/catalog-services/{serviceId}/api-specs/preview":{"parameters":[{"name":"serviceId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"post":{"operationId":"preview-catalog-service-api-spec","summary":"Preview API Spec","description":"Previews the contents of an API spec as JSON or YAML.\nSpecify `Accept: application/json` to retrieve the contents as JSON.\nSpecify `Accept: application/yaml` to retrieve the contents as YAML.\nDefaults to JSON format.\n","requestBody":{"$ref":"#/components/requestBodies/PreviewCatalogServiceApiRequest"},"responses":{"200":{"$ref":"#/components/responses/CatalogServiceApiSpecPreviewResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Specs"]}},"/catalog-services/{serviceId}/api-specs/{apiSpecId}":{"parameters":[{"name":"serviceId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}},{"name":"apiSpecId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"get":{"operationId":"fetch-catalog-service-api-spec","summary":"Get an API spec","description":"Returns the API spec for the given service.","responses":{"200":{"$ref":"#/components/responses/CatalogServiceApiSpecResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Specs"]},"patch":{"operationId":"update-catalog-service-api-spec","summary":"Update API Spec","description":"Updates the API spec for the given service.","requestBody":{"$ref":"#/components/requestBodies/UpdateCatalogServiceApiRequest"},"responses":{"200":{"$ref":"#/components/responses/CatalogServiceApiSpecResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Specs"]},"delete":{"operationId":"delete-catalog-service-api-spec","summary":"Delete API Spec","description":"Deletes the API spec for the given service.","responses":{"204":{"description":"API Spec was deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Specs"]}},"/catalog-services/{serviceId}/api-specs/{apiSpecId}/contents":{"parameters":[{"name":"serviceId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}},{"name":"apiSpecId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"get":{"operationId":"fetch-catalog-service-api-spec-contents","summary":"Get an API Spec Contents","description":"Returns the API spec for the given service.\nSpecify `Accept: application/json` to retrieve the contents as JSON.\nSpecify `Accept: application/yaml` to retrieve the contents as YAML.\nDefaults to JSON format.\n","responses":{"200":{"$ref":"#/components/responses/CatalogServiceApiSpecContentResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Service API Specs"]}},"/integrations":{"post":{"operationId":"create-catalog-integration","summary":"Create Integration","description":"Creates a catalog integration.","requestBody":{"$ref":"#/components/requestBodies/CreateCatalogIntegrationRequest"},"responses":{"201":{"$ref":"#/components/responses/CatalogIntegrationResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Catalog 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"]}},"/integrations/{integration}":{"parameters":[{"name":"integration","in":"path","description":"The name of the integration.","required":true,"schema":{"type":"string","example":"jira"}}],"get":{"operationId":"get-catalog-integration","summary":"Get Integration","description":"Gets a catalog integration.","responses":{"200":{"$ref":"#/components/responses/CatalogIntegrationResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Integrations"]},"patch":{"operationId":"update-catalog-integration","summary":"Update Integration","description":"Updates a catalog integration.","requestBody":{"$ref":"#/components/requestBodies/UpdateCatalogIntegrationRequest"},"responses":{"200":{"$ref":"#/components/responses/CatalogIntegrationResponse"},"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 Integrations"]},"delete":{"operationId":"delete-catalog-integration","summary":"Delete Integration","description":"Deletes a catalog integration.","responses":{"204":{"description":"Catalog Integration 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 Integrations"]}},"/integration-instances/{integrationInstanceId}/resources":{"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":"initialize-resource","summary":"Initialize Resource","description":"Initializes a placeholder resource. This operation is typically used in GitOps workflows or other infrastructure-as-code setups where a resource is declared before it is fully discovered.\nThe initialized resource acts as a stub — it contains minimal identifying metadata and does not yet include the full set of attributes typically populated by integration-based discovery.\nAfter initialization, the resource will be automatically hydrated with additional data by catalog integrations responsible for discovering and maintaining its up-to-date state.\nThis API is not intended for direct resource management, but rather for signaling the intent to track a given resource, allowing integrations to take over and populate it asynchronously.\n","requestBody":{"$ref":"#/components/requestBodies/InitializeCatalogResourceRequest"},"responses":{"201":{"$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"]},"put":{"operationId":"upsert-resources","summary":"Upsert Resources","description":"Upserts resources. If a resource with the same `externalId` already exists for the given integration instance, it will be updated; otherwise, a new resource will be created.\nWhen a resource's backing definition in the integration has `integration_data_schema` populated, the `integration_data` value provided for that resource will be validated against `integration_data_schema` during upsert operations.\nWhen a resource's backing definition in the integration has no `integration_data_schema` populated (i.e. null), no validation will be performed on the `integration_data` value provided for that resource.\nThis API is typically used by service catalog integration applications to report discovered resources back to the catalog.\n","requestBody":{"$ref":"#/components/requestBodies/UpsertCatalogResourcesRequest"},"responses":{"200":{"description":"All resources delivered in the payload were ingested successfully."},"202":{"description":"The payload was accepted but a no-op was performed."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Resources"]}},"/integration-instances/{id}/resources/bulk-delete":{"parameters":[{"name":"id","in":"path","description":"The `id` of the integration instance.","required":true,"schema":{"type":"string","example":"3f51fa25-310a-421d-bd1a-007f859021a3"}}],"post":{"operationId":"delete-resources","summary":"Delete Resources","description":"Delete up to 100 resources which belong to the related integration instance.\nThis API is intended only for service catalog integration applications.\n","requestBody":{"$ref":"#/components/requestBodies/DeleteCatalogResourcesRequest"},"responses":{"204":{"description":"Resources deleted successfully."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Catalog Resources"]}},"/scorecards/{id}/schedule-evaluation":{"parameters":[{"name":"id","in":"path","description":"The `id` of the scorecard.","required":true,"schema":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"}}],"post":{"operationId":"schedule-scorecard-evaluation","summary":"Schedule Scorecard Evaluation","description":"Schedules an evaluation of the scorecard selected services.","responses":{"202":{"description":"The scheduling for scorecard evaluation was accepted.\n"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Scorecards"]}},"/integration-instances/{integrationInstanceId}/resource-ingestion":{"parameters":[{"name":"integrationInstanceId","in":"path","description":"The `id` of the integration instance.","required":true,"schema":{"type":"string","example":"004d6d17-d21f-4518-89a2-b9177cb5485c"}}],"put":{"operationId":"schedule-resource-ingestion","summary":"Schedule Resource Ingestion","description":"Schedules a resource ingestion job for the given integration instance.","requestBody":{"$ref":"#/components/requestBodies/ResourceIngestionBody"},"responses":{"200":{"$ref":"#/components/responses/ResourceIngestionResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Resource Ingestion"]},"get":{"operationId":"fetch-resource-ingestion","summary":"Get a Resource Ingestion","description":"Fetches a resource ingestion job for the given integration instance.","responses":{"200":{"$ref":"#/components/responses/ResourceIngestionResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Resource Ingestion"]}},"/resource-actions":{"get":{"operationId":"list-resource-actions","summary":"List Resource Actions","description":"Returns a paginated collection of a resource actions.","parameters":[{"$ref":"#/components/parameters/CursorPageQuery"},{"$ref":"#/components/parameters/ResourceActionFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListResourceActionResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Resource Actions"]}},"/integration-instances/{integrationInstance}/proxy":{"parameters":[{"name":"integrationInstance","in":"path","description":"The `id` of the integration instance.","required":true,"schema":{"type":"string","example":"3321067c-407f-417b-8aac-cd2c5ec92d85"}}],"post":{"operationId":"integration-instance-proxy-request","summary":"Integration Instance Proxy Request","description":"Proxies a request to an external API for the integration instance.","requestBody":{"$ref":"#/components/requestBodies/IntegrationInstanceProxyBody"},"responses":{"400":{"description":"Error response indicating the proxy request could not be sent due to invalid state of the request body or integration instance\n","content":{"application/problem+json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/IntegrationUnauthorizedError"}]},"examples":{"Bad Request":{"$ref":"#/components/examples/BadRequestError"},"Integration Not Authorized":{"$ref":"#/components/examples/IntegrationNotAuthorizedError"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"description":"Not Found","content":{"application/problem+json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/IntegrationNotInstalledError"}]},"examples":{"Not Found":{"$ref":"#/components/examples/NotFoundExample"},"Integration Not Installed":{"$ref":"#/components/examples/IntegrationNotInstalledError"}}}}},"2XX":{"description":"2XX response code returned from the proxied API","headers":{"x-service-hub-integration-proxy":{"schema":{"description":"When `true`, indicates that the response comes from upstream APIs.","type":"boolean"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"3XX":{"description":"3XX response code returned from the proxied API","headers":{"x-service-hub-integration-proxy":{"schema":{"description":"When `true`, indicates that the response comes from upstream APIs.","type":"boolean"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"4XX":{"description":"4XX response code returned from the proxied API","headers":{"x-service-hub-integration-proxy":{"schema":{"description":"When `true`, indicates that the response comes from upstream APIs.","type":"boolean"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"tags":["Integration Instance Proxy"]}},"/integrations/{integration}/system-suggestion-rules":{"parameters":[{"name":"integration","in":"path","description":"Machine name of the integration.","required":true,"schema":{"type":"string","example":"gateway-manager"}}],"get":{"operationId":"list-system-integration-suggestion-rule","summary":"List System Suggestion Rules","description":"Returns a paginated collection of a system defined suggestion rules.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListSystemSuggestionRuleResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Suggestion Rules"]}},"/integrations/{integration}/suggestion-rules":{"parameters":[{"name":"integration","in":"path","description":"Machine name of the integration.","required":true,"schema":{"type":"string","example":"gateway-manager"}}],"post":{"operationId":"create-integration-suggestion-rule","summary":"Create Suggestion Rule","description":"Creates a suggestion rule for the given integration.","requestBody":{"$ref":"#/components/requestBodies/CreateSuggestionRuleBody"},"responses":{"201":{"$ref":"#/components/responses/SuggestionRuleResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Suggestion Rules"]},"get":{"operationId":"list-integration-suggestion-rule","summary":"List Suggestion Rules","description":"Returns a paginated collection of a suggestion rules.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SuggestionRuleFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListSuggestionRuleResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Suggestion Rules"]}},"/integrations/{integration}/suggestion-rules/{suggestionRuleId}":{"parameters":[{"name":"integration","in":"path","description":"Machine name of the integration.","required":true,"schema":{"type":"string","example":"gateway-manager"}},{"name":"suggestionRuleId","in":"path","description":"ID of the suggestion rule.","required":true,"schema":{"type":"string","format":"uuid","example":"22f72bd1-2897-473e-9471-302de3ccf38b"}}],"get":{"operationId":"get-integration-suggestion-rule","summary":"Get a Suggestion Rule","description":"Returns information about a suggestion rule from a given suggestion rule ID.","responses":{"200":{"$ref":"#/components/responses/SuggestionRuleResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Suggestion Rules"]},"put":{"operationId":"update-integration-suggestion-rule","summary":"Update Suggestion Rule","description":"Updates the given suggestion rule.","requestBody":{"$ref":"#/components/requestBodies/CreateSuggestionRuleBody"},"responses":{"200":{"$ref":"#/components/responses/SuggestionRuleResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Suggestion Rules"]},"delete":{"operationId":"delete-integration-suggestion-rule","summary":"Delete Suggestion Rule","description":"Deletes the given suggestion rule.","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Suggestion Rules"]}},"/integrations/{integration}/suggestion-rules/test":{"parameters":[{"name":"integration","in":"path","description":"Machine name of the integration.","required":true,"schema":{"type":"string","example":"gateway-manager"}}],"post":{"operationId":"test-suggestion-rule","summary":"Test a Suggestion Rule Configuration","description":"Test suggestion rule configuration against an integration record.","requestBody":{"$ref":"#/components/requestBodies/CreateTestSuggestionRuleBody"},"responses":{"200":{"$ref":"#/components/responses/TestSuggestionRuleResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Suggestion Rules"]}},"/suggestion-rule-errors":{"get":{"operationId":"list-suggestion-rule-errors","summary":"List Suggestion Rule Errors","description":"Returns a paginated collection of suggestion rule errors.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SuggestionRuleErrorFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListSuggestionRuleErrorResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Suggestion Rule Errors"]}},"/integration-events":{"get":{"operationId":"list-integration-events","summary":"List Integration Events","description":"Returns a paginated collection of integration events.","parameters":[{"$ref":"#/components/parameters/CursorPageQuery"},{"$ref":"#/components/parameters/IntegrationEventsFilter"},{"$ref":"#/components/parameters/IntegrationEventsSort"}],"responses":{"200":{"$ref":"#/components/responses/ListIntegrationEventsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Integration Events"]}},"/integration-instances/{integrationInstance}/integration-events":{"post":{"operationId":"create-integration-events","summary":"Bulk Create Integration Events","description":"Bulk-creates integration events for an integration.","parameters":[{"name":"integrationInstance","in":"path","description":"Machine name of the integration.","required":true,"schema":{"type":"string","example":"gateway-manager"}}],"requestBody":{"$ref":"#/components/requestBodies/CreateIntegrationEventsBody"},"responses":{"202":{"description":"The payload for bulk integration event create was accepted.\n"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Integration Events"]}},"/catalog-services/{serviceId}/integration-events":{"parameters":[{"name":"serviceId","in":"path","description":"ID of the service.","required":true,"schema":{"type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"get":{"operationId":"list-catalog-service-integration-events","summary":"List a catalog service integration Events","description":"Returns a paginated collection of integration events belonging to the given catalog service.","parameters":[{"$ref":"#/components/parameters/CursorPageQuery"},{"$ref":"#/components/parameters/CatalogServiceIntegrationEventsFilter"},{"$ref":"#/components/parameters/IntegrationEventsSort"}],"responses":{"200":{"$ref":"#/components/responses/ListIntegrationEventsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Integration Events"]}},"/catalog-services/{serviceId}/documents":{"parameters":[{"name":"serviceId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}}],"post":{"operationId":"create-catalog-service-document","summary":"Create Service Document","description":"Creates a service document","requestBody":{"$ref":"#/components/requestBodies/CreateServiceDocumentBody"},"responses":{"201":{"$ref":"#/components/responses/CatalogServiceDocumentResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}},"tags":["Catalog Service Documents"]},"get":{"operationId":"list-catalog-service-documents","summary":"List Catalog Service Documents","description":"Returns a paginated collection of documents attached to the given service.","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentContentTypeEnum"}},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogServiceDocumentsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}},"tags":["Catalog Service Documents"]}},"/catalog-services/{serviceId}/documents/{documentId}":{"parameters":[{"name":"serviceId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}},{"name":"documentId","in":"path","description":"The `id` of the document.","required":true,"schema":{"type":"string","example":"7b453ae4-66f5-4530-88b0-0b6e34072325"}}],"get":{"operationId":"fetch-catalog-service-document","summary":"Get a Catalog Service Document","description":"Fetched a service document.","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentFormatContentTypeEnum"}}],"responses":{"200":{"$ref":"#/components/responses/CatalogServiceDocumentResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}},"tags":["Catalog Service Documents"]},"patch":{"operationId":"update-catalog-service-document","summary":"Update Catalog Service Document","description":"Updates a service document.","requestBody":{"$ref":"#/components/requestBodies/UpdateServiceDocumentBody"},"responses":{"200":{"$ref":"#/components/responses/UpdateCatalogServiceDocumentResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}},"tags":["Catalog Service Documents"]},"delete":{"operationId":"delete-catalog-service-document","summary":"Delete Catalog Service Document","description":"Deletes a service document.","responses":{"204":{"description":"Service document was deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}},"tags":["Catalog Service Documents"]}},"/catalog-services/{serviceId}/documents/{documentId}/move":{"parameters":[{"name":"serviceId","in":"path","description":"The `id` of the service.","required":true,"schema":{"type":"string","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}},{"name":"documentId","in":"path","description":"The `id` of the document.","required":true,"schema":{"type":"string","example":"7b453ae4-66f5-4530-88b0-0b6e34072325"}}],"post":{"operationId":"move-catalog-service-document","summary":"Move Catalog Service Document","description":"Moves a service document.","requestBody":{"$ref":"#/components/requestBodies/MoveServiceDocumentBody"},"responses":{"204":{"description":"The service document has been moved"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}},"tags":["Catalog Service Documents"]}},"/suggested-resource-actions":{"get":{"operationId":"list-suggested-resource-action","summary":"List Suggested Resource Actions","description":"Returns a paginated collection of a suggested resource actions.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/SuggestedResourceActionFilter"},{"$ref":"#/components/parameters/SuggestedResourceActionSort"}],"responses":{"200":{"$ref":"#/components/responses/ListSuggestedResourceActionResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Suggested Resource Actions"]}},"/suggested-resource-actions/{suggestedResourceActionId}":{"parameters":[{"name":"suggestedResourceActionId","in":"path","description":"ID of the suggested resource action.","required":true,"schema":{"type":"string","example":"76ca0689-f08e-4c04-b2a6-4c992d89d554"}}],"get":{"operationId":"get-suggested-resource-action","summary":"Get a Suggested Resource Action","description":"Returns information about a suggested resource action.","responses":{"200":{"$ref":"#/components/responses/SuggestedResourceActionResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Suggested Resource Actions"]},"patch":{"operationId":"update-suggested-resource-action","summary":"Update Suggested Resource Action","description":"Updates the given suggested resource.","requestBody":{"$ref":"#/components/requestBodies/UpdateSuggestedResourceActionBody"},"responses":{"200":{"$ref":"#/components/responses/SuggestedResourceActionResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["Suggested Resource Actions"]}},"/vulnerability-scans":{"get":{"operationId":"list-vulnerability-scans","summary":"List Vulnerability Scans","description":"Returns a paginated collection of vulnerability scans.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/VulnerabilityScanFilter"},{"$ref":"#/components/parameters/VulnerabilityScanSort"}],"responses":{"200":{"$ref":"#/components/responses/ListVulnerabilityScansResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]},"post":{"operationId":"create-vulnerability-scan","summary":"Create Vulnerability Scan","description":"Create a vulnerability scan, to be broken down into a set of vulnerabilities.","requestBody":{"$ref":"#/components/requestBodies/CreateVulnerabilityScanBody"},"responses":{"201":{"$ref":"#/components/responses/VulnerabilityScanResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Vulnerabilities"]}},"/vulnerability-scans/{scanId}":{"parameters":[{"name":"scanId","in":"path","description":"ID of the vulnerability scan.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"fetch-vulnerability-scan","summary":"Get a Vulnerability Scan","description":"Returns vulnerability scan by ID.","responses":{"200":{"$ref":"#/components/responses/VulnerabilityScanResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/vulnerability-scans/{scanId}/vulnerabilities":{"parameters":[{"name":"scanId","in":"path","description":"ID of the vulnerability scan.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"list-vulnerability-scan-vulnerabilities","summary":"List Vulnerability Scan Vulnerabilities","description":"Returns a paginated collection of vulnerabilities for a given vulnerability scan.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/VulnerabilityScanVulnerabilityFilter"},{"$ref":"#/components/parameters/VulnerabilitySort"}],"responses":{"200":{"$ref":"#/components/responses/ListVulnerabilityScanVulnerabilitiesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/catalog-services/{serviceId}/vulnerability-scans":{"parameters":[{"name":"serviceId","in":"path","description":"ID of the service.","required":true,"schema":{"type":"string"}}],"get":{"operationId":"list-service-vulnerability-scans","summary":"List Service Vulnerability Scans","description":"Returns a paginated collection of vulnerability scans for a given service.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ServiceVulnerabilityScanFilter"},{"$ref":"#/components/parameters/VulnerabilityScanSort"}],"responses":{"200":{"$ref":"#/components/responses/ListVulnerabilityScansResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/catalog-services/{serviceId}/vulnerability-scans/{scanId}":{"parameters":[{"name":"serviceId","in":"path","description":"ID of the service.","required":true,"schema":{"type":"string"}},{"name":"scanId","in":"path","description":"ID of the vulnerability scan.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"fetch-service-vulnerability-scan","summary":"Get a Service Vulnerability Scan","description":"Returns vulnerability scan, for a given service, by ID.","responses":{"200":{"$ref":"#/components/responses/VulnerabilityScanResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/vulnerabilities":{"get":{"operationId":"list-vulnerabilities","summary":"List Vulnerabilities","description":"Returns a paginated collection of vulnerabilities.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogVulnerabilityFilter"},{"$ref":"#/components/parameters/CatalogVulnerabilitySort"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogVulnerabilitiesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/vulnerabilities/{vulnerabilityId}":{"parameters":[{"name":"vulnerabilityId","in":"path","description":"ID of the vulnerability.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"fetch-vulnerability","summary":"Get Vulnerability","description":"Returns vulnerability by ID.","responses":{"200":{"$ref":"#/components/responses/CatalogVulnerabilityResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/vulnerabilities/{vulnerabilityId}/catalog-services":{"parameters":[{"name":"vulnerabilityId","in":"path","description":"ID of the vulnerability.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"list-vulnerability-services","summary":"List Vulnerability Services","description":"Returns a paginated collection of services for a given vulnerability.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/VulnerabilityServiceSort"},{"$ref":"#/components/parameters/VulnerabilityServiceFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListVulnerabilityServicesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/vulnerabilities/{vulnerabilityId}/instances":{"parameters":[{"name":"vulnerabilityId","in":"path","description":"ID of the vulnerability.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"list-vulnerability-instances","summary":"List Vulnerability Instances","description":"Returns a paginated collection of vulnerability instances for a given vulnerability.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/VulnerabilityInstanceSort"},{"$ref":"#/components/parameters/VulnerabilityInstanceFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListVulnerabilityInstancesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/catalog-services/{serviceId}/vulnerabilities":{"parameters":[{"name":"serviceId","in":"path","description":"ID of the service.","required":true,"schema":{"type":"string"}}],"get":{"operationId":"list-service-vulnerabilities","summary":"List Service Vulnerabilities","description":"Returns a paginated collection of vulnerabilities for a given service.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/ServiceVulnerabilityFilter"},{"$ref":"#/components/parameters/VulnerabilitySort"}],"responses":{"200":{"$ref":"#/components/responses/ListVulnerabilitiesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/catalog-services/{serviceId}/vulnerabilities/{vulnerabilityId}":{"parameters":[{"name":"serviceId","in":"path","description":"ID of the service.","required":true,"schema":{"type":"string"}},{"name":"vulnerabilityId","in":"path","description":"ID of the vulnerability.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"fetch-service-vulnerability","summary":"Get Service Vulnerability","description":"Returns vulnerability instance, for a given service, by ID.","responses":{"200":{"$ref":"#/components/responses/VulnerabilityResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/catalog-services/{serviceId}/vulnerabilities/{vulnerabilityId}/instances":{"parameters":[{"name":"serviceId","in":"path","description":"ID of the service.","required":true,"schema":{"type":"string"}},{"name":"vulnerabilityId","in":"path","description":"ID of the vulnerability.","required":true,"schema":{"type":"string","format":"uuid"}}],"get":{"operationId":"list-service-vulnerability-instances","summary":"List Service Vulnerability Instances","description":"Returns a paginated collection of vulnerability instances for a given service.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/VulnerabilityInstanceSort"},{"$ref":"#/components/parameters/ServiceVulnerabilityInstanceFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListVulnerabilityInstancesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/catalog-services/{serviceId}/vulnerabilities/{vulnerabilityId}/severity":{"parameters":[{"name":"serviceId","in":"path","description":"ID of the service.","required":true,"schema":{"type":"string"}},{"name":"vulnerabilityId","in":"path","description":"ID of the vulnerability.","required":true,"schema":{"type":"string","format":"uuid"}}],"put":{"operationId":"put-service-vulnerability-severity-override","summary":"Put Service Vulnerability Severity Override","description":"Overrides a vulnerability severity for a given service.","requestBody":{"$ref":"#/components/requestBodies/PutVulnerabilitySeverityOverrideBody"},"responses":{"200":{"$ref":"#/components/responses/VulnerabilityResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]},"delete":{"operationId":"delete-service-vulnerability-severity-override","summary":"Delete Vulnerability Severity Override","description":"Deletes the severity override on a vulnerability for a given service.","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/catalog-services/{serviceId}/vulnerabilities/{vulnerabilityId}/dismissal":{"parameters":[{"name":"serviceId","in":"path","description":"ID of the service.","required":true,"schema":{"type":"string"}},{"name":"vulnerabilityId","in":"path","description":"ID of the vulnerability.","required":true,"schema":{"type":"string","format":"uuid"}}],"put":{"operationId":"put-service-vulnerability-dismissal","summary":"Put Service Vulnerability Dismissal","description":"Dismisses a vulnerability for a given service.","requestBody":{"$ref":"#/components/requestBodies/PutVulnerabilityDismissalBody"},"responses":{"200":{"$ref":"#/components/responses/VulnerabilityResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]},"delete":{"operationId":"delete-service-vulnerability-dismissal","summary":"Delete Service Vulnerability Dismissal","description":"Deletes the dismissal on a vulnerability for a given service.","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Vulnerabilities"]}},"/vulnerability-catalog-services":{"get":{"operationId":"list-catalog-vulnerability-services","summary":"List Catalog Vulnerability-Services","description":"Returns a paginated collection of services with cross-vulnerability context.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CatalogVulnerabilityServiceSort"},{"$ref":"#/components/parameters/CatalogVulnerabilityServiceFilter"}],"responses":{"200":{"$ref":"#/components/responses/ListCatalogVulnerabilityServicesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Vulnerabilities"]}},"/metrics/vulnerabilities":{"post":{"operationId":"query-vulnerabilities-metrics","summary":"Query Vulnerabilities Metrics","description":"Post a query to the endpoint to retrieve aggregated vulnerabilities metrics.\nData can be requested to group by any 2 dimensions and can include any number of filter conditions.\n","requestBody":{"$ref":"#/components/requestBodies/QueryVulnerabilitiesMetricsRequest"},"responses":{"200":{"$ref":"#/components/responses/VulnerabilitiesMetricsQueryResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Vulnerabilities"]}},"/catalog-custom-fields/schemas":{"get":{"operationId":"list-catalog-custom-field-schemas","summary":"List Catalog Custom Field Schemas","description":"Returns a paginated collection of catalog custom field schemas.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"$ref":"#/components/parameters/CustomFieldSchemaFilter"},{"$ref":"#/components/parameters/CustomFieldSchemaSort"}],"responses":{"200":{"$ref":"#/components/responses/ListCustomFieldSchemaResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Catalog Service Custom Fields"]}},"/catalog-default-quotas":{"get":{"operationId":"list-default-quotas","summary":"List Default Quotas","description":"Returns a paginated collection of system default quota definitions.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListDefaultQuotasResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Quotas"]}},"/catalog-quotas":{"get":{"operationId":"list-quotas","summary":"List Quotas","description":"Returns a paginated collection of quotas for the current organization.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListQuotasResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Quotas"]},"post":{"operationId":"create-quota","summary":"Create Quota","description":"Creates an organization quota override for a default quota. Each organization may have at most one quota row per default quota.","requestBody":{"$ref":"#/components/requestBodies/CreateQuotaRequest"},"responses":{"201":{"$ref":"#/components/responses/QuotaResponse"},"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":["Quotas"]}},"/catalog-quotas/{quotaId}":{"parameters":[{"name":"quotaId","in":"path","description":"The `id` of the quota.","required":true,"schema":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f"}}],"get":{"operationId":"fetch-quota","summary":"Get a Quota","description":"Fetches a single quota for the current organization.","responses":{"200":{"$ref":"#/components/responses/QuotaResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Quotas"]},"patch":{"operationId":"update-quota","summary":"Update Quota","description":"Updates the effective limit value for an organization quota.","requestBody":{"$ref":"#/components/requestBodies/UpdateQuotaRequest"},"responses":{"200":{"$ref":"#/components/responses/QuotaResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Quotas"]}},"/api-specs/preview":{"post":{"operationId":"preview-api-spec","summary":"Preview API Spec","description":"Previews the contents of an API spec as JSON or YAML string.\nSpecify `Accept: application/json` to retrieve the contents as JSON string.\nSpecify `Accept: application/yaml` to retrieve the contents as YAML string.\nDefaults to JSON string format.\n","requestBody":{"$ref":"#/components/requestBodies/ApiSpecPreviewRequest"},"responses":{"200":{"$ref":"#/components/responses/ApiSpecPreviewResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["API Specs Preview"]}}},"components":{"parameters":{"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"}},"CatalogServiceApiSpecFilter":{"name":"filter","description":"Filters a collection of API specs belonging to a service.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CatalogServiceApiSpecFilterParameters"}},"CatalogServiceApiSpecSort":{"name":"sort","description":"Sorts a collection of API specs belonging to a service. Supported sort attributes are:\n  - `name`\n  - `provider.type`\n\nDefault sort is `name` in ascending order.\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"CatalogServiceIntegrationEventsFilter":{"name":"filter","description":"Filters a collection of events for a given service.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CatalogServiceIntegrationEventsFilterParameters"}},"CatalogVulnerabilityFilter":{"name":"filter","description":"Filters a collection of catalog-wide vulnerabilities.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CatalogVulnerabilityFilterParameters"}},"CatalogVulnerabilityServiceFilter":{"name":"filter","description":"Filters a collection of services with cross-vulnerability context.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CatalogVulnerabilityServiceFilterParameters"}},"CatalogVulnerabilityServiceSort":{"name":"sort","description":"Sorts a collection of services with cross-ulnerability context. Supported sort attributes are:\n  - name\n  - display_name\n  - vulnerability.most_recent_vulnerability_opened_at\n  - vulnerability.vulnerability_count\n  - vulnerability.instance_count\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"CatalogVulnerabilitySort":{"name":"sort","description":"Sorts a collection of catalog-wide vulnerabilities. Supported sort attributes are:\n  - last_opened_at\n  - dismissed_at\n  - fixed_at\n  - instance_count\n  - service_count\n  - severity_score\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"}},"CustomFieldSchemaFilter":{"name":"filter","description":"Filters a collection of custom field schemas.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/CustomFieldSchemaFilterParameters"}},"CustomFieldSchemaSort":{"name":"sort","description":"Sorts a collection of custom field schemas. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - name\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"IntegrationEventsFilter":{"name":"filter","description":"Filters a collection of integration events.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/IntegrationEventsFilterParameters"}},"IntegrationEventsSort":{"name":"sort","description":"Sorts a collection of integration events. Supported sort attributes are:\n  - ts\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}},"ResourceActionFilter":{"name":"filter","description":"Filters a collection of resource actions.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/ResourceActionFilterParameters"}},"ServiceVulnerabilityFilter":{"name":"filter","description":"Filters a collection of vulnerabilities.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/ServiceVulnerabilityFilterParameters"}},"ServiceVulnerabilityInstanceFilter":{"name":"filter","description":"Filters a collection of vulnerability instances for a given service.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/ServiceVulnerabilityInstanceFilterParameters"}},"ServiceVulnerabilityScanFilter":{"name":"filter","description":"Filters a collection of vulnerability scans, for a given service.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/ServiceVulnerabilityScanFilterParameters"}},"SuggestedResourceActionFilter":{"name":"filter","description":"Filters a collection of suggested resource actions.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/SuggestedResourceActionFilterParameters"}},"SuggestedResourceActionSort":{"name":"sort","description":"Sorts a collection of suggested resource actions. Supported sort attributes are:\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"SuggestionRuleErrorFilter":{"name":"filter","description":"Filters a collection of suggestion rule errors.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/SuggestionRuleErrorFilterParameters"}},"SuggestionRuleFilter":{"name":"filter","description":"Filters a collection of suggestion rules.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/SuggestionRuleFilterParameters"}},"VulnerabilityInstanceFilter":{"name":"filter","description":"Filters a collection of vulnerability instances.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/VulnerabilityInstanceFilterParameters"}},"VulnerabilityInstanceSort":{"name":"sort","description":"Sorts a collection of vulnerability instances. Supported sort attributes are:\n  - last_opened_at\n  - fixed_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"VulnerabilityScanFilter":{"name":"filter","description":"Filters a collection of vulnerability scans.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/VulnerabilityScanFilterParameters"}},"VulnerabilityScanSort":{"name":"sort","description":"Sorts a collection of vulnerability scans. Supported sort attributes are:\n  - ts\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"VulnerabilityScanVulnerabilityFilter":{"name":"filter","description":"Filters a collection of vulnerabilities for a given vulnerability scan.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/VulnerabilityScanVulnerabilityFilterParameters"}},"VulnerabilityServiceFilter":{"name":"filter","description":"Filters a collection of services for a given vulnerability.","required":false,"in":"query","style":"deepObject","schema":{"$ref":"#/components/schemas/VulnerabilityServiceFilterParameters"}},"VulnerabilityServiceSort":{"name":"sort","description":"Sorts a collection of services for a given vulnerability. Supported sort attributes are:\n  - name\n  - display_name\n  - vulnerability.last_opened_at\n  - vulnerability.dismissed_at\n  - vulnerability.fixed_at\n  - vulnerability.instance_count\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"VulnerabilitySort":{"name":"sort","description":"Sorts a collection of vulnerabilities. Supported sort attributes are:\n  - last_opened_at\n  - dismissed_at\n  - fixed_at\n  - instance_count\n  - severity_score\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"]},"CatalogServiceSuggestion":{"type":"object","properties":{"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"},"description":{"description":"Optionally provide a description of the Service.","type":"string"},"labels":{"$ref":"#/components/schemas/LabelsSuggestion"},"metadata":{"$ref":"#/components/schemas/CustomFieldsSuggestion"}},"additionalProperties":false,"required":["name","display_name"]},"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"},"CreateCatalogServiceApiSpec":{"type":"object","properties":{"name":{"description":"The name of the API","type":"string","example":"Pet Store","maxLength":120,"minLength":1},"description":{"description":"The description of the API","type":"string","example":"A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification\n","maxLength":2048,"nullable":true},"provider":{"description":"Represents the provider, or source, of an API spec","oneOf":[{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/RawApiSpecProviderPayload"},{"$ref":"#/components/schemas/IntegrationApiSpecProviderPayload"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"}],"title":"CreateApiSpecProvider"}},"additionalProperties":false,"required":["name","description","provider"]},"UpdateCatalogServiceApiSpec":{"type":"object","properties":{"name":{"description":"The name of the API","type":"string","example":"Pet Store","maxLength":120,"minLength":1},"description":{"description":"The description of the API","type":"string","example":"A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification\n","maxLength":2048,"nullable":true},"provider":{"description":"Represents the provider, or source, of an API specs.\nNote that `provider` cannot be patched for API specs that are bound to a resource.\nTrying to do so will result in a 400 response.\n","oneOf":[{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/RawApiSpecProviderPayload"},{"$ref":"#/components/schemas/IntegrationApiSpecProviderPayload"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"}],"title":"CreateApiSpecProvider"}},"additionalProperties":false},"PreviewCatalogServiceApiSpec":{"type":"object","properties":{"provider":{"description":"Represents the provider, or source, of an API spec","oneOf":[{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/RawApiSpecProviderPayload"},{"$ref":"#/components/schemas/IntegrationApiSpecProviderPayload"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProviderPayload"}],"title":"CreateApiSpecProvider"}},"additionalProperties":false,"required":["provider"]},"CatalogServiceApiSpecFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"}}},"CatalogServiceApiSpec":{"type":"object","properties":{"id":{"description":"The API spec ID","type":"string","format":"uuid","example":"eadb88fe-e8eb-45c2-9591-dc783f93f29b"},"service_id":{"description":"The ID of the service the API spec is associated to.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"name":{"description":"The name of the API","type":"string","example":"Pet Store","maxLength":120,"minLength":1},"description":{"description":"The description of the API.","type":"string","example":"A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification.\n","maxLength":2048,"nullable":true},"resource_id":{"description":"The ID of the Resource that is bound to the API spec.\nOnly set when the given `provider.type` requires a 1-to-1 mapping between Resource\nand API Spec.\n","type":"string","example":"IqkHvMdyHukxcwAs","nullable":true},"provider":{"description":"Represents the provider, or source, of API spec contents.","anyOf":[{"$ref":"#/components/schemas/UrlApiSpecProvider"},{"$ref":"#/components/schemas/RawApiSpecProvider"},{"$ref":"#/components/schemas/IntegrationApiSpecProvider"},{"$ref":"#/components/schemas/ResourceBoundIntegrationApiSpecProvider"}],"title":"ApiSpecProvider","x-convert-oneOf":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","service_id","name","description","resource_id","provider","created_at","updated_at"]},"ApiSpecContents":{"description":"Represents raw API spec contents","type":"object","example":{"openapi":"3.0.0","info":{"version":"1.0.0","title":"Swagger Petstore"},"servers":[{"url":"http://petstore.swagger.io/v1"}],"paths":{}},"additionalProperties":true,"title":"ApiSpecContents"},"ApiSpecContentsPreview":{"description":"Represents raw API spec contents in JSON format","type":"string","title":"ApiSpecContentsPreview"},"ApiSpecContentsPreviewYaml":{"description":"Represents raw API spec contents in YAML format","type":"string","title":"ApiSpecContentsPreviewYaml"},"ApiSpecContentsYaml":{"description":"Represents raw API spec contents","type":"string","title":"ApiSpecContentsYaml"},"RawApiSpecProvider":{"type":"object","properties":{"type":{"type":"string","enum":["raw"]},"config":{"type":"object","additionalProperties":false,"maxProperties":0,"minProperties":0}},"required":["type","config"]},"RawApiSpecProviderPayload":{"type":"object","properties":{"type":{"type":"string","enum":["raw"]},"config":{"type":"object","additionalProperties":false,"properties":{"contents":{"description":"Raw API spec file contents.\nSupports JSON or YAML format.\nRaw specs have a maximum size limit of 8mb.\n","type":"string","example":"{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Swagger Petstore\",\"license\":{\"name\":\"MIT\"}},\"servers\":[{\"url\":\"http://petstore.swagger.io/v1\"}],\"paths\":{\"/pets\":{\"get\":{\"summary\":\"List all pets\",\"operationId\":\"listPets\",\"tags\":[\"pets\"],\"parameters\":[{\"name\":\"limit\",\"in\":\"query\",\"description\":\"How many items to return at one time (max 100)\",\"required\":false,\"schema\":{\"type\":\"integer\",\"maximum\":100,\"format\":\"int32\"}}],\"responses\":{\"200\":{\"description\":\"A paged array of pets\",\"headers\":{\"x-next\":{\"description\":\"A link to the next page of responses\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Pets\"}}}},\"default\":{\"description\":\"unexpected error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}},\"post\":{\"summary\":\"Create a pet\",\"operationId\":\"createPets\",\"tags\":[\"pets\"],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Pet\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Null response\"},\"default\":{\"description\":\"unexpected error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/pets/{petId}\":{\"get\":{\"summary\":\"Info for a specific pet\",\"operationId\":\"showPetById\",\"tags\":[\"pets\"],\"parameters\":[{\"name\":\"petId\",\"in\":\"path\",\"required\":true,\"description\":\"The id of the pet to retrieve\",\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Expected response to a valid request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Pet\"}}}},\"default\":{\"description\":\"unexpected error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}}},\"components\":{\"schemas\":{\"Pet\":{\"type\":\"object\",\"required\":[\"id\",\"name\"],\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"name\":{\"type\":\"string\"},\"tag\":{\"type\":\"string\"}}},\"Pets\":{\"type\":\"array\",\"maxItems\":100,\"items\":{\"$ref\":\"#/components/schemas/Pet\"}},\"Error\":{\"type\":\"object\",\"required\":[\"code\",\"message\"],\"properties\":{\"code\":{\"type\":\"integer\",\"format\":\"int32\"},\"message\":{\"type\":\"string\"}}}}}}\n"}},"required":["contents"],"title":"RawApiSpecProviderConfig"}},"required":["type","config"]},"UrlApiSpecProvider":{"type":"object","properties":{"type":{"type":"string","enum":["url"]},"config":{"type":"object","properties":{"url":{"description":"Public URL that resolves to the raw API spec contents.\nSupported formats are JSON and YAML.\n","type":"string","format":"uri","example":"https://api.petstore.com/v3/openapi.json"}},"required":["url"]}},"required":["type","config"]},"IntegrationApiSpecProviderPayload":{"description":"API spec provider registered by a catalog integration.\n\nIntegrations can function as API spec providers where they register a globally unique\n`type` and config schema which defines the shape of `config`.\n\nConsult integration documentation to learn more about available API spec providers.\n","type":"object","properties":{"type":{"description":"The globally unique API spec provider type that is registered by a given catalog integration.","type":"string","example":"swaggerhub_api_version","maxLength":120,"minLength":1},"config":{"description":"JSON object containing values as defined by integration provider's config schema.","type":"object","example":{"owner":"petco","api":"pet_store","version":"v3"},"additionalProperties":true,"minProperties":1},"integration_instance":{"description":"The integration instance id or name","type":"string"}},"required":["type","config","integration_instance"]},"IntegrationApiSpecProvider":{"description":"API spec provider registered by a catalog integration.\n\nIntegrations can function as API spec providers where they register a globally unique\n`type` and config schema which defines the shape of `config`.\n\nConsult integration documentation to learn more about available API spec providers.\n","type":"object","properties":{"type":{"description":"The globally unique API spec provider type that is registered by a given catalog integration.","type":"string","example":"swaggerhub_api_version","maxLength":120,"minLength":1},"config":{"description":"JSON object containing values as defined by integration provider's config schema.","type":"object","example":{"owner":"petco","api":"pet_store","version":"v3"},"additionalProperties":true,"minProperties":1},"integration":{"$ref":"#/components/schemas/IntegrationRef"}},"required":["type","config","integration"]},"ResourceBoundIntegrationApiSpecProvider":{"description":"API spec provider registered by a catalog integration.\n\nThese providers differ from `IntegrationApiSpecProvider` in that they\ndenote a binding relationship between a resource type and the API spec.\nThis means that the API Spec will automatically be created/deleted for/from a service\nas resources of the given type are mapped/unmapped.\n\nConsult integration documentation to learn more about available API spec providers.\n","type":"object","properties":{"type":{"description":"The globally unique API spec provider type that is registered by a given catalog integration.\nResource-bound providers create a 1-to-1 mapping between a resource type and the API Spec.\n","type":"string","maxLength":120,"minLength":1},"config":{"type":"object","properties":{"resource_id":{"description":"ID of the associated Resource the API spec is bound to.","type":"string","example":"IqkHvMdyHukxcwAs"}},"required":["resource_id"]},"integration":{"$ref":"#/components/schemas/IntegrationRef"}},"required":["type","config","integration"]},"ResourceBoundIntegrationApiSpecProviderPayload":{"description":"API spec provider registered by a catalog integration.\n\nThese providers differ from `IntegrationApiSpecProvider` in that they\ndenote a binding relationship between a resource type and the API spec.\nThis means that the API Spec will automatically be created/deleted for/from a service\nas resources of the given type are mapped/unmapped.\n\nConsult integration documentation to learn more about available API spec providers.\n","type":"object","properties":{"type":{"description":"The globally unique API spec provider type that is registered by a given catalog integration.\nResource-bound providers create a 1-to-1 mapping between a resource type and the API Spec.\n","type":"string","maxLength":120,"minLength":1},"config":{"type":"object","properties":{"resource_id":{"description":"ID of the associated Resource the API spec is bound to.","type":"string","example":"IqkHvMdyHukxcwAs"}},"required":["resource_id"]}},"required":["type","config"]},"CatalogIntegrationFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"},"visibility":{"$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"},"incident_provider":{"$ref":"#/components/schemas/CatalogIntegrationIncidentProvider"},"on_call_provider":{"$ref":"#/components/schemas/CatalogIntegrationOnCallProvider"},"pull_request_provider":{"$ref":"#/components/schemas/CatalogIntegrationPullRequestProvider"},"workflow_provider":{"$ref":"#/components/schemas/CatalogIntegrationWorkflowProvider"}},"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"}},"resource_id_template":"{{control_plane_id}}:{{gateway_service_id}}","integration_data_schema":null},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}},"resource_id_template":"{{dashboard_id}}","integration_data_schema":null}},"additionalProperties":{"type":"object","title":"ResourceType","required":["resource_id_template","schema","integration_data_schema"],"properties":{"display_name":{"description":"The user-friendly resource type name.","type":"string"},"resource_id_template":{"description":"Custom template used to generate a string that uniquely identifies a resource.\nThe template must include at least one key defined in the resource type schema definition, enclosed in double curly braces (e.g., `{{field_name}}`).\nThis template must not reference keys not required to identify the external resource.\n","type":"string"},"schema":{"$ref":"#/components/schemas/SimpleSchema"},"integration_data_schema":{"$ref":"#/components/schemas/CatalogIntegrationResourceTypeIntegrationDataSchema"}}}},"CatalogIntegrationResourceTypeIntegrationDataSchema":{"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":"CatalogIntegrationResourceTypeIntegrationDataSimpleSchema","description":"Defines the schema to validate incoming integration_data values for a resource type, on resource\ningestion, using simple schema.\nSet to `null` when the given resource type does not validate incoming integration_data.\n"},{"type":"object","required":["type","definition"],"properties":{"type":{"type":"string","enum":["json_schema"]},"definition":{"type":"object","additionalProperties":true}},"title":"CatalogIntegrationResourceTypeIntegrationDataJSONSchema","description":"Defines the schema to validate incoming integration_data values for a resource type, on resource\ningestion, using JSON schema.\nSet to `null` when the given resource type does not validate incoming integration_data.\n"}],"x-convert-oneOf":true},"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"]},"CatalogIntegrationIncidentProvider":{"description":"Defines how an integration behaves as a source provider of Catalog Service Incidents.\nIncidents are entities that can be attached to Catalog Services via an integration's Resource mapping.\nWhen an integration implements this capability, it can act as a source type for Incident data.\nIn this role, the integration becomes the source of truth for the incident data.\nWhen an incident is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the incident data.\nA null value indicates the given integration does not act as a source provider of incidents.\n","type":"object","nullable":true},"CatalogIntegrationOnCallProvider":{"description":"Defines how an integration behaves as a source provider of Catalog Service On-Call schedules.\nOn-Call schedules are entities that can be attached to Catalog Services via an integration's Resource mapping.\nWhen an integration implements this capability, it can act as a source type for On-Call data.\nIn this role, the integration becomes the source of truth for the on-call schedule data.\nWhen an on-call schedule is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the on-call schedule data.\nA null value indicates the given integration does not act as a source provider of on-call schedules.\n","type":"object","nullable":true},"CatalogIntegrationPullRequestProvider":{"description":"Defines how an integration behaves as a source provider of Catalog Service Pull Requests.\nPull Requests are entities that can be attached to Catalog Services via an integration's Resource mapping.\nWhen an integration implements this capability, it can act as a source type for Pull Request data.\nIn this role, the integration becomes the source of truth for the pull request data.\nWhen a pull request is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the pull request data.\nA null value indicates the given integration does not act as a source provider of pull requests.\n","type":"object","nullable":true},"CatalogIntegrationWorkflowProvider":{"description":"Defines how an integration behaves as a source provider of Catalog Service Workflows.\nWorkflows are entities that can be attached to Catalog Services via an integration's Resource mapping.\nWhen an integration implements this capability, it can act as a source type for Workflow data.\nIn this role, the integration becomes the source of truth for the workflow data.\nWhen a workflow is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the workflow data.\nA null value indicates the given integration does not act as a source provider of workflows.\n","type":"object","nullable":true},"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"]},"CreateCatalogIntegration":{"oneOf":[{"$ref":"#/components/schemas/CreatePrivateCatalogIntegration"}]},"CreatePrivateCatalogIntegration":{"type":"object","properties":{"visibility":{"type":"string","enum":["private"]},"resource_types":{"$ref":"#/components/schemas/CatalogIntegrationResourceTypes"},"description":{"description":"Description of the integration.","type":"string","maxLength":2048},"display_name":{"description":"The display name of the integration.","type":"string","example":"My Integration","maxLength":120,"minLength":1}},"additionalProperties":false,"required":["visibility","resource_types","description","display_name"]},"UpdateCatalogIntegration":{"type":"object","properties":{"description":{"description":"Description of the integration.","type":"string","maxLength":2048},"display_name":{"description":"The display name of the catalog integration.","type":"string","example":"Updated Catalog Integration","maxLength":120,"minLength":1}},"additionalProperties":false},"InitializeCatalogResource":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CatalogResourceType"},"config":{"$ref":"#/components/schemas/CatalogResourceConfig"}},"additionalProperties":false,"required":["type","config"]},"DeleteCatalogResources":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string"}}},"maxItems":100,"minItems":1}},"additionalProperties":false,"required":["data"]},"UpsertCatalogResource":{"type":"object","properties":{"name":{"description":"The name of the resource.","type":"string","maxLength":255,"minLength":1},"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.\n","type":"object","additionalProperties":true}},"additionalProperties":false,"required":["name","type","integration_data","config"]},"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},"ScheduleResourceIngestion":{"type":"object","properties":{"ingest_from":{"description":"A timestamp indicating when to start ingestion from.\nRFC-3339 format is used with a \"T\" character separating date from time within the field value.\nOmitting this property indicates ingestion will be triggered from the beginning of time until the present.\n","type":"string","format":"date-time"}},"additionalProperties":false},"ServiceDocument":{"type":"object","properties":{"slug":{"$ref":"#/components/schemas/Slug"},"title":{"description":"Document title","type":"string"},"parent_document_id":{"description":"parent document id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"id":{"description":"The service document identifier.","type":"string","format":"uuid","example":"de5c9818-be5c-42e6-b514-e3d4bc30ddeb"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","slug","title","created_at","updated_at"]},"ServiceDocumentTree":{"type":"object","properties":{"slug":{"$ref":"#/components/schemas/Slug"},"title":{"description":"Document title","type":"string"},"parent_document_id":{"description":"parent document id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"id":{"description":"The service document identifier.","type":"string","format":"uuid","example":"de5c9818-be5c-42e6-b514-e3d4bc30ddeb"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"children":{"type":"array","items":{"$ref":"#/components/schemas/ServiceDocumentTree"}}},"additionalProperties":false,"required":["id","slug","title","created_at","updated_at","children"]},"CreateServiceDocumentPayload":{"type":"object","properties":{"slug":{"$ref":"#/components/schemas/Slug"},"title":{"description":"Document title","type":"string"},"parent_document_id":{"description":"parent document id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"content":{"description":"Markdown content.","type":"string"}},"additionalProperties":false,"required":["slug","title","content"]},"UpdateServiceDocumentPayload":{"type":"object","properties":{"slug":{"$ref":"#/components/schemas/Slug"},"title":{"description":"Document title","type":"string"},"parent_document_id":{"description":"parent document id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"content":{"description":"Markdown content.","type":"string"}},"additionalProperties":false},"ServiceDocumentContentResponse":{"type":"object","properties":{"slug":{"$ref":"#/components/schemas/Slug"},"title":{"description":"Document title","type":"string"},"parent_document_id":{"description":"parent document id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2","nullable":true},"content":{"description":"Markdown content.","type":"string"},"id":{"description":"The service document identifier.","type":"string","format":"uuid","example":"de5c9818-be5c-42e6-b514-e3d4bc30ddeb"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["slug","title","content","id","parent_document_id","created_at","updated_at"]},"SuggestionRuleFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"active":{"$ref":"#/components/schemas/BooleanFieldFilter"},"auto_accept":{"$ref":"#/components/schemas/BooleanFieldFilter"},"binding":{"$ref":"#/components/schemas/StringFieldFilterExact"},"action.type":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilterExact"}]},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"additionalProperties":false,"title":"SuggestionRuleFilterParameters"},"SuggestionRuleErrorFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"resource_id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"suggestion_rule_id":{"$ref":"#/components/schemas/UuidFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"additionalProperties":false,"title":"SuggestionRuleErrorFilterParameters"},"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"}]}},"CustomFieldsSuggestion":{"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":{"anyOf":[{"$ref":"#/components/schemas/TextCustomField"},{"$ref":"#/components/schemas/NumericCustomField"},{"$ref":"#/components/schemas/BooleanCustomField"},{"$ref":"#/components/schemas/UrlCustomFieldSuggestion"}]}},"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"]},"UrlCustomFieldSuggestion":{"additionalProperties":{"type":"string"}},"SimpleSchema":{"type":"object","properties":{"type":{"type":"string","enum":["simple"]},"definition":{"type":"object","additionalProperties":{"type":"string","enum":["string","number","boolean"]}}},"required":["type","definition"]},"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"]},"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"]},"ResourceIngestionStatus":{"description":"The resource ingestion status.","type":"object","properties":{"last_scheduled":{"description":"The timestamp denoting when the last ingestion job was run.\nRFC-3339 format is used with a \"T\" character separating date from time within the field value.\nA `null` value denotes that ingestion for the given integration was never run.\n","type":"string","format":"date-time","nullable":true},"next_scheduled_at":{"description":"The timestamp denoting when the ingestion job is scheduled to run.\nRFC-3339 format is used with a \"T\" character separating date from time within the field value.\nA `null` value denotes that ingestion for the given integration is not scheduled to run.\n","type":"string","format":"date-time","nullable":true},"scheduler_state":{"oneOf":[{"$ref":"#/components/schemas/ResourceSchedulerStateOk"},{"$ref":"#/components/schemas/ResourceSchedulerStateNotOk"}]}},"additionalProperties":false,"required":["last_scheduled","next_scheduled_at","scheduler_state"],"title":"ResourceIngestionStatus"},"ResourceSchedulerStateOk":{"description":"Describes the resource ingestion scheduler state.","type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"additionalProperties":false,"required":["status"],"title":"ResourceSchedulerStateOk"},"ResourceSchedulerStateNotOk":{"description":"Describes the resource ingestion scheduler state.","type":"object","properties":{"status":{"type":"string","enum":["delayed","halted"]},"reason":{"description":"Reason for the current resource ingestion scheduler status.","type":"string"},"remediation":{"description":"Possible steps which can be taken to resolve resource scheduler status back to \"ok\".","type":"string","nullable":true}},"additionalProperties":false,"required":["status","reason","remediation"],"title":"ResourceSchedulerStateNotOk"},"IntegrationNotInstalledError":{"type":"object","properties":{"type":{"type":"string","enum":["service_catalog_integration_not_installed"]},"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},"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}},"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"}}}],"required":["type"]},"IntegrationUnauthorizedError":{"type":"object","properties":{"type":{"type":"string","enum":["service_catalog_integration_unauthorized"]},"status":{"type":"integer","enum":[400]},"title":{"type":"string","example":"Invalid Request"},"instance":{"description":"The Konnect trace ID.","type":"string","example":"konnect:trace:3674017986744198214"},"detail":{"type":"string","example":"The integration instance \"cc461d8c-dade-4ce0-ad86-290f3ff8de1a\" is unauthorized"},"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}},"required":["type","status","title","detail","instance","invalid_parameters"],"title":"IntegrationUnauthorizedError"},"ResourceAction":{"description":"Contains information about a resource action","type":"object","properties":{"id":{"description":"The resource action ID.","type":"string","format":"uuid","example":"93b411db-6f68-47d2-8959-de2d91914f2f"},"user_id":{"description":"Represents the user who performed the action.\nA `null` value represents that action was taken by the system.\n","type":"string","nullable":true},"action_type":{"description":"Represents which action was performed on a resource:\n  - `map`: a resource was mapped to a service\n  - `unmap`: a resource was unmapped from a service\n  - `archive`: a resource was archived\n  - `restore`: a resource was restored\n","type":"string","enum":["map","unmap","archive","restore"]},"cause":{"description":"Represents what caused the resource action to occur:\n- `user-action`: user performed a resource action\n- `suggestion-rule`: resource action performed based on the configuration of a suggestion rule\n","type":"string","enum":["user-action","suggestion-rule"]},"service_id":{"description":"The service effected by the resource action","type":"string","format":"uuid","example":"6567bdab-9a94-4763-a736-7638b777fc04","nullable":true},"resource_id":{"description":"The resource effected by the resource action","type":"string","example":"R4bimspbBIFkYA1v"},"resource_name":{"description":"The name of the resource affected by the resource action","type":"string","example":"Billing Service","maxLength":255,"nullable":true},"integration":{"$ref":"#/components/schemas/IntegrationRef"},"created_at":{"$ref":"#/components/schemas/CreatedAt"}},"additionalProperties":false,"required":["id","user_id","action_type","cause","service_id","resource_id","resource_name","integration","created_at"],"title":"ResourceAction"},"ResourceActionFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"user_id":{"$ref":"#/components/schemas/StringFieldFilter"},"service_id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"resource_id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"resource_name":{"$ref":"#/components/schemas/StringFieldFilter"},"integration.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.id":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilterExact"}]},"action_type":{"$ref":"#/components/schemas/StringFieldFilterExact"},"cause":{"$ref":"#/components/schemas/StringFieldFilterExact"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"additionalProperties":false},"LabelsTemplate":{"description":"Labels to facilitate grouping and tagged search.\nResolved keys must be of length 1-63 characters, and cannot start with ''kong'', ''konnect'', ''mesh'', ''kic'', or ''_''.'\nLabel key and value supports JQ expression syntax on discovered entity's `integration_record` property.\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string","minLength":1},"title":"LabelsTemplate"},"LabelsSuggestion":{"description":"Labels to facilitate grouping and tagged search.\nResolved keys must be of length 1-63 characters, and cannot start with ''kong'', ''konnect'', ''mesh'', ''kic'', or ''_''.'\nLabel key and value supports JQ expression syntax on discovered entity's `integration_record` property.\n","type":"object","example":{"env":"test"},"additionalProperties":{"type":"string"},"title":"LabelsTemplate"},"UrlMetadataValueBase":{"type":"object","properties":{"name":{"description":"The human-readable name for the url metadata value","type":"string","example":"#public-slack-channel","minLength":1}},"nullable":true,"required":["name"]},"UrlMetadataValueTemplate":{"description":"Contains the name and link value associated with a URL Metadata Field. Supports JQ templates which resolves to a string.","type":"object","allOf":[{"$ref":"#/components/schemas/UrlMetadataValueBase"},{"type":"object","required":["link"],"properties":{"link":{"description":"The url link associated with the metadata value.","type":"string","example":"#public-slack-channel","minLength":1}}}]},"MetadataTemplate":{"description":"Contains key value pairs information about entity's metadata. Supports JQ templates on values which resolves to a string.","type":"object","additionalProperties":{"anyOf":[{"type":"string","nullable":true},{"type":"number","nullable":true},{"type":"boolean","nullable":true},{"$ref":"#/components/schemas/UrlMetadataValueTemplate"}]}},"MapById":{"type":"object","properties":{"id":{"description":"Exact match on service identifier based on suggestion rule scope.\nSupports JQ expression syntax on discovered entity's `integration_record` property.\n","type":"string","example":"1ace6cb5-75ca-4488-a05d-9260628a37a8"}},"additionalProperties":false,"required":["id"]},"MapByName":{"type":"object","properties":{"name":{"description":"Exact match on service name based on suggestion rule scope.\nSupports JQ expression syntax on discovered entity's `integration_record` property.\n","type":"string","example":"{{ .gateway_service.name }}-{{ .runtime_group.labels.env }}"}},"additionalProperties":false,"required":["name"]},"ArchiveActionPayload":{"type":"object","properties":{"type":{"type":"string","enum":["archive"]}},"additionalProperties":false,"required":["type"],"title":"ArchiveActionPayload"},"MapServiceAction":{"type":"object","properties":{"type":{"type":"string","enum":["map"]},"data":{"type":"object","additionalProperties":false,"properties":{"service":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"The identifier of the service associated to this resource action.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"}},"required":["id"]},"resource":{"type":"object","additionalProperties":false,"properties":{"labels":{"$ref":"#/components/schemas/LabelsSuggestion"}},"required":["labels"]}},"required":["service","resource"]}},"additionalProperties":false,"required":["type","data"],"title":"MapServiceAction"},"CreateAndMapServiceActionPayload":{"type":"object","properties":{"type":{"type":"string","enum":["create"]},"data":{"type":"object","additionalProperties":false,"properties":{"service":{"$ref":"#/components/schemas/CreateCatalogService"},"resource":{"type":"object","additionalProperties":false,"properties":{"labels":{"$ref":"#/components/schemas/LabelsSuggestion"}},"required":["labels"]}},"required":["service","resource"]}},"additionalProperties":false,"required":["type","data"],"title":"CreateAndMapServiceActionPayload"},"IgnoreActionPayload":{"type":"object","properties":{"type":{"type":"string","enum":["ignore"]}},"additionalProperties":false,"required":["type"],"title":"IgnoreAction"},"MapActionPayload":{"description":"Must specify **at least one** of the following properties when `action_type` is `map`:\n- `id`\n- `name`\n","type":"object","properties":{"type":{"type":"string","enum":["map"]},"data":{"type":"object","additionalProperties":false,"properties":{"service":{"oneOf":[{"$ref":"#/components/schemas/MapByName"},{"$ref":"#/components/schemas/MapById"}]},"resource":{"type":"object","additionalProperties":false,"properties":{"labels":{"$ref":"#/components/schemas/LabelsTemplate"}},"required":["labels"]}},"required":["service","resource"]}},"additionalProperties":false,"required":["type","data"],"title":"MapAction"},"CreateOrMapAction":{"type":"object","properties":{"type":{"type":"string","enum":["create-or-map"]},"data":{"type":"object","additionalProperties":false,"properties":{"service":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"The name of the service to create or map to.\nSupports JQ expression syntax on discovered entity's `integration_record` property.\n","type":"string","minLength":1},"display_name":{"description":"The display name of the service on create. This property is ignored on map.\nSupports JQ expression syntax on discovered entity's `integration_record` property.\nIf value is set to null, display name will be set to name.\n","type":"string","minLength":1,"nullable":true},"description":{"description":"The description of the service. This property is ignored on map.\nSupports JQ expression syntax on discovered entity's `integration_record` property.\n","type":"string"},"labels":{"$ref":"#/components/schemas/LabelsTemplate"},"metadata":{"$ref":"#/components/schemas/MetadataTemplate"}},"required":["name","display_name","description","labels","metadata"]},"resource":{"type":"object","additionalProperties":false,"properties":{"labels":{"$ref":"#/components/schemas/LabelsTemplate"}},"required":["labels"]}},"required":["service","resource"]}},"required":["type","data"],"title":"CreateOrMapAction"},"CreateActionEvaluated":{"type":"object","properties":{"type":{"type":"string","enum":["create"]},"data":{"type":"object","additionalProperties":false,"properties":{"service":{"$ref":"#/components/schemas/CatalogServiceSuggestion"},"resource":{"type":"object","additionalProperties":false,"properties":{"labels":{"$ref":"#/components/schemas/LabelsTemplate"}},"required":["labels"]}},"required":["service","resource"]}},"required":["type","data"],"title":"CreateActionEvaluated"},"SuggestedRuleAction":{"oneOf":[{"$ref":"#/components/schemas/ArchiveActionPayload"},{"$ref":"#/components/schemas/IgnoreActionPayload"},{"$ref":"#/components/schemas/MapActionPayload"},{"$ref":"#/components/schemas/CreateOrMapAction"}]},"RankAfterPayload":{"description":"Determines how this suggestion rule ranks against existing suggestion rules for the integration.\nWhen rank is not specified, this suggestion rule will placed as the lowest priority rule.\n","type":"object","properties":{"after_suggestion_rule_id":{"description":"When set to `null`, this rule is indicated to be the highest priority rule.\n","type":"string","format":"uuid","nullable":true}},"additionalProperties":false,"required":["after_suggestion_rule_id"],"writeOnly":true},"RankBeforePayload":{"description":"Determines how this suggestion rule ranks against existing suggestion rules for the integration.\nWhen rank is not specified, this suggestion rule will placed as the lowest priority rule.\n","type":"object","properties":{"before_suggestion_rule_id":{"description":"When set to `null`, this rule is indicated to be the lowest priority rule.\n","type":"string","format":"uuid","nullable":true}},"additionalProperties":false,"required":["before_suggestion_rule_id"],"writeOnly":true},"SystemSuggestionRule":{"description":"Contains information about the system defined suggestion rule.","allOf":[{"type":"object","required":["id","name","description","binding","active","auto_accept","action"],"properties":{"id":{"description":"The suggestion rule ID.","type":"string","format":"uuid","example":"22f72bd1-2897-473e-9471-302de3ccf38b","readOnly":true},"name":{"description":"The display name of the suggestion rule.","type":"string","maxLength":120,"minLength":1},"description":{"description":"The description of the suggestion rule","type":"string","example":"Suggestion rule description","default":null,"maxLength":2048,"minLength":1,"nullable":true},"binding":{"description":"The integration binding object name","type":"string","example":"pagerduty_service"},"active":{"description":"Determines if this suggestion rule should be evaluated when generating suggested actions.","type":"boolean"},"auto_accept":{"description":"Determines if the suggested action should be applied automatically.\n- `true`: Suggested action will be applied automatically\n- `false`: Suggested action will not be automatically applied, user input required\n","type":"boolean"},"action":{"description":"The action configuration for this system suggestion rule.","type":"object","properties":{"type":{"description":"The type of action this system suggestion rule performs","type":"string","enum":["archive","map","create-or-map"]}},"required":["type"]}}}],"title":"SystemSuggestionRule"},"SuggestionRulePayload":{"description":"Payload to create a suggestion rule for an integration.","type":"object","properties":{"name":{"description":"The display name of the suggestion rule","type":"string","maxLength":120,"minLength":1},"description":{"description":"The description of the suggestion rule","type":"string","example":"Suggestion rule description","default":null,"maxLength":2048,"minLength":1,"nullable":true},"binding":{"description":"The integration binding object name","type":"string","example":"pagerduty_service"},"active":{"description":"Determines if this suggestion rule should be evaluated when generating suggested actions.","type":"boolean"},"auto_accept":{"description":"Determines if the suggested action should be applied automatically.\n- `true`: Suggested action will be applied automatically\n- `false`: Suggested action will not be automatically applied, user input required\n","type":"boolean"},"discovery_selector":{"description":"A boolean string or JQ expression that must evaluate to a boolean value.\nSupports JQ expressions syntax on discovered entity's `integration_record` property.\n","type":"string","example":".gateway_service.tags | contains([\"_KonnectDeployment:\"])","maxLength":2048},"action":{"oneOf":[{"$ref":"#/components/schemas/ArchiveActionPayload"},{"$ref":"#/components/schemas/MapActionPayload"},{"$ref":"#/components/schemas/CreateOrMapAction"}]},"rank":{"oneOf":[{"$ref":"#/components/schemas/RankAfterPayload"},{"$ref":"#/components/schemas/RankBeforePayload"}]}},"additionalProperties":false,"required":["name","binding","active","auto_accept","action","discovery_selector"],"title":"SuggestionRulePayload"},"TestSuggestionRulePayload":{"description":"Payload to test suggestion rule configuration against an integration record.","type":"object","properties":{"binding":{"description":"The integration binding object name","type":"string","example":"pagerduty_service"},"discovery_selector":{"description":"A boolean string or JQ expression that must evaluate to a boolean value.\nSupports JQ expressions syntax on discovered entity's `integration_record` property.\n","type":"string","example":".gateway_service.tags | contains([\"_KonnectDeployment:\"])","maxLength":2048},"action":{"$ref":"#/components/schemas/SuggestedRuleAction"},"integration_record":{"description":"JSON object that may contain additional context about the entity.","type":"object","example":{"control_plane":{"id":"0a7647d1-483a-4817-a5ac-28937b511563","name":"control_plane_name"},"gateway_service":{"id":"3fd1bff6-b60d-4c22-bb74-e4cac63196fb","name":"gateway_service_name"}},"additionalProperties":true}},"additionalProperties":false,"required":["binding","discovery_selector","action","integration_record"],"title":"TestSuggestionRulePayload"},"SuggestionRule":{"description":"Contains information about the suggestion rule.","allOf":[{"$ref":"#/components/schemas/SystemSuggestionRule"},{"type":"object","required":["created_at","updated_at","action","discovery_selector"],"properties":{"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"discovery_selector":{"description":"A boolean string or JQ expression that must evaluate to a boolean value.\nSupports JQ expressions syntax on discovered entity's `integration_record` property.\n","type":"string","example":".gateway_service.tags | contains([\"_KonnectDeployment:\"])"},"action":{"$ref":"#/components/schemas/SuggestedRuleAction"}}}],"title":"SuggestionRule"},"TestSuggestionRule":{"description":"Contains evaluation results of a suggestion rule configuration against an integration record.","type":"object","properties":{"evaluation":{"description":"Evaluation result of suggesetion rule configuration against given integration record.","type":"object","additionalProperties":false,"properties":{"matched":{"description":"Represents if the suggestion rule configuration matches the given integration record.","type":"boolean"},"service_id":{"description":"The identifier of a service the suggesiton rule configuration matches with the given integration record.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","nullable":true},"action":{"$ref":"#/components/schemas/SuggestedRuleActionEvaluated"}},"required":["matched","action","service_id"]},"errors":{"description":"List of errors that occured when evaluating suggestion rule configuration against given integration record.","type":"array","items":{"$ref":"#/components/schemas/SuggestionRuleErrorDetail"}}},"additionalProperties":false,"required":["evaluation","errors"],"title":"TestSuggestionRule"},"SuggestionRuleError":{"description":"Represents any errors which occured when evaluating a suggestion rule","allOf":[{"type":"object","nullable":true,"required":["suggestion_rule_id","details","created_at","updated_at"],"properties":{"id":{"description":"The id of the suggestion rule error\n","type":"string","example":"e4698717-7f0b-434d-aa16-a472089c2504"},"resource_id":{"description":"The id of the related resource which generated this error\n","type":"string","example":"qLgnGlFp4iveGUFl"},"suggestion_rule_id":{"description":"The id of the suggestion rule which generated this error\n","type":"string","example":"fd109d4a-e183-4488-98f2-10eab0964155"},"details":{"description":"Details of the error generated from the related suggested rule when evaluated\n","type":"array","items":{"$ref":"#/components/schemas/SuggestionRuleErrorDetail"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}}}],"title":"SuggestionRuleError"},"SuggestedRuleActionEvaluated":{"oneOf":[{"$ref":"#/components/schemas/ArchiveActionPayload"},{"$ref":"#/components/schemas/IgnoreActionPayload"},{"$ref":"#/components/schemas/MapActionPayload"},{"$ref":"#/components/schemas/CreateActionEvaluated"}]},"SuggestionRuleErrorDetail":{"type":"object","properties":{"type":{"description":"The type of error that occured when evaluating suggestion rule configuration against given integration record.\n  - `error`: represents a generic error.\n  - `timeout`: timeout occured when evaluating jq expression\n  - `invalid-expression`: jq expression could not be evaluated due to syntax error(s).\n  - `result-not-boolean`: jq expression was not evaluated to a boolean\n  - `result-not-string`: jq expression was not evaluated to a string\n  - `unexpected-result`: jq expression was not evaluated to a result that could not be determined\n  - `InvalidLabelKeyInputType`: Indicates the label key is of an invalid type (i.e. number or symbol)\n  - `InvalidEmptyLabelKey`: Indicates the label key is empty\n  - `InvalidLabelKeyFormat`: Indicates that the format of the label key is invalid, ex: \"-bad-format-\"\n  - `LabelKeyHasReservedPrefix`: Indicates that the label key starts with a Kong-reserved key prefix, ex: \"kong-test-key\"\n  - `MaxLabelKeyCharsExceeded`: Indicates that a label key exceeds the maximum number of allowed characters\n  - `InvalidLabelValueInputType`: Indicates the label value is of an invalid type (i.e. number or symbol)\n  - `InvalidEmptyLabelValue`: Indicates that the label value is empty\n  - `InvalidLabelValueFormat`: Indicates that the format of the label value is invalid, ex: \"-bad-format-\"\n  - `MaxLabelValueCharsExceeded`: Indicates that a label value exceeds the maximum number of allowed characters\n  - `InvalidLabelsInputType`: Indicates that a collection of labels is of an invalid type (i.e. array instead of key-value object)\n  - `MaxLabelsPerEntityExceeded`: Indicates that a collection of labels exceeds the maximum number of labels allowed for a given entity\n  - `ConflictingKeys`: Indicates that labels keys are not unique\n  - `InvalidName`: Indicates that the name is invalid\n  - `InvalidDisplayName`: Indicates that the display name is invalid\n  - `InvalidDescription`: Indicates that the description is invalid\n  - `InvalidLabels`: Indicates that the labels are invalid\n  - `InvalidMetadata`: Indicates that the metadata is invalid\n","type":"string"},"field":{"description":"The field from the payload given which is responsible for this error.","type":"string"},"expression":{"description":"Represents the resolved or unresolved JQ expression which failed validation","type":"string"},"message":{"description":"Details of the error which occured when evaluating suggestion rule configuration against given integration record.","type":"string"}},"required":["type","field","expression","message"]},"EventsAttributesFieldFilter":{"description":"Filters the events by values contained within the `attributes` field. Filters must use dot-notation to identify\nthe details property that will be used to filter the results.\n","oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}],"title":"EventsAttributesFieldFilter"},"BaseServiceEventsFilterParameters":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/StringFieldFilter"},"ts":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"integration.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.id":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilterExact"}]},"integration.instance.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"binding":{"$ref":"#/components/schemas/StringFieldFilterExact"},"attributes":{"$ref":"#/components/schemas/EventsAttributesFieldFilter"},"detail":{"$ref":"#/components/schemas/StringFieldFilter"},"actor.type":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"actor.id":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"actor.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]}},"title":"BaseServiceEventsFilterParameters"},"IntegrationEventsFilterParameters":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseServiceEventsFilterParameters"},{"type":"object","properties":{"service_id":{"$ref":"#/components/schemas/StringFieldFilter"}}}],"title":"IntegrationEventsFilterParameters"},"CatalogServiceIntegrationEventsFilterParameters":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseServiceEventsFilterParameters"}],"title":"ServiceEventsFilterParameters"},"IntegrationEventActor":{"description":"Information about the entity that triggered the integration event in the external system.\n","type":"object","properties":{"type":{"description":"Type of the entity that triggered the integration event in the external system.","type":"string","example":"user","nullable":true},"id":{"description":"Identifier of the entity that triggered the integration event in the external system.","type":"string","example":"PLH1HKV"},"name":{"description":"Name of the entity that triggered the integration event in the external system.","type":"string","example":"John Doe","nullable":true}},"additionalProperties":false,"nullable":true,"required":["type","id"],"title":"Integration Event Actor"},"IntegrationEvent":{"description":"Event on a resource binding for an integration.","type":"object","properties":{"id":{"description":"Unique identifier of the integration event.","type":"string","format":"uuid","example":"a90c4c20-bbd3-4229-8340-8b18e38cb1e5","readOnly":true},"type":{"description":"Type of the integration event.","type":"string","example":"incident.triggered"},"ts":{"description":"Date the integration event occurred at.","type":"string","format":"date-time","example":"2024-01-01T00:00:00Z"},"service_id":{"description":"Identifier of the service the integration event corresponds to.","type":"string","format":"uuid","example":"b268ca70-9b75-4355-8726-63788463a66f","readOnly":true},"deduplication_id":{"description":"Idempotent processing identifier of the integration event on ingestion.","type":"string","example":"1d34191ebfe305a56bf4f3303d1a8dcf"},"resource_id":{"description":"Identifier of the resource the integration event corresponds to.","type":"string","example":"8_l-yZ8UQtc_e6Pp"},"actor":{"$ref":"#/components/schemas/IntegrationEventActor"},"attributes":{"description":"Additional attributes of the integration event, specific to the binding resource and integration.","type":"object","example":{"service_id":"PLK33TY","incident_id":"PGR0VU2","escalation_policy_id":"P005NFS","priority_id":"P9BO35Z","urgency":"low","title":"Example API Service Incident","html_url":"https://acme.pagerduty.com/incidents/PGR0VU2"},"additionalProperties":true},"integration":{"$ref":"#/components/schemas/IntegrationRef"},"binding":{"description":"Binding resource the integration event corresponds to.","type":"string","example":"pagerduty_service"},"detail":{"description":"Additional detail about the integration event.","type":"string","example":"Example API Service Incident","nullable":true},"link_html":{"description":"URL to the web-page for the source of the integration event.","type":"string","example":"https://acme.pagerduty.com/incidents/PGR0VU2","nullable":true}},"additionalProperties":false,"required":["id","type","ts","service_id","deduplication_id","resource_id","actor","attributes","integration","binding","detail","link_html"],"title":"IntegrationEvent"},"CreateIntegrationEvent":{"description":"DTO object for creating an integration event for an integration. `type` and `binding` are parameters restricted by the\nintegration the event is being created for, found in the related integration manifest.\n","type":"object","properties":{"type":{"description":"Type of the event.","type":"string","example":"incident.triggered"},"ts":{"description":"Date the event occurred at.","type":"string","format":"date-time","example":"2024-01-01T00:00:00Z"},"deduplication_id":{"description":"Idempotent processing identifier of the event on ingestion.","type":"string","example":"1d34191ebfe305a56bf4f3303d1a8dcf"},"actor":{"$ref":"#/components/schemas/IntegrationEventActor"},"attributes":{"description":"Additional attributes of the event, specific to the binding resource and integration.","type":"object","example":{"service_id":"PLK33TY","incident_id":"PGR0VU2","escalation_policy_id":"P005NFS","priority_id":"P9BO35Z","urgency":"low","title":"Example API Service Incident","html_url":"https://acme.pagerduty.com/incidents/PGR0VU2"},"additionalProperties":true},"data":{"description":"JSON object containing the data which binds the integration to a service. Must match the schema defined for\nthe integration binding, referenced by the `binding` parameter.\n","type":"object","example":{"pagerduty_service_id":"PLK33TY"},"additionalProperties":true},"binding":{"description":"Binding resource the event corresponds to.","type":"string","example":"pagerduty_service"},"detail":{"description":"Additional detail about the event.","type":"string","example":"Example API Service Incident","nullable":true},"link_html":{"description":"URL to the web-page for the source of the event.","type":"string","example":"https://acme.pagerduty.com/incidents/PGR0VU2","nullable":true}},"additionalProperties":false,"required":["type","binding","ts","deduplication_id","actor","attributes","data","detail","link_html"]},"DocumentContentTypeEnum":{"description":"Determines if response should be in JSON format or a document tree","type":"string","default":"application/json","enum":["application/json","application/vnd.konnect.document-tree+json"]},"DocumentFormatContentTypeEnum":{"type":"string","default":"application/json","enum":["application/json"]},"SuggestedResourceAction":{"oneOf":[{"$ref":"#/components/schemas/ArchiveActionPayload"},{"$ref":"#/components/schemas/IgnoreActionPayload"},{"$ref":"#/components/schemas/MapServiceAction"},{"$ref":"#/components/schemas/CreateAndMapServiceActionPayload"}]},"SuggestedResourceActionFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"suggestion_rule_id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"entity_name":{"$ref":"#/components/schemas/StringFieldFilter"},"service_id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"integration.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.display_name":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}]},"integration.instance.id":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilterExact"}]},"ignored":{"$ref":"#/components/schemas/BooleanFieldFilter"},"action.type":{"oneOf":[{"$ref":"#/components/schemas/StringFieldFilterExact"}]},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"additionalProperties":false,"title":"SuggestedResourceActionFilterParameters"},"SuggestedResourceActionObject":{"description":"Contains information about a suggested resource action","allOf":[{"type":"object","required":["id","integration","suggestion_rule_id","entity_name","service_id","action","ignored"],"properties":{"id":{"description":"The suggested resource action rule ID.","type":"string","example":"76ca0689-f08e-4c04-b2a6-4c992d89d554"},"integration":{"$ref":"#/components/schemas/IntegrationRef"},"suggestion_rule_id":{"description":"The identifier of the suggestion rule that generated this suggested resource action.","type":"string","format":"uuid","example":"22f72bd1-2897-473e-9471-302de3ccf38b","nullable":true},"entity_name":{"description":"The entity name of the discovered entity associated to this suggested action.","type":"string","example":"My Service"},"service_id":{"description":"The identifier of the service this suggested resource action may act on.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","nullable":true},"ignored":{"description":"Determines if this suggested action has been ignored or not.\n- `true`: Suggested action has been ignored\n- `false`: Suggested action is ready to be accepted or ignored\n","type":"boolean","example":false},"action":{"$ref":"#/components/schemas/SuggestedResourceAction"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}}}],"title":"SuggestedResourceAction"},"UpdateSuggestedResourceAction":{"description":"Payload to update a suggested resource action.","type":"object","properties":{"ignored":{"description":"Determines if this suggested action has been ignored or not.\n- `true`: Suggested action has been ignored\n- `false`: Suggested action is ready to be accepted or ignored\n","type":"boolean","example":false}},"additionalProperties":false,"required":["ignored"],"title":"UpdateSuggestedResourceAction"},"VulnerabilityScanAttributesFieldFilter":{"description":"Filters the vulnerability scans by values contained within the 'attributes' field. Filters must use dot-notation to identity the property that will be used to filter the results.\n","oneOf":[{"$ref":"#/components/schemas/StringFieldFilter"}],"title":"VulnerabilityScanAttributesFieldFilter"},"ServiceVulnerabilityScanFilterParameters":{"type":"object","properties":{"scan_key":{"$ref":"#/components/schemas/StringFieldFilter"},"environment":{"$ref":"#/components/schemas/StringFieldFilter"},"region":{"$ref":"#/components/schemas/StringFieldFilter"},"source_correlation_key":{"$ref":"#/components/schemas/StringFieldFilter"},"attributes":{"$ref":"#/components/schemas/VulnerabilityScanAttributesFieldFilter"},"ts":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"ServiceVulnerabilityScanFilterParameters"},"VulnerabilityScanFilterParameters":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceVulnerabilityScanFilterParameters"},{"type":"object","properties":{"catalog_reference.service.id":{"$ref":"#/components/schemas/StringFieldFilterExact"}}}],"title":"VulnerabilityScanFilterParameters"},"VulnerabilityScan":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"0ca46543-e6a3-4a8b-8e2c-205935a1bb3a"},"scan_key":{"$ref":"#/components/schemas/VulnerabilityScanKey"},"tool":{"$ref":"#/components/schemas/VulnerabilityScanTool"},"tool_metadata":{"$ref":"#/components/schemas/VulnerabilityScanToolMetadata"},"description":{"type":"string","nullable":true},"catalog_reference":{"$ref":"#/components/schemas/VulnerabilityScanCatalogReference"},"environment":{"type":"string","example":"prod","nullable":true},"region":{"type":"string","example":"us-east-2","nullable":true},"source_correlation_key":{"type":"string","example":"kong/repo-id","nullable":true},"attributes":{"type":"object","example":{"org.kong.enterprise.source.version":"v1"},"additionalProperties":{"type":"string"}},"ts":{"description":"Date the vulnerability scan occurred at.","type":"string","format":"date-time","example":"2025-01-01T00:00:00Z"},"status":{"$ref":"#/components/schemas/VulnerabilityScanStatus"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","scan_key","tool","tool_metadata","description","catalog_reference","environment","region","source_correlation_key","attributes","ts","status","created_at","updated_at"],"title":"VulnerabilityScan"},"VulnerabilityScanKey":{"description":"Machine-usable value to correlate scans (and their vulnerabilities) on a given resource. This value is then\nused to determine vulnerabilities resolved/fixed between subsequent scans on the same resource.\n","type":"string","example":"namespaces/foo:pods/bar-api","title":"VulnerabilityScanKey"},"VulnerabilityScanTool":{"type":"string","example":"trivy","enum":["grype","trivy"]},"VulnerabilityScanToolMetadata":{"type":"object","properties":{"name":{"type":"string","example":"Trivy"},"version":{"type":"string","example":"1.0.0","nullable":true}},"required":["name","version"]},"VulnerabilityScanCatalogReference":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ServiceVulnerabilityScanCatalogReference"}]},"ServiceVulnerabilityScanCatalogReference":{"type":"object","properties":{"service":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"uuid","example":"b72008a7-1a8b-42d7-9691-ed88cbc1e61f"},"name":{"type":"string","example":"user-svc"},"display_name":{"type":"string","example":"User Service"}},"required":["id","name","display_name"]}},"additionalProperties":false,"required":["service"]},"VulnerabilityScanStatus":{"type":"string","enum":["in_progress","completed","failed"],"title":"VulnerabilityScanStatus"},"ServiceVulnerabilityFilterParameters":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringFieldFilterExact"},"state":{"$ref":"#/components/schemas/StringFieldFilterExact"},"title":{"$ref":"#/components/schemas/StringFieldFilter"},"severity":{"$ref":"#/components/schemas/StringFieldFilterExact"},"opened_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"reopened_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"last_opened_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"dismissed_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"fixed_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"instance_count":{"$ref":"#/components/schemas/NumericFieldFilter"}},"title":"ServiceVulnerabilityFilterParameters"},"VulnerabilityScanVulnerabilityFilterParameters":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceVulnerabilityFilterParameters"},{"type":"object","properties":{"scan_state":{"$ref":"#/components/schemas/StringFieldFilterExact"}}}],"title":"VulnerabilityScanVulnerabilityFilterParameters"},"CreateVulnerabilityScan":{"type":"object","properties":{"scan_key":{"$ref":"#/components/schemas/VulnerabilityScanKey"},"tool":{"$ref":"#/components/schemas/VulnerabilityScanTool"},"description":{"type":"string","nullable":true},"raw_scan_report":{"type":"object","additionalProperties":true},"catalog_reference":{"$ref":"#/components/schemas/CreateVulnerabilityScanCatalogReference"},"environment":{"type":"string","example":"prod","nullable":true},"region":{"type":"string","example":"us-east-2","nullable":true},"source_correlation_key":{"description":"Optional key used to correlate vulnerabilities found in this scan with the same vulnerabilities found across different sources.\nThis allows tracking the same vulnerability in two sources as one vulnerability instance.\nWhen omitted, this will inherit the value of `scan_key`.\n","type":"string","example":"kong/repo-id"},"attributes":{"type":"object","example":{"org.kong.enterprise.source.version":"v1"},"additionalProperties":{"type":"string"}},"ts":{"description":"Optional RFC-3339 timestamp indicating when the vulnerability scan was run.\nIf provided, this value will be used as the authoritative scan time.\nIf omitted, the system will attempt to extract a timestamp from the uploaded scan report.\nIf no timestamp can be extracted, the server's current time at ingestion will be used.\n","type":"string","format":"date-time","example":"2025-01-01T00:00:00Z"}},"additionalProperties":false,"required":["scan_key","tool","description","raw_scan_report","catalog_reference","environment","region","attributes"],"title":"UploadVulnerabilityScan"},"CreateServiceVulnerabilityScanCatalogReference":{"type":"object","properties":{"service":{"description":"Reference to the service to map the vulnerability scan to. Can be either the service name or ID.","type":"string","example":"user-svc"}},"additionalProperties":false,"required":["service"]},"CreateVulnerabilityScanCatalogReference":{"type":"object","oneOf":[{"$ref":"#/components/schemas/CreateServiceVulnerabilityScanCatalogReference"}]},"ScanVulnerabilityState":{"type":"string","example":"created","enum":["created","open","fixed"]},"CatalogVulnerabilityState":{"type":"string","example":"open","enum":["open","fixed","dismissed","closed"]},"VulnerabilityInstanceState":{"type":"string","example":"open","enum":["open","fixed"]},"VulnerabilityPackage":{"description":"Details about the package that is affected by vulnerability\n","type":"object","properties":{"name":{"description":"Name of the vulnerable package","type":"string","example":"apt","nullable":true},"version":{"description":"Version of the vulnerable package","type":"string","example":"1.4.11","nullable":true}},"additionalProperties":false,"nullable":true},"VulnerabilityType":{"type":"string","example":"container_image","enum":["container_image","library"],"readOnly":true},"VulnerabilitySeverity":{"type":"string","example":"low","enum":["low","medium","high","critical"]},"VulnerabilityState":{"type":"string","example":"dismissed","enum":["open","fixed","dismissed"]},"BaseVulnerability":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"9932dcab-ec65-46a1-9871-df0aae8e1e8e"},"cve_id":{"type":"string","example":"CVE-2025-1000","nullable":true},"fixed_versions":{"type":"array","items":{"type":"string"},"example":["1.0.1","2.0.0"],"nullable":true},"title":{"type":"string","example":"Summary of CVE finding."},"description":{"type":"string","example":"Further description text of CVE finding.","nullable":true},"severity":{"$ref":"#/components/schemas/VulnerabilitySeverity"},"severity_score":{"description":"numeric representation of severity","type":"integer","example":1},"type":{"$ref":"#/components/schemas/VulnerabilityType"},"raw_finding":{"type":"object","additionalProperties":true},"opened_at":{"type":"string","format":"date-time","example":"2025-01-01T20:41:45.068Z","readOnly":true},"reopened_at":{"type":"string","format":"date-time","example":"2025-01-02T20:41:45.068Z","nullable":true,"readOnly":true},"last_opened_at":{"type":"string","format":"date-time","example":"2025-01-02T20:41:45.068Z","readOnly":true},"dismissed_at":{"type":"string","format":"date-time","example":"2025-01-01T21:41:45.068Z","nullable":true,"readOnly":true},"dismissed_reason":{"type":"string","example":"no_bandwidth","nullable":true},"fixed_at":{"type":"string","format":"date-time","example":"2025-01-01T22:41:45.068Z","nullable":true,"readOnly":true},"instance_count":{"type":"integer","example":1,"readOnly":true},"package":{"$ref":"#/components/schemas/VulnerabilityPackage"},"sources":{"type":"array","items":{"type":"string"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","cve_id","title","description","severity","severity_score","type","raw_finding","opened_at","reopened_at","last_opened_at","dismissed_at","dismissed_reason","fixed_at","fixed_versions","instance_count","package","sources","created_at","updated_at"],"title":"BaseVulnerability"},"CatalogVulnerability":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseVulnerability"},{"type":"object","properties":{"state":{"$ref":"#/components/schemas/CatalogVulnerabilityState"},"service_count":{"type":"integer","example":1}},"required":["state","service_count"]}],"title":"Vulnerability"},"Vulnerability":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/BaseVulnerability"},{"type":"object","properties":{"state":{"$ref":"#/components/schemas/VulnerabilityState"},"service":{"$ref":"#/components/schemas/ServiceReference"}},"required":["state","service"]}],"title":"Vulnerability"},"ScanVulnerability":{"type":"object","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/Vulnerability"},{"type":"object","properties":{"scan_state":{"$ref":"#/components/schemas/ScanVulnerabilityState"}},"required":["scan_state"]}],"title":"ScanVulnerability"},"ServiceReference":{"description":"Reference object containing information about a related service.","type":"object","properties":{"id":{"description":"The service ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"description":"The name of the Service.","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}},"required":["id","name","display_name"],"title":"ServiceReference"},"CatalogVulnerabilityFilterParameters":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceVulnerabilityFilterParameters"},{"type":"object","properties":{"service_count":{"$ref":"#/components/schemas/NumericFieldFilter"}}}],"title":"CatalogVulnerabilityFilterParameters"},"VulnerabilityServiceFilterParameters":{"type":"object","allOf":[{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"vulnerability.state":{"$ref":"#/components/schemas/StringFieldFilterExact"},"vulnerability.opened_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"vulnerability.reopened_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"vulnerability.last_opened_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"vulnerability.dismissed_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"vulnerability.fixed_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"vulnerability.instance_count":{"$ref":"#/components/schemas/NumericFieldFilter"},"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"}]}}}],"title":"VulnerabilityServiceFilterParameters"},"ServiceVulnerabilityAttributes":{"description":"Service-specific attributes of a given vulnerability.","type":"object","properties":{"state":{"$ref":"#/components/schemas/VulnerabilityState"},"opened_at":{"type":"string","format":"date-time","example":"2025-01-01T20:41:45.068Z","readOnly":true},"reopened_at":{"type":"string","format":"date-time","example":"2025-01-02T20:41:45.068Z","nullable":true,"readOnly":true},"last_opened_at":{"type":"string","format":"date-time","example":"2025-01-02T20:41:45.068Z","readOnly":true},"dismissed_at":{"type":"string","format":"date-time","example":"2025-01-01T21:41:45.068Z","nullable":true,"readOnly":true},"dismissed_reason":{"type":"string","example":"no_bandwidth","nullable":true,"readOnly":true},"fixed_at":{"type":"string","format":"date-time","example":"2025-01-01T22:41:45.068Z","nullable":true,"readOnly":true},"instance_count":{"type":"number","example":1,"readOnly":true}},"additionalProperties":false,"required":["state","opened_at","reopened_at","last_opened_at","dismissed_at","dismissed_reason","fixed_at","instance_count"],"title":"ServiceVulnerabilityAttributes"},"VulnerabilityService":{"description":"Service representation that includes attributes for the related vulnerability.","allOf":[{"$ref":"#/components/schemas/CatalogService"},{"type":"object","required":["vulnerability"],"properties":{"vulnerability":{"$ref":"#/components/schemas/ServiceVulnerabilityAttributes"}}}],"title":"VulnerabilityService"},"VulnerabilityInstanceFilterParameters":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceVulnerabilityInstanceFilterParameters"},{"type":"object","properties":{"service.id":{"$ref":"#/components/schemas/StringFieldFilterExact"}}}],"title":"VulnerabilityInstanceFilterParameters"},"ServiceVulnerabilityInstanceFilterParameters":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/StringFieldFilter"},"environment":{"$ref":"#/components/schemas/StringFieldFilter"},"region":{"$ref":"#/components/schemas/StringFieldFilter"},"source_correlation_key":{"$ref":"#/components/schemas/StringFieldFilter"}},"title":"ServiceVulnerabilityInstanceFilterParameters"},"PutVulnerabilitySeverityOverride":{"type":"object","properties":{"comment":{"description":"A human-readable comment associated with the vulnerability override, to add further context and description.\n","type":"string","example":"Severity bumped to high due to business impact.","nullable":true},"severity":{"$ref":"#/components/schemas/VulnerabilitySeverity"}},"additionalProperties":false,"required":["comment","severity"],"title":"PutVulnerabilityOverride"},"PutVulnerabilityDismissal":{"type":"object","properties":{"comment":{"description":"A human-readable comment associated with the vulnerability dismissal, to add further context and description.\n","type":"string","example":"Acceptable risk.","nullable":true},"reason":{"description":"The reason the vulnerability was dismissed.","type":"string","example":"acceptable_risk","nullable":true}},"additionalProperties":false,"required":["comment","reason"],"title":"PutVulnerabilityDismissal"},"CatalogVulnerabilityServiceFilterParameters":{"type":"object","allOf":[{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"display_name":{"$ref":"#/components/schemas/StringFieldFilter"},"labels":{"$ref":"#/components/schemas/LabelsFieldFilter"},"vulnerability.most_recent_vulnerability_opened_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"vulnerability.instance_count":{"$ref":"#/components/schemas/NumericFieldFilter"},"vulnerability.vulnerability_count":{"$ref":"#/components/schemas/NumericFieldFilter"},"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"}]}}}],"title":"CatalogVulnerabilityServiceFilterParameters"},"VulnerabilitiesMetricsQuery":{"description":"A query against vulnerability metrics.","type":"object","properties":{"metrics":{"description":"List of aggregated metrics to collect across the requested time span.","type":"array","items":{"type":"string","enum":["vulnerability_count"]},"maxItems":1,"minItems":1},"dimensions":{"description":"The list of dimensions to group by.","type":"array","items":{"type":"string","enum":["time","service","severity","state","type","source","environment","region"]},"example":["service","state"],"maxItems":2},"filters":{"description":"A list of filters to apply to the query.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterByService"},{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterBySeverity"},{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterByState"},{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterByType"},{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterBySource"},{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterByEnvironment"},{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterByRegion"},{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterByCVE"},{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterByPackageName"},{"$ref":"#/components/schemas/VulnerabilitiesMetricsFilterByScanAttributes"}]}},"granularity":{"description":"Force time grouping into buckets of the specified duration. Only has an effect if `time` is in the `dimensions` list.\n\nThe granularity of the result may be coarser than requested.\nThe exact result granularity will be reported in the response `meta.granularity_ms` field.\n\nIf granularity is not specified and `time` is in the `dimensions` list, a default will be chosen based on the time range requested.\n\nDifferent relative times support different granularities:\n  - 1d  => daily\n  - 7d  => daily, weekly\n  - 3w  => daily, weekly\n  - 30d => daily, weekly\n  - 3mo => daily, weekly\n  - 1y  => daily, weekly\n\nFor special time ranges:\n  - current_week, previous_week   => daily\n  - current_month, previous_month => daily, weekly\n\nFor absolute time ranges, daily will be used.\n","type":"string","enum":["daily","weekly"]},"time_range":{"description":"The time range to query.","discriminator":{"propertyName":"type","mapping":{"relative":"#/components/schemas/VulnerabilityMetricsRelativeTimeRange","absolute":"#/components/schemas/VulnerabilityMetricsAbsoluteTimeRange"}},"oneOf":[{"$ref":"#/components/schemas/VulnerabilityMetricsRelativeTimeRange"},{"$ref":"#/components/schemas/VulnerabilityMetricsAbsoluteTimeRange"}]}},"additionalProperties":false,"required":["metrics","dimensions","filters","time_range"]},"VulnerabilitiesMetricsFilterByService":{"description":"Filters a metrics query by `service`.","type":"object","properties":{"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"type":"string","format":"uuid"}},"field":{"type":"string","enum":["service"]}},"required":["operator","value","field"]},"VulnerabilitiesMetricsFilterBySeverity":{"description":"Filters a metrics query by `severity`.","type":"object","properties":{"field":{"type":"string","enum":["severity"]},"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilitySeverity"}}},"required":["field","operator","value"]},"VulnerabilitiesMetricsFilterByState":{"description":"Filters a metrics query by `state`.","type":"object","properties":{"field":{"type":"string","enum":["state"]},"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityState"}}},"required":["field","operator","value"]},"VulnerabilitiesMetricsFilterByType":{"description":"Filters a metrics query by `type`.","type":"object","properties":{"field":{"type":"string","enum":["type"]},"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityType"}}},"required":["field","operator","value"]},"VulnerabilitiesMetricsFilterBySource":{"description":"Filters a metrics query by `source`.","type":"object","properties":{"field":{"type":"string","enum":["source"]},"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"type":"string","example":"trivy"}}},"required":["field","operator","value"]},"VulnerabilitiesMetricsFilterByEnvironment":{"description":"Filters a metrics query by `environment`.","allOf":[{"type":"object","required":["field"],"properties":{"field":{"type":"string","enum":["environment"]}}},{"oneOf":[{"$ref":"#/components/schemas/EmptyValueMetricsFilter"},{"type":"object","required":["operator","value"],"properties":{"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"type":"string","example":"prod"}}}}]}]},"VulnerabilitiesMetricsFilterByRegion":{"description":"Filters a metrics query by `region`.","allOf":[{"type":"object","required":["field"],"properties":{"field":{"type":"string","enum":["region"]}}},{"oneOf":[{"$ref":"#/components/schemas/EmptyValueMetricsFilter"},{"type":"object","required":["operator","value"],"properties":{"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"type":"string","example":"us-east-1"}}}}]}]},"VulnerabilitiesMetricsFilterByCVE":{"description":"Filters a metrics query by `cve_id`.","allOf":[{"type":"object","required":["field"],"properties":{"field":{"type":"string","enum":["cve_id"]}}},{"oneOf":[{"$ref":"#/components/schemas/EmptyValueMetricsFilter"},{"type":"object","required":["operator","value"],"properties":{"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"type":"string","example":"CVE-2025-1000"}}}}]}]},"VulnerabilitiesMetricsFilterByPackageName":{"description":"Filters a metrics query by `package.name`.","allOf":[{"type":"object","required":["field"],"properties":{"field":{"type":"string","enum":["package.name"]}}},{"oneOf":[{"$ref":"#/components/schemas/EmptyValueMetricsFilter"},{"type":"object","required":["operator","value"],"properties":{"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"type":"string","example":"log4j"}}}}]}]},"VulnerabilitiesMetricsFilterByScanAttributes":{"description":"Filters a metrics query by `scan_attributes` properties.\nDot-notation off of `scan_attributes` is used to specify the property to filter by.\n\nExample: `scan_attributes.image_tag`.\n","example":{"field":"scan_attributes.image_version","operator":"in","value":["2.0.7"]},"allOf":[{"type":"object","required":["field"],"properties":{"field":{"type":"string","pattern":"^scan_attributes\\.[^.\\s]+$"}}},{"oneOf":[{"$ref":"#/components/schemas/EmptyValueMetricsFilter"},{"$ref":"#/components/schemas/StringValueMetricsFilter"},{"$ref":"#/components/schemas/NumericValueMetricsFilter"}]}]},"VulnerabilitiesMetricsQueryResult":{"description":"A query result with metrics grouped by the dimensions specified in the query, at a particular time.","type":"object","properties":{"timestamp":{"description":"Timestamp corresponding to the aggregated metric data in the `event` object.\nRFC-3339 format with a \"T\" character separating date from time within the field value.\n","type":"string","format":"date-time","example":"2025-04-01T07:20:50.000Z"},"event":{"$ref":"#/components/schemas/VulnerabilitiesMetricsQueryResultEvent"}},"required":["timestamp","event"]},"VulnerabilitiesMetricsQueryResultEvent":{"description":"Payload containing the aggregated metric data and associated dimensions included in the query.","oneOf":[{"$ref":"#/components/schemas/VulnerabilityCountMetricEvent"}]},"VulnerabilityCountMetricEvent":{"description":"Payload containing the aggregated vulnerability count metric data and associated dimensions included in the query.","type":"object","properties":{"service":{"type":"string","format":"uuid"},"severity":{"$ref":"#/components/schemas/VulnerabilitySeverity"},"state":{"$ref":"#/components/schemas/VulnerabilityState"},"type":{"$ref":"#/components/schemas/VulnerabilityType"},"source":{"type":"string","example":"trivy"},"environment":{"type":"string","example":"prod"},"region":{"type":"string","example":"us-east-1"},"vulnerability_count":{"type":"number","format":"int32"}},"example":{"vulnerability_count":58,"state":"open","service":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"required":["vulnerability_count"]},"VulnerabilityMetricsAbsoluteTimeRange":{"description":"A duration representing an exact start and end time.","type":"object","properties":{"tz":{"description":"Time zone in IANA Time Zone Database format (e.g., 'America/New_York', 'Europe/London', 'Etc/UTC').\nOptional, defaults to UTC when unspecified.\n","type":"string","example":"America/Chicago","default":"Etc/UTC"},"type":{"type":"string","enum":["absolute"]},"start":{"description":"Start of the query time range in RFC-3339 format.","type":"string","format":"date-time","example":"2025-03-30T07:20:50Z"},"end":{"description":"Start of the query time range in RFC-3339 format.","type":"string","format":"date-time","example":"2025-06-30T08:20:50Z"}},"additionalProperties":false,"required":["type","start","end"]},"VulnerabilityMetricsRelativeTimeRange":{"description":"A duration representing a relative-to-now span of time.\nThe start time is floored to the requested granularity.\nThe exact start and end timestamps are returned in the result query in the meta.start and meta.end fields.\nExample:\n  7d from now, with 1day granularity initiated at 2024-01-08T17:11:00+05:00 will query for the time range from 2024-01-01T00:00:00+05:00 to 2024-01-08T17:11:00+05:00.\n","type":"object","properties":{"tz":{"description":"Time zone in IANA Time Zone Database format (e.g., 'America/New_York', 'Europe/London', 'Etc/UTC').\nOptional, defaults to UTC when unspecified.\n","type":"string","example":"America/Chicago","default":"Etc/UTC"},"type":{"type":"string","enum":["relative"]},"time_range":{"oneOf":[{"title":"RelativeDayTimeRange","type":"string","pattern":"^([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-9]{2}|3[0-5][0-9]|36[0-5])d$","default":"30d"},{"title":"RelativeWeekTimeRange","type":"string","pattern":"^([1-9]|[1-4][0-9]|5[0-2])w$"},{"title":"RelativeMonthTimeRange","type":"string","pattern":"^([1-9]|1[0-2])mo$"},{"title":"RelativeYearTimeRange","type":"string","enum":["1y"]},{"title":"RelativeReservedRange","type":"string","enum":["current_week","current_month","previous_week","previous_month"]}]}},"additionalProperties":false,"required":["type","time_range"]},"VulnerabilitiesMetricsResponseMetadata":{"description":"Metadata about the query response. This includes:\n  - The start and end times of the query\n  - The granularity of the result\n  - Whether the result was truncated\n  - The limit of the result\n  - The `query_id`\n","type":"object","properties":{"start":{"description":"Start of the query time range in RFC-3339 format.","type":"string","format":"date-time","example":"2025-03-30T07:20:50Z"},"start_ms":{"description":"Start of the query time range in epoch format with millisecond precision.","type":"number","example":1743319250000},"end":{"description":"End of the query time range in RFC-3339 format.","type":"string","format":"date-time","example":"2025-03-30T08:20:50Z"},"end_ms":{"description":"End of the query time range in epoch format with millisecond precision.","type":"number","example":1743322850000},"metric_names":{"description":"List of vulnerability metric names included in the result.","type":"array","items":{"type":"string","enum":["vulnerability_count"]}},"metric_units":{"description":"A mapping of metric names to their associated human-friendly display unit.\nThe keys are the metric names, and the values are the units.\n","type":"object","properties":{"vulnerability_count":{"type":"string","enum":["count"]}}},"granularity_ms":{"description":"The number of milliseconds per interval in a time series.\n","type":"number"},"truncated":{"description":"Set to `true`` when the limit of cardinarlity is hit.\nFor queries with 2 dimensions, the limit truncates the first dimension, and then groups all other groupings for the second dimension.\n\nExample: limit of 2 for `service` and `region` would return 2 services maximum, and 2 regions + ____OTHER____.\nThe ____OTHER___ is representative of all other regions.\n","type":"boolean"},"limit":{"description":"The applied cardinality limit.","type":"number"},"query_id":{"description":"An ID that can be used to reference the query.","type":"string","example":"e2a6c0ce-3a90-4b6b-b9bf-cf6428d30ffe"},"display":{"description":"Instructs how to interpret identifiers in the query result.\nThe structure consists of: dimension -> ID -> entity metadata.\nSince entity names within Konnect may overlap, ids are returned and used for exact grouping.\nThis blob may be used to join and display results in a more human-friendly manner.\nSince IDs represent entities in the system at all points in time, historical data will still exist even if an entity is deleted.\nThese such entities are marked with the `deleted: true` value.\nAnother special case is the `____OTHER____` entity.\nWhen the limit of cardinality is reached for a second dimension, the system will group all other entities into the ____OTHER____ grouping.\nThis prevents returning an overwhelming number of long tail entities.\n","type":"object","example":{"service":{"3a564a6a-1952-4181-89f0-a1cadc70123d":{"id":"3a564a6a-1952-4181-89f0-a1cadc70123d","name":"Pricing Svc","deleted":false},"58620e4e-27f4-42eb-9776-402ec319c665":{"id":"58620e4e-27f4-42eb-9776-402ec319c665","name":"Billing Svc","deleted":true}},"state":{"open":{"id":"open","name":"Open","deleted":false},"fixed":{"id":"fixed","name":"Fixed","deleted":false},"dismissed":{"id":"dismissed","name":"Dismissed","deleted":false}}},"properties":{"service":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MetricDimensionDisplayEntry"}},"severity":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MetricDimensionDisplayEntry"}},"state":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MetricDimensionDisplayEntry"}},"type":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MetricDimensionDisplayEntry"}},"source":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MetricDimensionDisplayEntry"}},"environment":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MetricDimensionDisplayEntry"}},"region":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/MetricDimensionDisplayEntry"}}}}},"required":["start","start_ms","end","end_ms","display","metric_names","metric_units","granularity_ms","truncated","limit","query_id"]},"StringValueMetricsFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/MetricsFilterInOperator"},"value":{"type":"array","items":{"type":"string"}}},"required":["operator","value"]},"NumericValueMetricsFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/MetricsFilterNumericOperator"},"value":{"type":"number"}},"required":["operator","value"]},"EmptyValueMetricsFilter":{"type":"object","properties":{"operator":{"$ref":"#/components/schemas/MetricsFilterEmptyOperator"}},"required":["operator"]},"MetricsFilterEmptyOperator":{"description":"The type of filter to apply.\nEmpty values are `null` or undefined.\n","type":"string","enum":["empty","not_empty"]},"MetricsFilterInOperator":{"description":"The type of filter to apply.\n  - `in` filters will limit results to only the specified values\n  - `not_in` filters will exclude the specified values\n","type":"string","enum":["in","not_in"]},"MetricsFilterNumericOperator":{"description":"The type of filter to apply to numeric field values.","type":"string","enum":["=","!=","<",">","<=",">="]},"MetricDimensionDisplayEntry":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"deleted":{"type":"boolean"},"is_other_group":{"type":"boolean"}},"required":["id","name"]},"BaseVulnerabilitySource":{"type":"object","properties":{"type":{"type":"string","example":"grype"},"raw_finding":{"type":"object","additionalProperties":true,"nullable":true}},"required":["type","raw_finding"]},"ScanVulnerabilitySource":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseVulnerabilitySource"},{"type":"object","properties":{"scan_key":{"type":"string"},"scan_tool":{"$ref":"#/components/schemas/VulnerabilityScanToolMetadata"}},"required":["scan_key","scan_tool"]}]},"VulnerabilitySource":{"type":"object","oneOf":[{"$ref":"#/components/schemas/ScanVulnerabilitySource"}]},"VulnerabilityInstance":{"type":"object","properties":{"vulnerability_id":{"type":"string","format":"uuid","example":"5c3ddf1c-d34a-4860-83c1-180bc741e8d4"},"service":{"$ref":"#/components/schemas/ServiceReference"},"state":{"$ref":"#/components/schemas/VulnerabilityInstanceState"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilitySource"}},"opened_at":{"type":"string","format":"date-time","example":"2025-01-01T20:41:45.068Z","readOnly":true},"reopened_at":{"type":"string","format":"date-time","example":"2025-01-02T20:41:45.068Z","nullable":true,"readOnly":true},"last_opened_at":{"type":"string","format":"date-time","example":"2025-01-02T20:41:45.068Z","readOnly":true},"fixed_at":{"type":"string","format":"date-time","example":"2025-01-01T22:41:45.068Z","nullable":true,"readOnly":true},"environment":{"type":"string","example":"prod","nullable":true},"region":{"type":"string","example":"us-east-2","nullable":true},"source_correlation_key":{"description":"Key used to correlate and group activity on this vulnerability instance across different sources (e.g. trivy, grype).\n","type":"string","example":"kong/repo-id","nullable":true}},"additionalProperties":false,"required":["vulnerability_id","service","state","sources","opened_at","reopened_at","last_opened_at","fixed_at","environment","region","source_correlation_key"],"title":"VulnerabilityInstance"},"CatalogVulnerabilityService":{"description":"Service representation that includes cross-vulnerability context.","allOf":[{"$ref":"#/components/schemas/CatalogService"},{"type":"object","required":["vulnerability"],"properties":{"vulnerability":{"$ref":"#/components/schemas/CatalogServiceVulnerabilityAttributes"}}}],"title":"CatalogVulnerabilityService"},"CatalogServiceVulnerabilityAttributes":{"description":"Service-specific attributes describing cross-vulnerability context.","properties":{"most_recent_vulnerability_opened_at":{"type":"string","format":"date-time","example":"2025-01-02T20:41:45.068Z","readOnly":true},"instance_count":{"type":"number","example":1,"readOnly":true},"vulnerability_count":{"type":"number","example":1,"readOnly":true}},"additionalProperties":false,"required":["most_recent_vulnerability_opened_at","instance_count","vulnerability_count"],"title":"CatalogServiceVulnerabilityAttributes"},"CustomFieldSchemaFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"id":{"$ref":"#/components/schemas/StringFieldEqualsFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"additionalProperties":false,"title":"CustomFieldSchemaFilterParameters"},"CustomFieldSchema":{"description":"Contains information about a custom field schema.","type":"object","properties":{"id":{"description":"The Custom Field ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"name":{"description":"The name of the custom field.","type":"string","example":"slack-url","maxLength":120},"schema":{"description":"JSON object containing the custom field schema definition.","type":"object","example":{"display_name":"slack url","description":"Slack URL metadata.","required":false,"type":"string"},"default":{},"additionalProperties":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","schema","created_at","updated_at"]},"CreateQuota":{"description":"Payload to create an organization override for a default quota.","type":"object","properties":{"qualifier":{"$ref":"#/components/schemas/QuotaQualifier"},"value":{"$ref":"#/components/schemas/QuotaValue"}},"additionalProperties":false,"required":["qualifier","value"]},"UpdateQuota":{"description":"Payload to update an organization override value.","type":"object","properties":{"value":{"$ref":"#/components/schemas/QuotaValue"}},"additionalProperties":false,"required":["value"]},"QuotaQualifier":{"description":"Identifies the kind of quota. The API may return additional qualifier values over time as new quota types are introduced.\n","type":"string","example":"scorecard_evaluation_usage_1h","enum":["scorecard_evaluation_usage_1h"]},"QuotaValue":{"description":"The value of a quota. Must be a non-negative integer. The interpretation of the value depends on the quota qualifier.\n","type":"integer","example":2,"minimum":0},"Quota":{"description":"Organization-specific quota overrides linked to a default quota.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f","readOnly":true},"qualifier":{"$ref":"#/components/schemas/QuotaQualifier"},"name":{"description":"Human-readable name of the default quota.","type":"string"},"description":{"description":"Longer description of what the quota limits.","type":"string"},"value":{"$ref":"#/components/schemas/QuotaValue"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","qualifier","name","description","value","created_at","updated_at"]},"DefaultQuota":{"description":"A system-defined default quota definition.","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"f3704e4c-104d-4f21-998a-20d4364c893f","readOnly":true},"qualifier":{"$ref":"#/components/schemas/QuotaQualifier"},"name":{"description":"Human-readable name of the default quota.","type":"string"},"description":{"description":"Longer description of what the quota limits.","type":"string"},"value":{"$ref":"#/components/schemas/QuotaValue"},"overrides":{"description":"Organizational overrides for this quota.","type":"array","items":{"$ref":"#/components/schemas/Quota"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","qualifier","name","description","value","created_at","updated_at"]},"StringFieldEqualsFilter":{"description":"Filters on the given string field value by exact match.","properties":{"eq":{"type":"string"}},"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"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"}}}]},"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"]},"Slug":{"description":"document slug","type":"string","example":"path-for-seo","maxLength":512,"pattern":"^[\\w\\/-]+$"},"MoveDocumentRequestPayload":{"description":"move document request payload","type":"object","properties":{"parent_document_id":{"description":"parent document id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2"},"index":{"description":"index of the document in the parent document's children","type":"integer","example":1}},"title":"Move document"},"UnsupportedMediaTypeError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":415},"title":{"example":"UnsupportedMediaType"},"type":{"example":"https://httpstatuses.com/415"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"UnsupportedMediaType"}}}]}},"examples":{"CatalogIntegrationResponse":{"value":{"name":"catalog-integration","display_name":"Catalog Integration","description":"Example of catalog integration.","built_in":false,"version":"v1","authorization":null,"config_schema":{},"visibility":"public","resource_types":{"service":{"display_name":"Service","schema":{"type":"simple","definition":{"id":"string"}},"integration_data_schema":{"type":"json_schema","definition":{"type":"object","properties":{"id":{"type":"string","example":"456"}}}},"resource_id_template":"{{id}}"}},"discovery":{"resource_integration_data_examples":{"service":{"id":456}}},"api_spec_provider":null,"events":null}},"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"}},"integration_data_schema":null,"resource_id_template":"{{control_plane_id}}:{{gateway_service_id}}"}},"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"}},"integration_data_schema":null,"resource_id_template":"{{report_id}}"}},"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"}},"integration_data_schema":null,"resource_id_template":"{{global_control_plane_id}}:{{mesh_name}}"}},"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}}}},"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"}},"CreatePrivateCatalogIntegrationPayload":{"value":{"visibility":"private","description":"description of integration","display_name":"Catalog Integration","resource_types":{"service":{"display_name":"Service","scope":"service","schema":{"type":"simple","definition":{"id":"string"}},"integration_data_schema":{"type":"json_schema","definition":{"type":"object","properties":{"id":{"type":"string","example":"456"}}}},"resource_id_template":"{{id}}"}}}},"UpdateCatalogIntegrationPayload":{"value":{"description":"Updated description","display_name":"Updated Integration"}},"CreateServiceApiUrlPayload":{"value":{"name":"spec-from-url","description":"API Spec from URL","provider":{"type":"url","config":{"url":"https://my-company.com/api-specs/openapi.yaml"}}}},"ServiceApiUrlResponse":{"value":{"id":"8e3882ff-ad0f-4690-a5a7-c69323084109","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","resource_id":null,"name":"spec-from-url","description":"API Spec from URL","created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z","provider":{"type":"url","config":{"url":"https://my-company.com/api-specs/openapi.yaml"}}}},"CreateServiceApiRawPayload":{"value":{"name":"spec-from-raw","description":"API Spec from Raw","provider":{"type":"raw","config":{"contents":"openapi: 3.0.0\ninfo:\n  version: 1.0.0\n  title: Swagger Petstore\n  license:\n    name: MIT\nservers:\n  - url: http://petstore.swagger.io/v1\npaths:\n  /pets:\n    get:\n      summary: List all pets\n      operationId: listPets\n      tags:\n        - pets\n      parameters:\n        - name: limit\n          in: query\n          description: How many items to return at one time (max 100)\n          required: false\n          schema:\n            type: integer\n            maximum: 100\n            format: int32\n      responses:\n        '200':\n          description: A paged array of pets\n          headers:\n            x-next:\n              description: A link to the next page of responses\n              schema:\n                type: string\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Pets'\n        default:\n          description: unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\n    post:\n      summary: Create a pet\n      operationId: createPets\n      tags:\n        - pets\n      requestBody:\n        content:\n          application/json:\n            schema:\n              $ref: '#/components/schemas/Pet'\n        required: true\n      responses:\n        '201':\n          description: Null response\n        default:\n          description: unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\n  /pets/{petId}:\n    get:\n      summary: Info for a specific pet\n      operationId: showPetById\n      tags:\n        - pets\n      parameters:\n        - name: petId\n          in: path\n          required: true\n          description: The id of the pet to retrieve\n          schema:\n            type: string\n      responses:\n        '200':\n          description: Expected response to a valid request\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Pet'\n        default:\n          description: unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\ncomponents:\n  schemas:\n    Pet:\n      type: object\n      required:\n        - id\n        - name\n      properties:\n        id:\n          type: integer\n          format: int64\n        name:\n          type: string\n        tag:\n          type: string\n    Pets:\n      type: array\n      maxItems: 100\n      items:\n        $ref: '#/components/schemas/Pet'\n    Error:\n      type: object\n      required:\n        - code\n        - message\n      properties:\n        code:\n          type: integer\n          format: int32\n        message:\n          type: string\n"}}}},"ServiceApiRawResponse":{"value":{"id":"a237f806-e9ea-4c56-89f5-ab92b5e19913","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","resource_id":null,"name":"spec-from-raw","description":"API Spec from Raw","created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z","provider":{"type":"raw","config":{}}}},"CreateServiceApiIntegrationPayload":{"value":{"name":"spec-from-integration","description":"API Spec from Integration","provider":{"type":"github_repo","integration_instance":"bd24cfdd-619e-4696-b58d-a9ea49e5ea39","config":{"owner":"MyOrganization","repo":"MyService","spec_path":"openapi.yaml"}}}},"CreateServiceApiIntegrationResponse":{"value":{"id":"3a276c30-f209-44dc-9814-df291bc94950","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","name":"spec-from-integration","description":"API Spec from Integration","resource_id":null,"created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z","provider":{"type":"github_repo","config":{"repo":"MyOrganization","owner":"MyService","spec_path":"openapi.yaml"},"integration":{"name":"github","display_name":"GitHub","instance":{"id":"bd24cfdd-619e-4696-b58d-a9ea49e5ea39","name":"github","display_name":"GitHub"}}}}},"CreateServiceApiResourcePayload":{"value":{"name":"spec-from-resource","description":"API Spec from Resource","provider":{"type":"swaggerhub_api_version","config":{"resource_id":"ok-qTDpuiQp7DWK0"}}}},"CreateServiceApiResourceResponse":{"value":{"id":"e0928050-20d0-448f-947d-624d9901947e","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","resource_id":"ok-qTDpuiQp7DWK0","name":"spec-from-resource","description":"API Spec from Resource","created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z","provider":{"type":"swaggerhub_api_version","config":{"resource_id":"ok-qTDpuiQp7DWK0"},"integration":{"name":"swaggerhub","display_name":"SwaggerHub","instance":{"id":"e0f2388b-2efe-42a3-a9e4-86f12d3e8c77","name":"swaggerhub-internal","display_name":"SwaggerHub (Internal)"}}}}},"UpdateServiceApiPayload":{"value":{"name":"api-spec-name","description":"API Spec Description"}},"ListServiceApiResponse":{"value":{"data":[{"id":"8e3882ff-ad0f-4690-a5a7-c69323084109","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","resource_id":null,"name":"spec-from-url","description":"API Spec from URL","created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z","provider":{"type":"url","config":{"url":"https://my-company.com/api-specs/openapi.yaml"}}},{"id":"a237f806-e9ea-4c56-89f5-ab92b5e19913","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","resource_id":null,"name":"spec-from-raw","description":"API Spec from Raw","created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z","provider":{"type":"raw","config":{}}},{"id":"3a276c30-f209-44dc-9814-df291bc94950","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","name":"spec-from-integration","description":"API Spec from Integration","resource_id":null,"created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z","provider":{"type":"github_repo","config":{"repo":"MyOrganization","owner":"MyService","spec_path":"openapi.yaml"},"integration":{"name":"github","display_name":"GitHub","instance":{"id":"bd24cfdd-619e-4696-b58d-a9ea49e5ea39","name":"github","display_name":"GitHub"}}}},{"id":"e0928050-20d0-448f-947d-624d9901947e","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","resource_id":"ok-qTDpuiQp7DWK0","name":"spec-from-resource","description":"API Spec from Resource","created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z","provider":{"type":"swaggerhub_api_version","config":{"resource_id":"ok-qTDpuiQp7DWK0"},"integration":{"name":"swaggerhub","display_name":"SwaggerHub","instance":{"id":"e0f2388b-2efe-42a3-a9e4-86f12d3e8c77","name":"swaggerhub-internal","display_name":"SwaggerHub (Internal)"}}}}],"meta":{"page":{"total":4,"size":100,"number":1}}}},"PreviewServiceApiUrlPayload":{"value":{"provider":{"type":"url","config":{"url":"https://my-company.com/api-specs/openapi.yaml"}}}},"PreviewServiceApiRawPayload":{"value":{"provider":{"type":"raw","config":{"contents":"openapi: 3.0.0\ninfo:\n  version: 1.0.0\n  title: Swagger Petstore\n  license:\n    name: MIT\nservers:\n  - url: http://petstore.swagger.io/v1\npaths:\n  /pets:\n    get:\n      summary: List all pets\n      operationId: listPets\n      tags:\n        - pets\n      parameters:\n        - name: limit\n          in: query\n          description: How many items to return at one time (max 100)\n          required: false\n          schema:\n            type: integer\n            maximum: 100\n            format: int32\n      responses:\n        '200':\n          description: A paged array of pets\n          headers:\n            x-next:\n              description: A link to the next page of responses\n              schema:\n                type: string\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Pets'\n        default:\n          description: unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\n    post:\n      summary: Create a pet\n      operationId: createPets\n      tags:\n        - pets\n      requestBody:\n        content:\n          application/json:\n            schema:\n              $ref: '#/components/schemas/Pet'\n        required: true\n      responses:\n        '201':\n          description: Null response\n        default:\n          description: unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\n  /pets/{petId}:\n    get:\n      summary: Info for a specific pet\n      operationId: showPetById\n      tags:\n        - pets\n      parameters:\n        - name: petId\n          in: path\n          required: true\n          description: The id of the pet to retrieve\n          schema:\n            type: string\n      responses:\n        '200':\n          description: Expected response to a valid request\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Pet'\n        default:\n          description: unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/Error'\ncomponents:\n  schemas:\n    Pet:\n      type: object\n      required:\n        - id\n        - name\n      properties:\n        id:\n          type: integer\n          format: int64\n        name:\n          type: string\n        tag:\n          type: string\n    Pets:\n      type: array\n      maxItems: 100\n      items:\n        $ref: '#/components/schemas/Pet'\n    Error:\n      type: object\n      required:\n        - code\n        - message\n      properties:\n        code:\n          type: integer\n          format: int32\n        message:\n          type: string\n"}}}},"PreviewServiceApiIntegrationPayload":{"value":{"provider":{"type":"github_repo","integration_instance":"bd24cfdd-619e-4696-b58d-a9ea49e5ea39","config":{"owner":"MyOrganization","repo":"MyService","spec_path":"openapi.yaml"}}}},"PreviewServiceApiResourcePayload":{"value":{"provider":{"type":"swaggerhub_api_version","config":{"resource_id":"ok-qTDpuiQp7DWK0"}}}},"PreviewServiceApiResponseJson":{"value":{"openapi":"3.0.0","info":{"version":"1.0.0","title":"Swagger Petstore","license":{"name":"MIT"}},"servers":[{"url":"http://petstore.swagger.io/v1"}],"paths":{},"components":{"schemas":{"Pet":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"tag":{"type":"string"}}},"Pets":{"type":"array","maxItems":100,"items":{"ref":"#/components/schemas/Pet"}},"Error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}}}}}},"PreviewApiSpecResponseJson":{"value":"\"{\\\"openapi\\\":\\\"3.0.0\\\",\\\"info\\\":{\\\"version\\\":\\\"1.0.0\\\",\\\"title\\\":\\\"Swagger Petstore\\\",\\\"license\\\":{\\\"name\\\":\\\"MIT\\\"}},\\\"servers\\\":[{\\\"url\\\":\\\"http://petstore.swagger.io/v1\\\"}],\\\"paths\\\":{\\\"/pets\\\":{\\\"get\\\":{\\\"summary\\\":\\\"List all pets\\\",\\\"operationId\\\":\\\"listPets\\\"}}}}\""},"PreviewServiceApiResponseYaml":{"value":"openapi: 3.0.0\ninfo:\n  version: 1.0.0\n  title: Swagger Petstore\n  license:\n    name: MIT\nservers:\n  - url: http://petstore.swagger.io/v1\npaths:\n  /pets:\n    get:\n      summary: List all pets\n      operationId: listPets\n      tags:\n        - pets\n      parameters:\n        - name: limit\n          in: query\n          description: How many items to return at one time (max 100)\n          required: false\n          schema:\n            type: integer\n            maximum: 100\n            format: int32\n      responses:\n        \"200\":\n          description: A paged array of pets\n          headers:\n            x-next:\n              description: A link to the next page of responses\n              schema:\n                type: string\n          content:\n            application/json:\n              schema:\n                $ref: \"#/components/schemas/Pets\"\n        default:\n          description: unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: \"#/components/schemas/Error\"\n    post:\n      summary: Create a pet\n      operationId: createPets\n      tags:\n        - pets\n      requestBody:\n        content:\n          application/json:\n            schema:\n              $ref: \"#/components/schemas/Pet\"\n        required: true\n      responses:\n        \"201\":\n          description: Null response\n        default:\n          description: unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: \"#/components/schemas/Error\"\n  /pets/{petId}:\n    get:\n      summary: Info for a specific pet\n      operationId: showPetById\n      tags:\n        - pets\n      parameters:\n        - name: petId\n          in: path\n          required: true\n          description: The id of the pet to retrieve\n          schema:\n            type: string\n      responses:\n        \"200\":\n          description: Expected response to a valid request\n          content:\n            application/json:\n              schema:\n                $ref: \"#/components/schemas/Pet\"\n        default:\n          description: unexpected error\n          content:\n            application/json:\n              schema:\n                $ref: \"#/components/schemas/Error\"\ncomponents:\n  schemas:\n    Pet:\n      type: object\n      required:\n        - id\n        - name\n      properties:\n        id:\n          type: integer\n          format: int64\n        name:\n          type: string\n        tag:\n          type: string\n    Pets:\n      type: array\n      maxItems: 100\n      items:\n        $ref: \"#/components/schemas/Pet\"\n    Error:\n      type: object\n      required:\n        - code\n        - message\n      properties:\n        code:\n          type: integer\n          format: int32\n        message:\n          type: string\n"},"ResourceIngestionPayload":{"value":{"ingest_from":"2025-07-01T00:00:00Z"}},"ResourceIngestionStatusOk":{"value":{"last_scheduled":"2025-07-01T00:00:00Z","next_scheduled_at":"2025-07-01T00:00:00Z","scheduler_state":{"status":"ok"}}},"ResourceIngestionStatusDelayed":{"value":{"last_scheduled":"2025-07-01T00:00:00Z","next_scheduled_at":"2025-07-01T00:00:00Z","scheduler_state":{"status":"delayed","reason":"Integration provider is experiencing a temporary outage.","remediation":null}}},"ResourceIngestionStatusHalted":{"value":{"last_scheduled":null,"next_scheduled_at":null,"scheduler_state":{"status":"halted","reason":"Resource ingestion failing due to insufficient permissions.","remediation":"Reauthorize integration instance with sufficient permissions."}}},"ListResourceActionsResponse":{"value":{"data":[{"id":"93b411db-6f68-47d2-8959-de2d91914f2f","user_id":"12345678-1234-5678-1234-123456789012","action_type":"map","cause":"user-action","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","resource_id":"rQIGLHo1vhgy5VYb","resource_name":"my-gateway-service","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"9de3f4dd-41bc-4844-a38b-de74eb6ed002","name":"gateway-manager","display_name":"Gateway Manager"}},"created_at":"2025-07-01T00:00:00Z"},{"id":"123e4567-e89b-12d3-a456-426614174000","user_id":"12345678-1234-5678-1234-123456789012","action_type":"unmap","cause":"user-action","service_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","resource_id":"rQIGLHo1vhgy5VYb","resource_name":"my-gateway-service","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"9de3f4dd-41bc-4844-a38b-de74eb6ed002","name":"gateway-manager","display_name":"Gateway Manager"}},"created_at":"2025-07-01T00:00:00Z"},{"id":"456e7890-e12b-34d5-a678-426614174000","user_id":"12345678-1234-5678-1234-123456789012","action_type":"archive","cause":"user-action","service_id":null,"resource_id":"rQIGLHo1vhgy5VYb","resource_name":"my-gateway-service","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"9de3f4dd-41bc-4844-a38b-de74eb6ed002","name":"gateway-manager","display_name":"Gateway Manager"}},"created_at":"2025-07-01T00:00:00Z"},{"id":"789e0123-e45b-67d8-a901-426614174000","user_id":null,"action_type":"restore","cause":"suggestion-rule","service_id":null,"resource_id":"rQIGLHo1vhgy5VYb","resource_name":"my-gateway-service","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"9de3f4dd-41bc-4844-a38b-de74eb6ed002","name":"gateway-manager","display_name":"Gateway Manager"}},"created_at":"2025-07-01T00:00:00Z"}],"meta":{"page":{"size":4,"next":"/servicehub/v1/resource-actions?page[size]=2&page[after]=CChwKiIxLSBscUg9KisFRwtOBVVBQ1pTPh8kIhVWHGwmFkA1ERxaLlMuRSEDf3sBcBRmfmJ6ZmZyEH98UGpsdFQEQBhiDW9DC10qTyYuAhhCbHhRWjIRHFo3QCZVNgN_e1IzRXF_cDoqODQhbHFIbzl8M34tYBJrQCkCA2Y7DWUaKQ","previous":null,"first":"/servicehub/v1/resource-actions?page[size]=2"}}}},"IntegrationNotInstalledError":{"value":{"status":404,"type":"service_catalog_integration_not_installed","title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}},"IntegrationNotAuthorizedError":{"value":{"status":400,"type":"service_catalog_integration_unauthorized","title":"Invalid Request","instance":"kong:trace:6816496025408232265","detail":"The integration instance \"cc461d8c-dade-4ce0-ad86-290f3ff8de1a\" is unauthorized","invalid_parameters":[{"field":"integration_instance","rule":"invalid","source":"path","reason":"The integration instance \"cc461d8c-dade-4ce0-ad86-290f3ff8de1a\" is unauthorized"}]}},"BadRequestError":{"value":{"status":400,"title":"Invalid Request","instance":"kong:trace:6816496025408232265","detail":"Invalid Parameters","invalid_parameters":[{"field":"method","rule":"required","source":"body","reason":"must have required property 'method'"}]}},"ListSystemSuggestionRulesResponse":{"value":{"data":[{"id":"00000000-0000-0000-0000-000000000000","name":"Gateway Manager System Rule","description":"This rule is triggered when a gateway service resource has a tag of the form \"KonnectService:<my-service-name>\".\nIt will map the resource to a service with the name <my-service-name>.\nIf there is no existing service with the name <my-service-name> a service will be created before mapping the resource.\nNote that service name will be transformed with the following rules:\n- all letters in <my-service-name> will be coverted to lower case letters\n- trailing and leading spaces in <my-service-name> will be removed\n- all consecutive spaces in <my-service-name> be converted to a hyphen\n- all underscores in <my-service-name> will be converted to a hyphen","auto_accept":true,"active":true,"binding":"gateway_svc","action":{"type":"create-or-map"}}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"ListSuggestionRulesResponse":{"value":{"data":[{"id":"fa4d3c44-a6f9-4077-b75f-66760ed3dc19","name":"sample-datadog-monitors","description":"Rule to map all sample monitors to the sample service. Matches any monitor that satisfies one of the following:\n- monitor is tagged with a value with the prefix \"service:sample\" (ex:\"service:sample\", \"service:sample-gateway-manager-app\")","auto_accept":true,"active":true,"binding":"datadog_monitor","discovery_selector":"| any(.tags[];  startswith(\"service:sample\"))","action":{"type":"map","data":{"service":{"name":"servicehub"},"resource":{"labels":{}}}},"created_at":"2024-10-23T15:55:32.985Z","updated_at":"2024-10-23T16:02:53.751Z"}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"SuggestionRule":{"value":{"id":"fa4d3c44-a6f9-4077-b75f-66760ed3dc19","name":"sample-datadog-monitors","description":"Rule to map all sample monitors to the sample service. Matches any monitor that satisfies one of the following:\n- monitor is tagged with a value with the prefix \"service:sample\" (ex:\"service:sample\", \"service:sample-gateway-manager-app\")","auto_accept":true,"active":true,"binding":"datadog_monitor","discovery_selector":"| any(.tags[];  startswith(\"service:sample\"))","action":{"type":"map","data":{"service":{"name":"sample"},"resource":{"labels":{}}}},"created_at":"2024-10-23T15:55:32.985Z","updated_at":"2024-10-23T16:02:53.751Z"}},"CreateSuggestionRule":{"value":{"name":"sample-datadog-monitors","description":"Rule to map all sample monitors to the sample service. Matches any monitor that satisfies one of the following:\n- monitor is tagged with a value with the prefix \"service:sample\" (ex:\"service:sample\", \"service:sample-gateway-manager-app\")","auto_accept":true,"active":true,"binding":"datadog_monitor","discovery_selector":"| any(.tags[];  startswith(\"service:sample\"))","action":{"type":"map","data":{"service":{"name":"sample"},"resource":{"labels":{}}}}}},"TestSuggestionRule":{"value":{"binding":"datadog_monitor","discovery_selector":"| any(.tags[];  startswith(\"service:sample\"))","action":{"type":"map","data":{"service":{"name":"sample"},"resource":{"labels":{}}}},"integration_record":{"name":"sample-monitor","description":"A sample monitor","tags":["service:sample"]}}},"TestSuggestionRuleArchiveResponse":{"value":{"evaluation":{"matched":true,"service_id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","action":{"type":"archive"}},"errors":[]}},"ListSuggestionRuleErrorsResponse":{"value":{"data":[{"id":"e4698717-7f0b-434d-aa16-a472089c2504","resource_id":"qLgnGlFp4iveGUFl","suggestion_rule_id":"fd109d4a-e183-4488-98f2-10eab0964155","details":[{"type":"invalid-expression","message":"JQ expression is invalid","expression":"invalid-jq-expression","field":"discovery_selector"}],"created_at":"2025-07-01T00:00:00Z","updated_at":"2025-07-01T00:00:00Z"}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"ListIntegrationEventsResponse":{"value":{"data":[{"id":"123e4567-e89b-12d3-a456-426614174000","type":"incident.triggered","ts":"2024-01-01T00:00:00Z","service_id":"b268ca70-9b75-4355-8726-63788463a66f","deduplication_id":"1d34191ebfe305a56bf4f3303d1a8dcf","resource_id":"8_l-yZ8UQtc_e6Pp","actor":{"type":"user","id":"PLH1HKV","name":"John Doe"},"attributes":{"service_id":"PLK33TY","incident_id":"PGR0VU2","escalation_policy_id":"P005NFS","priority_id":"P9BO35Z","urgency":"low","title":"Example API Service Incident","html_url":"https://acme.pagerduty.com/incidents/PGR0VU2"},"integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"9de3f4dd-41bc-4844-a38b-de74eb6ed002","name":"gateway-manager","display_name":"Gateway Manager"}},"binding":"pagerduty_service","detail":"Example API Service Incident","link_html":"https://acme.pagerduty.com/incidents/PGR0VU2"}],"meta":{"page":{"size":1,"next":"/v1/integration-events?page[size]=2&page[after]=CChwKiIxLSBscUg9KisFRwtOBVVBQ1pTPh8kIhVWHGwmFkA1ERxaLlMuRSEDf3sBcBRmfmJ6ZmZyEH98UGpsdFQEQBhiDW9DC10qTyYuAhhCbHhRWjIRHFo3QCZVNgN_e1IzRXF_cDoqODQhbHFIbzl8M34tYBJrQCkCA2Y7DWUaKQ","previous":null,"first":"/v1/integration-events?page[size]=2"}}}},"ServiceDocumentPayload":{"value":{"slug":"readme","title":"README","content":"My Documentation"}},"ServiceDocumentChildPayload":{"value":{"slug":"readme","title":"README","content":"My Documentation","parent_document_id":"11155a77-c87b-453e-93fd-5d517a68a211"}},"MoveServiceDocumentPayload":{"value":{"parent_document_id":"71a10e4f-8def-44db-b9b2-88823f41b5e8","index":0}},"ListServiceDocumentsResponseJSON":{"value":{"data":[{"id":"71a10e4f-8def-44db-b9b2-88823f41b5e8","slug":"readme","title":"README","parent_document_id":null,"created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z"},{"id":"238e1720-44d8-462d-a147-ed1d1c2a6412","slug":"architecture","title":"Architecture","parent_document_id":"7b453ae4-66f5-4530-88b0-0b6e34072325","created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z"}],"meta":{"page":{"number":1,"size":100,"total":2}}}},"ListServiceDocumentsResponseJSONTree":{"value":{"data":[{"id":"7b453ae4-66f5-4530-88b0-0b6e34072325","slug":"readme","title":"README","created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z","children":{"id":"238e1720-44d8-462d-a147-ed1d1c2a6412","slug":"architecture","title":"Architecture","parent_document_id":"7b453ae4-66f5-4530-88b0-0b6e34072325","children":[],"created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z"}}],"meta":{"page":{"number":1,"size":1,"total":1}}}},"ServiceDocumentResponseJSON":{"value":{"id":"7b453ae4-66f5-4530-88b0-0b6e34072325","slug":"readme","title":"README","content":"My Documentation","parent_document_id":null,"created_at":"2025-05-01T00:00:00.000000Z","updated_at":"2025-05-01T00:00:00.000000Z"}},"ListSuggestedResourceActionsResponse":{"value":{"data":[{"id":"123e4567-e89b-12d3-a456-426614174000","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"9de3f4dd-41bc-4844-a38b-de74eb6ed002","name":"gateway-manager","display_name":"Gateway Manager"}},"suggestion_rule_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","entity_name":"My Service","service_id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","ignored":false,"action":{"type":"map","data":{"service":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"resource":{"labels":{"env":"test"}}}},"created_at":"2025-07-01T00:00:00Z","updated_at":"2025-07-01T00:00:00Z"}],"meta":{"page":{"total":1,"size":100,"number":1}}}},"SuggestedResourceActionResponse":{"value":{"id":"123e4567-e89b-12d3-a456-426614174000","integration":{"name":"gateway-manager","display_name":"Gateway Manager","instance":{"id":"9de3f4dd-41bc-4844-a38b-de74eb6ed002","name":"gateway-manager","display_name":"Gateway Manager"}},"suggestion_rule_id":"204d85d2-1bb9-4864-842f-6d97a7cbca2c","entity_name":"My Service","service_id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","ignored":false,"action":{"type":"map","data":{"service":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"resource":{"labels":{"env":"test"}}}},"created_at":"2025-07-01T00:00:00Z","updated_at":"2025-07-01T00:00:00Z"}},"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"}},"UnsupportedMediaTypeExample":{"value":{"status":415,"title":"Unsupported Media Type","instance":"kong:trace:8347343766220159418","detail":"This API only supports requests with `Content-Type: application/json`"}}},"requestBodies":{"CreateCatalogServiceApiRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogServiceApiSpec"},"examples":{"Url":{"$ref":"#/components/examples/CreateServiceApiUrlPayload"},"Raw":{"$ref":"#/components/examples/CreateServiceApiRawPayload"},"Integration":{"$ref":"#/components/examples/CreateServiceApiIntegrationPayload"},"Resource":{"$ref":"#/components/examples/CreateServiceApiResourcePayload"}}}}},"UpdateCatalogServiceApiRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogServiceApiSpec"},"examples":{"Update Service API":{"$ref":"#/components/examples/UpdateServiceApiPayload"}}}}},"CreateCatalogIntegrationRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogIntegration"},"examples":{"Integration":{"$ref":"#/components/examples/CreatePrivateCatalogIntegrationPayload"}}}}},"UpdateCatalogIntegrationRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogIntegration"},"examples":{"Integration":{"$ref":"#/components/examples/UpdateCatalogIntegrationPayload"}}}}},"PreviewCatalogServiceApiRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewCatalogServiceApiSpec"},"examples":{"Url":{"$ref":"#/components/examples/PreviewServiceApiUrlPayload"},"Raw":{"$ref":"#/components/examples/PreviewServiceApiRawPayload"},"Integration":{"$ref":"#/components/examples/PreviewServiceApiIntegrationPayload"},"Resource":{"$ref":"#/components/examples/PreviewServiceApiResourcePayload"}}}}},"ApiSpecPreviewRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewCatalogServiceApiSpec"},"examples":{"Url":{"$ref":"#/components/examples/PreviewServiceApiUrlPayload"},"Raw":{"$ref":"#/components/examples/PreviewServiceApiRawPayload"},"Integration":{"$ref":"#/components/examples/PreviewServiceApiIntegrationPayload"},"Resource":{"$ref":"#/components/examples/PreviewServiceApiResourcePayload"}}}}},"InitializeCatalogResourceRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitializeCatalogResource"}}}},"DeleteCatalogResourcesRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCatalogResources"}}}},"UpsertCatalogResourcesRequest":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UpsertCatalogResource"},"maxItems":100,"minItems":1}},"additionalProperties":false,"required":["data"]}}}},"ResourceIngestionBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleResourceIngestion"},"examples":{"Resource Ingestion":{"$ref":"#/components/examples/ResourceIngestionPayload"}}}}},"IntegrationInstanceProxyBody":{"description":"Request body schema for an integration instance proxy request.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"description":"The HTTP request method.","type":"string","example":"GET","enum":["DELETE","GET","PATCH","POST","PUT"]},"base_url":{"description":"The base URL of the proxied API as defined in the integration manifest.","type":"string","format":"uri","example":"https://api.pagerduty.com"},"path":{"description":"The URL path of the proxied API request as defined in the integration manifest.","type":"string","example":"/incidents","writeOnly":true},"body":{"description":"JSON object representing the request body that will be sent to the proxied API.","type":"object","example":{"name":"Foo"},"additionalProperties":true},"query":{"description":"JSON object representing the query parameters that will be sent to the proxied API.","type":"object","example":{"limit":5,"offset":10},"additionalProperties":true},"headers":{"description":"JSON object representing the request headers that will be sent to the proxied API.","type":"object","example":{"content-type":"application/json"},"additionalProperties":true}},"additionalProperties":false,"required":["method","base_url","path"]}}}},"CreateSuggestionRuleBody":{"description":"Request body schema for creating a suggestion rule for an integration.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionRulePayload"},"examples":{"Suggestion Rule":{"$ref":"#/components/examples/CreateSuggestionRule"}}}}},"CreateTestSuggestionRuleBody":{"description":"Request body schema for testing a suggestion rule configuration against an integration data.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuggestionRulePayload"},"examples":{"Test Suggestion Rule":{"$ref":"#/components/examples/TestSuggestionRule"}}}}},"CreateIntegrationEventsBody":{"description":"Request body schema for bulk-creating integration events.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateIntegrationEvent"}}},"additionalProperties":false,"required":["data"]}}}},"CreateServiceDocumentBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateServiceDocumentPayload"},"examples":{"Service Document":{"$ref":"#/components/examples/ServiceDocumentPayload"},"Service Document Child":{"$ref":"#/components/examples/ServiceDocumentChildPayload"}}}}},"UpdateServiceDocumentBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateServiceDocumentPayload"},"examples":{"Service Document":{"$ref":"#/components/examples/ServiceDocumentPayload"},"Service Document Child":{"$ref":"#/components/examples/ServiceDocumentChildPayload"}}}}},"MoveServiceDocumentBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveDocumentRequestPayload"},"examples":{"Update Service Document Markdown Payload":{"$ref":"#/components/examples/MoveServiceDocumentPayload"}}}}},"UpdateSuggestedResourceActionBody":{"description":"Request body schema for updating a suggested resource action.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSuggestedResourceAction"}}}},"CreateVulnerabilityScanBody":{"description":"Request body schema for uploading a vulnerability scan.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVulnerabilityScan"}}}},"PutVulnerabilitySeverityOverrideBody":{"description":"Request body schema for overriding a vulnerability severity.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutVulnerabilitySeverityOverride"}}}},"PutVulnerabilityDismissalBody":{"description":"Request body schema for dismissing a vulnerability.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutVulnerabilityDismissal"}}}},"QueryVulnerabilitiesMetricsRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesMetricsQuery"}}}},"CreateQuotaRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQuota"}}}},"UpdateQuotaRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQuota"}}}}},"responses":{"CatalogServiceApiSpecResponse":{"description":"A response containing a single API spec.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogServiceApiSpec"},"examples":{"Url":{"$ref":"#/components/examples/ServiceApiUrlResponse"},"Raw":{"$ref":"#/components/examples/ServiceApiRawResponse"},"Integration":{"$ref":"#/components/examples/CreateServiceApiIntegrationResponse"},"Resource":{"$ref":"#/components/examples/CreateServiceApiResourceResponse"}}}}},"ListCatalogServiceApiSpecsResponse":{"description":"A paginated list response for a collection of API specs.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogServiceApiSpec"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Service APIs":{"$ref":"#/components/examples/ListServiceApiResponse"}}}}},"CatalogServiceApiSpecPreviewResponse":{"description":"Response object containing raw API spec contents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSpecContents"},"examples":{"JSON":{"$ref":"#/components/examples/PreviewServiceApiResponseJson"}}},"application/yaml":{"schema":{"$ref":"#/components/schemas/ApiSpecContentsYaml"},"examples":{"YAML":{"$ref":"#/components/examples/PreviewServiceApiResponseYaml"}}}}},"ApiSpecPreviewResponse":{"description":"Response object containing raw API spec string contents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSpecContentsPreview"},"examples":{"JSON":{"$ref":"#/components/examples/PreviewApiSpecResponseJson"}}},"application/yaml":{"schema":{"$ref":"#/components/schemas/ApiSpecContentsPreviewYaml"},"examples":{"YAML":{"$ref":"#/components/examples/PreviewServiceApiResponseYaml"}}}}},"CatalogIntegrationResponse":{"description":"A response containing a single integration object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogIntegration"},"examples":{"Integration":{"$ref":"#/components/examples/CatalogIntegrationResponse"}}}}},"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"}}}}},"CatalogServiceApiSpecContentResponse":{"description":"Response object containing raw API spec contents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiSpecContents"},"examples":{"JSON":{"$ref":"#/components/examples/PreviewServiceApiResponseJson"}}},"application/yaml":{"schema":{"$ref":"#/components/schemas/ApiSpecContentsYaml"},"examples":{"YAML":{"$ref":"#/components/examples/PreviewServiceApiResponseYaml"}}}}},"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"}}}}},"ResourceIngestionResponse":{"description":"A response containing the resource ingestion status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceIngestionStatus"},"examples":{"Resource Ingestion Ok":{"$ref":"#/components/examples/ResourceIngestionStatusOk"},"Resource Ingestion Delayed":{"$ref":"#/components/examples/ResourceIngestionStatusDelayed"},"Resource Ingestion Halted":{"$ref":"#/components/examples/ResourceIngestionStatusHalted"}}}}},"ListResourceActionResponse":{"description":"A paginated list response for a collection of resource actions.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ResourceAction"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Resource Actions":{"$ref":"#/components/examples/ListResourceActionsResponse"}}}}},"ListSystemSuggestionRuleResponse":{"description":"A paginated list response for a collection of system defined suggestion rules.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SystemSuggestionRule"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"System Suggestion Rules":{"$ref":"#/components/examples/ListSystemSuggestionRulesResponse"}}}}},"ListSuggestionRuleResponse":{"description":"A paginated list response for a collection of suggestion rules.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SuggestionRule"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Suggestion Rule Errors":{"$ref":"#/components/examples/ListSuggestionRulesResponse"}}}}},"ListSuggestionRuleErrorResponse":{"description":"A paginated list response for a collection of suggestion rule errors.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SuggestionRuleError"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Suggestion Rule Errors":{"$ref":"#/components/examples/ListSuggestionRuleErrorsResponse"}}}}},"SuggestionRuleResponse":{"description":"A response containg a suggestion rule object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestionRule"},"examples":{"Suggestion Rule":{"$ref":"#/components/examples/SuggestionRule"}}}}},"TestSuggestionRuleResponse":{"description":"A response containing the evaluation of a suggestion rule configuration against an integration data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuggestionRule"},"examples":{"Test Suggestion Rule":{"$ref":"#/components/examples/TestSuggestionRuleArchiveResponse"}}}}},"ListIntegrationEventsResponse":{"description":"A Paginated list response for a collection of integration events.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationEvent"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Integration Events":{"$ref":"#/components/examples/ListIntegrationEventsResponse"}}}}},"ListCatalogServiceDocumentsResponse":{"description":"A paginated list response for a collection of documents targeted by a service.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ServiceDocument"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"List Service Documents Response JSON":{"$ref":"#/components/examples/ListServiceDocumentsResponseJSON"}}},"application/vnd.konnect.document-tree+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ServiceDocumentTree"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"required":["data","meta"]},"examples":{"List Service Documents Response JSON Tree":{"$ref":"#/components/examples/ListServiceDocumentsResponseJSONTree"}}}}},"CatalogServiceDocumentResponse":{"description":"Response object for fetching a single service document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDocumentContentResponse"},"examples":{"Service Document":{"$ref":"#/components/examples/ServiceDocumentResponseJSON"}}}}},"UpdateCatalogServiceDocumentResponse":{"description":"A paginated list response for a collection of documents targeted by a service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceDocumentContentResponse"},"examples":{"Service Document":{"$ref":"#/components/examples/ServiceDocumentResponseJSON"}}}}},"ListSuggestedResourceActionResponse":{"description":"A paginated list response for a collection of suggested resource actions.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SuggestedResourceActionObject"}}},"additionalProperties":false,"required":["meta","data"]},"examples":{"Suggested Resource Actions":{"$ref":"#/components/examples/ListSuggestedResourceActionsResponse"}}}}},"SuggestedResourceActionResponse":{"description":"A response containg a suggested resource action object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestedResourceActionObject"},"examples":{"Suggested Resource Action":{"$ref":"#/components/examples/SuggestedResourceActionResponse"}}}}},"ListVulnerabilityScansResponse":{"description":"A paginated list response for a collection of vulnerability scans.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityScan"}}},"additionalProperties":false,"required":["meta","data"]}}}},"VulnerabilityScanResponse":{"description":"Response object containing a single vulnerability scan, without its catalog mapping.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerabilityScan"}}}},"ListVulnerabilityScanVulnerabilitiesResponse":{"description":"A paginated list response for a collection of vulnerabilities, for a given vulnerability scan.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ScanVulnerability"}}},"additionalProperties":false,"required":["meta","data"]}}}},"ListCatalogVulnerabilitiesResponse":{"description":"A paginated list response for a collection of catalog-wide vulnerabilities.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogVulnerability"}}},"additionalProperties":false,"required":["meta","data"]}}}},"CatalogVulnerabilityResponse":{"description":"Response object containing a single catalog-wide vulnerability.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogVulnerability"}}}},"ListVulnerabilityServicesResponse":{"description":"A paginated list response for a collection of services for a given vulnerability.\n","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityService"}}},"additionalProperties":false,"required":["meta","data"]}}}},"ListVulnerabilityInstancesResponse":{"description":"A paginated list response for a collection of vulnerability instances.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilityInstance"}}},"additionalProperties":false,"required":["meta","data"]}}}},"ListVulnerabilitiesResponse":{"description":"A paginated list response for a collection of vulnerabilities.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Vulnerability"}}},"additionalProperties":false,"required":["meta","data"]}}}},"VulnerabilityResponse":{"description":"Response object containing a single vulnerability.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vulnerability"}}}},"ListCatalogVulnerabilityServicesResponse":{"description":"A paginated list response for a collection of services with cross-vulnerability context.\n","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CatalogVulnerabilityService"}}},"additionalProperties":false,"required":["meta","data"]}}}},"VulnerabilitiesMetricsQueryResponse":{"description":"The result of a vulnerabilities metrics query.\nContains the aggregated data along with metadata about the query.\n","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VulnerabilitiesMetricsQueryResult"},"readOnly":true},"meta":{"$ref":"#/components/schemas/VulnerabilitiesMetricsResponseMetadata"}},"required":["data","meta"]}}}},"ListCustomFieldSchemaResponse":{"description":"A paginated list response for a collection of custom field schemas.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldSchema"}}},"additionalProperties":false,"required":["meta","data"]}}}},"ListDefaultQuotasResponse":{"description":"A paginated list response for a collection of default quotas.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DefaultQuota"}}},"additionalProperties":false,"required":["meta","data"]}}}},"ListQuotasResponse":{"description":"A paginated list response for a collection of organization quotas.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Quota"}}},"additionalProperties":false,"required":["meta","data"]}}}},"QuotaResponse":{"description":"A response containing a single organization quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Quota"}}}},"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"}}}},"Internal":{"description":"Internal","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"UnsupportedMediaType":{"description":"Unsupported Media Type","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeError"},"examples":{"UnsupportedMediaTypeExample":{"$ref":"#/components/examples/UnsupportedMediaTypeExample"}}}}}},"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 Service API Specs","description":"Attach API specifications which describe the interface and behavior of the service.\nThese specifications describe service API constracts for internal or external consumption.\nYou may attach an API specification by uploading a file, providing a link to the specification, or my mapping a resource from a API spec compliant integration.\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":"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":"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":"Resource Ingestion","description":"Get details and trigger resource ingestion from authorized integrations.\nResource ingestion allows for manually syncing resources from authorized integrations.\nIt provides details on when the resources were last synced from an authorized integration.\n"},{"name":"Resource Actions","description":"Resource actions provides an overview of actions taken on resources.\nIt provides information on when one of the following actions are taken on a resource:\n- Map\n- Unmap\n- Archive\n- Restore\n"},{"name":"Integration Instance Proxy","description":"The integration instance proxy allows requests to be made to the authorized integration instance.\nThe APIs which are allowed to be proxied to the integration instances are defined in the `proxies` section of the Integration.\n"},{"name":"Suggestion Rules","description":"Suggestion rules allow for automated management of resources.\nSuggestion rule can be configured to:\n- Map resources to existing catalog service\n- Map resources to a new catalog service\n- Archive resources\n\nSystem suggestion rules are built-in rules which are configured and managed by Kong.\n"},{"name":"Suggestion Rule Errors","description":"Suggestion rule errors describes errors which have occured when a suggestion rule was evaluated on a resource.\nAn error may occur due to syntax errors on the configured suggestion rule, or various other runtime errors.\n"},{"name":"Integration Events","description":"Integration events represent the activity within an integration instance.\n"},{"name":"Catalog Service Documents","description":"Attach documentation for your services to communicate it's architecture, support details, release notes, and usage examples, to help others understand and integrate with the service.\n"},{"name":"Suggested Resource Actions","description":"Provides suggested actions to take on resources. Suggested actions are generated from suggestion rules.\n"},{"name":"Vulnerabilities","description":"Retrieving, analyzing, and managing software vulnerabilities.\n"},{"name":"Catalog Service Custom Fields","description":"Manage custom fields for catalog services."},{"name":"Quotas","description":"Organization quotas and system default quota definitions used for usage limits and governance in the Service Catalog.\n"}],"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]},{"systemAccountAccessToken":[]}]}
```
