Namespaces

Search for namespaces

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

Request

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

Path parameters

tenantstring required

Query parameters

qstring nullable

A string filter

pageinteger required

The current page

sizeinteger required

The current page size

sortstring[] nullable

The sort of current page

existingboolean required

Return only existing namespace

Response

searchNamespaces 200 response

totalinteger required

Example response

{
  "total": 0,
  "results": [
    {
      "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"
      }
    },
    {
      "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

    • breaking

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

    • info

      added the optional property /// to the response with the status