Version 3.0Beta

Get Marketplace Installation Job

GET/api/v3/platform/marketplaceInstallationJobs/{marketplaceInstallationJobRid}

Warning

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 status of an installation job through draft preparation and execution.

The request token must have permission to view the draft or submitted job. Missing or inaccessible jobs return MarketplaceInstallationJobNotFound. A failed or aborted job still returns HTTP 200 with its current status.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:v3:marketplace-installation-job:read:get.

Path parameters

marketplaceInstallationJobRid

string

The RID of a Marketplace installation job or its draft.

Query parameters

preview

booleanoptional

Enables the use of preview functionality.

Response body

MarketplaceInstallationJob

object

An attempt to upgrade one or more existing product installations. The same RID identifies the draft and its submitted job.

Hide child attributes

rid

string

The RID of a Marketplace installation job or its draft.

status

string (enum)

Values:

ABORTED: The draft or running job was aborted. This can happen either via an explicit abort call or from a job submission failure. An aborted draft remains queryable until automatic cleanup, after which it is no longer found. Terminal status.
ABORTING: Cancellation has been requested for the submitted installation job, but it has not yet reached a terminal state. Continue polling.
BUILDING: Resources have been installed and dataset builds are being submitted or awaited. Continue polling.
FAILED: The installation job failed. Terminal.
IDLE_DRAFT: The draft is retained without running an installation job, either by request or because submission was prevented. Further action is required to submit it; polling alone will not advance it.
IN_PROGRESS: The installation job is executing. Continue polling.
PREPARING: The draft is resolving inputs, validating, or being submitted. Continue polling.
SUCCEEDED: The installation job completed successfully. Terminal.

Enum values: PREPARING, IDLE_DRAFT, ABORTING, IN_PROGRESS, BUILDING, ABORTED, SUCCEEDED, FAILED

Examples

Request

Copied!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v3/platform/marketplaceInstallationJobs/ri.marketplace.main.installation-job.1a80ebf8-341a-4d9e-98e2-9fd4ba7c14d8?preview=true"

Response

Copied!

{
  "rid": "ri.marketplace.main.installation-job.1a80ebf8-341a-4d9e-98e2-9fd4ba7c14d8",
  "status": "PREPARING"
}

Error responses

Error Name
`MarketplaceInstallationJobNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description
	Parameters	`marketplaceInstallationJobRid`

See Errors for a general overview of errors in the platform.