MEmendix
namespaces

Update Namespace

Updates a specific namespace.<br/> Please be aware that this endpoint cannot be used for the Main namespace of a Global Operator installation.

put/clusters/{clusterId}/namespaces/{namespaceId}

Request

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

Request body

manifestVersionstring required

Example request

{
  "manifestVersion": "2.0.0",
  "namespace": {
    "namespaceId": "9fab54b2-39f9-48e4-8ceb-5a7ecbba44e1",
    "name": "my-namespace",
    "installationType": "Connected",
    "secret": "base64 encoded string, e.g. c3Vic2NyaXB0aW9uLXNlY3JldA==",
    "productTypePCLM": "standard",
    "plans": [
      {
        "planName": "my-db | my-str",
        "planType": "OnDemand",
        "planConfig": "\"{type:\\\"database | storage\\\"}\""
      }
    ],
    "membership": [
      {
        "email": "abc@xxx.com",
        "role": "Developer | Administrator | Custom_DEPRECATED | MyCustomRole | OtherCustomRole",
        "status": "Invitation_Sent",
        "displayName": "member name"
      }
    ],
    "operationalLinks": {
      "metricsUrl": "https://www.exampleurl.com",
      "alertsUrl": "https://www.exampleurl.com",
      "logsUrl": "https://www.exampleurl.com",
      "backupsUrl": "https://www.exampleurl.com"
    }
  }
}

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.