Every API here is available over the APIs.io API and to AI agents over MCP.
{"openapi":"3.0.0","paths":{"/public/v1/catalog/entities":{"post":{"operationId":"CatalogEntityController_getCatalogEntities","summary":"Get catalog entities filtered by query.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityQueryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntitiesSearchResultDto"}}}},"400":{"description":"Returned when request body is not valid"}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/{id}":{"get":{"operationId":"CatalogEntityController_getCatalogEntityById","summary":"Get a catalog entity by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to return","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityDto"}}}},"404":{"description":"Returned when catalog entity with specified id is not found"}},"tags":["Catalog Entity"]},"delete":{"operationId":"CatalogEntityController_deleteCatalogEntityById","summary":"Delete the specified catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique ID for given catalog entity.","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"The requested catalog entity does not exist in the organisation."},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/person":{"post":{"operationId":"CatalogEntityController_createPersonEntity","summary":"Create a new person catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogPersonDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogPersonDto"}}}},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/resource/{id}":{"patch":{"operationId":"CatalogEntityController_updateResourceEntity","summary":"Update a resource catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogResourceDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResourceDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/service/{id}":{"patch":{"operationId":"CatalogEntityController_updateServiceEntity","summary":"Update a service catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogServiceDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogServiceDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/person/{id}":{"patch":{"operationId":"CatalogEntityController_updatePersonEntity","summary":"Update a person catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogPersonDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogPersonDto"}}}},"404":{"description":""},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/resource":{"post":{"operationId":"CatalogEntityController_createCatalogResourceEntity","summary":"Create a new resource catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogResourceDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResourceDto"}}}},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/library":{"post":{"operationId":"CatalogEntityController_createCatalogLibrary","summary":"Create a new library catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogLibraryDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogLibraryDto"}}}},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/repository":{"post":{"operationId":"CatalogEntityController_createCatalogRepository","summary":"Create an new repository catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogRepositoryDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogRepositoryDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/repository/{id}":{"patch":{"operationId":"CatalogEntityController_updateRepositoryEntity","summary":"Update a repository catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogRepositoryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogRepositoryDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/environment":{"post":{"operationId":"CatalogEntityController_createCatalogEnvironment","summary":"Create a new environment catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogEnvironmentDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEnvironmentDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/service":{"post":{"operationId":"CatalogEntityController_createServiceEntity","summary":"Create a new service catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogServiceDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogServiceDto"}}}},"404":{"description":"Returned if the repository, owners or applications don't exist"},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/system":{"post":{"operationId":"CatalogEntityController_createCatalogSystemEntity","summary":"Create a new system catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogSystemDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSystemDto"}}}},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/application":{"post":{"operationId":"CatalogEntityController_createCatalogApplicationEntity","summary":"Create a new application catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogApplicationDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogApplicationDto"}}}},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/application/{id}":{"patch":{"operationId":"CatalogEntityController_updateApplicationEntity","summary":"Update an application catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogApplicationDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogApplicationDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/manifest":{"post":{"operationId":"CatalogEntityController_createCatalogManifestEntity","summary":"Create a new manifest catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogManifestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogManifestDto"}}}},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/environment/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogEnvironmentEntity","summary":"Update an environment catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogEnvironmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEnvironmentDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/manifest/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogManifestEntity","summary":"Update a manifest catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogManifestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogManifestDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/system/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogSystemEntity","summary":"Update a system catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogSystemDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSystemDto"}}}},"404":{"description":""},"409":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/library/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogLibraryEntity","summary":"Update a library catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogLibraryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogLibraryDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/base":{"post":{"operationId":"CatalogEntityController_createCatalogBase","summary":"Create a new base catalog entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogBaseDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogBaseDto"}}}},"400":{"description":""},"422":{"description":""},"500":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/entities/base/{id}":{"patch":{"operationId":"CatalogEntityController_updateCatalogBaseEntity","summary":"Update a base catalog entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the catalog entity.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCatalogBaseDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogBaseDto"}}}},"404":{"description":""},"409":{"description":""},"422":{"description":""},"500":{"description":""}},"tags":["Catalog Entity"]}},"/public/v1/catalog/batch/entities/resource":{"post":{"operationId":"CatalogEntityBatchController_createCatalogEntitiesBulk","summary":"Batch create new resource catalog entities","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CreateCatalogResourceDto"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogResourceBatchResultDto"}}}}},"tags":["Catalog Entity Batch"]}},"/public/v1/catalog/batch/entities":{"delete":{"operationId":"CatalogEntityBatchController_deleteCatalogEntitiesBulk","summary":"Batch delete the specified catalog entities","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCatalogEntitiesBatchDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCatalogEntitiesBatchResultDto"}}}}},"tags":["Catalog Entity Batch"]}},"/public/v1/catalog/relations":{"get":{"operationId":"CatalogRelationController_getCatalogEntityRelations","summary":"GET a list of catalog relations.","parameters":[{"name":"sourceId","required":false,"in":"query","description":"Id of the source entity from which we want to get, if not provided, it will return all relations of the target entity or all relations if targetId is not provided","schema":{"type":"string"}},{"name":"targetId","required":false,"in":"query","description":"Id of the target entity from which we want to get, if not provided, it will return all relations of the source entity or all relations if sourceId is not provided","schema":{"type":"string"}},{"name":"pageNumber","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","schema":{"default":20,"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogRelationResultDto"}}}}},"tags":["Catalog Relation"]},"post":{"operationId":"CatalogRelationController_createCatalogEntityRelation","summary":"Create relation between catalog entities. \n NB: Resource-Resource relations are available only for non-discovery created resources.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCatalogRelationDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogRelationDto"}}}},"400":{"description":"Returned when request body is not valid"},"404":{"description":"At least one of the requested catalog entities was not found"},"422":{"description":"Returned when request data cannot be processed and is logically invalid"}},"tags":["Catalog Relation"]},"delete":{"operationId":"CatalogRelationController_deleteCatalogRelationById","summary":"Delete catalog entity relation.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCatalogRelationDto"}}}},"responses":{"200":{"description":""},"404":{"description":"At least one of the requested catalog entities was not found."},"422":{"description":"It's not possible for these requested entities to have relation between each other."}},"tags":["Catalog Relation"]}},"/public/v1/catalog/metadata/{id}":{"get":{"operationId":"CatalogEntityMetadataController_getCatalogEntityMetadataById","summary":"Get catalog entity's metadata id.","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to return its metadata","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityMetadataDto"}}}},"400":{"description":"Returned when request body is not valid"},"404":{"description":"Returned when catalog entity with specified id is not found"}},"tags":["Catalog Entity Metadata"]},"put":{"operationId":"CatalogEntityMetadataController_updateCatalogEntityMetadataById","summary":"Update catalog entity's metadata by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of catalog entity to update its metadata","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityMetadataUpdateDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogEntityMetadataDto"}}}},"404":{"description":"Returned when catalog entity with specified id is not found"},"422":{"description":"Returned when nickname meta tags are duplicated in category or in provider scope"}},"tags":["Catalog Entity Metadata"]}},"/public/v1/templates":{"get":{"operationId":"TemplateController_getAllTemplates","summary":"Get all the templates available.","parameters":[{"name":"name","required":false,"in":"query","description":"Templates name to filter the results","schema":{"type":"string"}},{"name":"type","required":false,"in":"query","description":"Templates type to filter the results","schema":{"enum":["core","user"],"type":"string"}},{"name":"category","required":false,"in":"query","description":"Template Category to filter the results","schema":{"enum":["create","display"],"type":"string"}},{"name":"entityType","required":false,"in":"query","description":"Template entity type to filter the results","schema":{"enum":["service"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TemplateDto"}}}}}},"tags":["Templates"]}},"/public/v1/users/{id}":{"patch":{"operationId":"UserController_updateUserById","summary":"Update a user entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of user to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDto"}}}},"404":{"description":"Requested user not found"},"409":{"description":""}},"tags":["Users"]},"delete":{"operationId":"UserController_deleteUserById","summary":"Delete a user entity","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of user to delete","schema":{"type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"Requested user not found"},"409":{"description":""}},"tags":["Users"]}},"/public/v1/users":{"get":{"operationId":"UserController_getAllUsers","summary":"Return list of users based on the given filters","parameters":[{"name":"searchTerms","required":false,"in":"query","description":"Search term to filter users on that, Regex expressions can be used too","schema":{"type":"string"}},{"name":"pageNumber","required":false,"in":"query","description":"Page number for getting results","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"How many users should be included in one page","schema":{"default":20,"type":"number"}},{"name":"sortProperty","required":false,"in":"query","description":"Sort the result based on this property","schema":{"default":"lastName","enum":["id","firstName","lastName","email","displayName","orgId","status","role","photoUrl","acceptedTermsOfServiceAndPrivacyPolicyAt","createdAt","updatedAt","lastChangedBy","lastLoginAt"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersPageDto"}}}}},"tags":["Users"]}},"/public/v1/scorecards/{id}/run":{"post":{"operationId":"ScorecardController_createScorecardSchedule","summary":"Trigger a reevaluate for the given scorecard","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of scorecard","schema":{"type":"string"}}],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleDto"}}}},"404":{"description":"Requested scorecard not found"}},"tags":["Scorecard"]}},"/public/v1/scorecards":{"get":{"operationId":"ScorecardController_getScorecards","summary":"GET an organizational list of scorecard definitions optionally filtered.","parameters":[{"name":"name","required":false,"in":"query","description":"Filter based on scorecard definition name","schema":{"type":"string"}},{"name":"serviceId","required":false,"in":"query","description":"Filter based on scorecard definition service id","schema":{"type":"string"}},{"name":"pageNumber","required":false,"in":"query","description":"Page number to return","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Number of items to return per page","schema":{"default":20,"type":"number"}},{"name":"sortProperty","required":false,"in":"query","description":"Sort property","schema":{"default":"name","enum":["orgId","id","name","createdAt","updatedAt","lastChangedBy","createdBy","startAt","dueAt","status","isEvaluating","evaluatedAt","evaluateTotal","evaluatePassed","evaluateFailed","evaluatePercentage","evaluateServicesPercentage"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScorecardPageDto"}}}}},"tags":["Scorecard"]}},"/public/v1/scorecards/{id}/metrics":{"get":{"operationId":"ScorecardController_getMetricsByScorecardId","summary":"Get scorecard metrics","parameters":[{"name":"id","required":true,"in":"path","description":"Filter by scorecard service id","schema":{"type":"string"}},{"name":"name","required":false,"in":"query","description":"Filter metrics by name","schema":{"type":"string"}},{"name":"onlySystem","required":false,"in":"query","description":"Filter metrics by system metrics only","schema":{"type":"boolean"}},{"name":"pageNumber","required":false,"in":"query","description":"Page number to return","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Number of items to return per page","schema":{"default":20,"type":"number"}},{"name":"sortProperty","required":false,"in":"query","description":"Sort property","schema":{"default":"name","enum":["id","measurementId","name","comparisonOperator","comparisonType","threshold","passOnNoData","category","createdAt","updatedAt","lastChangedBy","createdBy"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScorecardMetricPageDto"}}}},"404":{"description":"Scorecard is not found"}},"tags":["Scorecard"]}},"/public/v1/scorecards/{id}/results":{"get":{"operationId":"ScorecardController_getScorecardMetricResults","summary":"Get a scorecard results","parameters":[{"name":"id","required":true,"in":"path","description":"Unique id of scorecard","schema":{"type":"string"}},{"name":"serviceId","required":false,"in":"query","description":"Service id to filter the results","schema":{"nullable":false,"type":"string"}},{"name":"metricId","required":false,"in":"query","description":"Metric id to filter the results","schema":{"nullable":false,"type":"string"}},{"name":"passed","required":false,"in":"query","description":"Filter results based on passed or failed metrics","schema":{"nullable":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScorecardMetricResultDto"}}}}},"404":{"description":"Requested scorecard not found"}},"tags":["Scorecard"]}},"/public/v1/scorecards/{id}":{"put":{"operationId":"ScorecardController_updateScorecardById","summary":"Update an organizational scorecard definition by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Id of scorecard definition to update","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Scorecard metric object to be updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScorecardDefinitionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScorecardDto"}}}},"400":{"description":"Returned when request body is not valid"},"404":{"description":"Scorecard is not found"}},"tags":["Scorecard"]},"get":{"operationId":"ScorecardController_getScorecardDefinitionById","summary":"GET an organizational scorecard definition by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Id of scorecard definition to return","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScorecardDto"}}}},"404":{"description":"Scorecard definition is not found"},"422":{"description":""},"502":{"description":""}},"tags":["Scorecard"]}},"/public/v1/module-settings/{id}":{"get":{"operationId":"ModuleSettingsController_getModuleSettingById","summary":"Get a module setting by id.","parameters":[{"name":"id","required":true,"in":"path","description":"Id for given module setting.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleSettingsDto"}}}},"404":{"description":"No module setting found."}},"tags":["Module Settings"]}},"/public/v1/module-settings":{"post":{"operationId":"ModuleSettingsController_createModuleSetting","summary":"Create a module settings object.","parameters":[],"requestBody":{"required":true,"description":"Module settings object to be saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModuleSettingsDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleSettingsDto"}}}},"404":{"description":""}},"tags":["Module Settings"]}},"/public/v1/sync/services/diff":{"post":{"operationId":"SyncController_getServiceDiff","summary":"Get a diff of services and their dependencies based on the given input","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceDiffDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncServicesResultDto"}}}}},"tags":["Sync"]}},"/public/v1/sync/services":{"post":{"operationId":"SyncController_applyServiceDiff","summary":"Apply a diff of services and their dependencies","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyServiceDiffDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncServicesResultDto"}}}}},"tags":["Sync"]}},"/public/v1/deployments":{"post":{"operationId":"DeploymentController_create","summary":"Create a new deployment entity","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeploymentDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentDto"}}}},"400":{"description":"Returned when request body is not valid"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden request"},"404":{"description":"Deployment not found"},"500":{"description":"Internal server error"}},"tags":["Deployment"]},"get":{"operationId":"DeploymentController_getDeployments","summary":"GET an organizational list of deployments optionally filtered.","parameters":[{"name":"name","required":false,"in":"query","description":"Filter based on deployment name","schema":{"type":"string"}},{"name":"ownerEmail","required":false,"in":"query","description":"Filter based on owner email","schema":{"type":"string"}},{"name":"repositoryId","required":false,"in":"query","description":"Filter based on deployment repository id","schema":{"type":"string"}},{"name":"environmentId","required":false,"in":"query","description":"Filter based on deployment environment id","schema":{"type":"string"}},{"name":"pageNumber","required":false,"in":"query","description":"Page number to return","schema":{"default":0,"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"Number of items to return per page","schema":{"default":20,"type":"number"}},{"name":"sortProperty","required":false,"in":"query","description":"Sort property","schema":{"default":"startedAt","enum":["startedAt","name","createdAt","updatedAt","lastChangedBy","createdBy"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedResponseDto"},{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentDto"}}}}]}}}},"400":{"description":"Returned when request query is not valid"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden request"},"500":{"description":"Internal server error"}},"tags":["Deployment"]}},"/public/v1/deployments/{id}":{"patch":{"operationId":"DeploymentController_update","summary":"Update a deployment entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the deployment entity.","schema":{}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeploymentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentDto"}}}},"400":{"description":"Returned when request body is not valid"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden request"},"404":{"description":"Deployment not found"},"500":{"description":"Internal server error"}},"tags":["Deployment"]},"delete":{"operationId":"DeploymentController_delete","summary":"Delete a deployment entity","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the deployment entity.","schema":{}}],"responses":{"200":{"description":""},"400":{"description":"Returned when request body is not valid"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden request"},"404":{"description":"Deployment not found"},"500":{"description":"Internal server error"}},"tags":["Deployment"]}},"/public/v1/credentials":{"get":{"operationId":"CredentialController_getCredentials","summary":"GET a list of credentials","parameters":[{"name":"searchTerms","required":false,"in":"query","description":"Filter based on credential name","schema":{"type":"string"}},{"name":"providerType","required":false,"in":"query","description":"Filter based on credential provider type","schema":{"type":"string"}},{"name":"providerName","required"
# --- truncated at 32 KB (161 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/configure8/refs/heads/main/openapi/configure8-c8-public-api-openapi.json