{"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"},"type":"array"}},"required":["name"],"type":"object"},"CreateClusterRequest_allOf_nodepools":{"properties":{"disk_size":{"default":20,"description":"Size of the disk attached to each node, specified in GB.","type":"integer"},"disk_type":{"description":"Type of the disk attached to each node. Defaults to pd-standard(GKE), gp3(EKS)","type":"string"},"nodes":{"default":2,"description":"The number of nodes to provision for the cluster. Defaults to 2","type":"integer"},"preemptible":{"description":"Google specific parameter.Whether the nodes are created as preemptible machines. Defaults to false","type":"boolean"},"size":{"description":"Name or ID of size to use for the nodes. If not provided, the t3.medium(EKS), e2-medium(GKE) size will be used","type":"string"}},"type":"object"},"CreateClusterRequest_allOf_waiters":{"properties":{"name":{"type":"string"},"namespace":{"default":"default","type":"string"},"timeout":{"default":1800,"type":"integer"},"type":{"type":"string"}},"required":["name","type"],"type":"object"},"CreateClusterResponse":{"example":{"jobId":"jobId"},"properties":{"jobId":{"type":"string"}},"type":"object"},"CreateMachineRequest":{"example":{"cloud":"cloud","cloudinit":"cloudinit","disks":{"disk_path":"disk_path","disk_size":0},"dry":true,"expiration":{"action":"stop","date":"2000-01-23T04:56:07+00:00","notify":{"period":"minutes","value":1},"notify_msg":"notify_msg"},"extra":"","fqdn":"fqdn","image":"Debian","key":"","location":"","monitoring":true,"name":"DB mirror","net":"","optimize":"optimize","quantity":1.4658129805029452,"save":true,"schedules":["",""],"scripts":["",""],"size":"m1.small","tags":"{}","template":"{}","volumes":""},"properties":{"cloud":{"description":"Specify cloud to provision on","type":"string"},"cloudinit":{"description":"Run this Cloud Init script on first boot","type":"string"},"disks":{"$ref":"#/components/schemas/CreateMachineRequest_disks"},"dry":{"description":"Return provisioning plan and exit without executing it","type":"boolean"},"expiration":{"$ref":"#/components/schemas/Expiration"},"extra":{"anyOf":[{"$ref":"#/components/schemas/AzureExtra"},{"$ref":"#/components/schemas/DockerExtra"},{"$ref":"#/components/schemas/EquinixMetalExtra"},{"$ref":"#/components/schemas/GoogleExtra"},{"$ref":"#/components/schemas/LinodeExtra"},{"$ref":"#/components/schemas/LXDExtra"},{"$ref":"#/components/schemas/VSphereExtra"},{"$ref":"#/components/schemas/VultrExtra"}],"description":"Configure additional parameters"},"fqdn":{"description":"Add DNS A Record that points machine's public IP to this Fully Qualified Domain Name. Zone needs to be managed by a configured Cloud DNS provider","type":"string"},"image":{"description":"Operating System image to boot from","example":"Debian","oneOf":[{"type":"object"},{"description":"Name or ID of the image to boot from","type":"string"}]},"key":{"description":"Associate SSH key","oneOf":[{"properties":{"key":{"description":"Name or ID of the SSH key to deploy","type":"string"},"user":{"description":"SSH user, supported on Google","type":"string"}},"type":"object"},{"description":"Name or ID of the SSH key to deploy","type":"string"}]},"location":{"description":"Where to provision e.g. region, datacenter, rack","oneOf":[{"properties":{"prefer":{"type":"string"}},"type":"object"},{"type":"string"}]},"monitoring":{"description":"Enable monitoring of this machine","type":"boolean"},"name":{"description":"Specify machine name","example":"DB mirror","type":"string"},"net":{"anyOf":[{"$ref":"#/components/schemas/AlibabaNet"},{"$ref":"#/components/schemas/AmazonNet"},{"$ref":"#/components/schemas/AzureNet"},{"$ref":"#/components/schemas/DockerNet"},{"$ref":"#/components/schemas/EquinixMetalNet"},{"$ref":"#/components/schemas/GoogleNet"},{"$ref":"#/components/schemas/KVMNet"},{"$ref":"#/components/schemas/LinodeNet"},{"$ref":"#/components/schemas/LXDNet"},{"$ref":"#/components/schemas/OpenstackNet"},{"$ref":"#/components/schemas/VSphereNet"},{"$ref":"#/components/schemas/VultrNet"}],"description":"Specify network configuration parameters"},"optimize":{"description":"Criteria optimization, e.g \"cost\"","type":"string"},"provider":{"$ref":"#/components/schemas/SupportedProviders"},"quantity":{"description":"Provision multiple machines of this type","type":"number"},"save":{"description":"Save provisioning plan as template","type":"boolean"},"schedules":{"description":"Configure scheduled actions for the provisioned machine","items":{"allOf":[{"properties":{"action":{"enum":["start","stop","reboot","destroy"],"type":"string"},"description":{"type":"string"},"schedule_type":{"enum":["one_off","crontab","interval"],"type":"string"},"script":{"$ref":"#/components/schemas/PostDeployScript"}},"required":["schedule_type"],"type":"object"},{"discriminator":{"mapping":{"crontab":"#/components/schemas/CronSchedule","interval":"#/components/schemas/IntervalSchedule","one_off":"#/components/schemas/OneOffSchedule"},"propertyName":"schedule_type"},"oneOf":[{"$ref":"#/components/schemas/OneOffSchedule"},{"$ref":"#/components/schemas/CronSchedule"},{"$ref":"#/components/schemas/IntervalSchedule"}]}]},"type":"array"},"scripts":{"description":"Run post deploy scripts over SSH","items":{"allOf":[{"type":"object"},{"oneOf":[{"$ref":"#/components/schemas/InlineScript"},{"$ref":"#/components/schemas/PostDeployScript"}]}]},"type":"array"},"size":{"description":"Machine sizing spec e.g. cpu/ram/flavor","example":"m1.small","oneOf":[{"properties":{"accelerators":{"description":"Google specific parameter","properties":{"accelerator_count":{"description":"The number of the accelerator cards exposed to this machine","type":"integer"},"accelerator_type":{"description":"Accelerator type to attach to this machine. e.g. 'nvidia-tesla-p100'","type":"string"}},"type":"object"},"cpu":{"description":"Number of cpu cores. On container based providers this value will be used as the cpu limit. Mutually exclusive with 'search'","type":"number"},"memory":{"description":"Memory size in MBs. On container based providers this value will be used as the memory limit. Mutually exclusive with 'search'","type":"integer"},"prefer":{"description":"Optional properties to be used if applicable.","properties":{"cpu_shares":{"description":"Docker specific parameter. An integer value representing this container's relative CPU weight versus other containers","type":"integer"},"prefix":{"description":"A size name prefix. Used only on providers with standard sizes","type":"string"}},"type":"object"},"search":{"description":"Name or ID of the size to select for this machine. Mutually exclusive with 'cpu' and 'memory'","type":"string"}},"type":"object"},{"description":"Name or ID of the size to select for this machine","type":"string"}]},"tags":{"description":"Assign tags to provisioned machine","type":"object"},"template":{"type":"object"},"volumes":{"anyOf":[{"$ref":"#/components/schemas/AlibabaVolumes"},{"$ref":"#/components/schemas/AmazonVolumes"},{"$ref":"#/components/schemas/AzureVolumes"},{"$ref":"#/components/schemas/CloudSigmaVolumes"},{"$ref":"#/components/schemas/DigitalOceanVolumes"},{"$ref":"#/components/schemas/GoogleVolumes"},{"$ref":"#/components/schemas/LinodeVolumes"},{"$ref":"#/components/schemas/LXDVolumes"},{"$ref":"#/components/schemas/OpenstackVolumes"},{"$ref":"#/components/schemas/VultrVolumes"}],"description":"Configure of attached storage volumes, e.g. cloud disks"}},"required":["image","name"],"type":"object"},"CreateMachineRequest_disks":{"description":"Configure local disks","example":{"disk_path":"disk_path","disk_size":0},"properties":{"disk_path":{"description":"KVM specific parameter. Where the VM disk file will be created","type":"string"},"disk_size":{"description":"KVM, CloudSigma specific parameter","type":"integer"}},"type":"object"},"CreateMachineResponse":{"oneOf":[{"$ref":"#/components/schemas/CreateMachineResponse_oneOf"},{"$ref":"#/components/schemas/CreateMachineResponse_oneOf_1"}],"type":"object"},"CreateMachineResponse_oneOf":{"properties":{"jobId":{"type":"string"},"plan":{"type":"object"}}},"CreateMachineResponse_oneOf_1":{"properties":{"plan":{"type":"object"}}},"CreateNetworkRequest":{"example":{"cloud":"my-cloud","dry":true,"extra":"{}","name":"my-network","save":true,"tags":"{}","template":"{}"},"properties":{"cloud":{"description":"Specify cloud to provision on","example":"my-cloud","type":"string"},"dry":{"description":"Return provisioning plan and exit without executing it","type":"boolean"},"extra":{"description":"Configure additional parameters, e.g. cidr (EC2 network)","type":"object"},"name":{"description":"Specify network name","example":"my-network","type":"string"},"save":{"description":"Save provisioning plan as template","type":"boolean"},"tags":{"description":"Assign tags to provisioned network","type":"object"},"template":{"type":"object"}},"required":["cloud","name"],"type":"object"},"CreateNetworkResponse":{"oneOf":[{"$ref":"#/components/schemas/CreateMachineResponse_oneOf"},{"$ref":"#/components/schemas/CreateMachineResponse_oneOf_1"}],"type":"object"},"CreateSecretRequest":{"example":{"name":"name","secret":"{}"},"properties":{"name":{"description":"The name of the secret. This is equivalent to the path the secret will be stored in Vault","type":"string"},"secret":{"type":"object"}},"required":["name","secret"],"type":"object"},"CreateSnapshotResponse":{"type":"object"},"CreateVolumeRequest":{"example":{"cloud":"my-cloud","dry":true,"ex_disk_type":"pd-standard","ex_iops":"ex_iops","ex_volume_type":"standard","extra":"{}","location":"us-central1-a","name":"my-volume","quantity":0,"save":true,"size":1,"tags":"{}","template":"{}"},"properties":{"cloud":{"description":"Specify cloud to provision on","example":"my-cloud","type":"string"},"dry":{"description":"Return provisioning plan and exit without executing it","type":"boolean"},"ex_disk_type":{"description":"GCE-specific","enum":["pd-standard","pd-ssd"],"example":"pd-standard","type":"string"},"ex_iops":{"description":"EC2-specific. Needs to be specified if volume_type='io1'","type":"string"},"ex_volume_type":{"description":"EC2-specific","enum":["standard","io1","gp2","sc1","st1"],"example":"standard","type":"string"},"extra":{"description":"Configure additional parameters","type":"object"},"location":{"description":"Where to provision e.g. region, datacenter, rack","example":"us-central1-a","type":"string"},"name":{"description":"Specify volume name","example":"my-volume","type":"string"},"provider":{"$ref":"#/components/schemas/SupportedProviders"},"quantity":{"description":"Provision multiple volumes of this type","type":"integer"},"save":{"description":"Save provisioning plan as template","type":"boolean"},"size":{"description":"Volume sizing spec","example":1,"type":"integer"},"tags":{"description":"Assign tags to provisioned volume","type":"object"},"template":{"type":"object"}},"required":["cloud","location","name","size"],"type":"object"},"CreateVolumeResponse":{"oneOf":[{"$ref":"#/components/schemas/CreateMachineResponse_oneOf"},{"$ref":"#/components/schemas/CreateMachineResponse_oneOf_1"}],"type":"object"},"CreateZoneRequest":{"example":{"cloud":"my-cloud","name":"my-zone"},"properties":{"cloud":{"description":"Specify cloud to provision on","type":"string"},"dry":{"description":"Return provisioning plan and exit without executing it","type":"boolean"},"extra":{"description":"Configure additional parameters","type":"object"},"name":{"description":"Specify zone name/domain (e.g. example.com)","type":"string"},"save":{"description":"Save provisioning plan as template","type":"boolean"},"tags":{"description":"Assign tags to provisioned zone","type":"object"},"template":{"type":"object"}},"required":["cloud","name"],"type":"object"},"CreateZoneResponse":{"oneOf":[{"$ref":"#/components/schemas/CreateMachineResponse_oneOf"},{"$ref":"#/components/schemas/CreateMachineResponse_oneOf_1"}],"type":"object"},"CronSchedule":{"description":"crontab schedule","properties":{"day_of_month":{"type":"string"},"day_of_week":{"type":"string"},"expires":{"description":"The datetime when schedule should expire, e.g 2021-09-22T18:19:28Z","format":"date-time","type":"string"},"hour":{"type":"string"},"max_run_count":{"minimum":1,"type":"integer"},"minute":{"type":"string"},"month_of_year":{"type":"string"},"schedule_type":{"enum":["crontab"],"type":"string"},"start_after":{"description":"The datetime when schedule should start running, e.g 2021-09-22T18:19:28Z","format":"date-time","type":"string"}},"required":["day_of_month","day_of_week","hour","minute","month_of_year","schedule_type"],"title":"Cron","type":"object"},"DataType":{"enum":["metrics","logs"],"example":"logs","type":"string"},"Datapoints":{"example":{"data":{"result":[null,null],"resultType":"resultType"},"status":"status"},"properties":{"data":{"$ref":"#/components/schemas/Datapoints_data"},"status":{"type":"string"}},"type":"object"},"DatapointsValuesItem":{"anyOf":[{"type":"string"},{"type":"number"}]},"DatapointsValuesTuple":{"items":{"$ref":"#/components/schemas/DatapointsValuesItem"},"type":"array"},"Datapoints_data":{"example":{"result":[null,null],"resultType":"resultType"},"properties":{"result":{"items":{"$ref":"#/components/schemas/Vector"},"type":"array"},"resultType":{"type":"string"}},"type":"object"},"DestroyClusterResponse":{"example":{"cloud":"cloud","cluster":"cluster","jobId":"jobId"},"properties":{"cloud":{"type":"string"},"cluster":{"type":"string"},"jobId":{"type":"string"}},"type":"object"},"DigitalOceanVolumes":{"items":{"oneOf":[{"properties":{"volume":{"description":"Name or ID of the volume to attach","type":"string"}},"required":["volume"]},{"properties":{"filesystem_type":{"description":"The name of the filesystem type to be used on the volume","enum":["ext4","xfs"],"type":"string"},"name":{"description":"Name of the volume to be created","type":"string"},"size":{"description":"Size of the volume in GBs","type":"integer"}},"required":["name","size"]}],"type":"object"},"title":"DigitalOcean volumes parameter","type":"array"},"DigitaloceanCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/DigitaloceanCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["digitalocean"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"DigitaloceanCredentials":{"properties":{"token":{"description":"Your DigitalOcean API token","type":"string"}},"required":["token"],"type":"object"},"DockerCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/DockerCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["docker"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"DockerCredentials":{"properties":{"host":{"description":"Your Docker host","type":"string"},"password":{"description":"Your Docker password","type":"string"},"port":{"description":"Your Docker port","type":"string"},"showAll":{"description":"Show all containers, including stopped","type":"boolean"},"tlsCaCert":{"description":"Your TLS CA certifcate","type":"string"},"tlsCert":{"description":"Your TLS auth certificate","type":"string"},"tlsKey":{"description":"Your TLS auth key","type":"string"},"username":{"description":"Your Docker username","type":"string"}},"required":["host","port"],"type":"object"},"DockerExtra":{"properties":{"command":{"description":"Command to run specified as a string","type":"string"},"environment":{"description":"Key, value pairs of environment variables to set inside the container","type":"object"}},"title":"Docker extra parameter","type":"object"},"DockerNet":{"properties":{"port_bindings":{"description":"ContainerPort,HostPort pairs. For example \"80\"/\"80\", \"123/udp\"/\"123\"","type":"object"}},"title":"Docker net parameter","type":"object"},"EditCloudRequest":{"anyOf":[{"$ref":"#/components/schemas/EditCloudRequest_anyOf"},{"allOf":[{"properties":{"provider":{"$ref":"#/components/schemas/SupportedProviders"}},"required":["provider"],"type":"object"},{"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":{"name":"my-renamed-cloud"}},"EditCloudRequest_anyOf":{"additionalProperties":false,"properties":{"name":{"description":"Updated name","type":"string"}},"required":["name"],"type":"object"},"EditMachineRequest":{"example":{"expiration":{"action":"stop","date":"date","notify":0}},"properties":{"expiration":{"$ref":"#/components/schemas/EditMachineRequest_expiration"}},"type":"object"},"EditMachineRequest_expiration":{"example":{"action":"stop","date":"date","notify":0},"properties":{"action":{"enum":["stop","destroy"],"type":"string"},"date":{"description":"format should be \u03a5\u03a5\u03a5\u03a5-\u039c\u039c-DD HH:MM:SS","type":"string"},"notify":{"description":"seconds before the expiration date to be notified","type":"integer"}},"required":["action","date"],"type":"object"},"EditRuleRequest":{"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"]}],"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"},"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"}},"type":"object"},"EditScheduleRequest":{"example":{"action":"start","description":"This is a schedule that is about to be edited","enabled":true,"name":"schedule-name","params":"Parameters string","schedule_entry":"2022-05-28T00:00:00Z","schedule_type":"one_off","script_id":"d5775984772949de820fa8279c306b30","selectors":[null,null],"start_after":"2022-06-01T00:00:00Z"},"properties":{"action":{"description":"Edit 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 that is about to be edited","example":"This is a schedule that is about to be edited","type":"string"},"enabled":{"description":"Schedule status (enabled, disabled)","example":true,"type":"boolean"},"name":{"description":"The name of the schedule that is about to be edited","example":"schedule-name","type":"string"},"params":{"description":"Edit schedule parameters","example":"Parameters string","type":"string"},"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":"Edit 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":"Edit the date after that schedule starts. The format should be \u03a5\u03a5\u03a5\u03a5-\u039c\u039c-DD HH:MM:SS","example":"2022-06-01T00:00:00Z","type":"string"}},"type":"object"},"EditSecretRequest":{"example":{"secret":"{}"},"properties":{"secret":{"type":"object"}},"required":["secret"],"type":"object"},"EquinixCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/EquinixCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["equinix"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"EquinixCredentials":{"additionalProperties":false,"properties":{"apikey":{"description":"Your Equinix Metal API key","type":"string"}},"required":["apikey"],"type":"object"},"EquinixMetalExtra":{"properties":{"project_id":{"description":"Project UUID, if not given the first one available will be selected","type":"string"}},"title":"Equnix Metal extra parameter","type":"object"},"EquinixMetalNet":{"properties":{"ip_addresses":{"description":"Specify addresses to be created with your machine.By default Equinix configures public IPv4, public IPv6, and private IPv4","items":{"$ref":"#/components/schemas/EquinixMetalNet_ip_addresses"},"type":"array"}},"title":"Equnix Metal net parameter","type":"object"},"EquinixMetalNet_ip_addresses":{"properties":{"address_family":{"description":"Address Family for IP Address(IPv4, IPv6)","enum":[4,6],"type":"integer"},"cidr":{"description":"Cidr Size for the IP Block created. Valid values depend on the operating system being provisioned. (28..32 for IPv4 addresses, 124..127 for IPv6 addresses)","type":"integer"},"public":{"description":"Address Type for IP Address","type":"boolean"}},"required":["address_family","cidr","public"],"type":"object"},"Expiration":{"example":{"action":"stop","date":"2000-01-23T04:56:07+00:00","notify":{"period":"minutes","value":1},"notify_msg":"notify_msg"},"properties":{"action":{"enum":["stop","destroy"],"type":"string"},"date":{"description":"When machine should expire, e.g 2021-09-22T18:19:28Z","format":"date-time","type":"string"},"notify":{"$ref":"#/components/schemas/Expiration_notify"},"notify_msg":{"type":"string"}},"required":["action","date"],"type":"object"},"Expiration_notify":{"description":"Notify user before machine expiration","example":{"period":"minutes","value":1},"properties":{"period":{"enum":["minutes","hours","days"],"type":"string"},"value":{"minimum":1,"type":"integer"}},"required":["period","value"],"type":"object"},"FieldSelector":{"properties":{"field":{"description":"the name of the field","example":"count","type":"string"},"operator":{"description":"one of equal (eq) and regular expression (regex) operators type","enum":["eq","regex"],"example":"eq","type":"string"},"type":{"description":"field type","enum":["field"],"type":"string"},"value":{"description":"the value of the field","type":"object"}},"type":"object"},"Frequency":{"example":{"every":5,"period":"period"},"properties":{"every":{"description":"a positive integer denoting how often the rule must be evaluated\n","type":"integer"},"period":{"description":"units of time, e.g. \"seconds\"","type":"string"}},"required":["every","period"],"type":"object"},"GetCloudResponse":{"example":{"data":{"config":"{}","created_by":"created_by","features":{"compute":true,"container":false,"dns":false},"id":"id","name":"name","owned_by":"owned_by","tags":"{}"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Cloud"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetClusterResponse":{"example":{"data":{"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},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Cluster"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetDatapointsResponse":{"example":{"data":{"data":{"result":[null,null],"resultType":"resultType"},"status":"status"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Datapoints"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetImageResponse":{"example":{"data":{"cloud":"cloud","created_by":"created_by","external_id":"external_id","extra":"{}","id":"id","name":"name","os_type":"os_type","owned_by":"owned_by","starred":true,"tags":"{}"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Image"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetJobResponse":{"example":{"data":{"action":"action","cloud_id":"cloud_id","error":true,"finished_at":6.027456183070403,"job_id":"job_id","logs":[{"job_id":"job_id","org":"org"},{"job_id":"job_id","org":"org"}],"machine_id":"machine_id","org":"org","started_at":0.8008281904610115,"user":"user"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Job"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetKeyResponse":{"example":{"data":{"config":"{}","created_by":"created_by","default":true,"id":"id","name":"name","owned_by":"owned_by","tags":"{}","type":"ssh"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Key"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetLocationResponse":{"example":{"data":{"available_images":"{}","available_sizes":"{}","cloud":"cloud","country":"country","created_by":"created_by","external_id":"external_id","extra":"{}","id":"id","location_type":"location_type","name":"name","owned_by":"owned_by","parent":"parent"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Location"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetMachineResponse":{"example":{"data":{"actions":"{}","cloud":"cloud","cluster":"cluster","cores":0.8008281904610115,"cost":"{}","created":"created","created_by":"created_by","default":true,"expiration":"expiration","external_id":"external_id","extra":"{}","hostname":"hostname","id":"id","image":"image","key_associations":[{"key":"key","last_used":6,"machine":"machine","port":1,"sudo":true,"user":"user"},{"key":"key","last_used":6,"machine":"machine","port":1,"sudo":true,"user":"user"}],"last_seen":"last_seen","location":"location","missing_since":"missing_since","monitoring":"monitoring","name":"name","network":"network","os_type":"os_type","owned_by":"owned_by","parent":"parent","ports":"{}","private_ips":["private_ips","private_ips"],"probe":"{}","public_ips":["public_ips","public_ips"],"size":"size","subnet":"subnet","tags":"{}","type":"type","unreachable_since":"unreachable_since"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Machine"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetNetworkResponse":{"example":{"data":{"cloud":"cloud","created_by":"created_by","external_id":"external_id","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Network"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetOrgMemberResponse":{"example":{"data":{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Member"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetOrgResponse":{"example":{"data":{"clouds_count":"clouds_count","created":true,"enterprise_plan":"{}","id":"id","last_active":"last_active","name":"name","selected_plan":"selected_plan","teams_count":"teams_count","total_machine_count":"total_machine_count"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Org"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetRuleResponse":{"example":{"data":{"actions":"{}","data_type":"data_type","disabled":"disabled","frequency":"{}","id":"id","name":"name","queries":"{}","triggered_after":"{}","window":"{}"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Rule"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetScheduleResponse":{"example":{"data":{"action":"stop","created_by":"Manager A","description":"This is an test schedule","enabled":true,"id":"id","name":"reboot-schedule","owned_by":"Officer B","params":"Test parameters","run_immediately":true,"schedule_entry":"{\\\"minute\\\":\\\"0\\\", \\\"hour\\\":\\\"0\\\", \\\"day_of_week\\\":\\\"*\\\", \\\"day_of_month\\\":\\\"*\\\", \\\"month_of_year\\\":\\\"*\\\"}","schedule_type":"crontab","script_id":"d5775984772949de820fa8279c306b30","selectors":[null,null],"start_after":"2022-05-28T00:00:00Z","tags":"{}"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Schedule"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetScriptResponse":{"example":{"data":{"created_by":"created_by","description":"description","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Script"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetSecretResponse":{"example":{"data":{"created_by":"created_by","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Secret"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetSizeResponse":{"example":{"data":{"cloud":"cloud","external_id":"external_id","extra":"{}","id":"id","name":"name"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Size"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetVolumeResponse":{"example":{"data":{"actions":"{}","attached_to":["attached_to","attached_to"],"cloud":"cloud","created_by":"created_by","default":true,"external_id":"external_id","extra":"{}","id":"id","last_seen":"last_seen","location":"location","missing_since":"missing_since","name":"name","owned_by":"owned_by","size":"size","tags":"{}"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Volume"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GetZoneResponse":{"example":{"data":{"cloud":"cloud","created_by":"created_by","external_id":"external_id","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"$ref":"#/components/schemas/Zone"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"GoogleCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/GoogleCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["google"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"GoogleCredentials":{"properties":{"email":{"description":"Your GCP client email","type":"string"},"privateKey":{"description":"Your GCP private key","type":"string"},"projectId":{"description":"The Id of your GCP project","type":"string"}},"required":["email","privateKey","projectId"],"type":"object"},"GoogleExtra":{"properties":{"service_account":{"$ref":"#/components/schemas/GoogleExtra_service_account"}},"title":"Google extra parameter","type":"object"},"GoogleExtra_service_account":{"properties":{"email":{"description":"The email address of the service account.","type":"string"},"scopes":{"description":"A list of scopes to be made available for this machine.","items":{"type":"string"},"type":"array"}},"type":"object"},"GoogleNet":{"properties":{"network":{"description":"The network to associate with the machine","type":"string"},"subnetwork":{"description":"The subnetwork resource for this machine","type":"string"}},"title":"Google net parameter","type":"object"},"GoogleVolumes":{"items":{"oneOf":[{"properties":{"boot":{"description":"Whether this volume should be used as the boot drive. Up to one volume must set this parameter","type":"boolean"},"volume":{"description":"Name or ID of the volume to attach","type":"string"}},"required":["volume"]},{"properties":{"boot":{"description":"Whether this volume should be used as the boot drive. Up to one volume must set this parameter","type":"boolean"},"name":{"description":"Name of the volume to be created, mandatory on non-boot volumes","type":"string"},"size":{"description":"Size of the volume to be created","minimum":1,"type":"integer"},"type":{"description":"Type of the volume to create, defaults to 'pd-standard'","enum":["pd-standard","pd-ssd"],"type":"string"}},"required":["size"]}],"type":"object"},"title":"Google volumes parameter","type":"array"},"HelmChart":{"properties":{"chart_name":{"type":"string"},"namespace":{"description":"The namespace to install the release on","type":"string"},"release_name":{"type":"string"},"repo_url":{"description":"The url of the Helm repository","type":"string"},"type":{"enum":["helm"],"type":"string"},"values":{"description":"The contents of a Helm values.yaml file","type":"string"},"version":{"description":"A version constraint for the chart","type":"string"}},"required":["chart_name","release_name","repo_url","type"],"type":"object"},"IbmCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/IbmCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["ibm"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"IbmCredentials":{"properties":{"apikey":{"description":"Your IBM Cloud API key","type":"string"},"provider":{"enum":["ibm"],"type":"string"},"username":{"description":"Your IBM Cloud username","type":"string"}},"required":["apikey"],"type":"object"},"Image":{"example":{"cloud":"cloud","created_by":"created_by","external_id":"external_id","extra":"{}","id":"id","name":"name","os_type":"os_type","owned_by":"owned_by","starred":true,"tags":"{}"},"properties":{"cloud":{"type":"string"},"created_by":{"type":"string"},"external_id":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"name":{"type":"string"},"os_type":{"type":"string"},"owned_by":{"type":"string"},"starred":{"type":"boolean"},"tags":{"type":"object"}},"type":"object"},"InlineScript":{"properties":{"inline":{"type":"string"}},"required":["inline"],"type":"object"},"InstantVector":{"properties":{"metric":{"type":"object"},"values":{"items":{"$ref":"#/components/schemas/DatapointsValuesItem"},"type":"array"}},"type":"object"},"IntervalSchedule":{"description":"interval schedule","properties":{"every":{"type":"integer"},"expires":{"description":"The datetime when schedule should expire, e.g 2021-09-22T18:19:28Z","format":"date-time","type":"string"},"max_run_count":{"minimum":1,"type":"integer"},"period":{"enum":["minutes","hours","days"],"type":"string"},"schedule_type":{"enum":["interval"],"type":"string"},"start_after":{"description":"The datetime when schedule should start running, e.g 2021-09-22T18:19:28Z","format":"date-time","type":"string"}},"required":["every","period","schedule_type"],"title":"Interval","type":"object"},"Job":{"example":{"action":"action","cloud_id":"cloud_id","error":true,"finished_at":6.027456183070403,"job_id":"job_id","logs":[{"job_id":"job_id","org":"org"},{"job_id":"job_id","org":"org"}],"machine_id":"machine_id","org":"org","started_at":0.8008281904610115,"user":"user"},"properties":{"action":{"type":"string"},"cloud_id":{"type":"string"},"error":{"type":"boolean"},"finished_at":{"type":"number"},"job_id":{"type":"string"},"logs":{"items":{"$ref":"#/components/schemas/Log"},"type":"array"},"machine_id":{"type":"string"},"org":{"type":"string"},"started_at":{"type":"number"},"user":{"type":"string"}},"required":["action","error","finished_at","job_id","logs","org","started_at"],"type":"object"},"KVMNet":{"properties":{"networks":{"items":{"$ref":"#/components/schemas/KVMNet_networks"},"type":"array"},"vnfs":{"items":{"type":"string"},"type":"array"}},"title":"KVM net parameter","type":"object"},"KVMNet_networks":{"properties":{"gateway":{"description":"The IPv4 address for the default Gateway","type":"string"},"ip":{"description":"The IPv4 address to statically assign to the interface","type":"string"},"network":{"description":"Name or ID of the network, if only this field is provided a dynamic IP address will be assigned","type":"string"},"primary":{"description":"The primary interface, which will be assigned a routing rule for the default GW","type":"string"}},"required":["network"],"type":"object"},"Key":{"example":{"config":"{}","created_by":"created_by","default":true,"id":"id","name":"name","owned_by":"owned_by","tags":"{}","type":"ssh"},"properties":{"config":{"type":"object"},"created_by":{"type":"string"},"default":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"owned_by":{"type":"string"},"tags":{"type":"object"},"type":{"enum":["ssh","signed_ssh"],"type":"string"}},"type":"object"},"KeyMachineAssociation":{"example":{"key":"key","last_used":6,"machine":"machine","port":1,"sudo":true,"user":"user"},"properties":{"key":{"description":"Name or ID of the SSH key","type":"string"},"last_used":{"description":"Last used time","type":"integer"},"machine":{"description":"Name or ID of the machine","type":"string"},"port":{"description":"SSH port","type":"integer"},"sudo":{"description":"Indicates if the SSH user has sudo privileges","type":"boolean"},"user":{"description":"SSH user","type":"string"}},"type":"object"},"KeyMachineDisassociation":{"example":{"key":"key"},"properties":{"key":{"description":"Name or ID of the SSH key to disassociate","type":"string"}},"type":"object"},"KubernetesCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/KubernetesCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["kubernetes"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"KubernetesCredentials":{"properties":{"host":{"description":"Your Kubernetes API host","type":"string"},"password":{"description":"Your Kubernetes API password","type":"string"},"port":{"description":"Your Kubernetes API port","type":"string"},"showAll":{"description":"Show all containers, including stopped","type":"boolean"},"tlsCaCert":{"description":"Your TLS CA certifcate","type":"string"},"tlsCert":{"description":"Your TLS auth certificate","type":"string"},"tlsKey":{"description":"Your TLS auth key","type":"string"},"token":{"description":"Your Kubernetes API bearer token","type":"string"},"username":{"description":"Your Kubernetes API username","type":"string"}},"required":["host","port"],"type":"object"},"KubernetesManifest":{"properties":{"type":{"enum":["manifest"],"type":"string"}},"required":["type"],"type":"object"},"KubevirtCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/KubernetesCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["kubevirt"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"KvmCloudRequest":{"properties":{"credentials":{"type":"object"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["kvm"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"KvmCredentials":{"type":"object"},"LXDExtra":{"properties":{"ephemeral":{"description":"Whether to destroy the container on shutdown, defaults to False","type":"boolean"}},"title":"LXD extra parameter","type":"object"},"LXDNet":{"properties":{"networks":{"description":"An array of network names or IDs to launch the container into","items":{"type":"string"},"type":"array"}},"title":"LXD net parameter","type":"object"},"LXDVolumes":{"items":{"oneOf":[{"properties":{"path":{"description":"Path in the container the storage volume will be attached. e.g. /opt/mydata","type":"string"},"volume":{"description":"Name or ID of an existing storage volume to attach","type":"string"}},"required":["path","volume"]},{"properties":{"filesystem":{"description":"Filesystem of the storage volume, defaults to \"ext4\"","type":"string"},"mount_options":{"description":"Mount options for block devices,  defaults to \"discard\"","type":"string"},"name":{"description":"Name of the storage volume that will be created","type":"string"},"path":{"description":"Path in the container the storage volume will be attached. e.g. /opt/mydata","type":"string"},"pool":{"description":"The storage pool to create the volume into. If not given the default storage pool will be selected","type":"string"},"security_shifted":{"description":"Whether to enable id shifting overlay (allows attach by multiple isolated instances). Only supported on LXD version 3.16 and up","type":"boolean"},"size":{"description":"Size of the storage volume in GBs","type":"integer"}},"required":["name","path","size"]}],"type":"object"},"title":"LXD volumes parameter","type":"array"},"LinodeCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/LinodeCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["linode"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"LinodeCredentials":{"properties":{"apikey":{"description":"You Linode API key","type":"string"}},"required":["apikey"],"type":"object"},"LinodeExtra":{"properties":{"root_pass":{"description":"Set root password. If not given a secure password will be generated","type":"string"}},"title":"Linode extra parameter","type":"object"},"LinodeNet":{"properties":{"private_ip":{"description":"Assign a private IPv4 address, defaults to True","type":"boolean"}},"title":"Linode net parameter","type":"object"},"LinodeVolumes":{"items":{"oneOf":[{"properties":{"persist_across_boots":{"description":"Whether the volume should be attached to node across reboots, defaults to True","type":"boolean"},"volume":{"description":"Name or ID of the 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 to be created in GBs","type":"integer"}},"required":["name","size"]}],"type":"object"},"title":"Linode volumes parameter","type":"array"},"ListCloudsResponse":{"example":{"data":[{"config":"{}","created_by":"created_by","features":{"compute":true,"container":false,"dns":false},"id":"id","name":"name","owned_by":"owned_by","tags":"{}"},{"config":"{}","created_by":"created_by","features":{"compute":true,"container":false,"dns":false},"id":"id","name":"name","owned_by":"owned_by","tags":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Cloud"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListClustersResponse":{"example":{"data":[{"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},{"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}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Cluster"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListImagesResponse":{"example":{"data":[{"cloud":"cloud","created_by":"created_by","external_id":"external_id","extra":"{}","id":"id","name":"name","os_type":"os_type","owned_by":"owned_by","starred":true,"tags":"{}"},{"cloud":"cloud","created_by":"created_by","external_id":"external_id","extra":"{}","id":"id","name":"name","os_type":"os_type","owned_by":"owned_by","starred":true,"tags":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListKeysResponse":{"example":{"data":[{"config":"{}","created_by":"created_by","default":true,"id":"id","name":"name","owned_by":"owned_by","tags":"{}","type":"ssh"},{"config":"{}","created_by":"created_by","default":true,"id":"id","name":"name","owned_by":"owned_by","tags":"{}","type":"ssh"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Key"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListLocationsResponse":{"example":{"data":[{"available_images":"{}","available_sizes":"{}","cloud":"cloud","country":"country","created_by":"created_by","external_id":"external_id","extra":"{}","id":"id","location_type":"location_type","name":"name","owned_by":"owned_by","parent":"parent"},{"available_images":"{}","available_sizes":"{}","cloud":"cloud","country":"country","created_by":"created_by","external_id":"external_id","extra":"{}","id":"id","location_type":"location_type","name":"name","owned_by":"owned_by","parent":"parent"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Location"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListMachinesResponse":{"example":{"data":[{"actions":"{}","cloud":"cloud","cluster":"cluster","cores":0.8008281904610115,"cost":"{}","created":"created","created_by":"created_by","default":true,"expiration":"expiration","external_id":"external_id","extra":"{}","hostname":"hostname","id":"id","image":"image","key_associations":[{"key":"key","last_used":6,"machine":"machine","port":1,"sudo":true,"user":"user"},{"key":"key","last_used":6,"machine":"machine","port":1,"sudo":true,"user":"user"}],"last_seen":"last_seen","location":"location","missing_since":"missing_since","monitoring":"monitoring","name":"name","network":"network","os_type":"os_type","owned_by":"owned_by","parent":"parent","ports":"{}","private_ips":["private_ips","private_ips"],"probe":"{}","public_ips":["public_ips","public_ips"],"size":"size","subnet":"subnet","tags":"{}","type":"type","unreachable_since":"unreachable_since"},{"actions":"{}","cloud":"cloud","cluster":"cluster","cores":0.8008281904610115,"cost":"{}","created":"created","created_by":"created_by","default":true,"expiration":"expiration","external_id":"external_id","extra":"{}","hostname":"hostname","id":"id","image":"image","key_associations":[{"key":"key","last_used":6,"machine":"machine","port":1,"sudo":true,"user":"user"},{"key":"key","last_used":6,"machine":"machine","port":1,"sudo":true,"user":"user"}],"last_seen":"last_seen","location":"location","missing_since":"missing_since","monitoring":"monitoring","name":"name","network":"network","os_type":"os_type","owned_by":"owned_by","parent":"parent","ports":"{}","private_ips":["private_ips","private_ips"],"probe":"{}","public_ips":["public_ips","public_ips"],"size":"size","subnet":"subnet","tags":"{}","type":"type","unreachable_since":"unreachable_since"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Machine"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListNetworksResponse":{"example":{"data":[{"cloud":"cloud","created_by":"created_by","external_id":"external_id","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},{"cloud":"cloud","created_by":"created_by","external_id":"external_id","id":"id","name":"name","owned_by":"owned_by","tags":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Network"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListOrgMembersResponse":{"example":{"data":[{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"},{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Member"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListOrgTeamsResponse":{"example":{"data":[{"description":"description","id":"id","members":[{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"},{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"}],"members_count":"members_count","name":"name","policy":"{}"},{"description":"description","id":"id","members":[{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"},{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"}],"members_count":"members_count","name":"name","policy":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Team"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListOrgsResponse":{"example":{"data":[{"clouds_count":"clouds_count","created":true,"enterprise_plan":"{}","id":"id","last_active":"last_active","name":"name","selected_plan":"selected_plan","teams_count":"teams_count","total_machine_count":"total_machine_count"},{"clouds_count":"clouds_count","created":true,"enterprise_plan":"{}","id":"id","last_active":"last_active","name":"name","selected_plan":"selected_plan","teams_count":"teams_count","total_machine_count":"total_machine_count"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Org"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListRulesResponse":{"example":{"data":[{"actions":"{}","data_type":"data_type","disabled":"disabled","frequency":"{}","id":"id","name":"name","queries":"{}","triggered_after":"{}","window":"{}"},{"actions":"{}","data_type":"data_type","disabled":"disabled","frequency":"{}","id":"id","name":"name","queries":"{}","triggered_after":"{}","window":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Rule"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListSchedulesResponse":{"example":{"data":[{"action":"stop","created_by":"Manager A","description":"This is an test schedule","enabled":true,"id":"id","name":"reboot-schedule","owned_by":"Officer B","params":"Test parameters","run_immediately":true,"schedule_entry":"{\\\"minute\\\":\\\"0\\\", \\\"hour\\\":\\\"0\\\", \\\"day_of_week\\\":\\\"*\\\", \\\"day_of_month\\\":\\\"*\\\", \\\"month_of_year\\\":\\\"*\\\"}","schedule_type":"crontab","script_id":"d5775984772949de820fa8279c306b30","selectors":[null,null],"start_after":"2022-05-28T00:00:00Z","tags":"{}"},{"action":"stop","created_by":"Manager A","description":"This is an test schedule","enabled":true,"id":"id","name":"reboot-schedule","owned_by":"Officer B","params":"Test parameters","run_immediately":true,"schedule_entry":"{\\\"minute\\\":\\\"0\\\", \\\"hour\\\":\\\"0\\\", \\\"day_of_week\\\":\\\"*\\\", \\\"day_of_month\\\":\\\"*\\\", \\\"month_of_year\\\":\\\"*\\\"}","schedule_type":"crontab","script_id":"d5775984772949de820fa8279c306b30","selectors":[null,null],"start_after":"2022-05-28T00:00:00Z","tags":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Schedule"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListScriptsResponse":{"example":{"data":[{"created_by":"created_by","description":"description","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},{"created_by":"created_by","description":"description","id":"id","name":"name","owned_by":"owned_by","tags":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Script"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListSecretsResponse":{"example":{"data":[{"created_by":"created_by","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},{"created_by":"created_by","id":"id","name":"name","owned_by":"owned_by","tags":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Secret"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListSizesResponse":{"example":{"data":[{"cloud":"cloud","external_id":"external_id","extra":"{}","id":"id","name":"name"},{"cloud":"cloud","external_id":"external_id","extra":"{}","id":"id","name":"name"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Size"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListSnapshotsResponse":{"example":{"data":[null,null],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Snapshot"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListUsersResponse":{"example":{"data":[{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","registration_date":"registration_date","username":"username"},{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","registration_date":"registration_date","username":"username"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListVolumesResponse":{"example":{"data":[{"actions":"{}","attached_to":["attached_to","attached_to"],"cloud":"cloud","created_by":"created_by","default":true,"external_id":"external_id","extra":"{}","id":"id","last_seen":"last_seen","location":"location","missing_since":"missing_since","name":"name","owned_by":"owned_by","size":"size","tags":"{}"},{"actions":"{}","attached_to":["attached_to","attached_to"],"cloud":"cloud","created_by":"created_by","default":true,"external_id":"external_id","extra":"{}","id":"id","last_seen":"last_seen","location":"location","missing_since":"missing_since","name":"name","owned_by":"owned_by","size":"size","tags":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Volume"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"ListZonesResponse":{"example":{"data":[{"cloud":"cloud","created_by":"created_by","external_id":"external_id","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},{"cloud":"cloud","created_by":"created_by","external_id":"external_id","id":"id","name":"name","owned_by":"owned_by","tags":"{}"}],"meta":{"returned":6,"sort":"sort","start":1,"total":0}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Zone"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMetadata"}},"type":"object"},"Location":{"example":{"available_images":"{}","available_sizes":"{}","cloud":"cloud","country":"country","created_by":"created_by","external_id":"external_id","extra":"{}","id":"id","location_type":"location_type","name":"name","owned_by":"owned_by","parent":"parent"},"properties":{"available_images":{"type":"object"},"available_sizes":{"type":"object"},"cloud":{"type":"string"},"country":{"type":"string"},"created_by":{"type":"string"},"external_id":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"location_type":{"type":"string"},"name":{"type":"string"},"owned_by":{"type":"string"},"parent":{"type":"string"}},"type":"object"},"Log":{"example":{"job_id":"job_id","org":"org"},"properties":{"job_id":{"type":"string"},"org":{"type":"string"}},"required":["job_id","org"],"type":"object"},"LxdCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/LxdCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["lxd"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"LxdCredentials":{"properties":{"host":{"description":"Your LXD host","type":"string"},"password":{"description":"Your LXD password","type":"string"},"port":{"description":"Your LXD port","type":"string"},"showAll":{"description":"Show all containers, including stopped","type":"boolean"},"tlsCaCert":{"description":"Your TLS CA certifcate","type":"string"},"tlsCert":{"description":"Your TLS auth certificate","type":"string"},"tlsKey":{"description":"Your TLS auth key","type":"string"},"username":{"description":"Your LXD username","type":"string"}},"required":["host","port"],"type":"object"},"Machine":{"example":{"actions":"{}","cloud":"cloud","cluster":"cluster","cores":0.8008281904610115,"cost":"{}","created":"created","created_by":"created_by","default":true,"expiration":"expiration","external_id":"external_id","extra":"{}","hostname":"hostname","id":"id","image":"image","key_associations":[{"key":"key","last_used":6,"machine":"machine","port":1,"sudo":true,"user":"user"},{"key":"key","last_used":6,"machine":"machine","port":1,"sudo":true,"user":"user"}],"last_seen":"last_seen","location":"location","missing_since":"missing_since","monitoring":"monitoring","name":"name","network":"network","os_type":"os_type","owned_by":"owned_by","parent":"parent","ports":"{}","private_ips":["private_ips","private_ips"],"probe":"{}","public_ips":["public_ips","public_ips"],"size":"size","subnet":"subnet","tags":"{}","type":"type","unreachable_since":"unreachable_since"},"properties":{"actions":{"type":"object"},"cloud":{"type":"string"},"cluster":{"type":"string"},"cores":{"type":"number"},"cost":{"type":"object"},"created":{"type":"string"},"created_by":{"type":"string"},"default":{"type":"boolean"},"expiration":{"type":"string"},"external_id":{"type":"string"},"extra":{"type":"object"},"hostname":{"type":"string"},"id":{"type":"string"},"image":{"type":"string"},"key_associations":{"items":{"$ref":"#/components/schemas/KeyMachineAssociation"},"type":"array"},"last_seen":{"type":"string"},"location":{"type":"string"},"missing_since":{"type":"string"},"monitoring":{"type":"string"},"name":{"type":"string"},"network":{"type":"string"},"os_type":{"type":"string"},"owned_by":{"type":"string"},"parent":{"type":"string"},"ports":{"type":"object"},"private_ips":{"items":{"type":"string"},"type":"array"},"probe":{"type":"object"},"public_ips":{"items":{"type":"string"},"type":"array"},"size":{"type":"string"},"state":{"$ref":"#/components/schemas/MachineState"},"subnet":{"type":"string"},"tags":{"type":"object"},"type":{"type":"string"},"unreachable_since":{"type":"string"}},"type":"object"},"MachineState":{"enum":["running","starting","stopping","stopped","pending","suspended","terminated","error","rebooting","paused","reconfiguring","unknown","updating","migrating","normal","succeeded","failed"],"type":"string"},"MaxihostCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/MaxihostCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["maxihost"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"MaxihostCredentials":{"properties":{"token":{"description":"Your Maxihost API token","type":"string"}},"required":["token"],"type":"object"},"Member":{"example":{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"},"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"string"},"last_login":{"type":"string"},"last_name":{"type":"string"},"pending":{"type":"boolean"},"registration_date":{"type":"string"},"username":{"type":"string"}},"type":"object"},"Network":{"example":{"cloud":"cloud","created_by":"created_by","external_id":"external_id","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},"properties":{"cloud":{"type":"string"},"created_by":{"type":"string"},"external_id":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"owned_by":{"type":"string"},"tags":{"type":"object"}},"type":"object"},"OnappCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/OnappCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["onapp"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"OnappCredentials":{"properties":{"apikey":{"type":"string"},"authUrl":{"type":"string"},"host":{"type":"string"},"username":{"type":"string"},"verify":{"type":"boolean"}},"required":["apikey","host","username"],"type":"object"},"OneOffSchedule":{"description":"one_off schedule","properties":{"datetime":{"description":"When one_off schedule should run, e.g 2021-09-22T18:19:28Z","format":"date-time","type":"string"},"schedule_type":{"enum":["one_off"],"type":"string"}},"required":["datetime","schedule_type"],"title":"OneOff","type":"object"},"OpenshiftCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/OpenshiftCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["openshift"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"OpenshiftCredentials":{"properties":{"host":{"description":"Your OpenShift API host","type":"string"},"password":{"description":"Your OpenShift API password","type":"string"},"port":{"description":"Your OpenShift API port","type":"string"},"username":{"description":"Your OpenShift API username","type":"string"}},"required":["host","password","port","username"],"type":"object"},"OpenstackCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/OpenstackCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["openstack"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"OpenstackCredentials":{"properties":{"authUrl":{"type":"string"},"computeEndpoint":{"type":"string"},"domain":{"type":"string"},"password":{"type":"string"},"region":{"type":"string"},"tenant":{"type":"string"},"user":{"type":"string"}},"required":["authUrl","password","user"],"type":"object"},"OpenstackNet":{"properties":{"associate_floating_ip":{"description":"Assign a floating IP to the machine, defaults to True for Openstack and False for Vexxhost","type":"boolean"},"networks":{"description":"Name or ID of the networks to launch the machine into. Required parameter when there are multiple networks defined for the tenant","items":{"type":"string"},"type":"array"},"security_groups":{"description":"Name or Openstack UUID of the security groups to assign to the machine","items":{"type":"string"},"type":"array"}},"title":"Openstack & Vexxhost net parameter","type":"object"},"OpenstackVolumes":{"items":{"oneOf":[{"properties":{"boot":{"description":"Use as boot volume, up to one volume can be used as boot. Defaults to false","type":"boolean"},"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":{"boot":{"description":"Use as boot volume, up to one volume can be used as boot. Defaults to false","type":"boolean"},"delete_on_termination":{"description":"Delete the  volume when the machine is deleted. Defaults to false","type":"boolean"},"size":{"description":"Size of the volume to be created","minimum":1,"type":"integer"}},"required":["size"]}],"type":"object"},"title":"Openstack & Vexxhost volumes parameter","type":"array"},"Org":{"example":{"clouds_count":"clouds_count","created":true,"enterprise_plan":"{}","id":"id","last_active":"last_active","name":"name","selected_plan":"selected_plan","teams_count":"teams_count","total_machine_count":"total_machine_count"},"properties":{"clouds_count":{"type":"string"},"created":{"type":"boolean"},"enterprise_plan":{"type":"object"},"id":{"type":"string"},"last_active":{"type":"string"},"name":{"type":"string"},"selected_plan":{"type":"string"},"teams_count":{"type":"string"},"total_machine_count":{"type":"string"}},"type":"object"},"OtherCloudRequest":{"properties":{"credentials":{"type":"object"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["other"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"OtherCredentials":{"type":"object"},"PostDeployScript":{"properties":{"params":{"type":"string"},"script":{"description":"Name or ID of the script to run","type":"string"}},"required":["script"],"type":"object"},"Queries":{"items":{"$ref":"#/components/schemas/Query"},"type":"array"},"Query":{"example":{"aggregation":"aggregation","operator":"operator","target":"target","threshold":0.8008281904610115},"properties":{"aggregation":{"description":"the function to be applied on the computed series. Must be one\nof: all, any, avg\n","type":"string"},"operator":{"description":"the operator used to compare the computed value with the given\nthreshold\n","type":"string"},"target":{"description":"the metric's name, e.g. \"load.shortterm\"","type":"string"},"threshold":{"description":"the value over/under which an alert will be raised","type":"number"}},"required":["aggregation","operator","target","threshold"],"type":"object"},"RackspaceCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/RackspaceCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["rackspace"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"RackspaceCredentials":{"properties":{"apikey":{"description":"Your Rackspace Cloud API key","type":"string"},"provider":{"enum":["rackspace"],"type":"string"},"region":{"description":"Your Rackspace Cloud region","type":"string"},"username":{"description":"Your Rackspace Cloud username","type":"string"}},"required":["apikey","region","username"],"type":"object"},"RangeVector":{"properties":{"metric":{"type":"object"},"value":{"items":{"$ref":"#/components/schemas/DatapointsValuesTuple"},"type":"array"}},"type":"object"},"ResourceSelector":{"properties":{"ids":{"description":"a list of UUIDs in case type is resource like \"machines\", \"volumes\", \"clusters\" or \"networks\"","items":{"type":"string"},"type":"array"},"type":{"description":"one of \"machines\", \"volumes\", \"clusters\" or \"networks\" resource types","enum":["machines","volumes","clusters","networks"],"type":"string"}},"type":"object"},"ResponseMetadata":{"example":{"returned":6,"sort":"sort","start":1,"total":0},"properties":{"returned":{"description":"Number of items in response","type":"integer"},"sort":{"description":"Sort order of results","type":"string"},"start":{"description":"Index of first response item in total matching items","type":"integer"},"total":{"description":"Total items matching the query","type":"integer"}},"type":"object"},"Rule":{"example":{"actions":"{}","data_type":"data_type","disabled":"disabled","frequency":"{}","id":"id","name":"name","queries":"{}","triggered_after":"{}","window":"{}"},"properties":{"actions":{"type":"object"},"data_type":{"type":"string"},"disabled":{"type":"string"},"frequency":{"type":"object"},"id":{"type":"string"},"name":{"type":"string"},"queries":{"type":"object"},"triggered_after":{"type":"object"},"window":{"type":"object"}},"type":"object"},"RuleAction":{"example":{"action":"action","command":"command","emails":["emails","emails"],"teams":["teams","teams"],"type":"type","users":["users","users"]},"properties":{"action":{"description":"the action to be performed. Required by machine_action type\n","type":"string"},"command":{"description":"the command to be executed. Required by the command type\n","type":"string"},"emails":{"description":"a list of e-mails to send a notification to. Can be used by a\nnotification action (optional)\n","items":{"type":"string"},"type":"array"},"teams":{"description":"a list of teams, denoted by their UUIDs, whose users will be\nnotified. Can be used by a notification action (optional)\n","items":{"type":"string"},"type":"array"},"type":{"description":"the action's type: notification, machine_action, command\n","type":"string"},"users":{"description":"a list of user to be notified, denoted by their UUIDs. Can be\nused by a notification action (optional)\n","items":{"type":"string"},"type":"array"}},"required":["type"],"type":"object"},"RuleActions":{"items":{"$ref":"#/components/schemas/RuleAction"},"type":"array"},"RunScriptRequest":{"example":{"env":"EXAMPLE_VAR=123","job_id":"ab74e2f0b7ae4999b1e4013e20dac418","machine":"my-machine","params":"-v","su":"false"},"properties":{"env":{"example":"EXAMPLE_VAR=123","type":"string"},"job_id":{"example":"ab74e2f0b7ae4999b1e4013e20dac418","type":"string"},"machine":{"example":"my-machine","type":"string"},"params":{"example":"-v","type":"string"},"su":{"enum":["true","false"],"example":"false","type":"string"}},"required":["machine"],"type":"object"},"RunScriptResponse":{"example":{"job_id":"job_id"},"properties":{"job_id":{"type":"string"}},"type":"object"},"Schedule":{"example":{"action":"stop","created_by":"Manager A","description":"This is an test schedule","enabled":true,"id":"id","name":"reboot-schedule","owned_by":"Officer B","params":"Test parameters","run_immediately":true,"schedule_entry":"{\\\"minute\\\":\\\"0\\\", \\\"hour\\\":\\\"0\\\", \\\"day_of_week\\\":\\\"*\\\", \\\"day_of_month\\\":\\\"*\\\", \\\"month_of_year\\\":\\\"*\\\"}","schedule_type":"crontab","script_id":"d5775984772949de820fa8279c306b30","selectors":[null,null],"start_after":"2022-05-28T00:00:00Z","tags":"{}"},"properties":{"action":{"description":"The action that a schedule performs on a resource","example":"stop","type":"string"},"created_by":{"description":"The name of user that created the schedule","example":"Manager A","type":"string"},"description":{"description":"The description of the schedule","example":"This is an test schedule","type":"string"},"enabled":{"description":"Schedule status (enabled, disabled)","example":true,"type":"boolean"},"id":{"description":"The id of the schedule","type":"string"},"name":{"description":"The name of the schedule","example":"reboot-schedule","type":"string"},"owned_by":{"description":"The name of user that owns the schedule","example":"Officer B","type":"string"},"params":{"description":"Schedule parameters","example":"Test parameters","type":"string"},"run_immediately":{"description":"Decides if the schedule runs immediately of not","example":true,"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":"{\\\"minute\\\":\\\"0\\\", \\\"hour\\\":\\\"0\\\", \\\"day_of_week\\\":\\\"*\\\", \\\"day_of_month\\\":\\\"*\\\", \\\"month_of_year\\\":\\\"*\\\"}","type":"string"},"schedule_type":{"description":"The type of the schedule","example":"crontab","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-05-28T00:00:00Z","type":"string"},"tags":{"description":"The tags related to the schedule","type":"object"}},"type":"object"},"Script":{"example":{"created_by":"created_by","description":"description","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},"properties":{"created_by":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"owned_by":{"type":"string"},"tags":{"type":"object"}},"type":"object"},"Secret":{"example":{"created_by":"created_by","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},"properties":{"created_by":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"owned_by":{"type":"string"},"tags":{"type":"object"}},"type":"object"},"Selector":{"oneOf":[{"$ref":"#/components/schemas/ResourceSelector"},{"$ref":"#/components/schemas/FieldSelector"},{"$ref":"#/components/schemas/TaggingSelector"},{"$ref":"#/components/schemas/AgeSelector"}],"type":"object"},"Selectors":{"items":{"$ref":"#/components/schemas/Selector"},"type":"array"},"Size":{"example":{"cloud":"cloud","external_id":"external_id","extra":"{}","id":"id","name":"name"},"properties":{"cloud":{"type":"string"},"external_id":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"name":{"type":"string"}},"type":"object"},"Snapshot":{"type":"object"},"SupportedProviders":{"enum":["amazon","azure","google","alibaba","cloudsigma","equinix","ibm","digitalocean","linode","rackspace","maxihost","vultr","openstack","onapp","vsphere","vexxhost","kvm","lxd","docker","kubevirt","kubernetes","openshift","other"],"type":"string"},"TaggingSelector":{"properties":{"include":{"description":"a list of tags in case type is \"tags\"","items":{"type":"string"},"type":"array"},"type":{"description":"tag type","enum":["tags"],"type":"string"}},"type":"object"},"Team":{"example":{"description":"description","id":"id","members":[{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"},{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","pending":true,"registration_date":"registration_date","username":"username"}],"members_count":"members_count","name":"name","policy":"{}"},"properties":{"description":{"type":"string"},"id":{"type":"string"},"members":{"items":{"$ref":"#/components/schemas/Member"},"type":"array"},"members_count":{"type":"string"},"name":{"type":"string"},"policy":{"type":"object"}},"type":"object"},"TriggerAfter":{"example":{"offset":5,"period":"period"},"properties":{"offset":{"description":"a positive integer denoting the tolerance period","type":"integer"},"period":{"description":"units of time, e.g. \"seconds\"","type":"string"}},"required":["offset","period"],"type":"object"},"User":{"example":{"email":"email","first_name":"first_name","id":"id","last_login":"last_login","last_name":"last_name","registration_date":"registration_date","username":"username"},"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"string"},"last_login":{"type":"string"},"last_name":{"type":"string"},"registration_date":{"type":"string"},"username":{"type":"string"}},"type":"object"},"VSphereExtra":{"properties":{"datastore":{"description":"Name or ID of a VSphere datastore","type":"string"},"folder":{"description":"Name or ID of the Vsphere folder to place the machine into. Required for Vsphere 6.7","type":"string"}},"title":"VSphere extra parameter","type":"object"},"VSphereNet":{"properties":{"network":{"description":"Name or ID of the network to launch the machine into","type":"string"}},"title":"VSphere net parameter","type":"object"},"Vector":{"oneOf":[{"$ref":"#/components/schemas/InstantVector"},{"$ref":"#/components/schemas/RangeVector"}],"type":"object"},"Volume":{"example":{"actions":"{}","attached_to":["attached_to","attached_to"],"cloud":"cloud","created_by":"created_by","default":true,"external_id":"external_id","extra":"{}","id":"id","last_seen":"last_seen","location":"location","missing_since":"missing_since","name":"name","owned_by":"owned_by","size":"size","tags":"{}"},"properties":{"actions":{"type":"object"},"attached_to":{"items":{"type":"string"},"type":"array"},"cloud":{"type":"string"},"created_by":{"type":"string"},"default":{"type":"boolean"},"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"},"size":{"type":"string"},"tags":{"type":"object"}},"type":"object"},"VsphereCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/VsphereCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["vsphere"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"VsphereCredentials":{"properties":{"ca_cert_file":{"description":"CA certificate","type":"string"},"host":{"description":"Your vSphere/vCenter host","type":"string"},"password":{"description":"Your password","type":"string"},"username":{"description":"Your username","type":"string"}},"required":["host","password","username"],"type":"object"},"VultrCloudRequest":{"properties":{"credentials":{"$ref":"#/components/schemas/VultrCredentials"},"features":{"$ref":"#/components/schemas/CloudFeatures"},"provider":{"enum":["vultr"],"type":"string"}},"required":["credentials","provider"],"type":"object"},"VultrCredentials":{"properties":{"apikey":{"description":"Your Vultr API key","type":"string"}},"required":["apikey"],"type":"object"},"VultrExtra":{"properties":{"backups":{"description":"Enable automatic backups for the machine, invalid for \"Bare Metal\" & \"Dedicated Cloud\" size types. There is an additional charge depending on the size selected","type":"boolean"},"ddos_protection":{"description":"Enable DDoS protection, invalid for \"Bare Metal\" size type. There is an additional charge depending on the type of the size selected","type":"boolean"}},"title":"Vultr extra parameter","type":"object"},"VultrNet":{"properties":{"hostname":{"description":"The hostname to use when deploying this machine, defaults to machine name","type":"string"},"ipv6":{"description":"Enable IPv6, defaults to false","type":"boolean"},"networks":{"description":"An array of network names or IDs to attach to this machine, invalid for \"Bare Metal\" machines","items":{"type":"string"},"type":"array"}},"title":"Vultr net parameter","type":"object"},"VultrVolumes":{"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":10,"type":"integer"}},"required":["name","size"]}],"type":"object"},"title":"Vultr volumes parameter","type":"array"},"Window":{"example":{"period":"period","start":6,"stop":1},"properties":{"period":{"description":"units of time, e.g. \"seconds\"","type":"string"},"start":{"description":"a positive integer denoting the start of the search window in\nterms of \"now() - start\"\n","type":"integer"},"stop":{"default":0,"description":"a positive integer, where stop < start, denoting the end of the\nsearch window. Defaults to now\n","type":"integer"}},"required":["period","start"],"type":"object"},"Zone":{"example":{"cloud":"cloud","created_by":"created_by","external_id":"external_id","id":"id","name":"name","owned_by":"owned_by","tags":"{}"},"properties":{"cloud":{"type":"string"},"created_by":{"type":"string"},"external_id":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"owned_by":{"type":"string"},"tags":{"type":"object"}},"type":"object"},"inline_response_200":{"example":{"id":"id"},"properties":{"id":{"type":"string"}},"type":"object"},"inline_response_200_1":{"example":{"url":"url"},"properties":{"url":{"type":"string"}},"type":"object"}},"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"mist_api_v2.controllers.security_controller_.info_from_ApiKeyAuth"},"CookieAuth":{"in":"cookie","name":"session.id","type":"apiKey","x-apikeyInfoFunc":"mist_api_v2.controllers.security_controller_.info_from_CookieAuth"}}},"info":{"contact":{"email":"api@mist.io","name":"Mist API Team"},"title":"Mist API","version":"2.0.0","x-cli-name":"Mist CLI"},"openapi":"3.0.3","paths":{"/api/v2/clouds":{"get":{"description":"List clouds owned by the active org. READ permission required on cloud.","operationId":"list_clouds","parameters":[{"description":"Only return results matching search filter","examples":{"Composite filter":{"value":"provider:packet AND status:enabled"},"Filter by cloud provider":{"value":"provider:amazon"},"Filter by name":{"value":"name:LXD1"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name":{"value":"auto"},"Dereference creator by email, owner by name":{"value":"creator:email, owned_by:name"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCloudsResponse"}}},"description":"List clouds response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:cloud"]},{"CookieAuth":["read:cloud"]}],"summary":"List clouds","tags":["clouds"],"x-cli-table-default":["name","provider","tags"],"x-cli-table-extended":["id","name","provider","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.clouds_controller"},"post":{"description":"Adds a new cloud and returns the cloud's id. ADD permission required on cloud.","operationId":"add_cloud","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCloudRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200"}}},"description":"Cloud added succesfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["add:cloud"]},{"CookieAuth":["add:cloud"]}],"summary":"Add cloud","tags":["clouds"],"x-openapi-router-controller":"mist_api_v2.controllers.clouds_controller"}},"/api/v2/clouds/{cloud}":{"delete":{"description":"Remove target cloud","operationId":"remove_cloud","parameters":[{"example":"my-cloud","explode":false,"in":"path","name":"cloud","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Cloud removed successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Cloud not found"}},"security":[{"ApiKeyAuth":["remove:cloud"]},{"CookieAuth":["remove:cloud"]}],"summary":"Remove cloud","tags":["clouds"],"x-openapi-router-controller":"mist_api_v2.controllers.clouds_controller"},"get":{"description":"Get details about target cloud","operationId":"get_cloud","parameters":[{"example":"my-cloud","explode":false,"in":"path","name":"cloud","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"Automatically replace all foreign key ids with referenced resource name":{"value":"auto"},"Dereference creator by email, owner by name":{"value":"creator:email, owned_by:name"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCloudResponse"}}},"description":"Cloud returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Cloud not found"}},"security":[{"ApiKeyAuth":["read:cloud"]},{"CookieAuth":["read:cloud"]}],"summary":"Get cloud","tags":["clouds"],"x-cli-table-default":["name","provider","tags"],"x-cli-table-extended":["id","name","provider","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.clouds_controller"},"put":{"description":"Update target cloud name or credentials","operationId":"edit_cloud","parameters":[{"example":"my-cloud","explode":false,"in":"path","name":"cloud","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditCloudRequest"}}}},"responses":{"200":{"description":"Cloud updated successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Cloud not found"}},"security":[{"ApiKeyAuth":["edit:cloud"]},{"CookieAuth":["edit:cloud"]}],"summary":"Edit cloud","tags":["clouds"],"x-openapi-router-controller":"mist_api_v2.controllers.clouds_controller"}},"/api/v2/clusters":{"get":{"description":"List clusters","operationId":"list_clusters","parameters":[{"examples":{"Filter by cloud id":{"value":"0194030499e74b02bdf68fa7130fb0b2"},"Filter by cloud name":{"value":"OSP10-new"},"Filter by cloud provider":{"value":"provider:digitalocean"}},"explode":true,"in":"query","name":"cloud","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return results matching search filter","examples":{"Filter by cluster created_by attribute":{"value":"created_by:csk"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListClustersResponse"}}},"description":"List clusters response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:cluster","read:cloud"]},{"CookieAuth":["read:cluster","read:cloud"]}],"summary":"List clusters","tags":["clusters"],"x-cli-table-default":["name","cloud","total_nodes","tags"],"x-cli-table-extended":["id","name","cloud","total_nodes","total_cpus","total_ram","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.clusters_controller"},"post":{"description":"Create a new cluster and return the cluster's id","operationId":"create_cluster","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClusterRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClusterResponse"}}},"description":"Cluster creation started"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["create:cluster","read:cloud","create_resources:cloud"]},{"CookieAuth":["create:cluster","read:cloud","create_resources:cloud"]}],"summary":"Create cluster","tags":["clusters"],"x-openapi-router-controller":"mist_api_v2.controllers.clusters_controller"}},"/api/v2/clusters/{cluster}":{"delete":{"description":"Destroy target clusters","operationId":"destroy_cluster","parameters":[{"example":"my-cluster","explode":false,"in":"path","name":"cluster","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DestroyClusterResponse"}}},"description":"Cluster destruction successful"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Cluster not found"}},"security":[{"ApiKeyAuth":["read:cloud","destroy:cluster"]},{"CookieAuth":["read:cloud","destroy:cluster"]}],"summary":"Destroy cluster","tags":["clusters"],"x-openapi-router-controller":"mist_api_v2.controllers.clusters_controller"},"get":{"description":"Get details about target cluster","operationId":"get_cluster","parameters":[{"example":"my-cluster","explode":false,"in":"path","name":"cluster","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"description":"Return the cluster's credentials. Requires READ_CREDENTIALS permission on cluster.","example":true,"explode":true,"in":"query","name":"credentials","required":false,"schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetClusterResponse"}}},"description":"Cluster returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Cluster not found"}},"security":[{"ApiKeyAuth":["read:cluster","read:cloud"]},{"CookieAuth":["read:cluster","read:cloud"]}],"summary":"Get cluster","tags":["clusters"],"x-cli-table-default":["name","cloud","total_nodes","tags"],"x-cli-table-extended":["id","name","cloud","total_nodes","total_cpus","total_ram","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.clusters_controller"}},"/api/v2/datapoints":{"get":{"description":"Get datapoints for a specific query","operationId":"get_datapoints","parameters":[{"examples":{"Query net_bytes_sent":{"value":"rate(net_bytes_sent{interface=\"eth0\", machine_id=\"1234\"})"},"Query system_load1":{"value":"system_load1"}},"explode":true,"in":"query","name":"query","required":true,"schema":{"type":"string"},"style":"form"},{"examples":{"Example dictionary":{"value":{"cluster":"east1","production":""}},"Example string":{"value":"cluster=east1,production"}},"explode":true,"in":"query","name":"tags","required":false,"schema":{"type":"string"},"style":"form"},{"examples":{"Filter by machine type":{"value":"state:running"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"examples":{"RFC3339":{"value":"2019-10-12T07:20:50.520000+00:00"},"Unix timestamp":{"value":1633096171}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"examples":{"RFC3339":{"value":"2019-10-12T07:20:50.520000+00:00"},"Unix timestamp":{"value":1633096171}},"explode":true,"in":"query","name":"end","required":false,"schema":{"type":"string"},"style":"form"},{"examples":{"1 minute":{"value":"1m"},"1 year":{"value":"1y"},"2 hours":{"value":"2h"},"20 days":{"value":"20d"},"4 weeks":{"value":"4w"},"5 seconds (duration format)":{"value":"5s"},"5 seconds (float)":{"value":5.0}},"explode":true,"in":"query","name":"step","required":false,"schema":{"type":"string"},"style":"form"},{"examples":{"RFC3339":{"value":"2019-10-12T07:20:50.520000+00:00"},"Unix timestamp":{"value":1633096171}},"explode":true,"in":"query","name":"time","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDatapointsResponse"}}},"description":"Datapoints returned successfully"},"400":{"description":"Bad Request"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"422":{"description":"Unprocessable Entity"},"503":{"description":"Service Unavailable"}},"security":[{"ApiKeyAuth":["read:cloud","read:machine"]},{"CookieAuth":["read:cloud","read:machine"]}],"summary":"Get datapoints","tags":["datapoints"],"x-openapi-router-controller":"mist_api_v2.controllers.datapoints_controller"}},"/api/v2/images":{"get":{"description":"List images owned by the active org. READ permission required on image & cloud.","operationId":"list_images","parameters":[{"examples":{"Filter by cloud id":{"value":"0194030499e74b02bdf68fa7130fb0b2"},"Filter by cloud name":{"value":"my-cloud"},"Filter by cloud provider":{"value":"provider:digitalocean"}},"explode":true,"in":"query","name":"cloud","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return results matching search filter","examples":{"Filter by OS type":{"value":"os_type:windows"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImagesResponse"}}},"description":"List images response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:image","read:cloud"]},{"CookieAuth":["read:image","read:cloud"]}],"summary":"List images","tags":["images"],"x-cli-table-default":["starred","name","cloud","os_type","tags"],"x-cli-table-extended":["starred","id","external_id","name","cloud","os_type","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.images_controller"}},"/api/v2/images/{image}":{"get":{"description":"Get details about target image","operationId":"get_image","parameters":[{"example":"ubuntu-1604-xenial-v20210928","explode":false,"in":"path","name":"image","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImageResponse"}}},"description":"Image returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Image not found"}},"security":[{"ApiKeyAuth":["read:image","read:cloud"]},{"CookieAuth":["read:image","read:cloud"]}],"summary":"Get image","tags":["images"],"x-cli-table-default":["starred","name","cloud","os_type","tags"],"x-cli-table-extended":["starred","id","external_id","name","cloud","os_type","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.images_controller"}},"/api/v2/jobs/{job_id}":{"get":{"description":"null","operationId":"get_job","parameters":[{"example":"ab74e2f0b7ae4999b1e4013e20dac418","explode":false,"in":"path","name":"job_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetJobResponse"}}},"description":"Job returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Job not found"}},"security":[{"ApiKeyAuth":["read:job"]},{"CookieAuth":["read:job"]}],"summary":"Get job","tags":["jobs"],"x-openapi-router-controller":"mist_api_v2.controllers.jobs_controller"}},"/api/v2/keys":{"get":{"description":"List keys owned by the active org. READ permission required on key.","operationId":"list_keys","parameters":[{"description":"Only return results matching search filter","examples":{"Filter by owner":{"value":"owned_by:csk@mist.io"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name":{"value":"auto"},"Dereference creator by email, owner by name":{"value":"creator:email, owned_by:name"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListKeysResponse"}}},"description":"List keys response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:key"]},{"CookieAuth":["read:key"]}],"summary":"List keys","tags":["keys"],"x-cli-table-default":["name","default","tags"],"x-cli-table-extended":["id","name","default","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.keys_controller"},"post":{"description":"Adds a new key and returns the key's id. ADD permission required on key.","operationId":"add_key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddKeyRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddKeyResponse"}}},"description":"Key added succesfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["add:key"]},{"CookieAuth":["add:key"]}],"summary":"Add key","tags":["keys"],"x-openapi-router-controller":"mist_api_v2.controllers.keys_controller"}},"/api/v2/keys/{key}":{"delete":{"description":"Delete target key","operationId":"delete_key","parameters":[{"example":"my-key","explode":false,"in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"key deleted successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Key not found"}},"security":[{"ApiKeyAuth":["delete:key"]},{"CookieAuth":["delete:key"]}],"summary":"Delete key","tags":["keys"],"x-openapi-router-controller":"mist_api_v2.controllers.keys_controller"},"get":{"description":"Get details about target key","operationId":"get_key","parameters":[{"example":"my-key","explode":false,"in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Return the private key. Requires READ_PRIVATE permission on key.","explode":true,"in":"query","name":"private","required":false,"schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name":{"value":"auto"},"Dereference creator by email, owner by name":{"value":"creator:email, owned_by:name"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKeyResponse"}}},"description":"Key returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Key not found"}},"security":[{"ApiKeyAuth":["read:key"]},{"CookieAuth":["read:key"]}],"summary":"Get key","tags":["keys"],"x-cli-table-default":["name","default","tags"],"x-cli-table-extended":["id","name","default","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.keys_controller"},"put":{"description":"Edit target key","operationId":"edit_key","parameters":[{"example":"my-key","explode":false,"in":"path","name":"key","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"New key name","example":"my-renamed-key","explode":true,"in":"query","name":"name","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Set as default","explode":true,"in":"query","name":"default","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"description":"Key successfully updated"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Key not found"}},"security":[{"ApiKeyAuth":["edit:key"]},{"CookieAuth":["edit:key"]}],"summary":"Edit key","tags":["keys"],"x-openapi-router-controller":"mist_api_v2.controllers.keys_controller"}},"/api/v2/locations":{"get":{"description":"List locations owned by the active org. READ permission required on location & cloud.","operationId":"list_locations","parameters":[{"examples":{"Filter by cloud id":{"value":"0194030499e74b02bdf68fa7130fb0b2"},"Filter by cloud name":{"value":"my-cloud"},"Filter by cloud provider":{"value":"provider:digitalocean"}},"explode":true,"in":"query","name":"cloud","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return results matching search filter","examples":{"Filter by location name":{"value":"cinet3"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLocationsResponse"}}},"description":"List locations response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:cloud"]},{"CookieAuth":["read:cloud"]}],"summary":"List locations","tags":["locations"],"x-cli-table-default":["name","cloud"],"x-cli-table-extended":["id","name","cloud","external_id","machines"],"x-openapi-router-controller":"mist_api_v2.controllers.locations_controller"}},"/api/v2/locations/{location}":{"get":{"description":"Get details about target location","operationId":"get_location","parameters":[{"example":"us-central1-a","explode":false,"in":"path","name":"location","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationResponse"}}},"description":"Location returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Location not found"}},"security":[{"ApiKeyAuth":["read:cloud"]},{"CookieAuth":["read:cloud"]}],"summary":"Get location","tags":["locations"],"x-cli-table-default":["name","cloud"],"x-cli-table-extended":["id","name","cloud","locations","external_id","machines"],"x-openapi-router-controller":"mist_api_v2.controllers.locations_controller"}},"/api/v2/machines":{"get":{"description":"List machines owned by the active org. READ permission required on machine & cloud.","operationId":"list_machines","parameters":[{"examples":{"Filter by cloud id":{"value":"0194030499e74b02bdf68fa7130fb0b2"},"Filter by cloud name":{"value":"OSP10-new"},"Filter by cloud provider":{"value":"provider:digitalocean"}},"explode":true,"in":"query","name":"cloud","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return results matching search filter","examples":{"Filter by machine type":{"value":"state:running"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMachinesResponse"}}},"description":"List machines response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:machine","read:cloud"]},{"CookieAuth":["read:machine","read:cloud"]}],"summary":"List machines","tags":["machines"],"x-cli-table-default":["name","cloud","state","tags"],"x-cli-table-extended":["id","name","state","cloud","external_id","public_ips","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"},"post":{"description":"Creates one or more machines on the specified cloud. If async is true, a jobId will be returned.\nREAD permission required on cloud. CREATE_RESOURCES permission required on cloud. READ permission required on location.\nCREATE_RESOURCES permission required on location. CREATE permission required on machine. RUN permission required on script. READ permission required on key.\n","operationId":"create_machine","requestBody":{"content":{"application/json":{"examples":{"AmazonExampleMachine":{"summary":"Provision a machine in one of your Amazon clouds","value":{"image":"Ubuntu","name":"awsmachine","provider":"amazon","size":"t3.micro"}},"AzureExampleMachine":{"summary":"Provision a machine in one of your Azure clouds","value":{"image":"Ubuntu","name":"azuremachine","provider":"azure","size":"Standard_D4s_v5"}},"FullExample":{"summary":"Provision 2 machines with monitoring, schedules, expiration and provisioning scripts","value":{"cloud":"GCE","expiration":{"action":"destroy","date":"2025-08-30T18:24:15+00:00"},"image":"Ubuntu","key":"TestKey","location":"us-east1-b","monitoring":true,"name":"testmachine","quantity":2,"schedules":[{"datetime":"2023-09-22T18:19:28+00:00","schedule_type":"one_off","script":{"script":"test123"}}],"scripts":[{"inline":"#!/bin/bash\n touch ~/inline.txt"},{"script":"test123"}],"size":{"cpu":2,"memory":2048}}},"GoogleExampleMachine":{"summary":"Provision a machine in one of your Google clouds","value":{"image":"Ubuntu","name":"gcemachine","provider":"google","size":"e2-medium"}},"NoCloudSpecifiedMachine":{"summary":"Provision a machine without defining a specific cloud","value":{"image":"Ubuntu","key":"TestKey","monitoring":true,"name":"TestMachine","size":{"cpu":1,"memory":1024}}},"SelectedCloudMachine":{"summary":"Provision a machine in a specific cloud","value":{"cloud":"6a760c7690dc4ac9913ce9b109aa900c","image":"Ubuntu","name":"testmachine","size":{"cpu":2,"memory":2048}}}},"schema":{"$ref":"#/components/schemas/CreateMachineRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMachineResponse"}}},"description":"Machine provisioning started"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["create:machine","read:cloud","create_resources:cloud","read:location","create_resources:location","read:image","create_resources:image","read:script","read:key"]},{"CookieAuth":["create:machine","read:cloud","create_resources:cloud","read:location","create_resources:location","read:image","create_resources:image","read:script","read:key"]}],"summary":"Create machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}":{"get":{"description":"Get details about target machine","operationId":"get_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMachineResponse"}}},"description":"Machine returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"}},"security":[{"ApiKeyAuth":["read:machine","read:cloud"]},{"CookieAuth":["read:machine","read:cloud"]}],"summary":"Get machine","tags":["machines"],"x-cli-table-default":["name","cloud","state","tags"],"x-cli-table-extended":["id","name","state","cloud","external_id","public_ips","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"},"put":{"description":"Edit target machine","operationId":"edit_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditMachineRequest"}}}},"responses":{"200":{"description":"Machine successfully updated"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"}},"security":[{"ApiKeyAuth":["edit:machine"]},{"CookieAuth":["edit:machine"]}],"summary":"Edit machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/associate-key":{"put":{"description":"Associate a key with a machine.","operationId":"associate_key","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyMachineAssociation"}}}},"responses":{"200":{"description":"Association successful"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine or Key not found"},"422":{"description":"Action not supported on target machine"},"503":{"description":"Could not connect to target machine"}},"security":[{"ApiKeyAuth":["associate_key:machine","read:cloud","read_private:key"]},{"CookieAuth":["associate_key:machine","read:cloud","read_private:key"]}],"summary":"Associate a key with a machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/clone":{"post":{"description":"Clone target machine","operationId":"clone_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"my-machine-clone","explode":true,"in":"query","name":"name","required":true,"schema":{"type":"string"},"style":"form"},{"example":false,"explode":true,"in":"query","name":"run_async","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"description":"Machine clone issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["clone:machine"]},{"CookieAuth":["clone:machine"]}],"summary":"Clone machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/console":{"post":{"description":"Open VNC console on target machine","operationId":"console","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Machine console opened successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"},"501":{"description":"Action not implemented"}},"security":[{"ApiKeyAuth":["console:machine"]},{"CookieAuth":["console:machine"]}],"summary":"Open console","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"},"x-cli-ignore":true},"/api/v2/machines/{machine}/actions/destroy":{"post":{"description":"Destroy target machine","operationId":"destroy_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Machine destroy issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["destroy:machine"]},{"CookieAuth":["destroy:machine"]}],"summary":"Destroy machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/disassociate-key":{"delete":{"description":"Disassociate a key from a machine.","operationId":"disassociate_key","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyMachineDisassociation"}}}},"responses":{"200":{"description":"Disassociation successful"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine or Key not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["disassociate_key:machine","read:cloud"]},{"CookieAuth":["disassociate_key:machine","read:cloud"]}],"summary":"Disassociate a key from a machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/reboot":{"post":{"description":"Reboot target machine","operationId":"reboot_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Machine reboot issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["reboot:machine"]},{"CookieAuth":["reboot:machine"]}],"summary":"Reboot machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/rename":{"post":{"description":"Rename target machine","operationId":"rename_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"New machine name","example":"my-renamed-machine","explode":true,"in":"query","name":"name","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"Machine renamed successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["rename:machine"]},{"CookieAuth":["rename:machine"]}],"summary":"Rename machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/resize":{"post":{"description":"Resize target machine","operationId":"resize_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"9417745961a84bffbf6419e5of68faa5","explode":true,"in":"query","name":"size","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"Machine resize issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["resize:machine"]},{"CookieAuth":["resize:machine"]}],"summary":"Resize machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/resume":{"post":{"description":"Resume target machine","operationId":"resume_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Machine resume issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["resume:machine"]},{"CookieAuth":["resume:machine"]}],"summary":"Resume machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/ssh":{"post":{"description":"Open secure shell on target machine","operationId":"ssh","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"302":{"description":"Redirect to machine shell"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["read:cloud","read:machine","ssh:machine"]},{"CookieAuth":["read:cloud","read:machine","ssh:machine"]}],"summary":"Open secure shell","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"},"x-cli-ignore":true},"/api/v2/machines/{machine}/actions/start":{"post":{"description":"Start target machine","operationId":"start_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Machine start issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["start:machine"]},{"CookieAuth":["start:machine"]}],"summary":"Start machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/stop":{"post":{"description":"Stop target machine","operationId":"stop_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Machine stop issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["stop:machine"]},{"CookieAuth":["stop:machine"]}],"summary":"Stop machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/suspend":{"post":{"description":"Suspend target machine","operationId":"suspend_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Machine suspend issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["suspend:machine"]},{"CookieAuth":["suspend:machine"]}],"summary":"Suspend machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/actions/undefine":{"post":{"description":"Undefine target machine","operationId":"undefine_machine","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"},{"explode":true,"in":"query","name":"delete_domain_image","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"description":"Machine undefine issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["undefine:machine"]},{"CookieAuth":["undefine:machine"]}],"summary":"Undefine machine","tags":["machines"],"x-openapi-router-controller":"mist_api_v2.controllers.machines_controller"}},"/api/v2/machines/{machine}/snapshots":{"get":{"description":"List snapshots of target machine","operationId":"list_snapshots","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSnapshotsResponse"}}},"description":"List machine snapshots response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["read:machine","list_snapshots:machine"]},{"CookieAuth":["read:machine","list_snapshots:machine"]}],"summary":"List machine snapshots","tags":["snapshots"],"x-openapi-router-controller":"mist_api_v2.controllers.snapshots_controller"},"post":{"description":"Create snapshots of target machine","operationId":"create_snapshot","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"my-snapshot","explode":true,"in":"query","name":"name","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSnapshotResponse"}}},"description":"Create machine snapshot response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["read:machine","list_snapshots:machine","create_snapshots:machine"]},{"CookieAuth":["read:machine","list_snapshots:machine","create_snapshots:machine"]}],"summary":"Create snapshot","tags":["snapshots"],"x-openapi-router-controller":"mist_api_v2.controllers.snapshots_controller"}},"/api/v2/machines/{machine}/snapshots/{snapshot}":{"delete":{"description":"Remove target machine snapshot","operationId":"remove_snapshot","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"my-snapshot","explode":false,"in":"path","name":"snapshot","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Snapshot removed successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["read:machine","list_snapshots:machine","create_snapshots:machine"]},{"CookieAuth":["read:machine","list_snapshots:machine","create_snapshots:machine"]}],"summary":"Remove snapshot","tags":["snapshots"],"x-openapi-router-controller":"mist_api_v2.controllers.snapshots_controller"},"post":{"description":"Revert machine to snapshot","operationId":"revert_to_snapshot","parameters":[{"example":"my-machine","explode":false,"in":"path","name":"machine","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"my-snapshot","explode":false,"in":"path","name":"snapshot","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Revert machine to snapshot issued successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Machine not found"},"422":{"description":"Action not supported on target machine"}},"security":[{"ApiKeyAuth":["read:machine","list_snapshots:machine","revert_to_snapshots:machine"]},{"CookieAuth":["read:machine","list_snapshots:machine","revert_to_snapshots:machine"]}],"summary":"Revert to snapshot","tags":["snapshots"],"x-openapi-router-controller":"mist_api_v2.controllers.snapshots_controller"}},"/api/v2/networks":{"get":{"description":"List networks owned by the active org. READ permission required on network & cloud.","operationId":"list_networks","parameters":[{"examples":{"Filter by cloud id":{"value":"0194030499e74b02bdf68fa7130fb0b2"},"Filter by cloud name":{"value":"OSP10-new"},"Filter by cloud provider":{"value":"provider:digitalocean"}},"explode":true,"in":"query","name":"cloud","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return results matching search filter","examples":{"Filter by network name":{"value":"cinet3"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNetworksResponse"}}},"description":"List networks response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:network","read:cloud"]},{"CookieAuth":["read:network","read:cloud"]}],"summary":"List networks","tags":["networks"],"x-cli-table-default":["name","cloud","machines","tags"],"x-cli-table-extended":["id","name","cloud","external_id","machines","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.networks_controller"},"post":{"description":"Creates one or more networks on the specified cloud. If async is true, a jobId will be returned.\nREAD permission required on cloud. CREATE_RESOURCES permission required on cloud. CREATE permission required on network.\n","operationId":"create_network","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNetworkRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNetworkResponse"}}},"description":"Network provisioning started"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"501":{"description":"Network support is not available"}},"security":[{"ApiKeyAuth":["create:network","read:cloud","create_resources:cloud"]},{"CookieAuth":["create:network","read:cloud","create_resources:cloud"]}],"summary":"Create network","tags":["networks"],"x-openapi-router-controller":"mist_api_v2.controllers.networks_controller"}},"/api/v2/networks/{network}":{"delete":{"description":"Delete target network","operationId":"delete_network","parameters":[{"example":"my-network","explode":false,"in":"path","name":"network","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Cloud the target network belongs to","example":"my-cloud","explode":true,"in":"query","name":"cloud","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"Network deleted successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Network not found"}},"security":[{"ApiKeyAuth":["read:cloud","read:network","remove:network"]},{"CookieAuth":["read:cloud","read:network","remove:network"]}],"summary":"Delete network","tags":["networks"],"x-openapi-router-controller":"mist_api_v2.controllers.networks_controller"},"get":{"description":"Get details about target network","operationId":"get_network","parameters":[{"example":"my-network","explode":false,"in":"path","name":"network","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNetworkResponse"}}},"description":"Network returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Network not found"}},"security":[{"ApiKeyAuth":["read:network","read:cloud"]},{"CookieAuth":["read:network","read:cloud"]}],"summary":"Get network","tags":["networks"],"x-cli-table-default":["name","cloud","machines","tags"],"x-cli-table-extended":["id","name","cloud","location","external_id","subnets","machines","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.networks_controller"},"put":{"description":"Edit target network","operationId":"edit_network","parameters":[{"example":"my-network","explode":false,"in":"path","name":"network","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"New network name","example":"my-renamed-network","explode":true,"in":"query","name":"name","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"Network successfully updated"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Network not found"}},"security":[{"ApiKeyAuth":["edit:network"]},{"CookieAuth":["edit:network"]}],"summary":"Edit network","tags":["networks"],"x-openapi-router-controller":"mist_api_v2.controllers.networks_controller"}},"/api/v2/orgs":{"get":{"description":"List orgs owned by the requester. If parameter allorgs is true and requester is an admin then all orgs will be listed.","operationId":"list_orgs","parameters":[{"description":"Return all existing organizations","example":true,"explode":true,"in":"query","name":"allorgs","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return results matching search filter","examples":{"Filter by orgs by name":{"value":"name:Acme"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 100 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return name, id, teams":{"value":"name,id,teams"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name":{"value":"auto"},"Dereference teams":{"value":"teams:name"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrgsResponse"}}},"description":"List orgs response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":[""]},{"CookieAuth":[""]}],"summary":"List orgs","tags":["orgs"],"x-cli-table-default":["name","clouds_count","teams_count"],"x-cli-table-extended":["name","id","clouds_count","teams_count","last_active"],"x-openapi-router-controller":"mist_api_v2.controllers.orgs_controller"},"x-cli-ignore":true},"/api/v2/orgs/{org}":{"get":{"description":"Get details about target org","operationId":"get_org","parameters":[{"example":"my-org","explode":false,"in":"path","name":"org","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return name, id, teams":{"value":"name,id,teams"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name":{"value":"auto"},"Dereference teams by name":{"value":"teams:name"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrgResponse"}}},"description":"Organization returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Org not found"}},"security":[{"ApiKeyAuth":[""]},{"CookieAuth":[""]}],"summary":"Get Org","tags":["orgs"],"x-cli-table-extended":["name","id","clouds_count","total_machine_count","last_active"],"x-openapi-router-controller":"mist_api_v2.controllers.orgs_controller"},"x-cli-ignore":true},"/api/v2/orgs/{org}/members":{"get":{"description":"List org members owned by the requester. The requester must be a member of the org.","operationId":"list_org_members","parameters":[{"example":"my-org","explode":false,"in":"path","name":"org","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return results matching search filter","examples":{"Filter by orgs by email":{"value":"email:dev@mist.io"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return email, last name, registration date":{"value":"email,last_name,registration_date"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrgMembersResponse"}}},"description":"List org members response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":[""]},{"CookieAuth":[""]}],"summary":"List org members","tags":["orgs"],"x-cli-table-default":["email"],"x-cli-table-extended":["email","id","last_login","registration_date"],"x-openapi-router-controller":"mist_api_v2.controllers.orgs_controller"},"x-cli-ignore":true},"/api/v2/orgs/{org}/members/{member}":{"get":{"description":"Get details about target member","operationId":"get_member","parameters":[{"example":"my-org","explode":false,"in":"path","name":"org","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"my-member","explode":false,"in":"path","name":"member","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return email, last_name":{"value":"email,last_name"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrgMemberResponse"}}},"description":"member returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Org not found"}},"security":[{"ApiKeyAuth":[""]},{"CookieAuth":[""]}],"summary":"Get Org","tags":["orgs"],"x-cli-table-default":["email"],"x-cli-table-extended":["email","id","last_login","registration_date"],"x-openapi-router-controller":"mist_api_v2.controllers.orgs_controller"},"x-cli-ignore":true},"/api/v2/orgs/{org}/teams":{"get":{"description":"List teams in org.","operationId":"list_org_teams","parameters":[{"description":"Organization id","example":"my-org","explode":false,"in":"path","name":"org","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return results matching search filter","examples":{"Filter by teams by name":{"value":"name:finance"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return name, members":{"value":"name,members"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name":{"value":"auto"},"Dereference members by email":{"value":"members:email"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrgTeamsResponse"}}},"description":"List org teams response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":[""]},{"CookieAuth":[""]}],"summary":"List org teams","tags":["orgs"],"x-cli-table-default":["name","members_count"],"x-cli-table-extended":["id","name","members_count","members","description","policy"],"x-openapi-router-controller":"mist_api_v2.controllers.orgs_controller"},"x-cli-ignore":true},"/api/v2/rules":{"get":{"description":"Return a filtered list of rules","operationId":"list_rules","parameters":[{"description":"Only return results matching search filter","examples":{"Composite filter":{"value":"provider:packet AND total_run_count:5"},"Filter by name":{"value":"rule-disk*"},"Filter by total_run_count":{"value":"total_run_count:5"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRulesResponse"}}},"description":"List rules response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:rule"]},{"CookieAuth":["read:rule"]}],"summary":"List rules","tags":["rules"],"x-cli-table-default":["name","queries","actions","tags"],"x-cli-table-extended":["id","name","resource_type","selectors","queries","actions","window","frequency","tags"],"x-openapi-router-controller":"mist_api_v2.controllers.rules_controller"},"post":{"description":"Add a new rule, READ permission required on target resource, ADD permission required on Rule","operationId":"add_rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRuleRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"description":"Rule added succesfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["add:rule"]},{"CookieAuth":["add:rule"]}],"summary":"Add rule","tags":["rules"],"x-openapi-router-controller":"mist_api_v2.controllers.rules_controller"}},"/api/v2/rules/{rule}":{"delete":{"description":"Delete a rule given its UUID.","operationId":"delete_rule","parameters":[{"example":"my-rule","explode":false,"in":"path","name":"rule","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Rule deleted successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Rule not found"}},"security":[{"ApiKeyAuth":["delete:rule"]},{"CookieAuth":["delete:rule"]}],"summary":"Delete rule","tags":["rules"],"x-openapi-router-controller":"mist_api_v2.controllers.rules_controller"},"get":{"description":"Get details about target rule","operationId":"get_rule","parameters":[{"example":"my-rule","explode":false,"in":"path","name":"rule","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRuleResponse"}}},"description":"Rule returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Rule not found"}},"security":[{"ApiKeyAuth":["read:rule"]},{"CookieAuth":["read:rule"]}],"summary":"Get rule","tags":["rules"],"x-cli-table-default":["name","queries","actions","tags"],"x-cli-table-extended":["id","name","resource_type","selectors","queries","actions","window","frequency","tags"],"x-openapi-router-controller":"mist_api_v2.controllers.rules_controller"},"patch":{"description":"Rename a rule","operationId":"rename_rule","parameters":[{"example":"my-rule","explode":false,"in":"path","name":"rule","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"my-renamed-rule","explode":true,"in":"query","name":"name","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"Rule renamed successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Rule not found"}},"security":[{"ApiKeyAuth":["write:rule"]},{"CookieAuth":["write:rule"]}],"summary":"Rename rule","tags":["rules"],"x-openapi-router-controller":"mist_api_v2.controllers.rules_controller"},"post":{"description":"Edit a rule given its UUID, EDIT permission required on rule","operationId":"edit_rule","parameters":[{"example":"my-rule","explode":false,"in":"path","name":"rule","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditRuleRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rule"}}},"description":"Rule updated succesfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Rule not found"}},"security":[{"ApiKeyAuth":["read:cloud","edit:rule"]},{"CookieAuth":["read:cloud","edit:rule"]}],"summary":"Update rule","tags":["rules"],"x-openapi-router-controller":"mist_api_v2.controllers.rules_controller"},"put":{"description":"Enable or disable a rule","operationId":"toggle_rule","parameters":[{"example":"my-rule","explode":false,"in":"path","name":"rule","required":true,"schema":{"type":"string"},"style":"simple"},{"example":"disable","explode":true,"in":"query","name":"action","required":true,"schema":{"enum":["enable","disable"],"type":"string"},"style":"form"}],"responses":{"200":{"description":"Rule toggled successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Rule not found"}},"security":[{"ApiKeyAuth":["write:rule"]},{"CookieAuth":["write:rule"]}],"summary":"Toggle rule","tags":["rules"],"x-openapi-router-controller":"mist_api_v2.controllers.rules_controller"}},"/api/v2/schedules":{"get":{"description":"List schedules owned by the active org. READ permission required on schedules.","operationId":"list_schedules","parameters":[{"description":"Only return results matching search filter","examples":{"Filter by schedule name":{"value":"schedule-name"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 3rd result":{"value":"3"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & created_by":{"value":"id,name,created_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference creator by email, owner by name":{"value":"creator:email, owned_by:name'"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSchedulesResponse"}}},"description":"List schedules response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:schedule"]},{"CookieAuth":["read:schedule"]}],"summary":"List schedules","tags":["schedules"],"x-cli-table-default":["name","tags"],"x-cli-table-extended":["id","name","description","tags","enabled","action","script_id","params","selectors","schedule_type","schedule_entry","start_after","run_immediately","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.schedules_controller"},"post":{"description":"Add schedule to user schedules","operationId":"add_schedule","requestBody":{"content":{"application/json":{"examples":{"RebootMachineOneOffSchedule":{"summary":"Create a reboot machine schedule that runs once","value":{"action":"reboot","description":"This is a reboot machine schedule that runs once","enabled":true,"name":"TestMachineRebootSchedule","params":"None","run_immediately":false,"schedule_entry":"2022-06-05T00:00:00Z","schedule_type":"one_off","selectors":{"ids":["d5775984772949de820fa8279c306b30"],"type":"machines"},"start_after":"2022-06-08T00:00:00Z"}}},"schema":{"$ref":"#/components/schemas/AddScheduleRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200"}}},"description":"Schedule added succesfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["add:schedule"]},{"CookieAuth":["add:schedule"]}],"summary":"Add schedule","tags":["schedules"],"x-openapi-router-controller":"mist_api_v2.controllers.schedules_controller"}},"/api/v2/schedules/{schedule}":{"delete":{"description":"Delete target schedule","operationId":"delete_schedule","parameters":[{"example":"deleted-schedule","explode":false,"in":"path","name":"schedule","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Schedule deleted successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Schedule not found"}},"security":[{"ApiKeyAuth":["delete:schedule"]},{"CookieAuth":["delete:schedule"]}],"summary":"Delete schedule","tags":["schedules"],"x-openapi-router-controller":"mist_api_v2.controllers.schedules_controller"},"get":{"description":"Get details about target schedule","operationId":"get_schedule","parameters":[{"example":"retrieved-schedule","explode":false,"in":"path","name":"schedule","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference creator by email, owner by name":{"value":"creator:email, owned_by:name'"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetScheduleResponse"}}},"description":"Schedule returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Schedule not found"}},"security":[{"ApiKeyAuth":["read:schedule"]},{"CookieAuth":["read:schedule"]}],"summary":"Get schedule","tags":["schedules"],"x-cli-table-default":["name","tags"],"x-cli-table-extended":["id","name","description","tags","enabled","action","script_id","params","selectors","schedule_type","schedule_entry","start_after","run_immediately","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.schedules_controller"},"patch":{"description":"Edit target schedule","operationId":"edit_schedule","parameters":[{"example":"edited-schedule","explode":false,"in":"path","name":"schedule","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"examples":{"DeactivateSchedule":{"summary":"Deactivate an existing active schedule","value":{"description":"This is a deactivated schedule","enabled":false,"name":"DeactivatedSchedule"}},"RenameSchedule":{"summary":"Rename an existing schedule","value":{"description":"This is a renamed schedule","name":"RenamedSchedule"}}},"schema":{"$ref":"#/components/schemas/EditScheduleRequest"}}}},"responses":{"200":{"description":"Schedule successfully updated"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Schedule not found"}},"security":[{"ApiKeyAuth":["edit:schedule"]},{"CookieAuth":["edit:schedule"]}],"summary":"Edit schedule","tags":["schedules"],"x-openapi-router-controller":"mist_api_v2.controllers.schedules_controller"}},"/api/v2/scripts":{"get":{"description":"List scripts owned by the active org. READ permission required on script.","operationId":"list_scripts","parameters":[{"description":"Only return results matching search filter","examples":{"Filter by script name":{"value":"my-script"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 3rd result":{"value":"3"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & created_by":{"value":"id,name,created_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference creator by email, owner by name":{"value":"creator:email, owned_by:name'"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListScriptsResponse"}}},"description":"List scripts response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:script"]},{"CookieAuth":["read:script"]}],"summary":"List scripts","tags":["scripts"],"x-cli-table-default":["name","tags"],"x-cli-table-extended":["id","name","description","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.scripts_controller"},"post":{"description":"Add script to user scripts","operationId":"add_script","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddScriptRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200"}}},"description":"Script added succesfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["add:script"]},{"CookieAuth":["add:script"]}],"summary":"Add script","tags":["scripts"],"x-openapi-router-controller":"mist_api_v2.controllers.scripts_controller"}},"/api/v2/scripts/{script}":{"delete":{"description":"Delete target script","operationId":"delete_script","parameters":[{"example":"my-script","explode":false,"in":"path","name":"script","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Script deleted successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Script not found"}},"security":[{"ApiKeyAuth":["delete:script"]},{"CookieAuth":["delete:script"]}],"summary":"Delete script","tags":["scripts"],"x-openapi-router-controller":"mist_api_v2.controllers.scripts_controller"},"get":{"description":"Get details about target script","operationId":"get_script","parameters":[{"example":"my-script","explode":false,"in":"path","name":"script","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference creator by email, owner by name":{"value":"creator:email, owned_by:name'"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetScriptResponse"}}},"description":"Script returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Script not found"}},"security":[{"ApiKeyAuth":["read:script"]},{"CookieAuth":["read:script"]}],"summary":"Get script","tags":["scripts"],"x-cli-table-default":["name","tags"],"x-cli-table-extended":["id","name","description","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.scripts_controller"},"post":{"description":"Start a script job to run the script.","operationId":"run_script","parameters":[{"example":"my-script","explode":false,"in":"path","name":"script","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunScriptRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunScriptResponse"}}},"description":"Run script job started successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Script not found"}},"security":[{"ApiKeyAuth":["read:cloud","run_script:machine","run:script"]},{"CookieAuth":["read:cloud","run_script:machine","run:script"]}],"summary":"Run script","tags":["scripts"],"x-openapi-router-controller":"mist_api_v2.controllers.scripts_controller"},"put":{"description":"Edit target script","operationId":"edit_script","parameters":[{"example":"my-script","explode":false,"in":"path","name":"script","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"New script name","example":"my-renamed-script","explode":true,"in":"query","name":"name","required":false,"schema":{"type":"string"},"style":"form"},{"description":"New script description","example":"description","explode":true,"in":"query","name":"description","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"Script successfully updated"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Script not found"}},"security":[{"ApiKeyAuth":["edit:script"]},{"CookieAuth":["edit:script"]}],"summary":"Edit script","tags":["scripts"],"x-openapi-router-controller":"mist_api_v2.controllers.scripts_controller"}},"/api/v2/scripts/{script}/file":{"get":{"description":"Download script file or archive","operationId":"download_script","parameters":[{"example":"my-script","explode":false,"in":"path","name":"script","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Script downloaded successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Script not found"}},"summary":"Download script","tags":["scripts"],"x-openapi-router-controller":"mist_api_v2.controllers.scripts_controller"}},"/api/v2/scripts/{script}/url":{"get":{"description":"Generate url for fetching script file","operationId":"generate_script_url","parameters":[{"example":"my-script","explode":false,"in":"path","name":"script","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_1"}}},"description":"Script url generated successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Script not found"}},"security":[{"ApiKeyAuth":["read:script"]},{"CookieAuth":["read:script"]}],"summary":"Generate script url","tags":["scripts"],"x-openapi-router-controller":"mist_api_v2.controllers.scripts_controller"}},"/api/v2/secrets":{"get":{"description":"List secrets owned by the active org. READ permission required on secret.","operationId":"list_secrets","parameters":[{"description":"Only return results matching search filter","examples":{"Filter by name":{"value":"name:clouds/EC2-Tokyo"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & created_by":{"value":"id,title,created_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSecretsResponse"}}},"description":"List secrets response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:secret"]},{"CookieAuth":["read:secret"]}],"summary":"List secrets","tags":["secrets"],"x-cli-table-default":["id","name","tags"],"x-cli-table-extended":["id","name","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.secrets_controller"},"post":{"description":"Creates a new secret and returns the secret's id. CREATE permission required on secret.","operationId":"create_secret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSecretRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secret"}}},"description":"Secret added succesfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"409":{"description":"Path already exists. Change name of key"}},"security":[{"ApiKeyAuth":["create:secret"]},{"CookieAuth":["create:secret"]}],"summary":"Create secret","tags":["secrets"],"x-openapi-router-controller":"mist_api_v2.controllers.secrets_controller"}},"/api/v2/secrets/{secret}":{"delete":{"description":"Delete target secret","operationId":"delete_secret","parameters":[{"explode":false,"in":"path","name":"secret","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Secret deleted successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Secret not found"}},"security":[{"ApiKeyAuth":["delete:secret"]},{"CookieAuth":["delete:secret"]}],"summary":"Delete secret","tags":["secrets"],"x-openapi-router-controller":"mist_api_v2.controllers.secrets_controller"},"get":{"description":"Read target secret","operationId":"get_secret","parameters":[{"explode":false,"in":"path","name":"secret","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Return the secret's value. Requires READ_VALUE permission on secret.","explode":true,"in":"query","name":"value","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSecretResponse"}}},"description":"Secret returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Secret not found"}},"security":[{"ApiKeyAuth":["read:secret"]},{"CookieAuth":["read:secret"]}],"summary":"Get secret","tags":["secrets"],"x-openapi-router-controller":"mist_api_v2.controllers.secrets_controller"},"put":{"description":"Edit/update target secret","operationId":"edit_secret","parameters":[{"explode":false,"in":"path","name":"secret","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditSecretRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Secret"}}},"description":"Secret edited successfully"},"400":{"description":"Missing `secret` required parameter"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Secret not found"}},"security":[{"ApiKeyAuth":["edit:secret"]},{"CookieAuth":["edit:secret"]}],"summary":"Edit secret","tags":["secrets"],"x-openapi-router-controller":"mist_api_v2.controllers.secrets_controller"}},"/api/v2/sizes":{"get":{"description":"List sizes owned by the active org. READ permission required on size & cloud.","operationId":"list_sizes","parameters":[{"examples":{"Filter by cloud id":{"value":"0194030499e74b02bdf68fa7130fb0b2"},"Filter by cloud name":{"value":"my-cloud"},"Filter by cloud provider":{"value":"provider:digitalocean"}},"explode":true,"in":"query","name":"cloud","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return results matching search filter","examples":{"Filter by size name":{"value":"cinet3"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSizesResponse"}}},"description":"List sizes response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:cloud"]},{"CookieAuth":["read:cloud"]}],"summary":"List sizes","tags":["sizes"],"x-cli-table-default":["name","cloud"],"x-cli-table-extended":["id","name","cloud","external_id","machines"],"x-openapi-router-controller":"mist_api_v2.controllers.sizes_controller"}},"/api/v2/sizes/{size}":{"get":{"description":"Get details about target size","operationId":"get_size","parameters":[{"example":"n2-highcpu-2 (2 vCPUs 2 GB RAM)","explode":false,"in":"path","name":"size","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSizeResponse"}}},"description":"Size returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Size not found"}},"security":[{"ApiKeyAuth":["read:cloud"]},{"CookieAuth":["read:cloud"]}],"summary":"Get size","tags":["sizes"],"x-cli-table-default":["name","cloud"],"x-cli-table-extended":["id","name","cloud","locations","external_id","machines"],"x-openapi-router-controller":"mist_api_v2.controllers.sizes_controller"}},"/api/v2/users":{"get":{"description":"Return current user if requester is not admin. Return all users for admin.","operationId":"list_users","parameters":[{"description":"Only return results matching search filter","examples":{"Filter by email":{"value":"email:dev@mist.io"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return email, last_login & registration_date":{"value":"email,last_login,registration_date"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}},"description":"List users response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":[""]},{"CookieAuth":[""]}],"summary":"List users","tags":["users"],"x-cli-table-default":["email"],"x-cli-table-extended":["email","id","last_login","registration_date"],"x-openapi-router-controller":"mist_api_v2.controllers.users_controller"}},"/api/v2/volumes":{"get":{"description":"List volumes owned by the active org. READ permission required on volume & cloud.","operationId":"list_volumes","parameters":[{"examples":{"Filter by cloud id":{"value":"0194030499e74b02bdf68fa7130fb0b2"},"Filter by cloud name":{"value":"OSP10-new"},"Filter by cloud provider":{"value":"provider:digitalocean"}},"explode":true,"in":"query","name":"cloud","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return results matching search filter","examples":{"Filter by volume location":{"value":"location:Amsterdam"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVolumesResponse"}}},"description":"List volumes response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:volume","read:cloud"]},{"CookieAuth":["read:volume","read:cloud"]}],"summary":"List volumes","tags":["volumes"],"x-cli-table-default":["name","size","cloud","location","attached_to","tags"],"x-cli-table-extended":["id","name","size","cloud","location","external_id","attached_to","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.volumes_controller"},"post":{"description":"Creates one or more volumes on the specified cloud. If async is true, a jobId will be returned.\nREAD permission required on cloud. CREATE_RESOURCES permission required on cloud. READ permission required on location.\nCREATE_RESOURCES permission required on location. CREATE permission required on volume.\n","operationId":"create_volume","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVolumeRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVolumeResponse"}}},"description":"Volume provisioning started"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"501":{"description":"Volume support is not available"}},"security":[{"ApiKeyAuth":["create:volume","read:cloud","create_resources:cloud","read:location","create_resources:location"]},{"CookieAuth":["create:volume","read:cloud","create_resources:cloud","read:location","create_resources:location"]}],"summary":"Create volume","tags":["volumes"],"x-openapi-router-controller":"mist_api_v2.controllers.volumes_controller"}},"/api/v2/volumes/{volume}":{"delete":{"description":"Delete target volume","operationId":"delete_volume","parameters":[{"example":"my-volume","explode":false,"in":"path","name":"volume","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Volume successfully deleted"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Volume not found"}},"security":[{"ApiKeyAuth":["read:volume","delete:volume","read:cloud"]},{"CookieAuth":["read:volume","delete:volume","read:cloud"]}],"summary":"Delete volume","tags":["volumes"],"x-openapi-router-controller":"mist_api_v2.controllers.volumes_controller"},"get":{"description":"Get details about target volume","operationId":"get_volume","parameters":[{"example":"my-volume","explode":false,"in":"path","name":"volume","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVolumeResponse"}}},"description":"Volume returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Volume not found"}},"security":[{"ApiKeyAuth":["read:volume","read:cloud"]},{"CookieAuth":["read:volume","read:cloud"]}],"summary":"Get volume","tags":["volumes"],"x-cli-table-default":["name","size","cloud","location","attached_to","tags"],"x-cli-table-extended":["id","name","size","cloud","location","external_id","attached_to","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.volumes_controller"},"put":{"description":"Edit target volume","operationId":"edit_volume","parameters":[{"example":"my-volume","explode":false,"in":"path","name":"volume","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"New volume name","example":"my-renamed-volume","explode":true,"in":"query","name":"name","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"Volume successfully updated"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Volume not found"}},"security":[{"ApiKeyAuth":["edit:volume","read:cloud"]},{"CookieAuth":["edit:volume","read:cloud"]}],"summary":"Edit volume","tags":["volumes"],"x-openapi-router-controller":"mist_api_v2.controllers.volumes_controller"}},"/api/v2/zones":{"get":{"description":"List zones owned by the active org. READ permission required on zone & cloud.","operationId":"list_zones","parameters":[{"examples":{"Filter by cloud id":{"value":"0194030499e74b02bdf68fa7130fb0b2"},"Filter by cloud name":{"value":"OSP10-new"},"Filter by cloud provider":{"value":"provider:digitalocean"}},"explode":true,"in":"query","name":"cloud","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Only return results matching search filter","examples":{"Filter by zone name":{"value":"cinet3"}},"explode":true,"in":"query","name":"search","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Order results by","examples":{"Sort by name, descending":{"value":"-name"}},"explode":true,"in":"query","name":"sort","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Start results from index or id","examples":{"Start from item with id xyz":{"value":"xyz"},"Start from the 50th result":{"value":"50"}},"explode":true,"in":"query","name":"start","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Limit number of results, 1000 max","explode":true,"in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"},{"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"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListZonesResponse"}}},"description":"List zones response"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["read:zone","read:cloud"]},{"CookieAuth":["read:zone","read:cloud"]}],"summary":"List zones","tags":["zones"],"x-cli-table-default":["name","cloud","machines","tags"],"x-cli-table-extended":["id","name","cloud","external_id","machines","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.zones_controller"},"post":{"description":"Creates one or more zones on the specified cloud. If async is true, a jobId will be returned.\nREAD permission required on cloud. CREATE_RESOURCES permission required on cloud. CREATE permission required on zone.\n","operationId":"create_zone","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateZoneRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateZoneResponse"}}},"description":"Zone provisioning started"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"}},"security":[{"ApiKeyAuth":["create:zone","read:cloud","create_resources:cloud"]},{"CookieAuth":["create:zone","read:cloud","create_resources:cloud"]}],"summary":"Create zone","tags":["zones"],"x-openapi-router-controller":"mist_api_v2.controllers.zones_controller"}},"/api/v2/zones/{zone}":{"delete":{"description":"Delete target zone","operationId":"delete_zone","parameters":[{"example":"my-zone","explode":false,"in":"path","name":"zone","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Zone successfully deleted"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Zone not found"}},"security":[{"ApiKeyAuth":["read:zone","delete:zone","read:cloud"]},{"CookieAuth":["read:zone","delete:zone","read:cloud"]}],"summary":"Delete zone","tags":["zones"],"x-openapi-router-controller":"mist_api_v2.controllers.zones_controller"},"get":{"description":"Get details about target zone","operationId":"get_zone","parameters":[{"example":"my-zone","explode":false,"in":"path","name":"zone","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Only return these fields","examples":{"Only return id":{"value":"id"},"Return id, name & owned_by":{"value":"id,name,owned_by"}},"explode":true,"in":"query","name":"only","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Dereference foreign keys","examples":{"(default) Automatically replace all foreign key ids with referenced resource name ":{"value":"auto"},"Dereference cloud by provider, creator by email, owner by name":{"value":"cloud:provider, creator:email, owned_by:name"},"Dereference cloud id to cloud provider":{"value":"cloud:provider"},"Do not dereference anything, just return ids":{"value":"none"}},"explode":true,"in":"query","name":"deref","required":false,"schema":{"default":"auto","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetZoneResponse"}}},"description":"Zone returned successfully"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Zone not found"}},"security":[{"ApiKeyAuth":["read:zone","read:cloud"]},{"CookieAuth":["read:zone","read:cloud"]}],"summary":"Get zone","tags":["zones"],"x-cli-table-default":["name","cloud","machines","tags"],"x-cli-table-extended":["id","name","cloud","location","external_id","subnets","machines","tags","owned_by","created_by"],"x-openapi-router-controller":"mist_api_v2.controllers.zones_controller"},"put":{"description":"Edit target zone","operationId":"edit_zone","parameters":[{"example":"my-zone","explode":false,"in":"path","name":"zone","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Zone successfully updated"},"401":{"description":"Authentication failed"},"403":{"description":"You are not authorized to perform this action"},"404":{"description":"Zone not found"}},"security":[{"ApiKeyAuth":["edit:zone"]},{"CookieAuth":["edit:zone"]}],"summary":"Edit zone","tags":["zones"],"x-openapi-router-controller":"mist_api_v2.controllers.zones_controller"}}},"servers":[{"url":""}],"x-cli-waiters":{"job-finished":{"after":{"create-machine":{"job_id":"response.body#jobId"}},"attempts":900,"delay":2,"long":"Wait until job finishes","matchers":[{"expected":0,"select":"response.body#data.finished_at","state":"success","test":"notEqual"},{"expected":false,"select":"response.body#data.error","state":"failure","test":"notEqual"}],"operationId":"get-job","retryCodes":[404],"short":"Wait job","updates":"response.body#data.logs[:].action"}}}