Sign in
Tenants

Update a tenant

Changed on

Superadmin-only.

put/api/v1/tenants/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/tenants/{id}
  • Auth: none declared

Path parameters

idstring required

The tenant id

Request body

idstring required
namestring required
deletedboolean required
storageTypestring
storageConfigurationobject
secretTypestring
secretReadOnlyboolean
secretConfigurationobject
requireExistingNamespaceboolean
outputsInInternalStorageboolean

Example request

{
  "storageIsolation": {
    "deniedServices": [
      "EXECUTOR",
      "EXECUTOR"
    ],
    "enabled": true
  },
  "secretIsolation": {
    "deniedServices": [
      "EXECUTOR",
      "EXECUTOR"
    ],
    "enabled": true
  },
  "workerGroup": {
    "fallback": "FAIL",
    "key": "key"
  },
  "sdkDefaultAuthentication": {
    "password": "password",
    "apiToken": "apiToken",
    "username": "username"
  }
}

Response

update 200 response

idstring required
namestring required
deletedboolean required
storageTypestring
storageConfigurationobject
secretTypestring
secretReadOnlyboolean
secretConfigurationobject
requireExistingNamespaceboolean
outputsInInternalStorageboolean

Example response

{
  "storageIsolation": {
    "deniedServices": [
      "EXECUTOR",
      "EXECUTOR"
    ],
    "enabled": true
  },
  "secretIsolation": {
    "deniedServices": [
      "EXECUTOR",
      "EXECUTOR"
    ],
    "enabled": true
  },
  "workerGroup": {
    "fallback": "FAIL",
    "key": "key"
  },
  "sdkDefaultAuthentication": {
    "password": "password",
    "apiToken": "apiToken",
    "username": "username"
  }
}

Changes

  • b6097dbc46aeRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status