kibana/api_docs/cloud.json

{
  "id": "cloud",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "cloud",
        "id": "def-public.CloudConfigType",
        "type": "Interface",
        "tags": [],
        "label": "CloudConfigType",
        "description": [],
        "path": "x-pack/plugins/cloud/public/plugin.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "cloud",
            "id": "def-public.CloudConfigType.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "x-pack/plugins/cloud/public/plugin.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "cloud",
            "id": "def-public.CloudConfigType.cname",
            "type": "string",
            "tags": [],
            "label": "cname",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "x-pack/plugins/cloud/public/plugin.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "cloud",
            "id": "def-public.CloudConfigType.base_url",
            "type": "string",
            "tags": [],
            "label": "base_url",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "x-pack/plugins/cloud/public/plugin.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "cloud",
            "id": "def-public.CloudConfigType.profile_url",
            "type": "string",
            "tags": [],
            "label": "profile_url",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "x-pack/plugins/cloud/public/plugin.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "cloud",
            "id": "def-public.CloudConfigType.deployment_url",
            "type": "string",
            "tags": [],
            "label": "deployment_url",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "x-pack/plugins/cloud/public/plugin.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "cloud",
            "id": "def-public.CloudConfigType.organization_url",
            "type": "string",
            "tags": [],
            "label": "organization_url",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "x-pack/plugins/cloud/public/plugin.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "cloud",
            "id": "def-public.CloudConfigType.full_story",
            "type": "Object",
            "tags": [],
            "label": "full_story",
            "description": [],
            "signature": [
              "{ enabled: boolean; org_id?: string | undefined; }"
            ],
            "path": "x-pack/plugins/cloud/public/plugin.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "cloud",
      "id": "def-public.CloudSetup",
      "type": "Interface",
      "tags": [],
      "label": "CloudSetup",
      "description": [],
      "path": "x-pack/plugins/cloud/public/plugin.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "cloud",
          "id": "def-public.CloudSetup.cloudId",
          "type": "string",
          "tags": [],
          "label": "cloudId",
          "description": [],
          "signature": [
            "string | undefined"
          ],
          "path": "x-pack/plugins/cloud/public/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-public.CloudSetup.cname",
          "type": "string",
          "tags": [],
          "label": "cname",
          "description": [],
          "signature": [
            "string | undefined"
          ],
          "path": "x-pack/plugins/cloud/public/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-public.CloudSetup.baseUrl",
          "type": "string",
          "tags": [],
          "label": "baseUrl",
          "description": [],
          "signature": [
            "string | undefined"
          ],
          "path": "x-pack/plugins/cloud/public/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-public.CloudSetup.deploymentUrl",
          "type": "string",
          "tags": [],
          "label": "deploymentUrl",
          "description": [],
          "signature": [
            "string | undefined"
          ],
          "path": "x-pack/plugins/cloud/public/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-public.CloudSetup.profileUrl",
          "type": "string",
          "tags": [],
          "label": "profileUrl",
          "description": [],
          "signature": [
            "string | undefined"
          ],
          "path": "x-pack/plugins/cloud/public/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-public.CloudSetup.organizationUrl",
          "type": "string",
          "tags": [],
          "label": "organizationUrl",
          "description": [],
          "signature": [
            "string | undefined"
          ],
          "path": "x-pack/plugins/cloud/public/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-public.CloudSetup.snapshotsUrl",
          "type": "string",
          "tags": [],
          "label": "snapshotsUrl",
          "description": [],
          "signature": [
            "string | undefined"
          ],
          "path": "x-pack/plugins/cloud/public/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-public.CloudSetup.isCloudEnabled",
          "type": "boolean",
          "tags": [],
          "label": "isCloudEnabled",
          "description": [],
          "path": "x-pack/plugins/cloud/public/plugin.ts",
          "deprecated": false
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "cloud",
      "id": "def-server.CloudSetup",
      "type": "Interface",
      "tags": [],
      "label": "CloudSetup",
      "description": [],
      "path": "x-pack/plugins/cloud/server/plugin.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "cloud",
          "id": "def-server.CloudSetup.cloudId",
          "type": "string",
          "tags": [],
          "label": "cloudId",
          "description": [],
          "signature": [
            "string | undefined"
          ],
          "path": "x-pack/plugins/cloud/server/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-server.CloudSetup.deploymentId",
          "type": "string",
          "tags": [],
          "label": "deploymentId",
          "description": [],
          "signature": [
            "string | undefined"
          ],
          "path": "x-pack/plugins/cloud/server/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-server.CloudSetup.isCloudEnabled",
          "type": "boolean",
          "tags": [],
          "label": "isCloudEnabled",
          "description": [],
          "path": "x-pack/plugins/cloud/server/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "cloud",
          "id": "def-server.CloudSetup.apm",
          "type": "Object",
          "tags": [],
          "label": "apm",
          "description": [],
          "signature": [
            "{ url?: string | undefined; secretToken?: string | undefined; }"
          ],
          "path": "x-pack/plugins/cloud/server/plugin.ts",
          "deprecated": false
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}