Skip to content

Inspect installed products

POST /api/v1/products/installed/inspect: request fields and declared response contract.

POST/api/v1/products/installed/inspect

Authorization
Permissionsettings.read
Workspace scoperequired
Scope targetworkspace

Request body

Request body fields
FieldTypeRequiredNullableDefault
installationIdstringrequirednon-null—

Response

201

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.schemaVersionnumberrequirednon-null—
data.rootobjectrequirednon-null—
data.root.installationobjectrequirednon-null—
data.root.installation.idstringrequirednon-null—
data.root.installation.companyIdstringrequirednon-null—
data.root.installation.workspaceIdstringrequirednon-null—
data.root.installation.productKeystringrequirednon-null—
data.root.installation.productVersionstringrequirednon-null—
data.root.installation.namespacestringrequirednon-null—
data.root.installation.manifestDigeststringrequirednon-null—
data.root.installation.lifecycleState"installing" | "partial" | "installed" | "requires_resolution" | "failed" | "retired"requirednon-null—
data.root.installation.installedByPrincipalIdunknownrequirednon-null—
data.root.installation.ownedPackageInstallationIdunknownrequirednon-null—
data.root.installation.installedAtunknownrequirednon-null—
data.root.installation.updatedAtunknownrequirednon-null—
data.root.displayInputsobjectrequirednon-null—
data.root.displayInputs.bindingsobjectrequirednon-null—
data.root.displayInputs.roleSatisfactionsobjectoptionalnon-null—
data.root.displayInputs.productConfigobjectoptionalnon-null—
data.root.displayInputs.configurationProjectionDigeststringoptionalnon-null—
data.root.displayInputs.profileobjectoptionalnon-null—
data.root.displayInputs.configurationResolutionobjectoptionalnon-null—
data.root.displayInputs.referenceInputsobjectoptionalnon-null—
data.root.ownedContentobjectrequirednon-null—
data.root.ownedContent.materializedbooleanrequirednon-null—
data.root.ownedContent.installationIdstringoptionalnon-null—
data.root.ownedContent.statusstringoptionalnon-null—
data.root.ownedContent.packageDigeststringoptionalnon-null—
data.planobjectoptionalnon-null—
data.plan.planSchemaVersionintegerrequirednon-null—
data.plan.planHashstringrequirednon-null—
data.referencesarrayrequirednon-null—
data.readinessobjectrequirednon-null—
data.readiness.lifecycleState"installing" | "partial" | "installed" | "requires_resolution" | "failed" | "retired"requirednon-null—
data.readiness.ownedContentMaterializedbooleanrequirednon-null—
data.readiness.activeReferencesintegerrequirednon-null—
data.readiness.detachedReferencesintegerrequirednon-null—
data.attemptsarrayrequirednon-null—
data.receiptsarrayrequirednon-null—
data.terminal"ready" | "degraded" | "conflict"requirednon-null—
data.diagnosticsarrayrequirednon-null—
data.configurationobjectoptionalnon-null—
data.configuration.configurationobjectrequirednon-null—
data.configuration.configuration.productInstallationIdstringrequirednon-null—
data.configuration.configuration.companyIdstringrequirednon-null—
data.configuration.configuration.workspaceIdstringrequirednon-null—
data.configuration.configuration.validatorNamestringrequirednon-null—
data.configuration.configuration.validatorVersionstringrequirednon-null—
data.configuration.configuration.contractDigeststringrequirednon-null—
data.configuration.configuration.profileKeyunknownrequirednon-null—
data.configuration.configuration.profileVersionunknownrequirednon-null—
data.configuration.configuration.profileDigestunknownrequirednon-null—
data.configuration.configuration.installedSettingsobjectrequirednon-null—
data.configuration.configuration.installedBindingsobjectrequirednon-null—
data.configuration.configuration.installedRoleSatisfactionsobjectrequirednon-null{}
data.configuration.configuration.inputSlotSatisfactionsobjectrequirednon-null—
data.configuration.configuration.resolutionPlanHashstringrequirednon-null—
data.configuration.configuration.currentRevisionintegerrequirednon-null—
data.configuration.configuration.currentSettingsobjectrequirednon-null—
data.configuration.configuration.installedAtunknownrequirednon-null—
data.configuration.configuration.updatedAtunknownrequirednon-null—
data.configuration.pinsarrayrequirednon-null—
data.configuration.revisionsarrayrequirednon-null—
data.configuration.readinessobjectrequirednon-null—
data.configuration.readiness.statesarrayrequirednon-null—
data.configuration.readiness.findingsarrayrequirednon-null—

Declared failures

Declared failures
PRODUCT_OPERATION_FAILED500 — not retryable

Readback

This method returns the current state it read.

  • products.inspectInstalled

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

POST /api/v1/products/installed/inspect HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>
Content-Type: application/json

{
  "installationId": "<installationId>"
}