This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Get the current fulfilled input values and explicit unset inputs of an installation.
By default, only manually fulfilled inputs are returned. Set selection to ALL to return fulfilled inputs
from every stored source. Explicitly unset inputs are returned regardless of selection.
Optional inputs with neither a value nor an explicit unset are omitted.
Returned values may use a different supported representation from the value originally provided.
Credential values expose secret names only, never plaintext, and cannot be submitted to another installation job.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:v3:marketplace-installation-inputs:read:get.
string (enum)optionalWhich fulfilled inputs to return based on their source. Defaults to MANUAL_ONLY if omitted.
Enum values: MANUAL_ONLY, ALL
booleanoptionalEnables the use of preview functionality.
objectThe current fulfilled inputs and inputs explicitly left unfulfilled by the last job of a registered Marketplace installation.
list<InputApiName>optionalQualified API names explicitly left unfulfilled by the last job that modified the installation. Optional inputs that were neither fulfilled nor explicitly unset are absent from both fields.
map<InputApiName, CurrentInstallationInput>optionalFulfilled values keyed by qualified input API name. Optional inputs without a current value are absent.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v3/platform/marketplaceInstallations/ri.marketplace.main.block-set-installation.5b2d8f31-6c42-4a7e-9a13-8e0a3e6d9c52/inputs?selection=MANUAL_ONLY&preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"inputs": {
"myDataset": {
"value": {
"type": "rid",
"rid": "ri.foundry.main.dataset.2f6d7c83-9e41-4b5a-8d20-1c7a34f0e6b9"
},
"source": "MANUAL"
},
"myDataset.address": {
"value": {
"type": "string",
"value": "address"
},
"source": "MANUAL"
}
},
"explicitlyUnset": [
"myDataset.postcode"
]
}| Error Name | ||
|---|---|---|
Installation | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | One or more installations have product inputs without API names. Enable input API name generation for those products before interacting with them. | |
| Parameters | installationRids | |
Marketplace | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | ||
| Parameters | marketplaceInstallationRid | |
See Errors for a general overview of errors in the platform.