namespaces

Get Manifests of Multiple Namespaces

Retrieves the manifests of all namespaces of a cluster.

get/clusters/{clusterId}/namespaces

Request

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

Query parameters

offsetinteger

Used with paging and defines the offset. The default value is 0.

limitinteger

Used with paging and defines the maximum amount of objects to return. The default value is 20.

retrieveEnvironmentsboolean

Used to retrieve information about environments deployed into this namespace.

Response

The namespaces manifests response returned by a get-namespaces-manifests request.

Example response

{
  "namespaces": [
    {
      "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"
        },
        "additionalInformation": {
          "componentVersion": {
            "operatorVersion": "3.0.0",
            "repositoryURL": "docker-local.artifactory.url",
            "builderVersion": "ingvar-rhel",
            "metricsSidecarVersion": "1.0.0",
            "m2EESidecarVersion": "1.0.0"
          },
          "internalDetails": {
            "operatorSDK": "v0.18.2",
            "goRuntimeVersion": "go1.14.13_linux/amd64",
            "buildBranch": "HEAD",
            "buildDate": "2021-01-05_10:14:42",
            "buildHash": "7fd1d6df6e754cafb43efaa75071cff3a16932be"
          }
        },
        "environments": [
          {
            "environmentId": "e9m3vf7f",
            "environmentName": "my-awesome-environment",
            "applicationId": "c533ee0b-f7db-4e62-868b-1192d392ccec",
            "applicationName": "My Awesome App"
          }
        ]
      }
    }
  ]
}

Changes

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