@mistio/mist-form

{ "components": { "callbacks": {}, "examples": {}, "headers": {}, "links": {}, "parameters": { "atParam": { "description": "Limit results by specific datetime. Return resources created before or at, or deleted after or at, given datetime.", "examples": { "Return resources created before or deleted after `2021-07-21T17:32:28Z`": { "value": "2021-07-21T17:32:28+00:00" } }, "explode": true, "in": "query", "name": "at", "required": false, "schema": { "format": "date-time", "type": "string" }, "style": "form" } }, "requestBodies": {}, "responses": {}, "schemas": { "AddCloudRequest": { "allOf": [ { "$ref": "#/components/schemas/AddCloudRequest_allOf" }, { "discriminator": { "mapping": { "alibaba": "#/components/schemas/AlibabaCloudRequest", "amazon": "#/components/schemas/AmazonCloudRequest", "azure": "#/components/schemas/AzureCloudRequest", "cloudsigma": "#/components/schemas/CloudSigmaCloudRequest", "docker": "#/components/schemas/DockerCloudRequest", "equinix": "#/components/schemas/EquinixCloudRequest", "google": "#/components/schemas/GoogleCloudRequest", "ibm": "#/components/schemas/IbmCloudRequest", "kubernetes": "#/components/schemas/KubernetesCloudRequest", "kubevirt": "#/components/schemas/KubevirtCloudRequest", "kvm": "#/components/schemas/KvmCloudRequest", "linode": "#/components/schemas/LinodeCloudRequest", "lxd": "#/components/schemas/LxdCloudRequest", "maxihost": "#/components/schemas/MaxihostCloudRequest", "onapp": "#/components/schemas/OnappCloudRequest", "openshift": "#/components/schemas/OpenshiftCloudRequest", "openstack": "#/components/schemas/OpenstackCloudRequest", "other": "#/components/schemas/OtherCloudRequest", "rackspace": "#/components/schemas/RackspaceCloudRequest", "vsphere": "#/components/schemas/VsphereCloudRequest", "vultr": "#/components/schemas/VultrCloudRequest" }, "propertyName": "provider" }, "oneOf": [ { "$ref": "#/components/schemas/AmazonCloudRequest" }, { "$ref": "#/components/schemas/AzureCloudRequest" }, { "$ref": "#/components/schemas/GoogleCloudRequest" }, { "$ref": "#/components/schemas/AlibabaCloudRequest" }, { "$ref": "#/components/schemas/CloudSigmaCloudRequest" }, { "$ref": "#/components/schemas/EquinixCloudRequest" }, { "$ref": "#/components/schemas/IbmCloudRequest" }, { "$ref": "#/components/schemas/DigitaloceanCloudRequest" }, { "$ref": "#/components/schemas/LinodeCloudRequest" }, { "$ref": "#/components/schemas/RackspaceCloudRequest" }, { "$ref": "#/components/schemas/MaxihostCloudRequest" }, { "$ref": "#/components/schemas/VultrCloudRequest" }, { "$ref": "#/components/schemas/OpenstackCloudRequest" }, { "$ref": "#/components/schemas/OnappCloudRequest" }, { "$ref": "#/components/schemas/VsphereCloudRequest" }, { "$ref": "#/components/schemas/KvmCloudRequest" }, { "$ref": "#/components/schemas/LxdCloudRequest" }, { "$ref": "#/components/schemas/DockerCloudRequest" }, { "$ref": "#/components/schemas/KubernetesCloudRequest" }, { "$ref": "#/components/schemas/KubevirtCloudRequest" }, { "$ref": "#/components/schemas/OpenshiftCloudRequest" }, { "$ref": "#/components/schemas/OtherCloudRequest" } ] } ], "example": { "credentials": { "email": "email", "privateKey": "privateKey", "projectId": "projectId" }, "name": "my-cloud", "provider": "google" } }, "AddCloudRequest_allOf": { "properties": { "name": { "description": "The name of the cloud to add", "type": "string" }, "provider": { "$ref": "#/components/schemas/SupportedProviders" } }, "required": [ "name", "provider" ], "type": "object" }, "AddKeyRequest": { "anyOf": [ { "$ref": "#/components/schemas/AddKeyRequest_anyOf" }, { "$ref": "#/components/schemas/AddKeyRequest_anyOf_1" }, { "$ref": "#/components/schemas/AddKeyRequest_anyOf_2" } ], "example": { "name": "my-key", "private": "-----BEGIN RSA PRIVATE KEY-----\nMIICXAIBAAKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0FPqri0cb2JZfXJ/DgYSF6vUp wmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/3j+skZ6UtW+5u09lHNsj6tQ5 1s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQABAoGAFijko56+qGyN8M0RVyaRAXz++xTqHBLh 3tx4VgMtrQ+WEgCjhoTwo23KMBAuJGSYnRmoBZM3lMfTKevIkAidPExvYCdm5dYq3XToLkkLv5L2 pIIVOFMDG+KESnAFV7l2c+cnzRMW0+b6f8mR1CJzZuxVLL6Q02fvLi55/mbSYxECQQDeAw6fiIQX GukBI4eMZZt4nscy2o12KyYner3VpoeE+Np2q+Z3pvAMd/aNzQ/W9WaI+NRfcxUJrmfPwIGm63il AkEAxCL5HQb2bQr4ByorcMWm/hEP2MZzROV73yF41hPsRC9m66KrheO9HPTJuo3/9s5p+sqGxOlF L0NDt4SkosjgGwJAFklyR1uZ/wPJjj611cdBcztlPdqoxssQGnh85BzCj/u3WqBpE2vjvyyvyI5k X6zk7S0ljKtt2jny2+00VsBerQJBAJGC1Mg5Oydo5NwD6BiROrPxGo2bpTbu/fhrT8ebHkTz2epl U9VQQSQzY1oZMVX8i1m5WUTLPz2yLJIBQVdXqhMCQBGoiuSoSjafUhV7i1cEGpb88h5NBYZzWXGZ 37sJ5QsW+sJyoNde3xH8vdXhzU7eT82D6X/scw9RZz+/6rCJ4p0=\n-----END RSA PRIVATE KEY-----" }, "type": "object" }, "AddKeyRequest_anyOf": { "properties": { "certificate": { "description": "The signed public key, when using signed ssh keys", "type": "string" }, "name": { "description": "The key's name", "type": "string" }, "private": { "description": "The private key", "type": "string" } }, "required": [ "name", "private" ] }, "AddKeyRequest_anyOf_1": { "properties": { "dry": { "description": "Return generated key without actually adding it", "type": "boolean" }, "generate": { "description": "Generate a keypair instead of providing one", "type": "boolean" }, "name": { "description": "The key's name", "type": "string" } }, "required": [ "generate", "name" ] }, "AddKeyRequest_anyOf_2": { "properties": { "dry": { "description": "Return generated key without actually adding it", "type": "boolean" }, "generate": { "description": "Generate a keypair instead of providing one", "type": "boolean" } }, "required": [ "dry", "generate" ] }, "AddKeyResponse": { "example": { "id": "id", "private": "private", "public": "public" }, "properties": { "id": { "type": "string" }, "private": { "type": "string" }, "public": { "type": "string" } }, "type": "object" }, "AddRuleRequest": { "example": { "actions": [ { "action": "action", "command": "command", "emails": [ "emails", "emails" ], "teams": [ "teams", "teams" ], "type": "type", "users": [ "users", "users" ] }, { "action": "action", "command": "command", "emails": [ "emails", "emails" ], "teams": [ "teams", "teams" ], "type": "type", "users": [ "users", "users" ] } ], "data_type": "logs", "frequency": { "every": 5, "period": "period" }, "queries": [ { "aggregation": "aggregation", "operator": "operator", "target": "target", "threshold": 0.8008281904610115 }, { "aggregation": "aggregation", "operator": "operator", "target": "target", "threshold": 0.8008281904610115 } ], "trigger_after": { "offset": 5, "period": "period" }, "window": { "period": "period", "start": 6, "stop": 1 } }, "properties": { "actions": { "items": { "$ref": "#/components/schemas/RuleAction" }, "type": "array" }, "data_type": { "$ref": "#/components/schemas/DataType" }, "frequency": { "$ref": "#/components/schemas/Frequency" }, "queries": { "items": { "$ref": "#/components/schemas/Query" }, "type": "array" }, "selectors": { "$ref": "#/components/schemas/Selector" }, "trigger_after": { "$ref": "#/components/schemas/TriggerAfter" }, "window": { "$ref": "#/components/schemas/Window" } }, "required": [ "actions", "data_type", "frequency", "queries", "trigger_after", "window" ], "type": "object" }, "AddScheduleRequest": { "example": { "action": "start", "description": "This is a schedule", "enabled": true, "name": "backup-schedule", "params": "Parameters string", "run_immediately": false, "schedule_entry": "2022-05-28T00:00:00Z", "schedule_type": "one_off", "script_id": "d5775984772949de820fa8279c306b30", "selectors": [ null, null ], "start_after": "2022-06-01 T00:00:00" }, "properties": { "action": { "description": "The action that a schedule performs on a resource", "enum": [ "reboot", "destroy", "notify", "start", "stop", "delete" ], "example": "start", "type": "string" }, "description": { "description": "The description of the schedule", "example": "This is a schedule", "type": "string" }, "enabled": { "description": "Schedule status (enabled, disabled)", "example": true, "type": "boolean" }, "name": { "description": "The name of the schedule", "example": "backup-schedule", "type": "string" }, "params": { "description": "Schedule parameters", "example": "Parameters string", "type": "string" }, "run_immediately": { "description": "Decides if the schedule runs immediately of not", "example": false, "type": "boolean" }, "schedule_entry": { "description": "In case of One Off schedule type the date string that schedule runs (The format should be \u03a5\u03a5\u03a5\u03a5-\u039c\u039c-DD HH:MM:SS). In case of Interval and Crontab schedule types a JSON string with need time unit values. For Interval schedule type interval integer value and period string value needed. For Crontab schedule type minute, hour, day_of_week, day_of_month and month_of_year string values needed.", "example": "2022-05-28T00:00:00Z", "type": "string" }, "schedule_type": { "description": "The type of the schedule", "enum": [ "crontab", "interval", "one_off" ], "example": "one_off", "type": "string" }, "script_id": { "description": "The id of the script that schedule is about to run", "example": "d5775984772949de820fa8279c306b30", "type": "string" }, "selectors": { "items": { "$ref": "#/components/schemas/Selector" }, "type": "array" }, "start_after": { "description": "The date after that schedule starts. The format should be \u03a5\u03a5\u03a5\u03a5-\u039c\u039c-DD HH:MM:SS", "example": "2022-06-01 T00:00:00", "type": "string" } }, "required": [ "action", "name" ], "type": "object" }, "AddScriptRequest": { "example": { "description": "description", "entrypoint": "entrypoint.sh", "exec_type": "executable", "location_type": "inline", "name": "my-script", "script": "#!/usr/bin/env bash\necho Hello, World!" }, "properties": { "description": { "type": "string" }, "entrypoint": { "example": "entrypoint.sh", "type": "string" }, "exec_type": { "enum": [ "executable", "ansible" ], "example": "executable", "type": "string" }, "location_type": { "enum": [ "inline", "github", "url" ], "example": "inline", "type": "string" }, "name": { "example": "my-script", "type": "string" }, "script": { "example": "#!/usr/bin/env bash\necho Hello, World!", "type": "string" } }, "required": [ "exec_type", "location_type", "name", "script" ], "type": "object" }, "AgeSelector": { "properties": { "minutes": { "description": "an integer that represents the minutes passed from the creation of the resource", "example": 6000, "type": "integer" }, "type": { "description": "age type", "enum": [ "age" ], "type": "string" } }, "type": "object" }, "AlibabaCloudRequest": { "properties": { "credentials": { "$ref": "#/components/schemas/AlibabaCredentials" }, "features": { "$ref": "#/components/schemas/CloudFeatures" }, "provider": { "enum": [ "alibaba" ], "type": "string" } }, "required": [ "credentials", "provider" ], "type": "object" }, "AlibabaCredentials": { "properties": { "apikey": { "description": "Your Alibaba Cloud API key", "type": "string" }, "apisecret": { "description": "Your Alibaba Cloud API secret", "type": "string" }, "region": { "description": "Your Alibaba Cloud region", "type": "string" } }, "required": [ "apikey", "apisecret", "region" ], "type": "object" }, "AlibabaNet": { "properties": { "network": { "description": "Name or ID of an existing network to associate the machine with. If not provided, one existing network will be selected.", "type": "string" }, "security_group": { "description": "Name of the security group to assign to the machine. If not provided a default 'mistio' security group will be created.", "type": "string" }, "subnet": { "description": "Name or ID of an existing or new subnet(switch) to launch the machine into. If not provided a default 'mistio' subnet will be created.", "type": "string" } }, "title": "Alibaba net parameter", "type": "object" }, "AlibabaVolumes": { "items": { "oneOf": [ { "properties": { "delete_on_termination": { "description": "Delete the volume when the machine is deleted. Defaults to false", "type": "boolean" }, "volume": { "description": "Name or ID of an existing volume to attach", "type": "string" } }, "required": [ "volume" ] }, { "properties": { "delete_on_termination": { "description": "Delete the volume when the machine is deleted. Defaults to false", "type": "boolean" }, "name": { "description": "Name of the volume to be created", "type": "string" }, "size": { "description": "Size of the volume in GBs. The minimum size depends on the volume type", "type": "integer" }, "type": { "description": "Type of the volume to create, defaults to 'cloud'", "enum": [ "cloud", "cloud_efficiency", "cloud_ssd", "cloud_essd" ], "type": "string" } }, "required": [ "name", "size" ] } ], "type": "object" }, "title": "Alibaba volumes parameter", "type": "array" }, "AmazonCloudRequest": { "properties": { "credentials": { "$ref": "#/components/schemas/AmazonCredentials" }, "features": { "$ref": "#/components/schemas/CloudFeatures" }, "provider": { "enum": [ "amazon" ], "type": "string" } }, "required": [ "credentials", "provider" ], "type": "object" }, "AmazonCredentials": { "properties": { "apikey": { "description": "Your AWS API key", "type": "string" }, "apisecret": { "description": "Your AWS API secret", "type": "string" }, "region": { "description": "Your AWS region", "type": "string" } }, "required": [ "apikey", "apisecret", "region" ], "type": "object" }, "AmazonNet": { "properties": { "security_group": { "description": "Security group to assign to the machine", "type": "string" }, "subnet": { "description": "Name or ID of the subnet to launch the machine into", "type": "string" } }, "title": "Amazon net parameter", "type": "object" }, "AmazonVolumes": { "items": { "oneOf": [ { "properties": { "device": { "description": "The device name (for example, /dev/sdh or xvdh)", "type": "string" }, "volume": { "description": "Name or ID of the volume", "type": "string" } }, "required": [ "device", "volume" ] }, { "properties": { "delete_on_termination": { "description": "Delete volume when machine is deleted", "type": "boolean" }, "iops": { "description": "Number of I/O operations per second", "type": "integer" }, "name": { "description": "The device name (for example, /dev/sdh or xvdh)", "type": "string" }, "size": { "description": "Size of the volume in GBs", "type": "integer" }, "volume_type": { "enum": [ "gp2", "io1", "st1", "sc1", "standard" ], "type": "string" } }, "required": [ "name", "size" ] } ], "type": "object" }, "title": "Amazon volumes parameter", "type": "array" }, "AzureCloudRequest": { "properties": { "credentials": { "$ref": "#/components/schemas/AzureCredentials" }, "features": { "$ref": "#/components/schemas/CloudFeatures" }, "provider": { "enum": [ "azure" ], "type": "string" } }, "required": [ "credentials", "provider" ], "type": "object" }, "AzureCredentials": { "properties": { "key": { "description": "Your Azure key", "type": "string" }, "secret": { "description": "Your Azure secret", "type": "string" }, "subscriptionId": { "description": "Your Azure subscription ID", "type": "string" }, "tenantId": { "description": "Your Azure tenant ID", "type": "string" } }, "required": [ "key", "secret", "subscriptionId", "tenantId" ], "type": "object" }, "AzureExtra": { "properties": { "password": { "description": "The machine password. Only used on Microsoft images", "type": "string" }, "resource_group": { "description": "A new or existing resource group. If not provided a `mist` resource group will be used.", "type": "string" }, "storage_account_type": { "description": "Specifies the storage account type for the OS disk. Defaults to `StandardSSD_LRS`", "enum": [ "Premium_LRS", "Premium_ZRS", "StandardSSD_LRS", "StandardSSD_ZRS", "Standard_LRS" ], "type": "string" }, "user": { "description": "The machine username. Defaults to azureuser", "type": "string" } }, "title": "Azure extra parameter", "type": "object" }, "AzureNet": { "properties": { "network": { "description": "A new or existing network If not provided a `mist-resource_group-location` network will be used.", "type": "string" } }, "title": "Azure net parameter", "type": "object" }, "AzureVolumes": { "items": { "oneOf": [ { "properties": { "volume": { "description": "Name or ID of the volume to attach", "type": "string" } }, "required": [ "volume" ] }, { "properties": { "caching_type": { "description": "Specifies the caching requirements", "enum": [ "None", "ReadOnly", "ReadWrite" ], "type": "string" }, "name": { "description": "Name of the volume to be created", "type": "string" }, "size": { "description": "Size of the volume to be created in GBs", "type": "integer" }, "storage_account_type": { "description": "Specifies the storage account type for the managed volume. Defaults to `StandardSSD_LRS`", "enum": [ "Premium_LRS", "Premium_ZRS", "StandardSSD_LRS", "StandardSSD_ZRS", "Standard_LRS", "UltraSSD_LRS" ], "type": "string" } }, "required": [ "name", "size" ] } ], "type": "object" }, "title": "Azure volumes parameter", "type": "array" }, "Cloud": { "example": { "config": "{}", "created_by": "created_by", "features": { "compute": true, "container": false, "dns": false }, "id": "id", "name": "name", "owned_by": "owned_by", "tags": "{}" }, "properties": { "config": { "type": "object" }, "created_by": { "type": "string" }, "features": { "$ref": "#/components/schemas/CloudFeatures" }, "id": { "type": "string" }, "name": { "type": "string" }, "owned_by": { "type": "string" }, "provider": { "$ref": "#/components/schemas/SupportedProviders" }, "tags": { "type": "object" } }, "type": "object" }, "CloudFeatures": { "description": "The cloud features that should be enabled", "example": { "compute": true, "container": false, "dns": false }, "properties": { "compute": { "default": true, "description": "Enable compute services", "type": "boolean" }, "container": { "default": false, "description": "Enable container services", "type": "boolean" }, "dns": { "default": false, "description": "Enable DNS services", "type": "boolean" } }, "type": "object" }, "CloudSigmaCloudRequest": { "properties": { "credentials": { "$ref": "#/components/schemas/CloudSigmaCredentials" }, "features": { "$ref": "#/components/schemas/CloudFeatures" }, "provider": { "enum": [ "cloudsigma" ], "type": "string" } }, "required": [ "credentials", "provider" ], "type": "object" }, "CloudSigmaCredentials": { "properties": { "password": { "description": "Your CloudSigma password", "type": "string" }, "region": { "description": "Your CloudSigma region", "type": "string" }, "username": { "description": "Your CloudSigma username", "type": "string" } }, "required": [ "password", "region", "username" ], "type": "object" }, "CloudSigmaVolumes": { "items": { "oneOf": [ { "properties": { "volume": { "description": "Name or ID of an existing volume to attach", "type": "string" } }, "required": [ "volume" ] }, { "properties": { "name": { "description": "Name of the volume to be created", "type": "string" }, "size": { "description": "Size of the volume in GBs", "minimum": 1, "type": "integer" } }, "required": [ "name", "size" ] } ], "type": "object" }, "title": "CloudSigma volumes parameter", "type": "array" }, "Cluster": { "example": { "cloud": "cloud", "config": "{}", "created": "created", "created_by": "created_by", "credentials": "{}", "external_id": "external_id", "extra": "{}", "id": "id", "last_seen": "last_seen", "location": "location", "missing_since": "missing_since", "name": "name", "owned_by": "owned_by", "owner": "owner", "state": "state", "tags": "{}", "total_cpus": 6, "total_memory": 1, "total_nodes": 0 }, "properties": { "cloud": { "type": "string" }, "config": { "type": "object" }, "created": { "type": "string" }, "created_by": { "type": "string" }, "credentials": { "type": "object" }, "external_id": { "type": "string" }, "extra": { "type": "object" }, "id": { "type": "string" }, "last_seen": { "type": "string" }, "location": { "type": "string" }, "missing_since": { "type": "string" }, "name": { "type": "string" }, "owned_by": { "type": "string" }, "owner": { "type": "string" }, "provider": { "$ref": "#/components/schemas/ClusterProviders" }, "state": { "type": "string" }, "tags": { "type": "object" }, "total_cpus": { "type": "integer" }, "total_memory": { "type": "integer" }, "total_nodes": { "type": "integer" } }, "type": "object" }, "ClusterProviders": { "description": "The cloud provider of the cluster", "enum": [ "amazon", "azure", "digitalocean", "google", "kubernetes", "openshift", "linode" ], "type": "string" }, "CreateClusterRequest": { "allOf": [ { "$ref": "#/components/schemas/CreateClusterRequest_allOf" } ], "example": { "location": "europe-west2-b", "name": "my-cluster", "provider": "google" } }, "CreateClusterRequest_allOf": { "properties": { "cloud": { "description": "The cloud the cluster belongs to", "type": "string" }, "location": { "description": "Google specific parameter(Required).Name or ID of the location to create the cluster in", "type": "string" }, "name": { "description": "The name of the cluster to create", "type": "string" }, "nodepools": { "items": { "$ref": "#/components/schemas/CreateClusterRequest_allOf_nodepools" }, "type": "array" }, "provider": { "$ref": "#/components/schemas/ClusterProviders" }, "templates": { "items": { "allOf": [ { "properties": { "type": { "enum": [ "helm", "manifest" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, { "discriminator": { "mapping": { "helm": "#/components/schemas/HelmChart", "manifest": "#/components/schemas/KubernetesManifest" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/HelmChart" }, { "$ref": "#/components/schemas/KubernetesManifest" } ] } ] }, "type": "array" }, "waiters": { "items": { "$ref": "#/components/schemas/CreateClusterRequest_allOf_waiters" },