MEmendix
environments

Delete Environment

Deletes a specific environment.<br/> This should only be used if your application doesn't have environments deployed in multiple namespaces.<br/> We recommend using the endpoint Delete Environment for a specified Namespace.<br/> This endpoint will be removed in future versions.

delete/apps/{appId}/environments/{environmentId}

Request

  • Base URL
    https://privatecloud.mendixcloud.com/api/v4
  • Auth
    API key in header Authorization

Query parameters

forceboolean

Used to bypass the Default Studio Target validation and any errors received from the cluster while deleting the object from the portal. If the deleted environment was set as Default Studio Target, a new one must be selected from the UI or via API .

Response

The job response returned by a get-job request. The Location header is populated once the job has been created successfully.

idstring uuid required

Model for jobId.

status'created' | 'running' | 'failed' | 'finished' required

created - a job has been created but has not been picked up for processing <br/> running - the job is being processed <br/> finished - the job has finished processing <br/> failed - something went wrong and the job processing failed

detailsstring

Example response

{
  "id": "db6ed4d3-8b6d-4c2b-ad2b-2a69d0f7afe0",
  "status": "finished",
  "details": "Request to create cluster.",
  "error": {
    "code": 400,
    "message": "Request validation errors"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.