Namespaces

Get a namespace

Changed on
get/api/v1/{tenant}/namespaces/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/namespaces/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

idstring required

The namespace id

tenantstring required

Response

getNamespace 200 response

idstring required
deletedboolean required
descriptionstring
variablesobject
storageTypestring
storageConfigurationobject
secretTypestring
secretReadOnlyboolean
secretConfigurationobject
outputsInInternalStorageboolean

Example response

{
  "variables": {
    "key": "{}"
  },
  "secretConfiguration": {
    "key": "{}"
  },
  "storageIsolation": {
    "deniedServices": [
      "EXECUTOR",
      "EXECUTOR"
    ],
    "enabled": true
  },
  "description": "description",
  "pluginDefaults": [
    {
      "forced": true,
      "values": "{}",
      "type": "type"
    },
    {
      "forced": true,
      "values": "{}",
      "type": "type"
    }
  ],
  "secretReadOnly": true,
  "secretIsolation": {
    "deniedServices": [
      "EXECUTOR",
      "EXECUTOR"
    ],
    "enabled": true
  },
  "allowedNamespaces": [
    {
      "namespace": "namespace"
    },
    {
      "namespace": "namespace"
    }
  ],
  "deleted": true,
  "storageConfiguration": {
    "key": "{}"
  },
  "secretType": "secretType",
  "storageType": "storageType",
  "id": "id",
  "workerGroup": {
    "fallback": "FAIL",
    "key": "key"
  },
  "outputsInInternalStorage": true,
  "sdkDefaultAuthentication": {
    "password": "password",
    "apiToken": "apiToken",
    "username": "username"
  }
}

Changes

  • b6097dbc46aeRevision changes
    • breaking

      removed the required property //// from the response with the status

    • info

      added the optional property / to the response with the status