catalog
Scout API 1.0.0 — see schemas for shared types.
POST /api/catalog/adoption/apply
apply_adoption
Request body
Content-Type: application/json
Schema: AdoptionManifestBody
Responses
- 200 — OK
application/json→ AdoptionScanResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/catalog/adoption/scan
scan_adoption
Request body
Content-Type: application/json
Schema: AdoptionManifestBody
Responses
- 200 — OK
application/json→ AdoptionScanResponse- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/catalog/installations
list_installations
Responses
- 200 — OK
application/json→ InstalledEntityResponseList- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/catalog/packages
list_packages
Responses
- 200 — OK
application/json→ CatalogPackageSummaryResponseList- 422 — Unprocessable Content
application/json→ ValidationError
GET /api/catalog/packages/{package_id}
get_package
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
package_id |
path | string (path) | yes |
Responses
- 200 — OK
application/json→ CatalogPackageResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/catalog/packages/{package_id}/install
install_package
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
package_id |
path | string (path) | yes |
Request body
Content-Type: application/json
Schema: InstallPackageBody
Responses
- 200 — OK
application/json→ InstalledEntityResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/catalog/packages/{package_id}/update
update_package
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
package_id |
path | string (path) | yes |
Responses
- 200 — OK
application/json→ UpdatePackageResponse- 422 — Unprocessable Content
application/json→ ValidationError
POST /api/catalog/packages/{package_id}/validate
validate_install
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
package_id |
path | string (path) | yes |
Request body
Content-Type: application/json
Schema: ValidateInstallBody
Responses
- 200 — OK
application/json→ InstallValidationResponse- 422 — Unprocessable Content
application/json→ ValidationError