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.
Abort an installation job draft or request cancellation of a submitted installation job. This operation is
idempotent while the job remains available. Poll the job with get after aborting: submitted jobs may report
ABORTING before reaching ABORTED. Aborting a job that has already finished leaves its terminal status
unchanged.
A submitted job may already have created resources. Cancelling it can leave the installation in an inconsistent state. To recover to a consistent state, attempt a new job to the same target version.
An aborted draft remains queryable only until automatic cleanup.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:v3:marketplace-installation-job:write:abort.
stringThe RID of a Marketplace installation job or its draft.
1
2
3
curl -X POST \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v3/platform/marketplaceInstallationJobs/ri.marketplace.main.installation-job.1a80ebf8-341a-4d9e-98e2-9fd4ba7c14d8/abort?preview=true"| Error Name | ||
|---|---|---|
Abort | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The installation job is visible to the request token, but the request token does not have permission to abort it. | |
| Parameters | installationJobRid | |
Marketplace | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | ||
| Parameters | marketplaceInstallationJobRid | |
See Errors for a general overview of errors in the platform.