\n```\nFor more information, refer to our [controller installation guides](https://docs.flexera.com/spot/ocean/tutorials/spot-kubernetes-controller/). You can install with Helm, Kubectl or Terraform.\nFor more about Ocean and the Ocean Controller, see the documentation [here](https://docs.flexera.com/spot/ocean/overview-kubernetes).\n",
"operationId": "OceanGKEClusterCreate",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"cluster"
],
"properties": {
"cluster": {
"type": "object",
"description": "The specification of the Ocean cluster.",
"required": [
"name",
"controllerClusterId",
"compute"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"example": "o-abcd1234",
"description": "Ocean cluster identifier.\n"
},
"name": {
"type": "string",
"example": "test",
"description": "Add a name for the Ocean cluster.\n"
},
"controllerClusterId": {
"type": "string",
"example": "test-123124",
"description": "Enter the Ocean cluster identifier.\n"
},
"gke": {
"type": "object",
"required": [
"clusterName",
"masterLocation"
],
"description": "Use existing GKE cluster.\n",
"properties": {
"clusterName": {
"type": "string",
"description": "Required for the cluster.gke object.\n",
"example": "test-cluster"
},
"masterLocation": {
"type": "string",
"description": "Required for the cluster.gke object.\n",
"example": "us-central1-a"
}
}
},
"autoScaler": {
"type": "object",
"title": "auto-scaler",
"description": "The Ocean Kubernetes Autoscaler object.",
"properties": {
"isEnabled": {
"type": "boolean",
"description": "Enable the Ocean Kubernetes Autoscaler.",
"default": true,
"example": true
},
"cooldown": {
"type": "integer",
"description": "Cooldown period between scaling actions.",
"default": null,
"minimum": 180,
"example": 180
},
"resourceLimits": {
"type": "object",
"description": "Optionally set upper and lower bounds on the resource usage of the cluster.",
"properties": {
"maxMemoryGib": {
"type": "integer",
"description": "The maximum memory in GiB units that can be allocated to the cluster.",
"example": 1500
},
"maxVcpu": {
"type": "integer",
"description": "The maximum CPU in vCPU units that can be allocated to the cluster.",
"example": 750
}
}
},
"down": {
"type": "object",
"description": "Autoscaling scale down operations.",
"properties": {
"evaluationPeriods": {
"type": "integer",
"minimum": 3,
"description": "Number of minutes a node should be eligible for scale down before it is scaled down.",
"example": 3
},
"maxScaleDownPercentage": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The maximum percentage allowed to scale down in a single scaling action.",
"example": 30
},
"aggressiveScaleDown": {
"type": "object",
"description": "Enable and configure the Accelerated Scale Down feature to allow the Ocean autoscaler to immediately scale down eligible nodes without any waiting period.",
"properties": {
"isEnabled": {
"type": "boolean",
"description": "When set to 'true', Accelerated Scale Down is enabled.",
"default": false
}
}
}
}
},
"headRoom": {
"type": "object",
"description": "Spare resource capacity management enabling fast assignment of pods without waiting for new resources to launch.\n",
"properties": {
"cpuPerUnit": {
"type": "integer",
"description": "Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores where 1000 millicores = 1 vCPU.\n",
"example": 0
},
"memoryPerUnit": {
"type": "integer",
"description": "Optionally configure the amount of memory (MiB) to allocate the headroom.",
"example": 0
},
"gpuPerUnit": {
"type": "integer",
"description": "How much GPU to allocate to a headroom unit.",
"example": 0
},
"numOfUnit": {
"type": "integer",
"description": "The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.\n",
"example": 0
}
}
},
"isAutoConfig": {
"type": "boolean",
"description": "Use automatic headroom. When set to true, the values under cluster.autoScaler.headroom are not effective, as Ocean configures and optimizes headroom automatically.\n",
"default": true,
"example": false
},
"autoHeadroomPercentage": {
"type": "integer",
"description": "Optionally set the auto headroom percentage. Set a number between 0-200 to control the headroom percent of the cluster. Relevant when isAutoConfig=true.\n",
"example": null
},
"enableAutomaticAndManualHeadroom": {
"type": "boolean",
"description": "When set to true, both automatic and per-VNG manual headroom to be saved concurrently and independently in the cluster. prerequisite: isAutoConfig must be true\n",
"example": true
}
}
},
"autoUpdate": {
"type": "object",
"title": "auto-update",
"description": "The Ocean Kubernetes AutoUpdate object. If set to 'true', Ocean will ensure that your clusters have an up-to-date configuration according to the respective GKE cluster.",
"properties": {
"isEnabled": {
"type": "boolean",
"description": "Enable the Ocean Kubernetes AutoUpdate.",
"default": true,
"example": true
}
}
},
"capacity": {
"type": "object",
"title": "Capacity Units",
"description": "Capacity specifications for the Ocean cluster.",
"properties": {
"minimum": {
"type": "integer",
"example": 0,
"description": "The bottom limit of instances that the cluster can scale down to.\n"
},
"maximum": {
"type": "integer",
"default": 1000,
"example": 3,
"description": "The upper limit of instances that the cluster can scale up to.\n"
},
"target": {
"type": "integer",
"example": 3,
"description": "Number of instances to launch and maintain in the cluster.\n"
}
}
},
"strategy": {
"type": "object",
"title": "Ocean Strategy",
"properties": {
"drainingTimeout": {
"type": "integer",
"description": "The draining timeout (in seconds) before terminating the instance.\nIf no draining timeout is defined, the default draining timeout will be used.\n",
"example": 60
},
"provisioningModel": {
"type": "string",
"description": "Define the provisioning model of the launched instances\n",
"enum": [
"SPOT",
"PREEMPTIBLE"
]
},
"scalingOrientation": {
"type": "string",
"default": "BALANCED",
"description": "Set this value to control the approach that Ocean takes when launching nodes.\n",
"enum": [
"COST",
"AVAILABILITY",
"BALANCED"
]
},
"preemptiblePercentage": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 100,
"description": "The desired percentage of Spot/Preemptible instances out of all running instances.\\\nOnly available when the field is **not** set in any VNG directly (launchSpec.strategy.preemptiblePercentage).\n",
"example": 100
},
"shouldUtilizeCommitments": {
"type": "boolean",
"example": true,
"description": "Enable committed use discounts utilization.\n"
},
"revertToPreferred": {
"type": "object",
"description": "Allow the replacement of instances to Preferred ones if available.\n",
"properties": {
"shouldPerform": {
"type": "boolean",
"default": true,
"description": "If enabled, replacements will be performed for all of your cluster, unless configured on VNG level. TRUE is the default.\n"
},
"maxBatchPercentage": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 10,
"description": "Decide on the % of instances that will be replaced simultaneously.\n"
}
}
}
}
},
"scheduling": {
"type": "object",
"title": "Ocean GKE Scheduling",
"description": "Schedule an action such as a planned shutdown or a cluster roll.",
"properties": {
"shutdownHours": {
"type": "object",
"description": "Define time(s) for a scheduled shutdown.\n",
"required": [
"timeWindows"
],
"properties": {
"isEnabled": {
"type": "boolean",
"description": "Flag to enable or disable the shutdown hours mechanism. When false, the mechanism is deactivated and the cluster remains in its current state.\n",
"example": true
},
"timeWindows": {
"type": "array",
"description": "Set time windows for shutdown hours. Specify a list of timeWindows that includes at least one time window. Each string is in the format of - ddd:hh:mm-ddd:hh:mm ddd = day of week = Sun | Mon | Tue | Wed | Thu | Fri | Sat hh = hour 24 = 0 -23 mm = minute = 0 - 59. Time windows should not overlap. Required when cluster.scheduling.isEnabled = True.\n",
"items": {
"type": "string",
"example": [
"Fri:15:30-Wed:14:30",
"Wed:15:30-Thu:18:30"
]
}
}
}
},
"tasks": {
"type": "array",
"items": {
"type": "object",
"title": "Task Definition",
"required": [
"isEnabled",
"cronExpression",
"taskType"
],
"properties": {
"isEnabled": {
"type": "boolean",
"example": true,
"description": "Describes whether the task is enabled. When true, the task runs. When false, it does not run. Required for the cluster.scheduling.tasks object.\n"
},
"cronExpression": {
"type": "string",
"example": "0 1 * * *",
"description": "A valid cron expression. For example : \" * * * * * \". The cron is running in UTC time zone and is in Unix cron format [Cron Expression Validator Script](http://www.unix.com/man-page/linux/5/crontab/). Frequency and cronExpression cannot be used at a time.\n"
},
"taskType": {
"type": "string",
"enum": [
"clusterRoll"
],
"example": "clusterRoll",
"description": "Valid values: \"clusterRoll\". Required for the cluster.scheduling.tasks object.\n"
},
"parameters": {
"type": "object",
"properties": {
"clusterRoll": {
"type": "object",
"properties": {
"batchSizePercentage": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"example": 20,
"description": "Value as a percent to set the size of a batch in a roll. Valid values are 0-100.\n"
},
"comment": {
"type": "string",
"example": "This is why I deployed my cluster.",
"description": "Add a comment description for the roll. The comment is limited to 256 chars\n"
},
"batchMinHealthyPercentage": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50,
"example": 100,
"description": "Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.\n"
},
"respectPdb": {
"type": "boolean",
"description": "During the roll, if the parameter is set to true we honor PDB during the instance replacement.\n",
"example": true,
"default": false
}
}
}
}
}
}
}
}
}
},
"security": {
"type": "object",
"title": "Security",
"properties": {
"containerImage": {
"type": "object",
"properties": {
"approvedImages": {
"type": "array",
"description": "Set list of permitted repositories for container images.",
"items": {
"type": "string",
"example": [
"gce.io/*",
"docker.*"
]
}
}
}
}
}
},
"compute": {
"type": "object",
"title": "Ocean Compute",
"required": [
"subnetName",
"launchSpecification",
"networkInterfaces",
"availabilityZones"
],
"properties": {
"networkInterfaces": {
"type": "object",
"description": "Settings for network interfaces\n",
"required": [
"accessConfigs",
"network"
],
"properties": {
"network": {
"type": "string",
"example": "default"
},
"projectId": {
"type": "string",
"description": "Use a network resource from a different project. Set the project identifier to use its network resource. This parameter is relevant only if the network resource is in a different project.\n",
"example": "test-project"
},
"accessConfigs": {
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"example": "external-nat"
},
"type": {
"type": "string",
"description": "Possible values: ONE_TO_ONE_NAT\n",
"example": "ONE_TO_ONE_NAT"
}
}
},
"aliasIpRanges": {
"type": "object",
"required": [
"ipCidrRange",
"subnetworkRangeName"
],
"properties": {
"ipCidrRange": {
"type": "string",
"description": "Required for the cluster.compute.networkInterfaces.aliasIpRanges object.\n",
"example": "/24"
},
"subnetworkRangeName": {
"type": "string",
"description": "Required for the cluster.compute.networkInterfaces.aliasIpRanges object.\n",
"example": "gke-test-native-vpc-pods-5cb557f7"
}
}
}
}
},
"backendServices": {
"type": "object",
"description": "Settings for backend services.",
"required": [
"backendServiceName"
],
"properties": {
"backendServiceName": {
"type": "string",
"description": "Required for the cluster.compute.backendServices object.",
"example": "test-global-tcp"
},
"locationType": {
"type": "string",
"enum": [
"regional",
"global"
],
"example": "regional"
},
"scheme": {
"type": "string",
"description": "Required if locationType is set to \"regional\".\n",
"enum": [
"EXTERNAL",
"INTERNAL"
],
"example": "EXTERNAL"
},
"namedPorts": {
"type": "object",
"required": [
"name",
"ports"
],
"properties": {
"name": {
"type": "string",
"example": "https"
},
"ports": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
443,
8443
]
}
}
}
}
},
"subnetName": {
"type": "string",
"description": "Subnet identifier for the Ocean cluster",
"example": "default"
},
"availabilityZones": {
"type": "array",
"description": "Availability zone(s) used by the Ocean cluster.",
"items": {
"type": "string",
"example": "us-west1-a"
}
},
"instanceTypes": {
"type": "object",
"description": "The type of instances that may or may not be a part of the Ocean cluster.",
"properties": {
"whitelist": {
"type": "array",
"description": "Instance types allowed in the Ocean cluster. Cannot be configured if a deny list is configured.\n",
"items": {
"type": "string"
},
"example": [
"n1-standard-2"
]
},
"blacklist": {
"type": "array",
"description": "Instance types to avoid launching in the Ocean cluster. Cannot be configured if a permit list is configured.\n",
"items": {
"type": "string"
},
"example": [
"n2d-highcpu-96"
]
},
"filters": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/filters"
},
"preferredTypes": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/preferredTypes"
}
}
},
"launchSpecification": {
"type": "object",
"required": [
"sourceImage",
"tags",
"metadata",
"serviceAccount"
],
"properties": {
"sourceImage": {
"type": "string",
"description": "URL of the image used to launch the instances.",
"example": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre"
},
"metadata": {
"type": "object",
"description": "Set array of cluster metadata.\n",
"properties": {
"key": {
"type": "string",
"description": "Key of metadata key pair.\n",
"example": "example_key1"
},
"value": {
"type": "string",
"description": "Value of metadata key pair.\n",
"example": "exmample_value1"
}
}
},
"tags": {
"type": "array",
"description": "Every node launched from this configuration will be tagged with those tags.",
"items": {
"type": "string"
},
"example": [
"gke-cluster-name-12345-node"
]
},
"ipForwarding": {
"type": "boolean",
"example": true
},
"minCpuPlatform": {
"type": "string",
"description": "Set instance CPU platform.\n",
"example": "Intel Sandy Bridge"
},
"serviceAccount": {
"type": "string",
"example": "265168459660-compute@developer.gserviceaccount.com",
"description": "The service account used by applications running on the VM to call GCP APIs.\n"
},
"labels": {
"type": "array",
"description": "Set labels on cluster. Can set up to 60 labels\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "spotinst-gke-original-node-pool"
},
"value": {
"type": "string",
"example": "test-native-vpc__default-pool"
}
}
}
},
"rootVolumeSizeInGb": {
"type": "integer",
"description": "Optionally set root size (GB). Value should be greater than or equal to 100.",
"example": 100
},
"rootVolumeType": {
"type": "string",
"description": "Set the root volume disk type.",
"example": "pd-standard",
"enum": [
"pd-standard",
"pd-ssd",
"pd-balanced",
"pd-extreme",
"hyperdisk-balanced",
"hyperdisk-balanced-high-availability"
]
},
"shieldedInstanceConfig": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/shieldedInstanceConfig"
},
"useAsTemplateOnly": {
"type": "boolean",
"description": "The configuration specified on the Ocean object will function only as a template for virtual node groups.\n",
"default": false
}
}
}
}
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T08:13:08.000Z",
"description": "A timestamp of the Ocean creation.\n"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T15:06:13.000Z",
"description": "A timestamp of the latest Ocean update.\n"
}
}
}
}
},
{
"type": "object",
"properties": {
"cluster": {
"type": "object",
"required": [
"name"
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"description": "The specification of the Ocean cluster.",
"required": [
"name",
"controllerClusterId",
"compute"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"example": "o-abcd1234",
"description": "Ocean cluster identifier.\n"
},
"name": {
"type": "string",
"example": "test",
"description": "Add a name for the Ocean cluster.\n"
},
"controllerClusterId": {
"type": "string",
"example": "test-123124",
"description": "Enter the Ocean cluster identifier.\n"
},
"gke": {
"type": "object",
"required": [
"clusterName",
"masterLocation"
],
"description": "Use existing GKE cluster.\n",
"properties": {
"clusterName": {
"type": "string",
"description": "Required for the cluster.gke object.\n",
"example": "test-cluster"
},
"masterLocation": {
"type": "string",
"description": "Required for the cluster.gke object.\n",
"example": "us-central1-a"
}
}
},
"autoScaler": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoScaler"
},
"autoUpdate": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoUpdate"
},
"capacity": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/capacity"
},
"strategy": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/strategy"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/scheduling"
},
"security": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/security"
},
"compute": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/compute"
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T08:13:08.000Z",
"description": "A timestamp of the Ocean creation.\n"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T15:06:13.000Z",
"description": "A timestamp of the latest Ocean update.\n"
}
}
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Clusters",
"description": "List the configurations for all Ocean clusters in the specified account.\n",
"operationId": "OceanGKEClusterList",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"description": "Ocean GKE List Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0"
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanClusterId}/controllerHeartbeat": {
"get": {
"summary": "Get Heartbeat Status",
"description": "Get the heartbeat status of the Ocean Controller for the cluster.
The response returns the heartbeat status and the last heartbeat timestamp.\n",
"operationId": "oceanGkeGetHeartbeatStatus",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean Get Heartbeat Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/k8s/cluster/o-e0a2bd7c/controllerHeartbeat"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Controller Heartbeat",
"properties": {
"status": {
"type": "string",
"example": "ACTIVE"
},
"lastHeartbeat": {
"type": "string",
"example": "2019-11-24T14:33:00.746Z"
}
}
}
},
"kind": {
"example": "spotinst:ocean:k8s:cluster:controllerHeartbeat"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanClusterId}": {
"delete": {
"summary": "Delete Cluster",
"description": "Delete a specified Ocean cluster.\n",
"operationId": "OceanGKEClusterDelete",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean GKE Delete Cluster Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/o-abcd1234"
},
"method": {
"example": "DELETE"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "Get Cluster",
"description": "Get the configuration for a specified Ocean cluster.\n",
"operationId": "OceanGKEClusterGet",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean GKE Get Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/o-abcd1234"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0"
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"put": {
"summary": "Update Cluster",
"description": "All Ocean parameters are updatable, excluding the Name and controllerClusterId.
This API supports partial updates, so specific fields can be updated separately.\n",
"operationId": "OceanGKEClusterUpdate",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"cluster"
],
"properties": {
"cluster": {
"type": "object",
"description": "The specification of the Ocean cluster.",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"example": "o-abcd1234",
"description": "Ocean cluster identifier.\n"
},
"name": {
"type": "string",
"example": "test",
"description": "Add a name for the Ocean cluster.\n"
},
"autoScaler": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoScaler"
},
"autoUpdate": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoUpdate"
},
"capacity": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/capacity"
},
"strategy": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/strategy"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/scheduling"
},
"security": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/security"
},
"compute": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/compute"
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T08:13:08.000Z",
"description": "A timestamp of the Ocean creation.\n"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T15:06:13.000Z",
"description": "A timestamp of the latest Ocean update.\n"
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean GKE Update Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/o-abcd1234"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0"
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanClusterId}/reImport": {
"put": {
"summary": "Reimport Cluster",
"description": "Reimport the cluster's configuration from GKE.\n",
"operationId": "reImportGke",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"description": "Reimport cluster response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/o-12345abc/reImport"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cluster": {
"type": "object",
"properties": {
"oceanId": {
"type": "string",
"description": "The identifier of the Ocean cluster.\n",
"example": "o-12345abc"
},
"associatedClusterName": {
"type": "string",
"description": "The name of the corresponding GKE cluster.\n",
"example": "gke-cluster"
},
"isUpdated": {
"type": "boolean",
"description": "If `true`, then the Ocean's configuration was updated.\n",
"example": true
},
"launchSpecs": {
"type": "array",
"description": "Shows the Ocean's virtual node groups and their update status.\n",
"items": {
"type": "object",
"properties": {
"launchSpecId": {
"type": "string",
"example": "ols-12345abc",
"description": "The identifier of the virtual node group.\n"
},
"associatedNodePool": {
"type": "string",
"description": "The virtual node group's associated node pool in GKE.\n",
"example": "default-pool"
},
"isUpdated": {
"type": "boolean",
"description": "If `true`, then the virtual node group's configuration was updated.\n",
"example": true
}
}
},
"example": [
{
"launchSpecId": "ols-12345abc",
"associatedNodePool": "default-pool",
"isUpdated": true
},
{
"launchSpecId": "ols-98765cba",
"associatedNodePool": "pool-1",
"isUpdated": false
}
]
}
}
}
}
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanClusterId}/detachInstances": {
"put": {
"summary": "Detach Instances",
"description": "Detach instances from your Ocean cluster.\n",
"operationId": "oceanGkeDetachInstance",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"instancesToDetach"
],
"properties": {
"instancesToDetach": {
"type": "array",
"description": "Array of instance identifiers to be detached.\n",
"items": {
"type": "string"
},
"example": [
"sin-9d317117a0df-oesg-02cff6a8",
"sin-49784809d76a-oesg-02cff6a8"
]
},
"shouldTerminateInstances": {
"type": "boolean",
"description": "Determines whether the detached instances should be terminated or not. (Default true)\n",
"example": true
},
"shouldDecrementTargetCapacity": {
"type": "boolean",
"description": "Determines whether the Ocean cluster's target capacity should be decremented. (Default false)\n",
"example": false
},
"drainingTimeout": {
"type": "integer",
"description": "(Applies only if shouldTerminateInstances is on) The draining timeout (in seconds) before terminating the instance.\n"
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/o-4c794b06/detachInstances"
},
"method": {
"example": "PUT"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanClusterId}/log": {
"summary": "Ocean for GKE",
"get": {
"summary": "Get Elastilog",
"description": "Get group’s Elastilog by \n",
"operationId": "oceanGkeFetchLog",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1mcs~1ecs~1cluster~1%7BclusterName%7D~1costs/get/parameters/2"
},
{
"$ref": "#/paths/~1mcs~1ecs~1cluster~1%7BclusterName%7D~1costs/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D~1log/get/parameters/4"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D~1log/get/parameters/5"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D~1log/get/parameters/6"
}
],
"responses": {
"200": {
"description": "Ocean Get Log Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"request": {
"type": "object",
"description": "Original request properties.\n",
"properties": {
"id": {
"type": "string",
"example": "3213f42e-455e-4801-a185-cd3eb65fac5f",
"description": "Unique identifier associated with this request.\n"
},
"url": {
"type": "string",
"example": "/ocean/gcp/k8s/cluster/o-e0a2bd7c/log?fromDate=2020-10-06&toDate=2020-10-08&severity=ALL&limit=500",
"description": "The URL that was used for the request.\n"
},
"method": {
"type": "string",
"example": "GET",
"description": "The HTTP **METHOD** used for the request.\n"
},
"timestamp": {
"type": "string",
"example": "2020-10-05T16:20:38.579Z",
"description": "When the request was received by Spot.\n"
}
}
},
"response": {
"type": "object",
"description": "Response package that includes status, type, and any relevant data.\n",
"properties": {
"status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": "200",
"description": "HTTP status code assigned to this response.\n"
},
"message": {
"type": "string",
"example": "OK",
"description": "HTTP status message for the respective status code.\n"
}
}
},
"kind": {
"type": "string",
"example": "spotinst:ocean:cluster:log"
},
"items": {
"type": "array",
"description": "Array of data objects.\n",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"createdAt": {
"type": "string"
}
}
},
"example": [
{
"message": "Ocean o-e0a2bd7c successfully created.",
"severity": "INFO",
"createdAt": "2020-10-07T09:51:12.000Z"
}
]
},
"count": {
"type": "integer",
"example": "1"
}
}
}
}
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanClusterId}/aggregatedCosts": {
"post": {
"summary": "Get Cluster Aggregated Detailed Costs",
"description": "Provides Kubernetes cluster resource usage and costs over a time interval which can be grouped and/or filtered by label/annotaion.\\\nFor example - application name (webapp, backend), environment (production, staging), version etc.\\\nThe response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory) and storage.\nThe response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation.\\\nWithin the group, resource costs are broken down per resource kind (Deployment, DaemonSet etc.).\n\nTime Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call.\\\nFor example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.\n",
"operationId": "oceanGkeK8sClusterAggregatedDetailedCosts",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"endTime",
"startTime"
],
"properties": {
"startTime": {
"type": "string",
"example": "2018-06-20T11:35:02.745Z",
"description": "Beginning date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"endTime": {
"type": "string",
"example": "2018-06-22T11:30:01.745Z",
"description": "End date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"groupBy": {
"type": "string",
"description": "The parameter we want to group the costs by.\n",
"default": "namespace",
"example": "namespace.label.env",
"enum": [
"namespace",
"namespace.label.${labelKey}",
"resource.label.${labelKey}",
"resource.annotation.${annotationKey}",
"namespace.annotation.${annotationKey}"
]
},
"filter": {
"type": "object",
"description": "Describe how to filter the costs. Optional field.",
"required": [
"scope",
"conditions"
],
"properties": {
"scope": {
"type": "string",
"enum": [
"namespace",
"resource"
]
},
"conditions": {
"type": "object",
"required": [
"anyMatch"
],
"properties": {
"anyMatch": {
"type": "array",
"description": "Array of conditions set that OR operator is applied between them.\n",
"items": {
"type": "object",
"required": [
"allMatch"
],
"properties": {
"allMatch": {
"type": "array",
"description": "Array of conditions that AND operator is applied between them.\\\nFor example, (label env equals prod) AND (label app exists)\n",
"items": {
"type": "object",
"description": "The basic expression of a condition",
"required": [
"type",
"key",
"operator"
],
"properties": {
"type": {
"type": "string",
"enum": [
"label",
"annotation"
]
},
"key": {
"type": "string",
"description": "May be any string, but shouldn't be empty.\n",
"example": "env"
},
"operator": {
"type": "string",
"enum": [
"equals",
"notEquals",
"exists",
"notExists"
]
},
"value": {
"type": "string",
"description": "Required whenever the operator is \"equals\" or \"notEquals\".\n",
"example": "prod"
}
}
}
}
}
},
"example": [
{
"allMatch": [
{
"type": "label",
"key": "env",
"operator": "equals",
"value": "prod"
},
{
"type": "label",
"key": "app",
"operator": "exists"
}
]
},
{
"allMatch": [
{
"type": "annotation",
"key": "meta.data",
"operator": "exists"
}
]
}
]
}
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Cluster Aggregated Detailed Costs Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/o-abcd1234/aggregatedCosts"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"totalForDuration": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"example": "2018-06-20T11:35:01.745Z",
"description": "Beginning date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"endTime": {
"type": "string",
"example": "2018-06-22T11:30:01.745Z",
"description": "End date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"summary": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 41772.882658036,
"description": "The total costs of cluster in a given time range"
},
"compute": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 40668.1299631538,
"description": "The total compute costs of the cluster in a given time range"
},
"workloads": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 40668.1299631538
}
}
},
"headroom": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0
}
}
}
}
},
"storage": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819,
"description": "The total storage costs of the cluster in given time range"
},
"block": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819
},
"pdPv": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819
}
}
},
"pdBoot": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0
}
}
}
}
}
}
}
}
},
"detailedCosts": {
"type": "object",
"properties": {
"groupedBy": {
"type": "string",
"example": "n.l.name"
},
"aggregations": {
"type": "object",
"description": "Contains aggregation for each group by value.\n",
"additionalProperties": {
"type": "object",
"description": "For example - if group by is namespace so each property name will a namesapce in the cluster.",
"properties": {
"summary": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 425.23778
},
"compute": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 125.23778
}
}
},
"storage": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 300
},
"block": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 300
},
"pdPv": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 300
}
}
},
"pdBoot": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0
}
}
}
}
}
}
}
}
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "k8s-events"
},
"type": {
"type": "string",
"example": "Deployment"
},
"namespace": {
"type": "string",
"example": "kube-system"
}
}
},
"total": {
"type": "number",
"example": 1.655635222
},
"compute": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1.4213600158
}
}
},
"storage": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0.2342752062
},
"block": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0.2342752062
},
"pdPv": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0
}
}
},
"pdBoot": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0.2342752062
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"kind": {
"example": "ocean:k8s:cluster:aggregatedCosts:detailed"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanClusterId}/aggregatedCosts/summary": {
"post": {
"summary": "Get Cluster Aggregated Summary Costs",
"description": "Provides Kubernetes cluster summary usage and costs over a time interval which can be grouped and/or filtered by label/annotaion,\\\nfor example - application name (webapp, backend), environment (production, staging), version etc.\\\nThe response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).\nThe response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation.\n\nTime Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call.\\\nFor example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.\n",
"operationId": "oceanGkeK8sClusterAggregatedSummaryCosts",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"endTime",
"startTime"
],
"properties": {
"startTime": {
"type": "string",
"example": "2023-07-20T11:35:01.745Z",
"description": "Beginning date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"endTime": {
"type": "string",
"example": "2023-07-22T11:30:01.745Z",
"description": "End date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"groupBy": {
"type": "string",
"description": "The parameter we want to group the costs by.\n",
"default": "namespace",
"example": "namespace.label.env",
"enum": [
"namespace",
"namespace.label.${labelKey}",
"resource.label.${labelKey}",
"resource.annotation.${annotationKey}",
"namespace.annotation.${annotationKey}"
]
},
"filter": {
"type": "object",
"description": "Describe how to filter the costs. Optional field.",
"required": [
"scope",
"conditions"
],
"properties": {
"scope": {
"type": "string",
"enum": [
"namespace",
"resource"
]
},
"conditions": {
"type": "object",
"required": [
"anyMatch"
],
"properties": {
"anyMatch": {
"type": "array",
"description": "Array of conditions set that OR operator is applied between them.\n",
"items": {
"type": "object",
"required": [
"allMatch"
],
"properties": {
"allMatch": {
"type": "array",
"description": "Array of conditions that AND operator is applied between them.\\\nFor example, (label env equals prod) AND (label app exists)\n",
"items": {
"type": "object",
"description": "The basic expression of a condition",
"required": [
"type",
"key",
"operator"
],
"properties": {
"type": {
"type": "string",
"enum": [
"label",
"annotation"
]
},
"key": {
"type": "string",
"description": "May be any string, but shouldn't be empty.\n",
"example": "env"
},
"operator": {
"type": "string",
"enum": [
"equals",
"notEquals",
"exists",
"notExists"
]
},
"value": {
"type": "string",
"description": "Required whenever the operator is \"equals\" or \"notEquals\".\n",
"example": "prod"
}
}
}
}
}
},
"example": [
{
"allMatch": [
{
"type": "label",
"key": "env",
"operator": "equals",
"value": "prod"
},
{
"type": "label",
"key": "app",
"operator": "exists"
}
]
},
{
"allMatch": [
{
"type": "annotation",
"key": "meta.data",
"operator": "exists"
}
]
}
]
}
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Cluster Aggregated Summary Costs Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/o-abcd1234/aggregatedCosts/summary"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"totalForDuration": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"example": "2023-07-20T11:35:01.745Z",
"description": "Beginning date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"endTime": {
"type": "string",
"example": "2023-07-22T11:30:01.745Z",
"description": "End date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"summary": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 41772.882658035785,
"format": "float",
"description": "The total costs of cluster in a given time range"
},
"compute": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 40668.1299631538,
"format": "float",
"description": "The total compute costs of the cluster in a given time range"
},
"workloads": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 39882.13803327978,
"format": "float"
}
}
},
"headroom": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0,
"format": "float"
}
}
}
}
},
"storage": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819868,
"format": "float",
"description": "The total storage costs of the cluster in given time range"
},
"block": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819868,
"format": "float"
},
"pdPv": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819868,
"format": "float"
}
}
},
"pdBoot": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0,
"format": "float"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"kind": {
"example": "ocean:k8s:cluster:aggregatedCosts:summary"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanClusterId}/instanceTypeFiltersSimulation": {
"post": {
"summary": "Instance Types Filters Simulation",
"description": "Returns all instances types that match the given filters. These instance types will be used if the cluster is configured with these filters.\n",
"operationId": "oceanGkeInstanceTypeFiltersSimulation",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"filters"
],
"properties": {
"filters": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/filters"
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Instance Types Filters Simulation Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/o-abcd1234/instanceTypeFiltersSimulation"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"filteredInstanceTypes": {
"type": "array",
"description": "The simulated instance types.\n",
"items": {
"type": "string"
},
"example": [
"n1-highcpu-4",
"n1-highcpu-2",
"n1-highcpu-8",
"n1-standard-2",
"n1-standard-1"
]
}
}
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s:instanceTypesFilters:simulation"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/launchSpec": {
"summary": "Ocean for GKE",
"post": {
"summary": "Create VNG",
"description": "Create a Virtual Node Group.\n",
"operationId": "OceanGKELaunchSpecCreate",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1launchSpec/post/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"launchSpec"
],
"properties": {
"launchSpec": {
"type": "object",
"description": "Ocean Cluster Virtual Node Group (VNG).\n",
"required": [
"oceanId",
"sourceImage",
"metadata"
],
"properties": {
"oceanId": {
"type": "string",
"example": "o-1fff54ed",
"description": "The Ocean cluster identifier. Required to create the virtual node group.\n"
},
"name": {
"type": "string",
"example": "lp_name",
"description": "Set the name for the virtual node group.\n"
},
"sourceImage": {
"type": "string",
"example": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"description": "Set the image URL. Can be null.\n"
},
"serviceAccount": {
"type": "string",
"example": "265168459660-compute@developer.gserviceaccount.com",
"description": "The account used by applications running on the VM to call GCP APIs.\n"
},
"rootVolumeSizeInGb": {
"type": "integer",
"description": "Set root volume size (in GB).",
"example": 8
},
"rootVolumeType": {
"type": "string",
"description": "Set the root volume disk type.",
"example": "pd-standard",
"enum": [
"pd-standard",
"pd-ssd",
"pd-balanced",
"pd-extreme",
"hyperdisk-balanced",
"hyperdisk-balanced-high-availability"
]
},
"metadata": {
"type": "array",
"description": "Add metadata to the cluster.\n",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"description": "Set the metadata key. Required for launchSpec.metadata.",
"example": "key1"
},
"value": {
"type": "string",
"description": "Set the metadata name. Required for launchSpec.metadata.",
"example": "value1"
}
}
},
"example": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
]
},
"instanceTypes": {
"type": "array",
"description": "An array of supported machine types for the virtual node group. Can be null.\n",
"items": {
"type": "string"
},
"example": [
"n1-standard-1",
"n1-standard-2"
]
},
"filters": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/filters"
},
"preferredTypes": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/preferredTypes"
},
"availabilityZones": {
"type": "array",
"description": "An array holding availability zones, this configures the availability zones the Ocean may launch instances in per VNG. Can be null.\n",
"items": {
"type": "string"
},
"example": [
"us-central1-a",
"us-central1-b"
]
},
"tags": {
"type": "array",
"description": "Every node launched from this VNG will have those tags. If the value is null, the nodes will have the tags configured at the cluster level.\n",
"items": {
"type": "string"
},
"example": [
"gke-cluster-name-12345-node",
"network-tag-1"
]
},
"taints": {
"type": "array",
"description": "Add taints to the virtual node group.",
"items": {
"type": "object",
"required": [
"key",
"value",
"effect"
],
"properties": {
"key": {
"type": "string",
"description": "Set taint key."
},
"value": {
"type": "string",
"description": "Set taint value."
},
"effect": {
"type": "string",
"description": "Set taint effect."
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"labels": {
"type": "array",
"description": "An array of labels to add to the virtual node group. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"description": "Set label key.\\\nThe following are not allowed:\n* \"kubernetes.io/hostname\"\n* \"failure-domain.beta.kubernetes.io/zone\"\n* \"topology.kubernetes.io/zone\"\n* \"failure-domain.beta.kubernetes.io/region\"\n* \"topology.kubernetes.io/region\"\n* \"beta.kubernetes.io/instance-type\"\n* \"node.kubernetes.io/instance-type\"\n* \"beta.kubernetes.io/os\"\n* \"kubernetes.io/os\"\n* \"beta.kubernetes.io/arch\"\n* \"kubernetes.io/arch\"\n* \"spotinst.io/node-lifecycle\"\n* \"spotinst.io/gpu-type\"\n"
},
"value": {
"type": "string",
"description": "Set label value."
}
}
},
"example": [
{
"key": "env",
"value": "test"
}
]
},
"autoScale": {
"type": "object",
"description": "Object specifying the automatic scaling of an Ocean VNG.\n",
"properties": {
"headrooms": {
"type": "array",
"description": "Set custom headroom per virtual node group. Provide a list of launchSpec.autoScale.headroom objects.\n",
"items": {
"type": "object",
"required": [
"numOfUnits"
],
"properties": {
"cpuPerUnit": {
"type": "integer",
"description": "Configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.\n",
"example": 1000
},
"memoryPerUnit": {
"type": "integer",
"description": "Configure the amount of memory (MiB) to allocate the headroom.\n",
"example": 2048
},
"gpuPerUnit": {
"type": "integer",
"description": "The amount of GPU to allocate per headroom unit.\n",
"example": 0
},
"numOfUnits": {
"type": "integer",
"description": "The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.\n",
"example": 3
}
}
}
},
"autoHeadroomPercentage": {
"type": "integer",
"description": "Number between 0-200 to control the headroom % of the specific Virtual Node Group. Effective when cluster.autoScaler.isAutoConfig=true is set on the Ocean cluster\n",
"example": 20
},
"down": {
"type": "object",
"description": "Autoscaling scale down operations.\n",
"properties": {
"maxScaleDownPercentage": {
"type": "number",
"format": "double",
"minimum": 0.1,
"maximum": 100,
"description": "The maximum percentage allowed to scale down in a single scaling action on the nodes running in a specific VNG. Allowed only if maxScaleDownPercentage is set to null at the cluster level.\n",
"example": 30
}
}
}
}
},
"resourceLimits": {
"type": "object",
"properties": {
"maxInstanceCount": {
"description": "Option to set a maximum number of instances per virtual node group. Can be null. If set, the value must be greater than or equal to 0.\n",
"type": "integer",
"example": 5
},
"minInstanceCount": {
"description": "Option to set a minimum number of instances per virtual node group.\\\nCan be null. If set, value must be greater than or equal to 0.\n",
"type": "integer",
"example": 2
}
}
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
},
"shieldedInstanceConfig": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/shieldedInstanceConfig"
},
"strategy": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/strategy"
},
"storage": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/storage"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/scheduling"
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2019-06-03T08:13:08.000Z"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2019-06-10T15:06:13.000Z"
},
"networkInterfaces": {
"type": "array",
"required": [
"accessConfigs",
"network"
],
"description": "Settings for network interfaces\n",
"items": {
"type": "object",
"required": [
"network"
],
"properties": {
"network": {
"type": "string",
"description": "The name of the network.\n",
"example": "default"
},
"projectId": {
"type": "string",
"description": "Use a network resource from a different project. Set the project identifier to use its network resource. This parameter is relevant only if the network resource is in a different project.\n",
"example": "test-project"
},
"accessConfigs": {
"type": "array",
"description": "The network protocol of the VNG.\n",
"required": [
"name",
"type"
],
"items": {
"properties": {
"name": {
"type": "string",
"description": "The name of the access configuration.\n",
"example": "external-nat"
},
"type": {
"type": "string",
"description": "The type of the access configuration.\n",
"enum": [
"ONE_TO_ONE_NAT"
],
"example": "ONE_TO_ONE_NAT"
}
}
}
},
"aliasIpRanges": {
"type": "array",
"description": "use the imported node pool’s associated aliasIpRange to assign secondary IP addresses to the nodes. Cannot be changed after VNG creation.",
"items": {
"required": [
"ipCidrRange",
"subnetworkRangeName"
],
"properties": {
"ipCidrRange": {
"type": "string",
"description": "specify the IP address range in CIDR notation that can be used for the alias IP addresses associated with the imported node pool.\n",
"example": "/24"
},
"subnetworkRangeName": {
"type": "string",
"description": "specify the IP address range for the subnet secondary IP range.\n",
"example": "gke-test-native-vpc-pods-5cb557f7"
}
}
}
}
}
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Virtual Node Group Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/launchSpec"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec/post/requestBody/content/application~1json/schema/allOf/0/properties/launchSpec"
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s:launchSpec"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List VNGs",
"operationId": "OceanGKELaunchSpecList",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "query",
"name": "oceanId",
"schema": {
"type": "string"
},
"required": true,
"example": "o-12345abc",
"description": "Identifier of the Ocean cluster.\n"
}
],
"responses": {
"200": {
"description": "Ocean Virtual Node Group Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/launchSpec"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec/post/requestBody/content/application~1json/schema/allOf/0/properties/launchSpec"
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s:launchSpec"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/launchSpec/import": {
"summary": "Ocean for GKE",
"post": {
"summary": "Import GKE Node Pool To VNG",
"description": "Returns an Ocean Virtual Node Group (VNG) configuration based on a given GCP GKE Cluster Node Pool.\\\nThe returned value (\"Imported VNG\") can then be used as input to the Create VNG API in order to create an actual VNG in your Ocean cluster.\n",
"operationId": "oceanGkeImportNodePoolToLaunchSpec",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec/get/parameters/1"
},
{
"in": "query",
"name": "nodePoolName",
"schema": {
"type": "string"
},
"required": true,
"example": "test",
"description": "Name of the Node Pool.\n"
}
],
"responses": {
"200": {
"description": "Ocean Virtual Node Group Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/launchSpec/import"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"description": "Ocean Cluster Virtual Node Group (VNG).\n",
"required": [
"oceanId",
"sourceImage"
],
"properties": {
"oceanId": {
"type": "string",
"example": "o-1fff54ed",
"description": "The Ocean cluster identifier. Required to create the virtual node group.\n"
},
"sourceImage": {
"type": "string",
"example": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"description": "Set the image URL. Can be null.\n"
},
"serviceAccount": {
"type": "string",
"example": "265168459660-compute@developer.gserviceaccount.com",
"description": "The account used by applications running on the VM to call GCP APIs.\n"
},
"rootVolumeType": {
"type": "string",
"description": "Set the root volume disk type.",
"example": "pd-standard",
"enum": [
"pd-standard",
"pd-ssd",
"pd-balanced",
"pd-extreme",
"hyperdisk-balanced",
"hyperdisk-balanced-high-availability"
]
},
"metadata": {
"type": "array",
"required": [
"key",
"value"
],
"description": "Add metadata to the cluster.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set the metadata key. Required for launchSpec.metadata.",
"example": "key1"
},
"value": {
"type": "string",
"description": "Set the metadata name. Required for launchSpec.metadata.",
"example": "value1"
}
}
},
"example": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
]
},
"availabilityZones": {
"type": "array",
"description": "An array holding availability zones, this configures the availability zones the Ocean may launch instances in per VNG. Can be null.\n",
"items": {
"type": "string"
},
"example": [
"us-central1-a",
"us-central1-b"
]
},
"tags": {
"type": "array",
"description": "Every node launched from this VNG will have those tags. If the value is null, the nodes will have the tags configured at the cluster level.\n",
"items": {
"type": "string"
},
"example": [
"gke-cluster-name-12345-node",
"network-tag-1"
]
},
"taints": {
"type": "array",
"description": "Add taints to the virtual node group.",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set taint key."
},
"value": {
"type": "string",
"description": "Set taint value."
},
"effect": {
"type": "string",
"description": "Set taint effect."
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"labels": {
"type": "array",
"description": "An array of labels to add to the virtual node group. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set label key.\\\nThe following are not allowed:\n* \"kubernetes.io/hostname\"\n* \"failure-domain.beta.kubernetes.io/zone\"\n* \"topology.kubernetes.io/zone\"\n* \"failure-domain.beta.kubernetes.io/region\"\n* \"topology.kubernetes.io/region\"\n* \"beta.kubernetes.io/instance-type\"\n* \"node.kubernetes.io/instance-type\"\n* \"beta.kubernetes.io/os\"\n* \"kubernetes.io/os\"\n* \"beta.kubernetes.io/arch\"\n* \"kubernetes.io/arch\"\n* \"spotinst.io/node-lifecycle\"\n* \"spotinst.io/gpu-type\"\n"
},
"value": {
"type": "string",
"description": "Set label value."
}
}
},
"example": [
{
"key": "env",
"value": "test"
}
]
},
"shieldedInstanceConfig": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/shieldedInstanceConfig"
},
"storage": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema/properties/storage"
}
}
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s:launchSpec"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/launchSpec/{launchSpecId}": {
"summary": "Ocean for GKE",
"delete": {
"summary": "Delete VNG",
"description": "Delete a specified virtual node group in an Ocean cluster.\n",
"operationId": "OceanGKELaunchSpecDelete",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1launchSpec~1%7BlaunchSpecId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1launchSpec~1%7BlaunchSpecId%7D/delete/parameters/2"
}
],
"responses": {
"200": {
"description": "Ocean Virtual Node Group Delete Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/launchSpec/ols-12345abc"
},
"method": {
"example": "DELETE"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"put": {
"summary": "Update VNG",
"description": "All Ocean parameters in a virtual node group are updatable.\n",
"operationId": "OceanGKELaunchSpecUpdate",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1launchSpec~1%7BlaunchSpecId%7D/get/parameters/1"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Ocean Cluster Virtual Node Group (VNG).\n",
"required": [
"oceanId",
"sourceImage"
],
"properties": {
"oceanId": {
"type": "string",
"example": "o-1fff54ed",
"description": "The Ocean cluster identifier. Required to create the virtual node group.\n"
},
"name": {
"type": "string",
"example": "lp_name",
"description": "Set the name for the virtual node group.\n"
},
"sourceImage": {
"type": "string",
"example": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/container-v1-3-v20160517",
"description": "Set the image URL. Can be null.\n"
},
"serviceAccount": {
"type": "string",
"example": "265168459660-compute@developer.gserviceaccount.com",
"description": "The account used by applications running on the VM to call GCP APIs.\n"
},
"rootVolumeSizeInGb": {
"type": "integer",
"description": "Set root volume size (in GB).",
"example": 8
},
"rootVolumeType": {
"type": "string",
"description": "Set the root volume disk type.",
"example": "pd-standard",
"enum": [
"pd-standard",
"pd-ssd",
"pd-balanced",
"pd-extreme",
"hyperdisk-balanced",
"hyperdisk-balanced-high-availability"
]
},
"metadata": {
"type": "array",
"description": "Add metadata to the cluster.\n",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"description": "Set the metadata key. Required for launchSpec.metadata.",
"example": "key1"
},
"value": {
"type": "string",
"description": "Set the metadata name. Required for launchSpec.metadata.",
"example": "value1"
}
}
},
"example": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
]
},
"instanceTypes": {
"type": "array",
"description": "An array of supported machine types for the virtual node group. Can be null.\n",
"items": {
"type": "string"
},
"example": [
"n1-standard-1",
"n1-standard-2"
]
},
"filters": {
"type": "object",
"description": "List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.\n",
"title": "InstanceTypesFilters",
"properties": {
"minVcpu": {
"type": "integer",
"description": "Minimum number of vcpus available.\n",
"minimum": 0,
"example": 2
},
"maxVcpu": {
"type": "integer",
"description": "Maximum number of vcpus available.\n",
"minimum": 1,
"example": 16
},
"minMemoryGiB": {
"type": "number",
"format": "double",
"description": "Minimum amount of Memory (GiB).\n",
"minimum": 0,
"example": 8
},
"maxMemoryGiB": {
"type": "number",
"format": "double",
"description": "Maximum amount of Memory (GiB).\n",
"minimum": 0,
"example": 16
},
"includeFamilies": {
"type": "array",
"description": "Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported).\n",
"items": {
"type": "string"
},
"example": [
"c2",
"c3"
]
},
"excludeFamilies": {
"type": "array",
"description": "Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported).\n",
"items": {
"type": "string"
},
"example": [
"n2",
"c3"
]
}
}
},
"preferredTypes": {
"type": "array",
"description": "When Ocean scales up VMs, it prioritizes the preferred instance types for launching new nodes. If launching nodes from this preferred list is not feasible, Ocean will then proceed to utilize the configured instance types available within the cluster. Note that the preferred types must be a subset of the instance types configured for the cluster/vng.\n",
"title": "preferredTypes",
"items": {
"type": "string"
},
"example": [
"c3d-standard-4",
"c3d-standard-8"
]
},
"availabilityZones": {
"type": "array",
"description": "An array holding availability zones, this configures the availability zones the Ocean may launch instances in per VNG. Can be null.\n",
"items": {
"type": "string"
},
"example": [
"us-central1-a",
"us-central1-b"
]
},
"tags": {
"type": "array",
"description": "Every node launched from this VNG will have those tags. If the value is null, the nodes will have the tags configured at the cluster level.\n",
"items": {
"type": "string"
},
"example": [
"gke-cluster-name-12345-node",
"network-tag-1"
]
},
"taints": {
"type": "array",
"description": "Add taints to the virtual node group.",
"items": {
"type": "object",
"required": [
"key",
"value",
"effect"
],
"properties": {
"key": {
"type": "string",
"description": "Set taint key."
},
"value": {
"type": "string",
"description": "Set taint value."
},
"effect": {
"type": "string",
"description": "Set taint effect."
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"labels": {
"type": "array",
"description": "An array of labels to add to the virtual node group. Only custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"description": "Set label key.\\\nThe following are not allowed:\n* \"kubernetes.io/hostname\"\n* \"failure-domain.beta.kubernetes.io/zone\"\n* \"topology.kubernetes.io/zone\"\n* \"failure-domain.beta.kubernetes.io/region\"\n* \"topology.kubernetes.io/region\"\n* \"beta.kubernetes.io/instance-type\"\n* \"node.kubernetes.io/instance-type\"\n* \"beta.kubernetes.io/os\"\n* \"kubernetes.io/os\"\n* \"beta.kubernetes.io/arch\"\n* \"kubernetes.io/arch\"\n* \"spotinst.io/node-lifecycle\"\n* \"spotinst.io/gpu-type\"\n"
},
"value": {
"type": "string",
"description": "Set label value."
}
}
},
"example": [
{
"key": "env",
"value": "test"
}
]
},
"autoScale": {
"type": "object",
"description": "Object specifying the automatic scaling of an Ocean VNG.\n",
"properties": {
"headrooms": {
"type": "array",
"description": "Set custom headroom per virtual node group. Provide a list of launchSpec.autoScale.headroom objects.\n",
"items": {
"type": "object",
"required": [
"numOfUnits"
],
"properties": {
"cpuPerUnit": {
"type": "integer",
"description": "Configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.\n",
"example": 1000
},
"memoryPerUnit": {
"type": "integer",
"description": "Configure the amount of memory (MiB) to allocate the headroom.\n",
"example": 2048
},
"gpuPerUnit": {
"type": "integer",
"description": "The amount of GPU to allocate per headroom unit.\n",
"example": 0
},
"numOfUnits": {
"type": "integer",
"description": "The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.\n",
"example": 3
}
}
}
},
"autoHeadroomPercentage": {
"type": "integer",
"description": "Number between 0-200 to control the headroom % of the specific Virtual Node Group. Effective when cluster.autoScaler.isAutoConfig=true is set on the Ocean cluster\n",
"example": 20
},
"down": {
"type": "object",
"description": "Autoscaling scale down operations.\n",
"properties": {
"maxScaleDownPercentage": {
"type": "number",
"format": "double",
"minimum": 0.1,
"maximum": 100,
"description": "The maximum percentage allowed to scale down in a single scaling action on the nodes running in a specific VNG. Allowed only if maxScaleDownPercentage is set to null at the cluster level.\n",
"example": 30
}
}
}
}
},
"resourceLimits": {
"type": "object",
"properties": {
"maxInstanceCount": {
"description": "Option to set a maximum number of instances per virtual node group. Can be null. If set, the value must be greater than or equal to 0.\n",
"type": "integer",
"example": 5
},
"minInstanceCount": {
"description": "Option to set a minimum number of instances per virtual node group.\\\nCan be null. If set, value must be greater than or equal to 0.\n",
"type": "integer",
"example": 2
}
}
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
},
"shieldedInstanceConfig": {
"type": "object",
"title": "shielded-instance-config",
"description": "The Ocean shielded instance configuration object.\n",
"properties": {
"enableSecureBoot": {
"type": "boolean",
"description": "Enable the secure boot parameter on the GCP instances.\n",
"example": true
},
"enableIntegrityMonitoring": {
"type": "boolean",
"description": "Enable the integrity monitoring parameter on the GCP instances.\n",
"example": true
}
}
},
"strategy": {
"type": "object",
"title": "strategy",
"description": "The Ocean virtual node group strategy object.\n",
"properties": {
"preemptiblePercentage": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 100,
"description": "The desired percentage of Spot/Preemptible instances out of all running instances for this VNG.\\\nOnly available when the field is **not** set in the cluster directly (cluster.strategy.preemptiblePercentage).\n",
"example": 80
},
"scalingOrientation": {
"type": "string",
"default": "BALANCED",
"description": "Set this value to control the approach that Ocean takes when launching nodes.\n",
"enum": [
"COST",
"AVAILABILITY",
"BALANCED"
]
},
"shouldUtilizeCommitments": {
"type": "boolean",
"example": true,
"description": "Enable committed use discounts utilization.\n"
},
"revertToPreferred": {
"type": "object",
"description": "Allow the replacement of instances to Preferred ones if available.\n",
"properties": {
"shouldPerform": {
"type": "boolean",
"default": true,
"description": "If enabled, replacements will be performed for your VNG. TRUE is the default.\n"
},
"maxBatchPercentage": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"default": 10,
"description": "Decide on the % of instances that will be replaced simultaneously.\n"
}
}
}
}
},
"storage": {
"type": "object",
"title": "storage",
"description": "The Ocean virtual node group storage object.\n",
"properties": {
"localSsdCount": {
"type": "integer",
"description": "Defines the number of local SSDs to be attached per node for this VNG.\n\nIf instanceTypes are configured in this VNG, **all of them** must support the value of localSsdCount.\nOtherwise, if the Ocean cluster has instanceTypes on a permit list, **at least one** must support the value of localSsdCount.\n\nFor more information about local SSDs, it is recommended to review the GCP documentation:\n* [GCP Local SSD](https://cloud.google.com/compute/docs/disks#localssds)\n* [Local SSDs and machine types](https://cloud.google.com/compute/docs/disks#local_ssd_machine_type_restrictions)\n* [GKE Using local SSDs](https://cloud.google.com/kubernetes-engine/docs/how-to/persistent-volumes/local-ssd#use)\n",
"example": 2
},
"localSsdEphemeralStorageCount": {
"type": "integer",
"description": "Defines the number of local SSDs to be used as ephemeral storage per node for this VNG.\n\nThis field is derived from nodes enabled with the `--ephemeral-storage-local-ssd` flag in GKE,\nwhich configures ephemeral storage (used for temporary data such as container images and writable layers)\nbacked by local SSDs instead of the boot disk.\n\n**All** instanceTypes configured in this VNG must support the value of localSsdEphemeralStorageCount.\nOtherwise, if the Ocean cluster has instanceTypes on a permit list, **at least one** must support the value of localSsdEphemeralStorageCount.\n\nFor more information about local SSDs with ephemeral storage, it is recommended to review the GCP documentation:\n* [GKE ephemeral storage backed by local SSDs](https://cloud.google.com/kubernetes-engine/docs/how-to/persistent-volumes/local-ssd#lssd-ephemeral-storage)\n",
"example": 2
},
"localNvmeSsdCount": {
"type": "integer",
"description": "Defines the number of local NVMe SSDs to be attached per node in raw block mode for this VNG.\n\nThis field is derived from nodes enabled with the `--local-nvme-ssd-block` flag in GKE,\nwhich attaches local NVMe SSDs as raw block devices, providing the highest possible storage performance.\n\n**All** instanceTypes configured in this VNG must support the value of localNvmeSsdCount.\nOtherwise, if the Ocean cluster has instanceTypes on a permit list, **at least one** must support the value of localNvmeSsdCount.\n\nFor more information about local NVMe SSDs, it is recommended to review the GCP documentation:\n* [GKE local NVMe SSD block storage](https://cloud.google.com/kubernetes-engine/docs/how-to/persistent-volumes/local-ssd-raw)\n",
"example": 2
}
}
},
"scheduling": {
"type": "object",
"description": "An object used to define scheduled tasks such as a manual headroom update or a VNG-level shutdown window.\n",
"title": "Ocean Scheduling",
"properties": {
"shutdownHours": {
"type": "object",
"description": "An object used to specify times that the nodes in the virtual node group will be taken down.\n",
"required": [
"timeWindows"
],
"properties": {
"isEnabled": {
"type": "boolean",
"description": "Flag to enable or disable the shutdown hours mechanism. When False, the mechanism is deactivated, and the virtual node group remains in its current state.\n",
"example": true
},
"timeWindows": {
"type": "array",
"description": "The times that the shutdown hours will apply.\n",
"items": {
"type": "string"
},
"example": [
"Mon:00:30-Mon:23:00",
"Tue:06:30-Tue:23:00"
]
}
}
},
"tasks": {
"type": "array",
"items": {
"type": "object",
"title": "Task Definition",
"required": [
"isEnabled",
"cronExpression",
"taskType"
],
"properties": {
"isEnabled": {
"type": "boolean",
"example": true,
"description": "Describes whether the task is enabled. When True, the task runs. When False, it does not run. Required for launchSpec.scheduling.tasks. In case automatic headroom is configured, please make sure to set autoScaler.enableAutomaticAndManualHeadroom on Ocean level to true in order to make sure that the manual headroom would be affective.\n"
},
"cronExpression": {
"type": "string",
"example": "0 1 * * *",
"description": "A valid cron expression. For example : \" * * * * * \". The cron job runs in UTC time and is in Unix cron format. (See the Cron Expression Validator Script.)\n"
},
"taskType": {
"type": "string",
"example": "manualHeadroomUpdate",
"enum": [
"manualHeadroomUpdate"
],
"description": "The activity that you are scheduling. Valid values: \"manualHeadroomUpdate\". Required for launchSpec.scheduling.tasks.\n"
},
"config": {
"description": "The config of this scheduled task. Depends on the value of `taskType`.",
"oneOf": [
{
"type": "object",
"title": "manualHeadroomUpdate",
"required": [
"headrooms"
],
"properties": {
"headrooms": {
"description": "Set custom headroom per VNG. Provide a list of launchSpec.autoscale.headroom objects.\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"cpuPerUnit": {
"description": "Configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.\n",
"type": "integer"
},
"memoryPerUnit": {
"description": "Configure the amount of memory (MiB) to allocate the headroom.\n",
"type": "integer"
},
"numOfUnits": {
"description": "The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.\n",
"type": "integer"
},
"gpuPerUnit": {
"type": "integer",
"description": "Amont of GPU to allocate for headroom unit.\n"
}
}
},
"example": [
{
"cpuPerUnit": 1024,
"memoryPerUnit": 512,
"gpuPerUnit": 0,
"numOfUnits": 1
}
]
}
}
}
]
}
}
}
}
}
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2019-06-03T08:13:08.000Z"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2019-06-10T15:06:13.000Z"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Ocean Virtual Node Group Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/launchSpec/ols-12345abc"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1%7BlaunchSpecId%7D/put/requestBody/content/application~1json/schema"
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s:launchSpec"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "Get VNG",
"operationId": "OceanGKELaunchSpecGet",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1launchSpec~1%7BlaunchSpecId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean Virtual Node Group Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/launchSpec/ols-12345abc"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec/post/requestBody/content/application~1json/schema/allOf/0/properties/launchSpec"
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s:launchSpec"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanId}/roll": {
"summary": "Ocean for GKE",
"post": {
"summary": "Initiate Roll",
"description": "Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceNames. Performing this request will start the roll immediately, and the roll will take place according to defined batches.
Note that the first response for a successful request will notify about the start of a roll. In order to check the status of a roll, you can use the GET Cluster Roll API using the roll identifier.\n",
"operationId": "oceanGkeRollInit",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"title": "Roll",
"properties": {
"roll": {
"allOf": [
{
"type": "object",
"properties": {
"batchSizePercentage": {
"type": "integer",
"description": "Value is a percentage to set the size of a batch in a roll. Valid values are 0-100.\n",
"example": 20
}
}
},
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Add a comment description for the roll. The comment is limited to 256 chars.\n",
"example": "This is why I deployed my cluster."
}
}
},
{
"type": "object",
"properties": {
"respectPdb": {
"type": "boolean",
"description": "During the roll, if the parameter is set to 'true', PDB is honored during the instance replacement.\n",
"example": true,
"default": false
}
}
},
{
"type": "object",
"properties": {
"batchMinHealthyPercentage": {
"type": "integer",
"description": "Indicates the threshold percentage of minimum healthy instances in a single batch. If the number is below the threshold, the cluster roll will fail. The parameter value has a range of 1-100 (default = 50%).\n",
"example": 100,
"default": 50
}
}
}
]
}
}
},
{
"type": "object",
"title": "Roll with instance ids",
"properties": {
"roll": {
"allOf": [
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/properties/roll/allOf/0"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/properties/roll/allOf/1"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/properties/roll/allOf/2"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/properties/roll/allOf/3"
},
{
"type": "object",
"properties": {
"instanceIds": {
"type": "array",
"description": "List of instance identifiers to be rolled. Each identifier is a string. InstanceIds can be null, and cannot be used together with launchSpecIds.\n",
"items": {
"type": "string"
},
"example": [
"i-0003a99ffb566f039",
"i-0567a99ffb566f765"
]
}
}
}
]
}
}
},
{
"type": "object",
"title": "Roll with Virtual Node Group ids",
"properties": {
"roll": {
"allOf": [
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/properties/roll/allOf/0"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/properties/roll/allOf/1"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/properties/roll/allOf/2"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/properties/roll/allOf/3"
},
{
"type": "object",
"properties": {
"launchSpecIds": {
"type": "array",
"description": "List of virtual node group identifiers to be rolled. Each identifier is a string. LaunchSpecIds can be null, and cannot be used together with instanceIds.\n",
"items": {
"type": "string"
},
"example": [
"ols-76694a7d",
"ols-56694a76"
]
}
}
},
{
"type": "object",
"properties": {
"disableLaunchSpecAutoScaling": {
"type": "boolean",
"description": "When set to 'true' and virtual node group identifiers are defined to roll, the specified virtual node group(s) will be blocked from scaling up. Replacements will scale up in other virtual node groups that match the displaced pods instead. This applies to migrating nodes from one virtual node group to another.\n",
"example": true
}
}
}
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Cluster Roll Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rollId": {
"type": "string",
"example": "roll-1234"
},
"oceanId": {
"type": "string",
"example": "o-12e31234"
},
"scope": {
"type": "string",
"enum": [
"Cluster",
"Vngs",
"Vng",
"Instances",
"Instance"
],
"example": "Cluster"
},
"status": {
"type": "string",
"example": "IN_PROGRESS",
"enum": [
"IN_PROGRESS",
"COMPLETED",
"FAILED",
"STOPPED"
]
},
"batchNumber": {
"type": "integer",
"example": 1
},
"numOfBatches": {
"type": "integer",
"example": 5
},
"comment": {
"type": "string",
"example": "This is why I deployed my cluster."
},
"respectPdb": {
"type": "boolean",
"example": true
},
"progress": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"example": "percentage"
},
"value": {
"type": "integer",
"example": 0
},
"detailedStatus": {
"type": "object",
"properties": {
"oldInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instanceName": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"example": [
{
"instanceName": "sin-0a4becc0-sig-1234abcd",
"status": "REPLACED"
},
{
"instanceName": "sin-1a4becc0-sig-1234abcd",
"status": "TO_BE_REPLACED"
},
{
"instanceName": "sin-2a4becc0-sig-1234abcd",
"status": "COULD_NOT_BE_REPLACED"
},
{
"instanceName": "sin-3a4becc0-sig-1234abcd",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
}
}
}
},
"instanceNames": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"sin-0a4becc0-sig-6952238d",
"sin-0542ecc0-sig-695223r4"
]
},
"launchSpecIds": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"ols-76694a7d",
"ols-56694a76"
]
},
"batchMinHealthyPercentage": {
"type": "integer",
"example": 100
},
"createdAt": {
"type": "string",
"example": "2019-03-24T15:46:09.000Z"
},
"updatedAt": {
"type": "string",
"example": "2019-03-24T15:46:09.000Z"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Rolls",
"description": "Get status for all rolls of an Ocean cluster.\n",
"operationId": "oceanGkeRollList",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "path",
"name": "oceanId",
"schema": {
"type": "string"
},
"required": true,
"example": "o-abcd1234",
"description": "Identifier of the Ocean cluster.\n"
}
],
"responses": {
"200": {
"description": "Ocean Get List Of Rolls Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "OK"
}
}
},
"kind": {
"type": "string",
"example": "spotinst:ocean:aws:k8s:cluster:roll"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "scr-5aaf854e"
},
"scope": {
"type": "string",
"enum": [
"Cluster",
"Vngs",
"Vng",
"Instances",
"Instance"
],
"example": "Cluster"
},
"status": {
"type": "string",
"example": "IN_PROGRESS",
"enum": [
"IN_PROGRESS",
"COMPLETED",
"FAILED",
"STOPPED"
]
},
"currentBatch": {
"type": "integer",
"example": 2
},
"numOfBatches": {
"type": "integer",
"example": 2
},
"comment": {
"type": "string",
"example": "This is why I deployed my cluster."
},
"progress": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"example": "percentage"
},
"value": {
"type": "integer",
"example": 0
},
"detailedStatus": {
"type": "object",
"properties": {
"oldInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instanceName": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"example": [
{
"instanceName": "sin-0a4becc0-sig-1234abcd",
"status": "REPLACED"
},
{
"instanceName": "sin-1a4becc0-sig-1234abcd",
"status": "TO_BE_REPLACED"
},
{
"instanceName": "sin-2a4becc0-sig-1234abcd",
"status": "COULD_NOT_BE_REPLACED"
},
{
"instanceName": "sin-3a4becc0-sig-1234abcd",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
}
}
}
},
"batchMinHealthyPercentage": {
"type": "integer",
"example": 100
},
"oceanId": {
"type": "string",
"example": "o-30681b13"
},
"launchSpecIds": {
"type": "array",
"items": {
"type": "string",
"example": [
"ols-76694a7d",
"ols-56694a76"
]
}
},
"respectPdb": {
"type": "boolean",
"example": true
},
"createdAt": {
"type": "string",
"example": "2019-03-24T15:46:09.000Z"
},
"updatedAt": {
"type": "string",
"example": "2019-03-24T15:46:09.000Z"
}
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanId}/roll/{rollId}": {
"summary": "Ocean for GKE",
"put": {
"summary": "Update Roll",
"description": "Update a roll of an Ocean cluster.\n\n*Performing the request will stop the next batch in a roll.*\n",
"operationId": "oceanGkeRollUpdate",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/get/parameters/1"
},
{
"in": "path",
"name": "rollId",
"example": "scr-12345abc",
"description": "Ocean Cluster Roll identifier\n",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"roll": {
"type": "object",
"required": [
"status"
],
"description": "Object that specifies the parameters of a roll (also called a deployment).\n",
"properties": {
"status": {
"type": "string",
"enum": [
"STOPPED"
],
"description": "Set status of a roll. Valid values: \"STOPPED\"\n",
"example": "STOPPED"
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Cluster Roll Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rollId": {
"type": "string",
"example": "roll-1234"
},
"status": {
"type": "string",
"example": "STOPPED",
"enum": [
"STOPPED"
]
},
"batchNumber": {
"type": "integer",
"example": 1
},
"numOfBatches": {
"type": "integer",
"example": 5
},
"scope": {
"type": "string",
"enum": [
"Cluster",
"Vngs",
"Vng",
"Instances",
"Instance"
],
"example": "Cluster"
},
"progress": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"example": "percentage"
},
"value": {
"type": "integer",
"example": 0
},
"detailedStatus": {
"type": "object",
"properties": {
"oldInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instanceName": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"example": [
{
"instanceName": "sin-0a4becc0-sig-1234abcd",
"status": "REPLACED"
},
{
"instanceName": "sin-1a4becc0-sig-1234abcd",
"status": "TO_BE_REPLACED"
},
{
"instanceName": "sin-2a4becc0-sig-1234abcd",
"status": "COULD_NOT_BE_REPLACED"
},
{
"instanceName": "sin-3a4becc0-sig-1234abcd",
"status": "NOT_REPLACED_DUE_TO_PDB"
}
]
}
}
}
}
},
"batchMinHealthyPercentage": {
"type": "integer",
"example": 100
},
"oceanId": {
"type": "string",
"example": "o-12e31234"
},
"respectPdb": {
"type": "boolean",
"example": true
},
"createdAt": {
"type": "string",
"example": "2019-03-24T15:46:09.000Z"
},
"updatedAt": {
"type": "string",
"example": "2019-03-24T15:46:09.000Z"
}
}
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "Get Roll",
"description": "Get status for roll of an Ocean cluster.\n",
"operationId": "oceanGkeRollGetSingleRoll",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll~1%7BrollId%7D/put/parameters/2"
}
],
"responses": {
"200": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/post/responses/200"
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/{oceanClusterId}/nodes": {
"get": {
"summary": "Get Cluster Nodes",
"description": "Get nodes data of an Ocean cluster.\n",
"operationId": "oceanGkeGetNodes",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D~1nodes/get/parameters/2"
},
{
"in": "query",
"name": "instanceName",
"schema": {
"type": "string"
},
"example": "sin-123",
"description": "Get a specific node by instance name."
}
],
"responses": {
"200": {
"description": "Ocean GKE Nodes Data Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/o-12345abc/nodes"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Ocean node data",
"description": "Node data of Ocean cluster.",
"properties": {
"instanceName": {
"type": "string",
"example": "sin-123",
"description": "The GCP instance name of this node.\n"
},
"instanceType": {
"type": "string",
"example": "n1-standard-2",
"description": "The GCP instance type of this node.\n"
},
"availabilityZone": {
"type": "string",
"example": "us-central1-b",
"description": "The GCP availability zone of this node.\n"
},
"launchSpecId": {
"type": "string",
"example": "ols-123",
"description": "The node's Virtual Node Group id.\n"
},
"launchSpecName": {
"type": "string",
"example": "dev-launchSpec",
"description": "The node's Virtual Node Group name.\n"
},
"lifeCycle": {
"type": "string",
"enum": [
"Preemtible",
"OD",
"Spot"
],
"example": "Preemtible",
"description": "The GCP lifeCycle of this node.\n"
},
"publicIp": {
"type": "string",
"example": "1.2.3.4",
"description": "This node's public ip.\n"
},
"workloadRequestedMilliCpu": {
"type": "number",
"format": "double",
"example": 1320,
"description": "The amount of milli cpus requested by the kubernetes workload.\n"
},
"workloadRequestedMemoryInMiB": {
"type": "number",
"example": 500,
"description": "The amount of memory in MiB requested by the kubernetes workload.\n"
},
"workloadRequestedGpu": {
"type": "number",
"example": 1,
"description": "The amount of gpus requested by the kubernetes workload.\n"
},
"headroomRequestedMilliCpu": {
"type": "number",
"example": 1320,
"description": "The amount of milli cpus saved for headroom.\n"
},
"headroomRequestedMemoryInMiB": {
"type": "number",
"example": 512,
"description": "The amount of memory in MiB saved for headroom.\n"
},
"headroomRequestedGpu": {
"type": "number",
"example": 1,
"description": "The amount of gpus saved for headroom.\n"
},
"allocatableMilliCpu": {
"type": "number",
"example": 2000,
"description": "The amount of allocatable milli cpus as registered in kubernetes.\n"
},
"allocatableMemoryInMiB": {
"type": "number",
"example": 3646.1,
"description": "The amount of allocatable memory in MiB as registered in kubernetes.\n"
},
"allocatableGpu": {
"type": "number",
"example": 1,
"description": "The amount of allocatable gpus as registered in kubernetes.\n"
},
"nodeName": {
"type": "string",
"example": "node-1",
"description": "The kubernetes node name.\n"
},
"registrationStatus": {
"type": "string",
"enum": [
"Registered",
"Registering",
"Failed"
],
"example": "Registered",
"description": "The registration status of this node.\n"
},
"createdAt": {
"type": "string",
"example": "2021-10-1T05:51:06.000Z",
"description": "When was this node's instance was created at.\n"
}
}
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s:nodes"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/import": {
"post": {
"summary": "Upgrade Elastigroup To Ocean",
"description": "\n**Prerequisites** | Perform the following validations prior to upgrade executions: | * Group identifier cannot be null. * Group identifier exists in Elastigroup. * Group should be a GKE Elastigroup with defined scaling policy. * Group identifier is already managed by Ocean.\n",
"operationId": "oceanGkeUpgradeElastigroup",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1import/post/parameters/0"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"description": "Ocean Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "e1aba6b3-d1be-419f-b19a-9542e09716a5"
},
"url": {
"type": "string",
"example": "/ocean/gcp/k8s/cluster/import?groupId=o-210e0c0b?accountId=act-7461862f"
},
"method": {
"type": "string",
"example": "GET"
},
"timestamp": {
"type": "string",
"example": "2019-03-05T15:43:16.306Z"
}
}
},
"response": {
"type": "object",
"properties": {
"status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "OK"
}
}
},
"kind": {
"type": "string",
"example": "spotinst:ocean:gcp:k8s"
},
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "o-9aa80ccb"
},
"name": {
"type": "string",
"example": "ocean test"
},
"controllerClusterId": {
"type": "string",
"example": "Test-5837c8ad1"
},
"gke": {
"type": "object",
"properties": {
"clusterName": {
"type": "string",
"example": "test-native-vpc"
},
"masterLocation": {
"type": "string",
"example": "us-central1-a"
}
}
},
"capacity": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/capacity"
},
"compute": {
"type": "object",
"properties": {
"networkInterfaces": {
"type": "object",
"description": "Settings for network interfaces.\n",
"properties": {
"network": {
"type": "string",
"example": "default"
},
"accessConfigs": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "external-nat"
},
"type": {
"type": "string",
"description": "Possible values: ONE_TO_ONE_NAT\n",
"example": "ONE_TO_ONE_NAT"
}
}
},
"aliasIpRanges": {
"type": "object",
"properties": {
"ipCidrRange": {
"type": "string",
"description": "Required for the cluster.compute.networkInterfaces.aliasIpRanges object.\n",
"example": "/24"
},
"subnetworkRangeName": {
"type": "string",
"description": "Required for the cluster.compute.networkInterfaces.aliasIpRanges object.\n",
"example": "gke-test-native-vpc-pods-5cb557f7"
}
}
}
}
},
"subnetName": {
"type": "string",
"description": "Subnet identifier for the Ocean cluster.",
"example": "default"
},
"instanceTypes": {
"type": "object",
"description": "The type of instances that may or may not be a part of the Ocean cluster.",
"properties": {
"whitelist": {
"type": "array",
"items": {
"type": "string"
},
"description": "Instance types allowed in the Ocean cluster.\n",
"example": [
"n1-standard-2"
]
}
}
},
"launchSpecification": {
"type": "object",
"properties": {
"sourceImage": {
"type": "string",
"description": "URL of the image used to launch the instances.",
"example": "https://www.googleapis.com/compute/v1/projects/gke-node-images/global/images/gke-1117-gke12-cos-69-10895-138-0-v190225-pre"
},
"metadata": {
"type": "object",
"description": "Set array of cluster metadata.\n",
"properties": {
"key": {
"type": "string",
"description": "Key of metadata key-pair.\n",
"example": "example_key1"
},
"value": {
"type": "string",
"description": "Value of metadata key-pair.\n",
"example": "exmample_value1"
}
}
},
"tags": {
"type": "array",
"description": "Every node launched from this configuration will be tagged with those tags.",
"items": {
"type": "string"
},
"example": [
"gke-cluster-name-12345-node"
]
},
"ipForwarding": {
"type": "boolean",
"example": true
},
"serviceAccount": {
"type": "string",
"example": "265168459660-compute@developer.gserviceaccount.com"
},
"labels": {
"type": "array",
"description": "Set labels on cluster. You can set up to 60 labels.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "spotinst-gke-original-node-pool"
},
"value": {
"type": "string",
"example": "test-native-vpc__default-pool"
}
}
}
},
"rootVolumeSizeInGb": {
"type": "integer",
"description": "Optionally set root size (GB). Value should be greater than or equal to 100.",
"example": 100
}
}
},
"availabilityZones": {
"type": "array",
"items": {
"type": "string",
"example": [
"us-central1-a"
]
}
}
}
},
"createdAt": {
"type": "string",
"example": "2018-11-05T12:55:50.000+0000"
},
"updatedAt": {
"type": "string",
"example": "2018-11-05T12:58:15.000+0000"
}
}
},
"count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/cluster/gke/import": {
"summary": "Ocean for GKE",
"post": {
"summary": "Import GKE Cluster To Ocean",
"description": "Returns an Ocean Cluster configuration, and optionally Virtual Node Group (VNG) configurations based on a given GKE Cluster and its Node Pools.\\\nThe returned values (\"Imported Cluster/VNGs\") can then be used as inputs to the Create Cluster/VNG APIs in order to create the respectful resources.\n",
"operationId": "oceanGkeImportGkeToOcean",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "query",
"name": "location",
"schema": {
"type": "string"
},
"required": true,
"example": "us-central1-a",
"description": "Location GKE Cluster Master.\n"
},
{
"in": "query",
"name": "clusterName",
"schema": {
"type": "string"
},
"required": true,
"example": "test-gke",
"description": "Name of the GKE Cluster.\n"
},
{
"in": "query",
"name": "nodePoolName",
"schema": {
"type": "string"
},
"example": "test",
"description": "Name of the Node Pool to use as a default for the Cluster configuration.\n"
},
{
"in": "query",
"name": "includeLaunchSpecs",
"example": true,
"description": "When set to \"true\", GKE cluster node pools will be imported to Ocean custom VNG (\"customLaunchSpec\") configurations.\n",
"schema": {
"type": "boolean",
"default": true
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"cluster"
],
"properties": {
"cluster": {
"type": "object",
"description": "The specification of the Ocean cluster.",
"required": [
"compute"
],
"properties": {
"name": {
"type": "string",
"example": "test",
"description": "Add a name for the Ocean cluster.\n"
},
"controllerClusterId": {
"type": "string",
"example": "test-123124",
"description": "Enter the Ocean cluster identifier.\n"
},
"capacity": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/capacity"
},
"instanceTypes": {
"type": "object",
"description": "The type of instances that may or may not be a part of the Ocean cluster.",
"properties": {
"whitelist": {
"type": "array",
"description": "Instance types allowed in the Ocean cluster. Cannot be configured if a deny list is configured.\n",
"items": {
"type": "string"
},
"example": [
"n1-standard-2"
]
},
"blacklist": {
"type": "array",
"description": "Instance types to avoid launching in the Ocean cluster. Cannot be configured if a permit list is configured.\n",
"items": {
"type": "string"
},
"example": [
"n2d-highcpu-96"
]
}
}
},
"autoScaler": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoScaler"
},
"availabilityZones": {
"type": "array",
"description": "An array holding availability zones, this configures the availability zones the Ocean may launch instances in per VNG. Can be null.\n",
"items": {
"type": "string"
},
"example": [
"us-central1-a",
"us-central1-b"
]
},
"backendServices": {
"type": "array",
"items": {
"type": "object",
"required": [
"backendServiceName"
],
"properties": {
"backendServiceName": {
"type": "string",
"example": "bserv-2"
},
"locationType": {
"type": "string",
"enum": [
"regional",
"global"
],
"example": "regional"
},
"scheme": {
"type": "string",
"description": "Required if locationType is set to \"regional\".\n",
"enum": [
"EXTERNAL",
"INTERNAL"
],
"example": "EXTERNAL"
},
"namedPorts": {
"type": "object",
"required": [
"name",
"ports"
],
"properties": {
"name": {
"type": "string",
"example": "https"
},
"ports": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
443,
8443
]
}
}
}
}
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean CKE Cluster Import Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/cluster/gke/import"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cluster": {
"type": "object",
"description": "The specification of the Ocean cluster.",
"properties": {
"name": {
"type": "string",
"example": "test",
"description": "Add a name for the Ocean cluster.\n"
},
"controllerClusterId": {
"type": "string",
"example": "test-123124",
"description": "Enter the Ocean cluster identifier.\n"
},
"gke": {
"type": "object",
"required": [
"clusterName",
"masterLocation"
],
"description": "Use existing GKE cluster.\n",
"properties": {
"clusterName": {
"type": "string",
"description": "Required for the cluster.gke object.\n",
"example": "test-cluster"
},
"masterLocation": {
"type": "string",
"description": "Required for the cluster.gke object.\n",
"example": "us-central1-a"
}
}
},
"autoScaler": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoScaler"
},
"autoUpdate": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoUpdate"
},
"capacity": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/capacity"
},
"compute": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/compute"
}
}
},
"customLaunchSpecs": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec~1import/post/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
}
}
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/gcp/k8s/launchSpec/{launchSpecId}/launchNodes": {
"put": {
"summary": "Launch Nodes In VNG",
"description": "Launch nodes in virtual node group.\n",
"operationId": "oceanGkeLaunchSpecLaunchNodes",
"tags": [
"Ocean GKE"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1launchSpec~1%7BlaunchSpecId%7D/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"launchRequest": {
"type": "object",
"title": "Ocean GKE Virtual Node Group Launch Request",
"required": [
"amount"
],
"properties": {
"amount": {
"description": "The number of nodes to launch.\n",
"type": "integer",
"example": 5
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Virtual Node Group Launch Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/gcp/k8s/launchSpec/ols-12345abc/launchNodes"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"launchSpecId": {
"type": "string",
"example": "ols-f73821bc"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"newInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instanceName": {
"type": "string",
"example": "sin-00b61aa5dde4-oesg-97499562",
"description": "Name of the node launched.\n"
},
"availabilityZone": {
"type": "string",
"example": "us-west-2b",
"description": "The availability zone the node is launched in.\n"
},
"instanceType": {
"type": "string",
"example": "c3.xlarge",
"description": "Type of the launched node.\n"
},
"lifeCycle": {
"type": "string",
"example": "Preemptible",
"description": "Preemptible or On Demand.\n"
}
}
}
}
}
}
},
"kind": {
"example": "spotinst:ocean:gcp:k8s:launchSpec:launchNodes"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster": {
"summary": "Ocean for AKS",
"post": {
"summary": "Create Cluster",
"description": "Creates an Ocean entity according to a given specification.\n\nNotes:
\n\nIt is recommended to import all necessary information from the existing AKS cluster using the Ocean [AKS Cluster Import](https://spec.dev.spot.io/#operation/oceanAKSClusterImport) API call and use its output to create a fully configured Ocean cluster.\n\nThe Ocean Controller is used to monitor the cluster resources and report back to Ocean SaaS. A properly functioning controller is mandatory for Ocean to operate.\n\nInstalling the controller can be easily done by Helm, Terraform or a script using the [guide](https://docs.flexera.com/spot/ocean/tutorials/spot-kubernetes-controller/ocean-controller-two-install?id=new-clusters-install-the-ocean-controller-version-2).
\n",
"operationId": "oceanAKSClusterCreate",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"cluster"
],
"properties": {
"cluster": {
"type": "object",
"description": "The Ocean cluster.\n",
"required": [
"name",
"controllerClusterId",
"aks",
"virtualNodeGroupTemplate"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"example": "o-134abcd",
"description": "Ocean cluster identifier.\n"
},
"name": {
"type": "string",
"example": "test",
"description": "Add a name for the Ocean cluster.\n"
},
"controllerClusterId": {
"type": "string",
"example": "test-123124",
"description": "Enter a unique Ocean cluster identifier. Cannot be updated.\n"
},
"aks": {
"type": "object",
"title": "Ocean AKS - AKS Cluster Configuration",
"required": [
"clusterName",
"resourceGroupName",
"region",
"infrastructureResourceGroupName"
],
"description": "AKS cluster configuration. Cannot be updated.\n",
"properties": {
"clusterName": {
"type": "string",
"description": "The name of the AKS Cluster.\n",
"example": "test-cluster"
},
"resourceGroupName": {
"type": "string",
"description": "The name of the cluster's resource group.\n",
"example": "TestResourceGroup"
},
"region": {
"type": "string",
"description": "The cluster's region.\n",
"example": "eastus"
},
"infrastructureResourceGroupName": {
"type": "string",
"description": "The name of the cluster's infrastructure resource group.\n",
"example": "MC_TestResourceGroup_test-cluster_eastus"
}
}
},
"autoScaler": {
"type": "object",
"title": "Ocean AKS Autoscaler",
"description": "The Ocean Kubernetes Autoscaler object.\n",
"properties": {
"isEnabled": {
"type": "boolean",
"description": "Enable the Ocean Kubernetes Autoscaler.\n",
"example": true
},
"resourceLimits": {
"type": "object",
"description": "Optionally set upper and lower bounds on the resource usage of the cluster.\n",
"properties": {
"maxVCpu": {
"type": "integer",
"description": "The maximum cpu in vCpu units that can be allocated to the cluster.\n",
"example": 750
},
"maxMemoryGib": {
"type": "integer",
"description": "The maximum memory in GiB units that can be allocated to the cluster.\n",
"example": 1500
}
}
},
"down": {
"type": "object",
"description": "Autoscaling scale down operations.\n",
"properties": {
"maxScaleDownPercentage": {
"type": "number",
"format": "double",
"minimum": 1,
"maximum": 100,
"description": "The maximum percentage allowed to scale down in a single scaling action.",
"example": 30
}
}
},
"enableAutomaticAndManualHeadroom": {
"type": "boolean",
"description": "Enable mixed mode for manual and automatic headroom.\nRelevant only when `headroom.automatic.isEnabled` is set to true.\nIf false, Ocean manages headroom automatically without combining with manual VNG headrooms.\n",
"example": true
},
"headroom": {
"type": "object",
"description": "Spare resource capacity management enabling fast assignment of pods without waiting for new resources to launch.\n",
"properties": {
"automatic": {
"type": "object",
"description": "Automatic headroom configuration.\n",
"properties": {
"isEnabled": {
"type": "boolean",
"description": "Enable automatic headroom. When set to True, Ocean configures and optimizes headroom automatically.\n"
},
"percentage": {
"type": "integer",
"description": "Optionally set a number between 0-200 to control the percentage of total cluster resources dedicated to headroom.\n",
"example": 5,
"minimum": 0,
"maximum": 200
}
}
}
}
}
}
},
"scheduling": {
"type": "object",
"description": "An object used to specify times when the cluster will turn off. Once the shutdown time will be over, the cluster will return to its previous state.\n",
"title": "Ocean AKS Scheduling",
"properties": {
"shutdownHours": {
"type": "object",
"description": "An object used to specify times that the nodes in the cluster will be taken down.\n",
"title": "Shutdown Hours",
"properties": {
"timeWindows": {
"type": "array",
"description": "The times that the shutdown hours will apply. Required if isEnabled is true.\n",
"items": {
"type": "string",
"example": "Sat:08:00-Sun:08:00"
}
},
"isEnabled": {
"type": "boolean",
"example": true,
"description": "Flag to enable or disable the shutdown hours mechanism. When False, the mechanism is deactivated, and the cluster remains in its current state.\n"
}
}
},
"tasks": {
"type": "array",
"description": "A list of scheduling tasks to preform on the cluster at a specific cron time.\n",
"items": {
"type": "object",
"required": [
"isEnabled",
"cronExpression",
"taskType"
],
"properties": {
"isEnabled": {
"type": "boolean",
"description": "Flag to enable or disable the scheduling task.\n"
},
"cronExpression": {
"type": "string",
"description": "A valid cron expression. The cron is running in UTC time zone and is in Unix cron format of Cron Expression Validator Script.\n",
"example": "0 1 * * *"
},
"taskType": {
"type": "string",
"description": "The type of the scheduling task.\n",
"enum": [
"clusterRoll",
"autoUpgradeVersion"
],
"example": "clusterRoll"
},
"parameters": {
"type": "object",
"description": "The parameters of the scheduling task. Each task type will have properties relevant only to it.\n",
"oneOf": [
{
"type": "object",
"description": "The parameters of the cluster roll scheduling task.\n",
"title": "Cluster Roll",
"properties": {
"batchSizePercentage": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The percentage of the cluster that will be rolled at each batch.\n",
"example": 20
},
"comment": {
"type": "string",
"description": "A comment to be added to the cluster roll.\n",
"example": "Scheduled cluster roll"
},
"respectPdb": {
"type": "boolean",
"description": "During the roll, if the parameter is set to true we honor PDB during the instance replacement.\n",
"example": true
},
"respectRestrictScaleDown": {
"type": "boolean",
"description": "During the roll, if the parameter is set to true we honor Restrict Scale Down label during the nodes replacement.\n",
"example": true
},
"batchMinHealthyPercentage": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The minimum percentage of the scaled nodes that should be healthy at each batch.\n",
"example": 80
},
"vngIds": {
"type": "array",
"description": "List of Virtual Node Group IDs to be rolled. If not set or set to null, cluster roll will be applied.\n",
"example": [
"vng-123456"
],
"items": {
"type": "string"
}
}
}
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1autoUpgrade/post/requestBody/content/application~1json/schema/allOf/0/properties/upgradeConfig"
}
]
}
}
}
},
"suspensionHours": {
"type": "object",
"description": "An object used to specify times that the cluster should be exempted from Ocean's scaling-down activities to ensure uninterrupted operations during critical periods.\n",
"title": "Suspension Hours",
"properties": {
"timeWindows": {
"type": "array",
"description": "The times that the suspension hours will apply. Required if isEnabled is true.\n",
"items": {
"type": "string",
"example": "Sat:08:00-Sun:08:00"
}
},
"isEnabled": {
"type": "boolean",
"example": true,
"description": "Flag to enable or disable the suspension hours mechanism. When False, the mechanism is deactivated, and the cluster remains in its current state.\n"
}
}
}
}
},
"logging": {
"type": "object",
"title": "Ocean AKS Logging",
"description": "The Ocean AKS Logging object.",
"required": [
"export"
],
"properties": {
"export": {
"type": "object",
"title": "The Ocean AKS Logging Export",
"description": "The Ocean AKS Logging Export object.",
"required": [
"azureBlob"
],
"properties": {
"azureBlob": {
"type": "object",
"title": "The Ocean AKS Logging Azure Blob Export",
"description": "Exports your cluster's logs to the storage account and container configured on the storage account [data integration](https://docs.flexera.com/spot/ocean/features/log-integration-with-azure-blob?id=log-integration-with-azure-blob) given.\nEach file contains logs of 3 minutes where each log is separated by a new line and saved as a JSON.\nThe file formats are `container`/`accountId`_`oceanId`_`oceanName`_`startTime`.log\n",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The identifier of The Azure Blob data integration to export the logs to.",
"example": "di-123"
}
}
}
}
}
}
},
"health": {
"type": "object",
"title": "Ocean AKS Health",
"description": "The Ocean AKS Health object.\n",
"properties": {
"shouldReplaceUnhealthyInstances": {
"type": "boolean",
"example": false,
"default": false,
"description": "'Indicates whether Ocean automatically replaces nodes that remain in a NotReady or Unschedulable state. When false, unhealthy nodes are detected but not replaced. When true, unhealthy nodes are automatically replaced.\n"
},
"gracePeriod": {
"type": "integer",
"example": 120,
"default": 120,
"minimum": 60,
"description": "The amount of time, in seconds, from the moment the node is registered and observed by Ocean until health checks for replacement purposes begin. Defines a grace period during which health checks are suppressed for newly observed nodes.\n"
},
"healthCheckUnhealthyDurationBeforeReplacement": {
"type": "integer",
"example": 180,
"default": 180,
"minimum": 120,
"maximum": 3600,
"description": "The amount of time, in seconds, a node is allowed to remain unhealthy after the grace period has elapsed before Ocean automatically replaces it.\n"
}
}
},
"virtualNodeGroupTemplate": {
"type": "object",
"title": "Ocean AKS Virtual Node Group Template",
"required": [
"availabilityZones"
],
"properties": {
"availabilityZones": {
"type": "array",
"description": "An Array holding Availability Zones, this configures the availability zones the Ocean may launch nodes in per VNG.\\\nSelect zone 0 if you have a workload that requires no availability zone redundancy (AZ=null). You can select this option either alone or together with other availability zones.\\\nIn case zone 0 is selected together with other availability zones, nodes of zone 0 will be scaled only for workloads that demand it.\n",
"items": {
"type": "string"
},
"example": [
"0",
"1",
"2",
"3"
]
},
"nodePoolProperties": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup/post/requestBody/content/application~1json/schema/allOf/0/properties/virtualNodeGroup/properties/nodePoolProperties"
},
"nodeCountLimits": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodeCountLimits"
},
"strategy": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/strategy"
},
"autoScale": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/autoScale"
},
"labels": {
"type": "object",
"description": "key-value pairs of labels to add to the virtual node group.\\\nOnly custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.\\\nThe following are not allowed:\n* \"kubernetes.azure.com/agentpool\"\n* \"kubernetes.io/arch\"* \"kubernetes.io/os\"\n* \"node.kubernetes.io/instance-type\"\n* \"topology.kubernetes.io/region\"\n* \"topology.kubernetes.io/zone\"\n* \"kubernetes.azure.com/cluster\"\n* \"kubernetes.azure.com/mode\"\n* \"kubernetes.azure.com/role\"\n* \"kubernetes.azure.com/scalesetpriority\"\n* \"kubernetes.io/hostname\"\n* \"kubernetes.azure.com/storageprofile\"\n* \"kubernetes.azure.com/storagetier\"\n* \"kubernetes.azure.com/instance-sku\"\n* \"kubernetes.azure.com/node-image-version\"\n* \"kubernetes.azure.com/subnet\"\n* \"kubernetes.azure.com/vnet\"\n* \"kubernetes.azure.com/ppg\"\n* \"kubernetes.azure.com/encrypted-set\"\n* \"kubernetes.azure.com/accelerator\"\n* \"kubernetes.azure.com/fips_enabled\"\n* \"kubernetes.azure.com/os-sku\"\n",
"example": {
"key": "value"
}
},
"taints": {
"type": "array",
"description": "Add taints to a virtual node group.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set taint key.\nThe following are not allowed:\n* \"kubernetes.azure.com/scalesetpriority\"\n"
},
"value": {
"type": "string",
"description": "Set taint value.\n"
},
"effect": {
"type": "string",
"description": "Set taint effect.\n",
"enum": [
"NoSchedule",
"PreferNoSchedule",
"NoExecute",
"PreferNoExecute"
]
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"tags": {
"type": "object",
"description": "A maximum of 20 unique key-value pairs for VM tags in the virtual node group.\nNote: Azure has a tag limit of 50 per node pool.\n"
},
"vmSizes": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/vmSizes"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/scheduling"
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
}
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean AKS Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:ocean:azure:np"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Clusters",
"description": "List the configurations for all Ocean clusters in the specified account.\n",
"operationId": "oceanAKSClusterList",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"description": "Ocean AKS Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"description": "The Ocean cluster.\n",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"example": "o-134abcd",
"description": "Ocean cluster identifier.\n"
},
"name": {
"type": "string",
"example": "test",
"description": "Add a name for the Ocean cluster.\n"
},
"controllerClusterId": {
"type": "string",
"example": "test-123124",
"description": "Enter a unique Ocean cluster identifier. Cannot be updated.\n"
},
"aks": {
"type": "object",
"title": "Ocean AKS - AKS Cluster Configuration",
"required": [
"clusterName",
"resourceGroupName",
"region",
"infrastructureResourceGroupName"
],
"description": "AKS cluster configuration. Cannot be updated.\n",
"properties": {
"clusterName": {
"type": "string",
"description": "The name of the AKS Cluster.\n",
"example": "test-cluster"
},
"resourceGroupName": {
"type": "string",
"description": "The name of the cluster's resource group.\n",
"example": "TestResourceGroup"
},
"region": {
"type": "string",
"description": "The cluster's region.\n",
"example": "eastus"
},
"infrastructureResourceGroupName": {
"type": "string",
"description": "The name of the cluster's infrastructure resource group.\n",
"example": "MC_TestResourceGroup_test-cluster_eastus"
}
}
},
"autoScaler": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoScaler"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/scheduling"
},
"logging": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/logging"
},
"health": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/health"
},
"virtualNodeGroupTemplate": {
"type": "object",
"title": "Ocean AKS Virtual Node Group Template",
"properties": {
"availabilityZones": {
"type": "array",
"description": "An Array holding Availability Zones, this configures the availability zones the Ocean may launch instances in per VNG.\n",
"items": {
"type": "string"
},
"example": [
"1",
"2",
"3"
]
},
"nodePoolProperties": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup/post/requestBody/content/application~1json/schema/allOf/0/properties/virtualNodeGroup/properties/nodePoolProperties"
},
"nodeCountLimits": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodeCountLimits"
},
"strategy": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/strategy"
},
"autoScale": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/autoScale"
},
"labels": {
"type": "object",
"description": "key-value pairs of labels to add to the virtual node group.\\\nOnly custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.\\\nThe following are not allowed:\n* \"kubernetes.azure.com/agentpool\"\n* \"kubernetes.io/arch\"* \"kubernetes.io/os\"\n* \"node.kubernetes.io/instance-type\"\n* \"topology.kubernetes.io/region\"\n* \"topology.kubernetes.io/zone\"\n* \"kubernetes.azure.com/cluster\"\n* \"kubernetes.azure.com/mode\"\n* \"kubernetes.azure.com/role\"\n* \"kubernetes.azure.com/scalesetpriority\"\n* \"kubernetes.io/hostname\"\n* \"kubernetes.azure.com/storageprofile\"\n* \"kubernetes.azure.com/storagetier\"\n* \"kubernetes.azure.com/instance-sku\"\n* \"kubernetes.azure.com/node-image-version\"\n* \"kubernetes.azure.com/subnet\"\n* \"kubernetes.azure.com/vnet\"\n* \"kubernetes.azure.com/ppg\"\n* \"kubernetes.azure.com/encrypted-set\"\n* \"kubernetes.azure.com/accelerator\"\n* \"kubernetes.azure.com/fips_enabled\"\n* \"kubernetes.azure.com/os-sku\"\n",
"example": {
"key": "value"
}
},
"taints": {
"type": "array",
"description": "Add taints to a virtual node group.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set taint key.\nThe following are not allowed:\n* \"kubernetes.azure.com/scalesetpriority\"\n"
},
"value": {
"type": "string",
"description": "Set taint value.\n"
},
"effect": {
"type": "string",
"description": "Set taint effect.\n",
"enum": [
"NoSchedule",
"PreferNoSchedule",
"NoExecute",
"PreferNoExecute"
]
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"tags": {
"type": "object",
"description": "A maximum of 20 unique key-value pairs for VM tags in the virtual node group.\nNote: Azure has a tag limit of 50 per node pool.\n"
},
"vmSizes": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/vmSizes"
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
}
}
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T08:13:08.000Z",
"description": "A timestamp of the Ocean creation.\n"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T15:06:13.000Z",
"description": "A timestamp of the latest Ocean update.\n"
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:np"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}": {
"get": {
"summary": "Get Cluster",
"description": "Get the configurations for a specified Ocean cluster.\n",
"operationId": "oceanAKSClusterGet",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean AKS Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:ocean:azure:np"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"put": {
"summary": "Update Cluster",
"description": "Update a specified Ocean cluster.\n
\nThis API supports partial updates, so specific fields can be updated separately.\n\nNotes:\n
\nWhen labels, tags and taints are updated in the VNG template, all existing nodes from VNGs that inherit these properties\nfrom the tamplate will be updated as well.\n",
"operationId": "oceanAKSClusterUpdate",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"cluster"
],
"properties": {
"cluster": {
"type": "object",
"description": "The Ocean cluster.\n",
"properties": {
"name": {
"type": "string",
"example": "test",
"description": "A name for the Ocean cluster.\n"
},
"autoScaler": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoScaler"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/scheduling"
},
"logging": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/logging"
},
"health": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/health"
},
"virtualNodeGroupTemplate": {
"type": "object",
"title": "Ocean AKS Virtual Node Group Template",
"properties": {
"availabilityZones": {
"type": "array",
"description": "An Array holding Availability Zones, this configures the availability zones the Ocean may launch instances in per VNG.\n",
"items": {
"type": "string"
},
"example": [
"1",
"2",
"3"
]
},
"nodePoolProperties": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodePoolProperties"
},
"nodeCountLimits": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodeCountLimits"
},
"strategy": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/strategy"
},
"autoScale": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/autoScale"
},
"labels": {
"type": "object",
"description": "key-value pairs of labels to add to the virtual node group.\\\nOnly custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.\\\nThe following are not allowed:\n* \"kubernetes.azure.com/agentpool\"\n* \"kubernetes.io/arch\"* \"kubernetes.io/os\"\n* \"node.kubernetes.io/instance-type\"\n* \"topology.kubernetes.io/region\"\n* \"topology.kubernetes.io/zone\"\n* \"kubernetes.azure.com/cluster\"\n* \"kubernetes.azure.com/mode\"\n* \"kubernetes.azure.com/role\"\n* \"kubernetes.azure.com/scalesetpriority\"\n* \"kubernetes.io/hostname\"\n* \"kubernetes.azure.com/storageprofile\"\n* \"kubernetes.azure.com/storagetier\"\n* \"kubernetes.azure.com/instance-sku\"\n* \"kubernetes.azure.com/node-image-version\"\n* \"kubernetes.azure.com/subnet\"\n* \"kubernetes.azure.com/vnet\"\n* \"kubernetes.azure.com/ppg\"\n* \"kubernetes.azure.com/encrypted-set\"\n* \"kubernetes.azure.com/accelerator\"\n* \"kubernetes.azure.com/fips_enabled\"\n* \"kubernetes.azure.com/os-sku\"\n",
"example": {
"key": "value"
}
},
"taints": {
"type": "array",
"description": "Add taints to a virtual node group.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set taint key.\nThe following are not allowed:\n* \"kubernetes.azure.com/scalesetpriority\"\n"
},
"value": {
"type": "string",
"description": "Set taint value.\n"
},
"effect": {
"type": "string",
"description": "Set taint effect.\n",
"enum": [
"NoSchedule",
"PreferNoSchedule",
"NoExecute",
"PreferNoExecute"
]
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"tags": {
"type": "object",
"description": "A maximum of 20 unique key-value pairs for VM tags in the virtual node group.\nNote: Azure has a tag limit of 50 per node pool.\n"
},
"vmSizes": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/vmSizes"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/scheduling"
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
}
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean AKS Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:ocean:azure:np"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"delete": {
"summary": "Delete Cluster",
"description": "Delete a specified Ocean cluster.\n",
"operationId": "oceanAKSClusterDelete",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean AKS Delete Cluster Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc"
},
"method": {
"example": "DELETE"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/aks/import": {
"post": {
"summary": "Import Cluster",
"description": "The Import Cluster API call returns a JSON formatted Ocean cluster specification for a given AKS cluster and import identifier.\nThe returned specification is ready to use in the [Ocean AKS Cluster Create](https://spec.dev.spot.io/#operation/oceanAKSClusterCreate) API call.\n",
"operationId": "oceanAKSClusterImport",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "query",
"name": "resourceGroupName",
"example": "test-clust_group",
"description": "The name of the resource group of the AKS cluster.\n",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "aksClusterName",
"example": "test-cluster",
"description": "The name of the aks cluster.\n",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Ocean AKS Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/aks/import"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cluster": {
"type": "object",
"description": "The Ocean cluster.\n",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"example": "o-134abcd",
"description": "Ocean cluster identifier.\n"
},
"name": {
"type": "string",
"example": "test",
"description": "Add a name for the Ocean cluster.\n"
},
"controllerClusterId": {
"type": "string",
"example": "test-123124",
"description": "Enter a unique Ocean cluster identifier. Cannot be updated.\n"
},
"aks": {
"type": "object",
"title": "Ocean AKS - AKS Cluster Configuration",
"required": [
"clusterName",
"resourceGroupName",
"region",
"infrastructureResourceGroupName"
],
"description": "AKS cluster configuration. Cannot be updated.\n",
"properties": {
"clusterName": {
"type": "string",
"description": "The name of the AKS Cluster.\n",
"example": "test-cluster"
},
"resourceGroupName": {
"type": "string",
"description": "The name of the cluster's resource group.\n",
"example": "TestResourceGroup"
},
"region": {
"type": "string",
"description": "The cluster's region.\n",
"example": "eastus"
},
"infrastructureResourceGroupName": {
"type": "string",
"description": "The name of the cluster's infrastructure resource group.\n",
"example": "MC_TestResourceGroup_test-cluster_eastus"
}
}
},
"autoScaler": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/autoScaler"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/scheduling"
},
"health": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster/post/requestBody/content/application~1json/schema/allOf/0/properties/cluster/properties/health"
},
"virtualNodeGroupTemplate": {
"type": "object",
"title": "Ocean AKS Virtual Node Group Template",
"properties": {
"availabilityZones": {
"type": "array",
"description": "An Array holding Availability Zones, this configures the availability zones the Ocean may launch instances in per VNG.\n",
"items": {
"type": "string"
},
"example": [
"1",
"2",
"3"
]
},
"nodePoolProperties": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup/post/requestBody/content/application~1json/schema/allOf/0/properties/virtualNodeGroup/properties/nodePoolProperties"
},
"nodeCountLimits": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodeCountLimits"
},
"strategy": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/strategy"
},
"labels": {
"type": "object",
"description": "key-value pairs of labels to add to the virtual node group.\\\nOnly custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.\\\nThe following are not allowed:\n* \"kubernetes.azure.com/agentpool\"\n* \"kubernetes.io/arch\"* \"kubernetes.io/os\"\n* \"node.kubernetes.io/instance-type\"\n* \"topology.kubernetes.io/region\"\n* \"topology.kubernetes.io/zone\"\n* \"kubernetes.azure.com/cluster\"\n* \"kubernetes.azure.com/mode\"\n* \"kubernetes.azure.com/role\"\n* \"kubernetes.azure.com/scalesetpriority\"\n* \"kubernetes.io/hostname\"\n* \"kubernetes.azure.com/storageprofile\"\n* \"kubernetes.azure.com/storagetier\"\n* \"kubernetes.azure.com/instance-sku\"\n* \"kubernetes.azure.com/node-image-version\"\n* \"kubernetes.azure.com/subnet\"\n* \"kubernetes.azure.com/vnet\"\n* \"kubernetes.azure.com/ppg\"\n* \"kubernetes.azure.com/encrypted-set\"\n* \"kubernetes.azure.com/accelerator\"\n* \"kubernetes.azure.com/fips_enabled\"\n* \"kubernetes.azure.com/os-sku\"\n",
"example": {
"key": "value"
}
},
"taints": {
"type": "array",
"description": "Add taints to a virtual node group.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set taint key.\nThe following are not allowed:\n* \"kubernetes.azure.com/scalesetpriority\"\n"
},
"value": {
"type": "string",
"description": "Set taint value.\n"
},
"effect": {
"type": "string",
"description": "Set taint effect.\n",
"enum": [
"NoSchedule",
"PreferNoSchedule",
"NoExecute",
"PreferNoExecute"
]
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"tags": {
"type": "object",
"description": "A maximum of 10 unique key-value pairs for VM tags in the virtual node group.\n"
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
}
}
}
}
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:np"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/launchNewNodes": {
"put": {
"summary": "Launch New Nodes",
"description": "Launch new nodes for a cluster.\n",
"operationId": "oceanAKSClusterLaunchNodes",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Ocean AKS Launch Request",
"required": [
"oceanId",
"adjustment"
],
"properties": {
"oceanId": {
"type": "string",
"example": "o-134abcd",
"description": "Ocean cluster identifier.\n"
},
"vngIds": {
"type": "array",
"minimum": 1,
"items": {
"type": "string",
"example": "vng-12345abc",
"description": "Virtual node group identifier.\n"
}
},
"preferredLifecycle": {
"type": "string",
"enum": [
"Spot",
"Regular"
],
"description": "The preferred life cycle to launch the node.\nIf not specified, the life cycle is chosen accoring to the scaled VNG.\n",
"example": "Spot"
},
"availabilityZones": {
"type": "array",
"description": "An Array holding Availability Zones, this configures the availability zones the Ocean may launch instances in per VNG.\n",
"items": {
"type": "string"
},
"example": [
"1",
"2",
"3"
]
},
"adjustment": {
"type": "integer",
"description": "The number of nodes to launch.\n",
"example": 2,
"minimum": 1
},
"minCoresPerNode": {
"type": "integer",
"description": "Minimum number of core per node.",
"example": 2,
"minimum": 2
},
"minMemoryGiBPerNode": {
"type": "number",
"format": "float",
"description": "Minimum memory per node.",
"example": 2,
"minimum": 2
},
"applicableVmSizes": {
"type": "array",
"minimum": 1,
"items": {
"type": "string",
"description": "Applicable VM sizes.\n"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Ocean Cluster Launch Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/launchNewNodes"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"vngScalingUpResults": {
"type": "array",
"description": "Virtual node group identifier.\n",
"items": {
"type": "object",
"description": "vng scaling up results\n",
"properties": {
"vngId": {
"type": "string",
"example": "vng-12345abc"
},
"scaleNodePoolName": {
"type": "string",
"example": "omnp9e26aa3e"
},
"vmSizeName": {
"type": "string",
"example": "standard_d2as_v5"
},
"zones": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"1"
]
},
"lifeCycle": {
"type": "string",
"example": "Spot"
},
"numOfNewScaleNodes": {
"type": "integer",
"example": 1
}
}
}
},
"nodesLeftToScale": {
"type": "integer",
"description": "The number of nodes left to scale.\n",
"example": 0
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:np:cluster:launchNodes"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/detachNodes": {
"put": {
"summary": "Detach Nodes",
"description": "Detach Nodes nodes for a cluster.\n",
"operationId": "oceanAKSV2ClusterDetachNodes",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Ocean AKS Detach Request",
"required": [
"oceanId",
"nodeNamesToDetach"
],
"properties": {
"oceanId": {
"type": "string",
"example": "o-134abcd",
"description": "Ocean cluster identifier.\n"
},
"nodeNamesToDetach": {
"type": "array",
"minimum": 1,
"description": "Node names to detach from the Ocean cluster.\n",
"items": {
"type": "string",
"example": "aks-omnpf52d2a6b-36204769-vmss000012"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Detach ocean nodes response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/detachNodes"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"oceanId": {
"type": "string",
"example": "o-134abcd",
"description": "Ocean cluster identifier.\n"
},
"detachedNodeNames": {
"type": "array",
"minimum": 1,
"description": "Node names to detach from the Ocean cluster.\n",
"items": {
"type": "string",
"example": "aks-omnpf52d2a6b-36204769-vmss000012"
}
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:np:cluster:detachNodes"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/virtualNodeGroup": {
"post": {
"summary": "Create Virtual Node Group",
"description": "Create a virtual node group.\n",
"operationId": "oceanAKSVirtualNodeGroupCreate",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"virtualNodeGroup"
],
"properties": {
"virtualNodeGroup": {
"type": "object",
"title": "Ocean AKS Virtual Node Group",
"required": [
"oceanId",
"name"
],
"properties": {
"name": {
"type": "string",
"example": "testVng",
"description": "Enter a name for the virtual node group.\n"
},
"oceanId": {
"type": "string",
"example": "o-134abcd",
"description": "Ocean cluster identifier.\n"
},
"availabilityZones": {
"type": "array",
"description": "An Array holding Availability Zones, this configures the availability zones the Ocean may launch nodes in per VNG.\\\nSelect zone 0 if you have a workload that requires no availability zone redundancy (AZ=null). You can select this option either alone or together with other availability zones.\\\nIn case zone 0 is selected together with other availability zones, nodes of zone 0 will be scaled only for workloads that demand it.\n",
"items": {
"type": "string"
},
"example": [
"0",
"1",
"2",
"3"
]
},
"nodePoolProperties": {
"type": "object",
"title": "Ocean AKS Node Pool Properties",
"description": "The Ocean Node Pool Properties.\n",
"properties": {
"maxPodsPerNode": {
"type": "integer",
"description": "The maximum number of pods per node in the node pools.\n",
"minimum": 0,
"maximum": 250,
"example": 30,
"default": 110
},
"enableNodePublicIP": {
"description": "enable node public IP.\n",
"type": "boolean",
"example": true,
"default": false
},
"osDiskSizeGB": {
"type": "integer",
"description": "The size of the OS disk in GB. \nFor Linux OS, the minimum size is 32GB and for Windows OS the minimum is 128GB.\n",
"maximum": 1023,
"example": 64,
"default": 128
},
"osDiskType": {
"type": "string",
"description": "The type of the OS disk.\n",
"enum": [
"Managed",
"Ephemeral"
],
"example": "Managed",
"default": "Ephemeral"
},
"osType": {
"type": "string",
"description": "The OS type of the OS disk.\n",
"enum": [
"Linux",
"Windows"
],
"example": "Linux"
},
"osSKU": {
"type": "string",
"description": "The OS SKU of the OS type. Must correlate with the os type.\n",
"enum": [
"Ubuntu",
"AzureLinux",
"CBLMariner",
"Windows2019",
"Windows2022"
],
"example": "Ubuntu",
"default": "Ubuntu"
},
"kubernetesVersion": {
"type": "string",
"description": "The desired Kubernetes version of the launched nodes.\nIn case the value is null, the Kubernetes version of the control plane\nis used.\n",
"example": 1.26
},
"vnetSubnetIDs": {
"type": "array",
"description": "The IDs of subnets in an existing VNet into which to assign nodes in the cluster (requires azure network-plugin).\n",
"items": {
"type": "string"
},
"example": [
"/subscriptions/123456-1234-1234-1234-123456789/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/virtualNetworks/ExampleVirtualNetwork/subnets/default"
]
},
"podSubnetIDs": {
"type": "array",
"description": "The IDs of subnets in an existing VNet into which to assign pods in the cluster (requires azure network-plugin).\n",
"items": {
"type": "string"
},
"example": [
"/subscriptions/123456-1234-1234-1234-123456789/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/virtualNetworks/ExampleVirtualNetwork/subnets/default"
]
},
"linuxOSConfig": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodePoolProperties/properties/linuxOSConfig"
},
"localDnsProfile": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodePoolProperties/properties/localDnsProfile"
},
"encryptionAtHost": {
"type": "boolean",
"description": "Whether to enable host-based encryption for nodes launched from this virtual node group.\nWhen set to true, use vmSizes.preferredVmSizes to provide compatible VM sizes.\n\nIMPORTANT: This setting is immutable at the Azure infrastructure level once nodes are launched.\nChanging this value requires a roll operation for new nodes to reflect the updated configuration.\n",
"example": true,
"default": false
}
}
},
"nodeCountLimits": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodeCountLimits"
},
"strategy": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/strategy"
},
"autoScale": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/autoScale"
},
"labels": {
"type": "object",
"description": "key-value pairs of labels to add to the virtual node group.\\\nOnly custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.\\\nThe following are not allowed:\n* \"kubernetes.azure.com/agentpool\"\n* \"kubernetes.io/arch\"* \"kubernetes.io/os\"\n* \"node.kubernetes.io/instance-type\"\n* \"topology.kubernetes.io/region\"\n* \"topology.kubernetes.io/zone\"\n* \"kubernetes.azure.com/cluster\"\n* \"kubernetes.azure.com/mode\"\n* \"kubernetes.azure.com/role\"\n* \"kubernetes.azure.com/scalesetpriority\"\n* \"kubernetes.io/hostname\"\n* \"kubernetes.azure.com/storageprofile\"\n* \"kubernetes.azure.com/storagetier\"\n* \"kubernetes.azure.com/instance-sku\"\n* \"kubernetes.azure.com/node-image-version\"\n* \"kubernetes.azure.com/subnet\"\n* \"kubernetes.azure.com/vnet\"\n* \"kubernetes.azure.com/ppg\"\n* \"kubernetes.azure.com/encrypted-set\"\n* \"kubernetes.azure.com/accelerator\"\n* \"kubernetes.azure.com/fips_enabled\"\n* \"kubernetes.azure.com/os-sku\"\n",
"example": {
"key": "value"
}
},
"taints": {
"type": "array",
"description": "Add taints to a virtual node group.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set taint key.\nThe following are not allowed:\n* \"kubernetes.azure.com/scalesetpriority\"\n"
},
"value": {
"type": "string",
"description": "Set taint value.\n"
},
"effect": {
"type": "string",
"description": "Set taint effect.\n",
"enum": [
"NoSchedule",
"PreferNoSchedule",
"NoExecute",
"PreferNoExecute"
]
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"tags": {
"type": "object",
"description": "A maximum of 20 unique key-value pairs for VM tags in the virtual node group.\nNote: Azure has a tag limit of 50 per node pool.\n"
},
"vmSizes": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/vmSizes"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/scheduling"
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Virtual Node Group Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/virtualNodeGroup"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:ocean:azure:np:virtualNodeGroup"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Virtual Node Groups",
"description": "List the configurations for all virtual node groups in the account or in a specified cluster.\n",
"operationId": "oceanAKSVirtualNodeGroupList",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean Virtual Node Group Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/virtualNodeGroup"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Ocean AKS Virtual Node Group",
"properties": {
"id": {
"type": "string",
"description": "Virtual Node Group identifier.\n",
"example": "vng-134abcd"
},
"name": {
"type": "string",
"example": "testVng",
"description": "Enter a name for the virtual node group.\n"
},
"oceanId": {
"type": "string",
"readOnly": true,
"example": "o-134abcd",
"description": "Ocean cluster identifier.\n"
},
"availabilityZones": {
"type": "array",
"description": "An Array holding Availability Zones, this configures the availability zones the Ocean may launch instances in per VNG.\n",
"items": {
"type": "string"
},
"example": [
"1",
"2",
"3"
]
},
"nodePoolProperties": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup/post/requestBody/content/application~1json/schema/allOf/0/properties/virtualNodeGroup/properties/nodePoolProperties"
},
"nodeCountLimits": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodeCountLimits"
},
"strategy": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/strategy"
},
"autoScale": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/autoScale"
},
"labels": {
"type": "object",
"description": "key-value pairs of labels to add to the virtual node group.\\\nOnly custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.\\\nThe following are not allowed:\n* \"kubernetes.azure.com/agentpool\"\n* \"kubernetes.io/arch\"* \"kubernetes.io/os\"\n* \"node.kubernetes.io/instance-type\"\n* \"topology.kubernetes.io/region\"\n* \"topology.kubernetes.io/zone\"\n* \"kubernetes.azure.com/cluster\"\n* \"kubernetes.azure.com/mode\"\n* \"kubernetes.azure.com/role\"\n* \"kubernetes.azure.com/scalesetpriority\"\n* \"kubernetes.io/hostname\"\n* \"kubernetes.azure.com/storageprofile\"\n* \"kubernetes.azure.com/storagetier\"\n* \"kubernetes.azure.com/instance-sku\"\n* \"kubernetes.azure.com/node-image-version\"\n* \"kubernetes.azure.com/subnet\"\n* \"kubernetes.azure.com/vnet\"\n* \"kubernetes.azure.com/ppg\"\n* \"kubernetes.azure.com/encrypted-set\"\n* \"kubernetes.azure.com/accelerator\"\n* \"kubernetes.azure.com/fips_enabled\"\n* \"kubernetes.azure.com/os-sku\"\n",
"example": {
"key": "value"
}
},
"taints": {
"type": "array",
"description": "Add taints to a virtual node group.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set taint key.\nThe following are not allowed:\n* \"kubernetes.azure.com/scalesetpriority\"\n"
},
"value": {
"type": "string",
"description": "Set taint value.\n"
},
"effect": {
"type": "string",
"description": "Set taint effect.\n",
"enum": [
"NoSchedule",
"PreferNoSchedule",
"NoExecute",
"PreferNoExecute"
]
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"tags": {
"type": "object",
"description": "A maximum of 20 unique key-value pairs for VM tags in the virtual node group.\nNote: Azure has a tag limit of 50 per node pool.\n"
},
"vmSizes": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/vmSizes"
},
"scheduling": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/scheduling"
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T08:13:08.000Z",
"description": "A timestamp of the Ocean creation.\n"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T15:06:13.000Z",
"description": "A timestamp of the latest Ocean update.\n"
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:np:virtualNodeGroup"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/virtualNodeGroup/{virtualNodeGroupId}": {
"get": {
"summary": "Get Virtual Node Group",
"description": "Get the configuration of a specified virtual node group.\n",
"operationId": "oceanAKSVirtualNodeGroupGet",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "path",
"name": "virtualNodeGroupId",
"example": "vng-12345abc",
"description": "Ocean Virtual Node Group identifier.\n",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Ocean Virtual Node Group Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/virtualNodeGroup/vng-12345abc"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:ocean:azure:np:virtualNodeGroup"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"put": {
"summary": "Update Virtual Node Group",
"description": "Update a specified virtual node group in an Ocean cluster.\n
\nThis API supports partial updates, so specific fields can be updated separately.\n\nNotes:\n
\nWhen labels, tags and taints are updated the existing nodes are updated as well.\n",
"operationId": "oceanAKSVirtualNodeGroupUpdate",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/get/parameters/1"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"virtualNodeGroup"
],
"properties": {
"virtualNodeGroup": {
"type": "object",
"title": "Ocean AKS Virtual Node Group",
"properties": {
"name": {
"type": "string",
"example": "testVng",
"description": "Enter a name for the virtual node group.\n"
},
"availabilityZones": {
"type": "array",
"description": "An Array holding Availability Zones, this configures the availability zones the Ocean may launch instances in per VNG.\n",
"items": {
"type": "string"
},
"example": [
"1",
"2",
"3"
]
},
"nodePoolProperties": {
"type": "object",
"title": "Ocean AKS Node Pool Properties",
"description": "The Ocean Node Pool Properties.\n",
"properties": {
"maxPodsPerNode": {
"type": "integer",
"description": "The maximum number of pods per node in the node pools.\n",
"minimum": 0,
"maximum": 250,
"example": 30
},
"enableNodePublicIP": {
"description": "enable node public IP.\n",
"type": "boolean",
"example": true
},
"osDiskSizeGB": {
"type": "integer",
"description": "The size of the OS disk in GB. \nFor Linux OS, the minimum size is 32GB and for Windows OS the minimum is 128GB.\n",
"maximum": 1023,
"example": 64
},
"osDiskType": {
"type": "string",
"description": "The type of the OS disk.\n",
"enum": [
"Managed",
"Ephemeral"
],
"example": "Ephemeral"
},
"osSKU": {
"type": "string",
"description": "The OS SKU of the OS type. Must correlate with the os type.\n",
"enum": [
"Ubuntu",
"AzureLinux",
"CBLMariner",
"Windows2019",
"Windows2022"
],
"example": "Ubuntu"
},
"kubernetesVersion": {
"type": "string",
"description": "The desired Kubernetes version of the luanched nodes.\nIn case the value is null, the Kubernetes version of the control plane\nis used.\n",
"example": 1.26
},
"vnetSubnetIDs": {
"type": "array",
"description": "The IDs of subnets in an existing VNet into which to assign nodes in the cluster (requires azure network-plugin).\n",
"items": {
"type": "string"
},
"example": [
"/subscriptions/123456-1234-1234-1234-123456789/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/virtualNetworks/ExampleVirtualNetwork/subnets/default"
]
},
"podSubnetIDs": {
"type": "array",
"description": "The IDs of subnets in an existing VNet into which to assign pods in the cluster (requires azure network-plugin).\n",
"items": {
"type": "string"
},
"example": [
"/subscriptions/123456-1234-1234-1234-123456789/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/virtualNetworks/ExampleVirtualNetwork/subnets/default"
]
},
"linuxOSConfig": {
"type": "object",
"title": "Ocean AKS Linux OS Config",
"description": "Custom Linux OS configuration\n",
"properties": {
"sysctls": {
"type": "object",
"properties": {
"vmMaxMapCount": {
"type": "integer",
"description": "Maximum number of memory map areas a process may have.\nCan be configured only if OS type is Linux.\n",
"example": 79550,
"minimum": 65530,
"maximum": 262144
}
}
}
}
},
"localDnsProfile": {
"type": "object",
"title": "Ocean AKS LocalDNS Profile",
"description": "AKS LocalDNS profile configuration for the VNG.\nRequires VM sizes with at least 4 vCPUs and Linux (Ubuntu 22.04+ or Azure Linux) OS.\nSee: https://learn.microsoft.com/en-us/azure/aks/localdns-custom\n",
"example": {
"mode": "Required",
"vnetDNSOverrides": {
".": {
"queryLogging": "Error",
"protocol": "PreferUDP",
"forwardDestination": "VnetDNS",
"forwardPolicy": "Sequential",
"maxConcurrent": 1000,
"cacheDurationInSeconds": 3600,
"serveStaleDurationInSeconds": 3600,
"serveStale": "Immediate"
},
"cluster.local": {
"queryLogging": "Error",
"protocol": "ForceTCP",
"forwardDestination": "ClusterCoreDNS",
"forwardPolicy": "Sequential",
"maxConcurrent": 1000,
"cacheDurationInSeconds": 3600,
"serveStaleDurationInSeconds": 3600,
"serveStale": "Immediate"
}
},
"kubeDNSOverrides": {
".": {
"queryLogging": "Error",
"protocol": "PreferUDP",
"forwardDestination": "ClusterCoreDNS",
"forwardPolicy": "Sequential",
"maxConcurrent": 1000,
"cacheDurationInSeconds": 3600,
"serveStaleDurationInSeconds": 3600,
"serveStale": "Immediate"
},
"cluster.local": {
"queryLogging": "Error",
"protocol": "ForceTCP",
"forwardDestination": "ClusterCoreDNS",
"forwardPolicy": "Sequential",
"maxConcurrent": 1000,
"cacheDurationInSeconds": 3600,
"serveStaleDurationInSeconds": 3600,
"serveStale": "Immediate"
}
}
},
"properties": {
"mode": {
"type": "string",
"enum": [
"Required",
"Preferred",
"Disabled"
],
"description": "The LocalDNS mode. Required when localDnsProfile is configured.",
"example": "Required"
},
"vnetDNSOverrides": {
"type": "object",
"description": "Per-zone DNS override configuration for VNet DNS resolution.\nKeys are DNS zone names (e.g. \".\" or \"cluster.local\").\n\nExample:\n\n```json\n{\n \".\": {\n \"queryLogging\": \"Error\",\n \"protocol\": \"PreferUDP\",\n \"forwardDestination\": \"VnetDNS\",\n \"forwardPolicy\": \"Sequential\",\n \"maxConcurrent\": 1000,\n \"cacheDurationInSeconds\": 3600,\n \"serveStaleDurationInSeconds\": 3600,\n \"serveStale\": \"Immediate\"\n },\n \"cluster.local\": {\n \"queryLogging\": \"Error\",\n \"protocol\": \"ForceTCP\",\n \"forwardDestination\": \"ClusterCoreDNS\",\n \"forwardPolicy\": \"Sequential\",\n \"maxConcurrent\": 1000,\n \"cacheDurationInSeconds\": 3600,\n \"serveStaleDurationInSeconds\": 3600,\n \"serveStale\": \"Immediate\"\n }\n}\n```\n"
},
"kubeDNSOverrides": {
"type": "object",
"description": "Per-zone DNS override configuration for kube-dns/CoreDNS resolution.\nKeys are DNS zone names (e.g. \".\" or \"cluster.local\").\n\nExample:\n\n```json\n{\n \".\": {\n \"queryLogging\": \"Error\",\n \"protocol\": \"PreferUDP\",\n \"forwardDestination\": \"ClusterCoreDNS\",\n \"forwardPolicy\": \"Sequential\",\n \"maxConcurrent\": 1000,\n \"cacheDurationInSeconds\": 3600,\n \"serveStaleDurationInSeconds\": 3600,\n \"serveStale\": \"Immediate\"\n },\n \"cluster.local\": {\n \"queryLogging\": \"Error\",\n \"protocol\": \"ForceTCP\",\n \"forwardDestination\": \"ClusterCoreDNS\",\n \"forwardPolicy\": \"Sequential\",\n \"maxConcurrent\": 1000,\n \"cacheDurationInSeconds\": 3600,\n \"serveStaleDurationInSeconds\": 3600,\n \"serveStale\": \"Immediate\"\n }\n}\n```\n"
}
},
"required": [
"mode"
]
},
"encryptionAtHost": {
"type": "boolean",
"description": "Whether to enable host-based encryption for nodes launched from this virtual node group.\nWhen set to true, use vmSizes.preferredVmSizes to provide compatible VM sizes.\n\nIMPORTANT: This setting is immutable at the Azure infrastructure level once nodes are launched.\nChanging this value requires a roll operation for new nodes to reflect the updated configuration.\n",
"example": true,
"default": false
}
}
},
"nodeCountLimits": {
"type": "object",
"title": "Ocean AKS Node Count Limits",
"description": "Limit the number of nodes in a VNG.\n",
"properties": {
"minCount": {
"description": "Minimum node count limit.\n",
"type": "integer",
"minimum": 0,
"example": 1,
"default": 0
},
"maxCount": {
"description": "Maximum node count limit.\n",
"type": "integer",
"minimum": 0,
"example": 100,
"default": 1000
}
}
},
"strategy": {
"type": "object",
"title": "Ocean AKS Strategy",
"description": "The Ocean AKS Strategy object.\n",
"properties": {
"shouldUtilizeCommitments": {
"type": "boolean",
"description": "Determines whether to utilize any existing Azure Savings Plans or Reserved Instances associated with the subscription for On-Demand VMs.\n",
"example": true,
"default": false
},
"spotPercentage": {
"type": "integer",
"description": "Percentage of spot VMs to maintain.\n",
"example": 50,
"minimum": 0,
"maximum": 100
},
"fallbackToOd": {
"type": "boolean",
"description": "If no spot instance markets are available, enable Ocean to launch on-demand instances instead.\n",
"example": true
},
"drainingTimeout": {
"type": "integer",
"description": "Time in seconds to allow the node to drain before it is terminated.\n",
"example": 600,
"minimum": 300,
"maximum": 3600
}
}
},
"autoScale": {
"type": "object",
"description": "Object specifying the automatic scaling of an Ocean VNG.\n",
"title": "Ocean AKS Auto Scale",
"properties": {
"autoHeadroomPercentage": {
"type": "integer",
"description": "Optionally set a number between 0-200 to control the percentage of VNG resources dedicated to automatic headroom.\n",
"example": 5,
"minimum": 0,
"maximum": 200
},
"headrooms": {
"type": "array",
"description": "Specify the custom headroom per VNG. Provide a list of headroom objects.\n",
"title": "Headrooms",
"items": {
"type": "object",
"properties": {
"cpuPerUnit": {
"description": "Configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.\n",
"type": "integer",
"example": 1024,
"default": 0
},
"memoryPerUnit": {
"description": "Configure the amount of memory (MiB) to allocate the headroom.\n",
"type": "integer",
"example": 512,
"default": 0
},
"gpuPerUnit": {
"type": "integer",
"description": "Amont of GPU to allocate for headroom unit.\n",
"example": 0,
"default": 0
},
"numOfUnits": {
"description": "The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.\n",
"type": "integer",
"example": 2,
"default": 0
}
}
}
}
}
},
"labels": {
"type": "object",
"description": "key-value pairs of labels to add to the virtual node group.\\\nOnly custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.\\\nThe following are not allowed:\n* \"kubernetes.azure.com/agentpool\"\n* \"kubernetes.io/arch\"* \"kubernetes.io/os\"\n* \"node.kubernetes.io/instance-type\"\n* \"topology.kubernetes.io/region\"\n* \"topology.kubernetes.io/zone\"\n* \"kubernetes.azure.com/cluster\"\n* \"kubernetes.azure.com/mode\"\n* \"kubernetes.azure.com/role\"\n* \"kubernetes.azure.com/scalesetpriority\"\n* \"kubernetes.io/hostname\"\n* \"kubernetes.azure.com/storageprofile\"\n* \"kubernetes.azure.com/storagetier\"\n* \"kubernetes.azure.com/instance-sku\"\n* \"kubernetes.azure.com/node-image-version\"\n* \"kubernetes.azure.com/subnet\"\n* \"kubernetes.azure.com/vnet\"\n* \"kubernetes.azure.com/ppg\"\n* \"kubernetes.azure.com/encrypted-set\"\n* \"kubernetes.azure.com/accelerator\"\n* \"kubernetes.azure.com/fips_enabled\"\n* \"kubernetes.azure.com/os-sku\"\n",
"example": {
"key": "value"
}
},
"taints": {
"type": "array",
"description": "Add taints to a virtual node group.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set taint key.\nThe following are not allowed:\n* \"kubernetes.azure.com/scalesetpriority\"\n"
},
"value": {
"type": "string",
"description": "Set taint value.\n"
},
"effect": {
"type": "string",
"description": "Set taint effect.\n",
"enum": [
"NoSchedule",
"PreferNoSchedule",
"NoExecute",
"PreferNoExecute"
]
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"tags": {
"type": "object",
"description": "A maximum of 20 unique key-value pairs for VM tags in the virtual node group.\nNote: Azure has a tag limit of 50 per node pool.\n"
},
"vmSizes": {
"type": "object",
"title": "Ocean AKS VM Sizes",
"description": "The Ocean AKS VM Sizes object.\n",
"properties": {
"preferredVmSizes": {
"type": "array",
"description": "Preferred VM sizes for this virtual node group.\nUsed when nodePoolProperties.encryptionAtHost is true to constrain launches to compatible sizes.\n",
"items": {
"type": "string"
},
"example": [
"Standard_D4s_v3",
"Standard_D8s_v3"
]
},
"filters": {
"type": "object",
"description": "Filters for the VM sizes that can be launched from the virtual node group.\n",
"properties": {
"minVCpu": {
"description": "Minimum number of vcpus available.\n",
"type": "integer",
"minimum": 2,
"example": 2
},
"maxVCpu": {
"description": "Maximum number of vcpus available.\n",
"type": "integer",
"minimum": 2,
"example": 16
},
"minMemoryGiB": {
"description": "Minimum amount of Memory (GiB).\n",
"type": "number",
"format": "float",
"minimum": 4,
"example": 8
},
"maxMemoryGiB": {
"description": "Maximum amount of Memory (GiB).\n",
"type": "number",
"format": "float",
"minimum": 0,
"example": 16
},
"architectures": {
"type": "array",
"description": "The filtered vm sizes will support at least one of the architectures from this list.\nx86_64 includes both intel64 and amd64.\n",
"items": {
"type": "string",
"enum": [
"X86_64",
"INTEL64",
"AMD64",
"ARM64"
]
},
"example": [
"x86_64"
]
},
"series": {
"type": "array",
"description": "Only vm sizes belonging to a series from the list will be available for scaling.\n",
"items": {
"type": "string"
},
"example": [
"D v3",
"F",
"E v4"
]
},
"excludeSeries": {
"type": "array",
"description": "Vm sizes belonging to a series from the list will not be available for scaling.\n",
"items": {
"type": "string"
},
"example": [
"Bs",
"Da v4"
]
},
"minDisk": {
"description": "Minimum number of data disks available.\n",
"type": "integer",
"minimum": 1,
"maximum": 64,
"example": 1
},
"minGpu": {
"description": "Minimum number of GPUs available.\n",
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 8,
"example": 1
},
"maxGpu": {
"description": "Maximum number of GPUs available.\n",
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 8,
"example": 2
},
"diskPerformance": {
"type": "string",
"description": "The filtered vm sizes will support at least one of the classes from this list.\n",
"enum": [
"Standard",
"Premium"
],
"example": "Standard"
},
"acceleratedNetworking": {
"type": "string",
"description": "In case acceleratedNetworking is set to Enabled, accelerated networking applies only to the VM that enables it.\n",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled"
},
"minNICs": {
"description": "Minimum number of network interfaces.\n",
"type": "integer",
"minimum": 1,
"maximum": 16,
"example": 4
},
"vmTypes": {
"type": "array",
"description": "The filtered vm types will belong to one of the vm types from this list.\n",
"items": {
"type": "string",
"enum": [
"generalPurpose",
"memoryOptimized",
"computeOptimized",
"highPerformanceCompute",
"storageOptimized",
"GPU"
]
},
"example": [
"memoryOptimized"
]
},
"gpuTypes": {
"type": "array",
"description": "The filtered gpu types will belong to one of the gpu types from this list.\n",
"items": {
"type": "string",
"enum": [
"nvidia-tesla-v100",
"amd-radeon-instinct-mi25",
"nvidia-a10",
"nvidia-tesla-a100",
"nvidia-tesla-k80",
"nvidia-tesla-m60",
"nvidia-tesla-p100",
"nvidia-tesla-p40",
"nvidia-tesla-t4",
"nvidia-tesla-h100"
],
"example": [
"nvidia-tesla-t4"
]
}
}
}
}
}
},
"scheduling": {
"type": "object",
"description": "An object used to specify times when the virtual node group will turn off all its node pools. Once the shutdown time will be over, the virtual node group will return to its previous state.\n",
"title": "Ocean VNG AKS Scheduling",
"properties": {
"shutdownHours": {
"type": "object",
"description": "An object used to specify times that the nodes in the virtual node group will be stopped.\n",
"title": "Shutdown Hours",
"properties": {
"timeWindows": {
"type": "array",
"description": "The times that the shutdown hours will apply. Required if isEnabled is true.\n",
"items": {
"type": "string",
"example": "Sat:08:00-Sun:08:00"
}
},
"isEnabled": {
"type": "boolean",
"example": true,
"description": "Flag to enable or disable the shutdown hours mechanism. When False, the mechanism is deactivated, and the virtual node gorup remains in its current state.\n"
}
}
}
}
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Ocean Virtual Node Group Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/virtualNodeGroup/vng-12345abc"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:ocean:azure:np:virtualNodeGroup"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"delete": {
"summary": "Delete Virtual Node Group",
"description": "Delete a specified virtual node group in an Ocean cluster.\n",
"operationId": "oceanAKSVirtualNodeGroupDelete",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean AKS Virtual Node Group Delete Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/virtualNodeGroup/vng-12345abc"
},
"method": {
"example": "DELETE"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/virtualNodeGroup/import": {
"post": {
"summary": "Import Virtual Node Group",
"description": "The Import Ocean Virtual Node Group (VNG) returns a JSON formatted Ocean Virtual Node Group specification based on a given AKS Node Pool.\nThe returned specification is ready to use in the [Ocean AKS Virtual Node Group Create](https://spec.dev.spot.io/#operation/oceanAKSVirtualNodeGroupCreate) API call.\n",
"operationId": "oceanAKSVirtualNodeGroupImport",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1gcp~1k8s~1launchSpec/get/parameters/1"
},
{
"in": "query",
"name": "nodePoolName",
"description": "The name of the Node Pool.\n",
"schema": {
"type": "string"
},
"required": true,
"example": "nodePoolNameTest"
}
],
"responses": {
"200": {
"description": "Ocean AKS Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/virtualNodeGroup/import"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"virtualNodeGroup": {
"type": "object",
"title": "Ocean AKS Virtual Node Group",
"properties": {
"name": {
"type": "string",
"example": "testVng",
"description": "Enter a name for the virtual node group.\n"
},
"oceanId": {
"type": "string",
"readOnly": true,
"example": "o-134abcd",
"description": "Ocean cluster identifier.\n"
},
"availabilityZones": {
"type": "array",
"description": "An Array holding Availability Zones, this configures the availability zones the Ocean may launch instances in per VNG.\n",
"items": {
"type": "string"
},
"example": [
"1",
"2",
"3"
]
},
"nodePoolProperties": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup/post/requestBody/content/application~1json/schema/allOf/0/properties/virtualNodeGroup/properties/nodePoolProperties"
},
"nodeCountLimits": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/nodeCountLimits"
},
"strategy": {
"$ref": "#/paths/~1ocean~1azure~1np~1virtualNodeGroup~1%7BvirtualNodeGroupId%7D/put/requestBody/content/application~1json/schema/properties/virtualNodeGroup/properties/strategy"
},
"labels": {
"type": "object",
"description": "key-value pairs of labels to add to the virtual node group.\\\nOnly custom user labels are allowed, and not Kubernetes built-in labels or Spot internal labels.\\\nThe following are not allowed:\n* \"kubernetes.azure.com/agentpool\"\n* \"kubernetes.io/arch\"* \"kubernetes.io/os\"\n* \"node.kubernetes.io/instance-type\"\n* \"topology.kubernetes.io/region\"\n* \"topology.kubernetes.io/zone\"\n* \"kubernetes.azure.com/cluster\"\n* \"kubernetes.azure.com/mode\"\n* \"kubernetes.azure.com/role\"\n* \"kubernetes.azure.com/scalesetpriority\"\n* \"kubernetes.io/hostname\"\n* \"kubernetes.azure.com/storageprofile\"\n* \"kubernetes.azure.com/storagetier\"\n* \"kubernetes.azure.com/instance-sku\"\n* \"kubernetes.azure.com/node-image-version\"\n* \"kubernetes.azure.com/subnet\"\n* \"kubernetes.azure.com/vnet\"\n* \"kubernetes.azure.com/ppg\"\n* \"kubernetes.azure.com/encrypted-set\"\n* \"kubernetes.azure.com/accelerator\"\n* \"kubernetes.azure.com/fips_enabled\"\n* \"kubernetes.azure.com/os-sku\"\n",
"example": {
"key": "value"
}
},
"taints": {
"type": "array",
"description": "Add taints to a virtual node group.\n",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Set taint key.\nThe following are not allowed:\n* \"kubernetes.azure.com/scalesetpriority\"\n"
},
"value": {
"type": "string",
"description": "Set taint value.\n"
},
"effect": {
"type": "string",
"description": "Set taint effect.\n",
"enum": [
"NoSchedule",
"PreferNoSchedule",
"NoExecute",
"PreferNoExecute"
]
}
}
},
"example": [
{
"key": "taintKey",
"value": "taintValue",
"effect": "NoSchedule"
}
]
},
"tags": {
"type": "object",
"description": "A maximum of 10 unique key-value pairs for VM tags in the virtual node group.\n"
},
"restrictScaleDown": {
"type": "boolean",
"description": "When set to True, VNG nodes will be treated as if all pods running have the [restrict-scale-down label](https://docs.flexera.com/spot/ocean/features/labels-and-taints).\nTherefore, Ocean will not scale nodes down unless they are empty.\n",
"example": false
}
}
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:np"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/virtualNodeGroup/vmSizes": {
"get": {
"summary": "Get Virtual Node Group Allowed VM Sizes",
"description": "Get the allowed VM sizes that can be launched according to the virtual node group properties and selected VM size filters.\n",
"operationId": "oceanAKSVirtualNodeGroupVmSizes",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "query",
"name": "virtualNodeGroupId",
"example": "vng-12345abc",
"required": true,
"description": "Ocean Virtual Node Group identifier.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Ocean Cluster Launch Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/virtualNodeGroup/vmSizes"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allowedVmSizes": {
"type": "array",
"description": "A list of the allowed VM sizes that can be launched.\n",
"items": {
"type": "string"
},
"example": [
"standard_d2",
"standard_d2_v2",
"standard_d2_v3",
"standard_d2_v4",
"standard_d2_v5"
]
},
"numOfAllowedVmSizes": {
"type": "number",
"description": "The number of allowed VM sizes that can be launched.\n",
"example": 5
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:k8s:np:virtualNodeGroup:allowedVmSizes"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/roll": {
"summary": "Ocean for AKS",
"post": {
"summary": "Initiate Roll",
"description": "Roll an entire Ocean cluster or roll subsets of the cluster by specifying vngIds, nodePoolNames or nodeNames. Performing this request will start the roll immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a roll, you can use the GET Roll API.\n",
"operationId": "oceanAksRollInit",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"title": "Roll",
"allOf": [
{
"type": "object",
"properties": {
"batchSizePercentage": {
"type": "integer",
"description": "Value as a percent to set the size of a batch in a roll. Valid values are 0-100. In case of null as value, the default value in the backend will be 20%.\n",
"example": 25
}
}
},
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Add a comment description for the roll. The comment is limited to 256 chars and optional.\n",
"example": "This is why I deployed my cluster."
}
}
},
{
"type": "object",
"properties": {
"respectPdb": {
"type": "boolean",
"description": "During the roll, if the parameter is set to true we honor PDB during the nodes replacement.\n",
"example": false,
"default": true
}
}
},
{
"type": "object",
"properties": {
"respectRestrictScaleDown": {
"type": "boolean",
"description": "During the roll, if the parameter is set to true we honor Restrict Scale Down label during the nodes replacement.\n",
"example": true,
"default": false
}
}
},
{
"type": "object",
"properties": {
"batchMinHealthyPercentage": {
"type": "integer",
"description": "Indicates the threshold of minimum healthy nodes in single batch. If the amount of healthy nodes in single batch is under the threshold, the roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.\n",
"example": 100,
"default": 50
}
}
}
]
},
{
"type": "object",
"title": "Roll with node names",
"allOf": [
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/0"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/1"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/2"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/3"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/4"
},
{
"type": "object",
"properties": {
"nodeNames": {
"type": "array",
"description": "List of node names to be rolled. Each identifier is a string. nodeNames can be null, and cannot be used together with nodePoolNames and vngIds.\n",
"items": {
"type": "string"
},
"example": [
"aks-omnpbc2ebdb1-15563275-vmss00000g",
"aks-omnpe9429a2f-26725402-vmss000015"
]
}
}
}
]
},
{
"type": "object",
"title": "Roll with node pool names",
"allOf": [
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/0"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/1"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/2"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/3"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/4"
},
{
"type": "object",
"properties": {
"nodePoolNames": {
"type": "array",
"description": "List of node pools to be rolled. Each node pool name is a string. nodePoolNames can be null, and cannot be used together with nodeNames and vngIds.\n",
"items": {
"type": "string"
},
"example": [
"omnp35f6cccb",
"omnp55bd559b"
]
}
}
}
]
},
{
"type": "object",
"title": "Roll with virtual node group ids",
"allOf": [
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/0"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/1"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/2"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/3"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/post/requestBody/content/application~1json/schema/oneOf/0/allOf/4"
},
{
"type": "object",
"properties": {
"vngIds": {
"type": "array",
"description": "List of virtual node group identifiers to be rolled. Each identifier is a string. vngIds can be null, and cannot be used together with nodeNames and nodePoolNames.\n",
"items": {
"type": "string"
},
"example": [
"vng-69dc457b",
"vng-175947a4"
]
}
}
}
]
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean AKS Create Cluster Roll Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/roll"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
},
{
"type": "object",
"properties": {
"status": {
"example": "IN_PROGRESS"
}
}
},
{
"type": "object",
"properties": {
"progress": {
"example": {
"detailedStatus": {
"rollNodes": [
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000q",
"status": "IN_PROGRESS"
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss000008",
"status": "TO_BE_REPLACED"
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000r",
"status": "TO_BE_REPLACED"
},
{
"nodeName": "aks-omnpe9429a2f-26725402-vmss00000z",
"status": "IN_PROGRESS"
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000001",
"status": "IN_PROGRESS"
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000003",
"status": "TO_BE_REPLACED"
}
]
}
}
}
}
}
]
}
},
"kind": {
"example": "spotinst:ocean:azure:np:roll"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Rolls",
"description": "Get status for all rolls of an Ocean cluster.\n",
"operationId": "oceanAksRollList",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean AKS Get Cluster Roll Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/roll"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the cluster roll.\n",
"example": "scr-12345abc"
},
"oceanId": {
"type": "string",
"description": "The identifier of the ocean cluster being rolled.\n",
"example": "o-12e31234"
},
"type": {
"type": "string",
"description": "The type of the trigger for the cluster roll\n",
"enum": [
"scheduled",
"manual"
],
"example": "manual"
},
"scope": {
"type": "string",
"enum": [
"Cluster",
"Vng",
"Node Pool",
"Node"
],
"example": "Cluster"
},
"status": {
"type": "string",
"description": "The status of the roll.\n",
"enum": [
"IN_PROGRESS",
"COMPLETED",
"PARTLY_COMPLETED",
"FAILED",
"STOPPED"
],
"example": "COMPLETED"
},
"currentBatch": {
"type": "integer",
"description": "The current batch being handled by the roll.\n",
"example": 1
},
"numOfBatches": {
"type": "integer",
"description": "The total number of batches in the roll.\n",
"example": 2
},
"comment": {
"type": "string",
"example": "This is why I deployed my cluster."
},
"progress": {
"type": "object",
"properties": {
"progressPercentage": {
"type": "integer",
"example": 0
},
"detailedStatus": {
"type": "object",
"description": "An object containing detailed information about the progress of the roll.\n",
"properties": {
"rollNodes": {
"type": "array",
"description": "An array of objects containing detailed information about each node handled by the roll.\n",
"items": {
"type": "object",
"properties": {
"nodeName": {
"type": "string"
},
"status": {
"description": "The status of the node according to the roll.\n",
"type": "string",
"enum": [
"REPLACED",
"TO_BE_REPLACED",
"COULD_NOT_BE_REPLACED",
"NOT_REPLACED_DUE_TO_PDB",
"DID_NOT_REPLACE",
"IN_PROGRESS"
]
}
}
},
"example": [
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000q",
"status": "REPLACED"
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss000008",
"status": "TO_BE_REPLACED"
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000r",
"status": "COULD_NOT_BE_REPLACED"
},
{
"nodeName": "aks-omnpe9429a2f-26725402-vmss00000z",
"status": "NOT_REPLACED_DUE_TO_PDB"
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000001",
"status": "IN_PROGRESS"
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000003",
"status": "DID_NOT_REPLACE"
}
]
}
}
}
}
},
"respectPdb": {
"type": "boolean",
"example": true
},
"respectRestrictScaleDown": {
"type": "boolean",
"example": false
},
"batchMinHealthyPercentage": {
"type": "integer",
"example": 70
},
"createdAt": {
"type": "string",
"description": "The creation timestamp of the roll.\n",
"example": "2019-03-24T15:46:09.000Z"
},
"updatedAt": {
"type": "string",
"description": "The latest update timestamp of the roll.\n",
"example": "2019-03-24T15:46:09.000Z"
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:np:roll"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/roll/{rollId}": {
"summary": "Ocean for AKS",
"get": {
"summary": "Get Roll",
"description": "Get status for a roll of an Ocean cluster.\n",
"operationId": "oceanAksGetSingleRoll",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"in": "path",
"name": "rollId",
"schema": {
"type": "string"
},
"required": true,
"example": "acr-12345abc",
"description": "Ocean cluster roll identifier.\n"
}
],
"responses": {
"200": {
"description": "Ocean AKS Get Roll Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/roll/scr-12345abc"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:ocean:azure:np:roll"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/roll/{rollId}/stop": {
"summary": "Ocean for AKS",
"put": {
"summary": "Stop Roll",
"description": "Stop a roll of an Ocean cluster.\n\n*Performing the request will stop the next batch in a roll.*\n",
"operationId": "oceanAksRollStop",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll~1%7BrollId%7D/get/parameters/2"
}
],
"responses": {
"200": {
"description": "Ocean AKS STOP Cluster Roll Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/roll/scr-12345abc/stop"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1roll/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
},
{
"type": "object",
"properties": {
"status": {
"example": "STOPPED"
},
"progress": {
"example": {
"detailedStatus": {
"progressPercentage": 50,
"rollNodes": [
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000q",
"status": "REPLACED"
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss000008",
"status": "DID_NOT_REPLACE"
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000r",
"status": "DID_NOT_REPLACE"
},
{
"nodeName": "aks-omnpe9429a2f-26725402-vmss00000z",
"status": "REPLACED"
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000001",
"status": "REPLACED"
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000003",
"status": "DID_NOT_REPLACE"
}
]
}
}
}
}
}
]
}
},
"kind": {
"example": "spotinst:ocean:azure:np:roll"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/migration/discovery": {
"get": {
"summary": "Get Migration Discovery",
"description": "Get information about nodes which can be migrated into Ocean.\n",
"operationId": "oceanAksGetMigrationDiscovery",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"in": "query",
"name": "shouldFetchPods",
"example": "true",
"description": "Should fetch data about running pods for each node.\n",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Migration Discovery Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "ocean/azure/np/cluster/o-abcd1234/migration/discovery"
},
"method": {
"example": "GET"
}
}
},
"response": {
"properties": {
"items": {
"type": "array",
"items": {
"title": "Workload migration discovery details",
"description": "Information about available nodes which can be migrated to the Ocean cluster",
"type": "object",
"properties": {
"nodeName": {
"type": "string",
"description": "The node name.",
"example": "aks-mynodepool-18735776-vmss000001"
},
"nodePoolName": {
"type": "string",
"description": "The NodePool Name.",
"example": "mynodepool"
},
"runningPods": {
"type": "integer",
"description": "The number of running pods on the node (appears if shouldFetchPods was true).",
"example": "6"
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:k8s:np:nodePoolUnmanaged"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/migration": {
"summary": "Ocean for AKS",
"post": {
"summary": "Create Migration",
"description": "Migrate to ocean workloads that run on unmanaged nodes by specifying nodePoolNames or nodeNames. Performing this request will start the migration immediately and run it in defined batches. Note that the first response for a successful request will indicate the start of a migration. In order to check the status of a migration, you can use the GET migration API.\n",
"operationId": "oceanAksCreateMigration",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"title": "Migration with node names",
"allOf": [
{
"type": "object",
"properties": {
"batchSizePercentage": {
"type": "integer",
"description": "Value as a percent to set the size of a batch in a migration. Valid values are 0-100. In case of null as value, the default value in the backend will be 20%.\n",
"minimum": 1,
"maximum": 100,
"example": 25
}
}
},
{
"type": "object",
"properties": {
"comment": {
"type": "string",
"description": "Add a comment description for the migration. The comment is limited to 256 chars and optional.\n",
"example": "This is why I deployed my cluster."
}
}
},
{
"type": "object",
"properties": {
"respectPdb": {
"type": "boolean",
"description": "During the migration, if the parameter is set to true we honor PDB during the nodes replacement.\n",
"example": false,
"default": true
}
}
},
{
"type": "object",
"properties": {
"respectRestrictScaleDown": {
"type": "boolean",
"description": "During the migration, if the parameter is set to true we honor Restrict Scale Down label during the nodes replacement.\n",
"example": true,
"default": false
}
}
},
{
"type": "object",
"properties": {
"shouldTerminateNodes": {
"type": "boolean",
"description": "If the parameter is set to true we will terminate the node after the migration has finished successfully. If the parameter is set to false we will leave the nodes. example: true\n",
"default": true
}
}
},
{
"type": "object",
"properties": {
"shouldEvictStandalonePods": {
"type": "boolean",
"description": "If the parameter is set to true we will evict all standalone pods during the migration.\n",
"example": true,
"default": true
}
}
},
{
"type": "object",
"properties": {
"batchMinHealthyPercentage": {
"type": "integer",
"description": "Indicates the threshold of minimum healthy nodes in single batch. If the amount of healthy nodes in single batch is under the threshold, the migration will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.\n",
"minimum": 1,
"maximum": 100,
"example": 100,
"default": 50
}
}
},
{
"type": "object",
"properties": {
"nodeNames": {
"type": "array",
"description": "List of node names to be migrated. Each identifier is a string. nodeNames can be null, and cannot be used together with nodePoolNames.\n",
"items": {
"type": "string",
"example": [
"aks-omnpbc2ebdb1-15563275-vmss00000g",
"aks-omnpe9429a2f-26725402-vmss000015"
]
}
}
}
}
]
},
{
"type": "object",
"title": "Migration with node pool names",
"allOf": [
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/post/requestBody/content/application~1json/schema/oneOf/0/allOf/0"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/post/requestBody/content/application~1json/schema/oneOf/0/allOf/1"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/post/requestBody/content/application~1json/schema/oneOf/0/allOf/2"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/post/requestBody/content/application~1json/schema/oneOf/0/allOf/3"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/post/requestBody/content/application~1json/schema/oneOf/0/allOf/4"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/post/requestBody/content/application~1json/schema/oneOf/0/allOf/5"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/post/requestBody/content/application~1json/schema/oneOf/0/allOf/6"
},
{
"type": "object",
"properties": {
"nodePoolNames": {
"type": "array",
"description": "List of node pools to be migrated. Each node pool name is a string. nodePoolNames can be null, and cannot be used together with nodeNames.\n",
"items": {
"type": "string",
"example": [
"omnp35f6cccb",
"omnp55bd559b"
]
}
}
}
}
]
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean AKS Create Migration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/migration"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
]
}
},
"kind": {
"example": "spotinst:ocean:azure:np:migration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Migrations",
"description": "Get status for all migrations of an Ocean cluster.\n",
"operationId": "oceanAksMigrationsList",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean AKS Get Migration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/migration"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the migration.\n",
"example": "scr-12345abc"
},
"oceanId": {
"type": "string",
"description": "The identifier of the ocean cluster.\n",
"example": "o-12e31234"
},
"status": {
"type": "string",
"description": "The status of the migration.\n",
"enum": [
"IN_PROGRESS",
"COMPLETED",
"PARTLY_COMPLETED",
"FAILED",
"STOPPED"
],
"example": "COMPLETED"
},
"currentBatch": {
"type": "integer",
"description": "The current batch being handled by the migration.\n",
"example": 1
},
"numOfBatches": {
"type": "integer",
"description": "The total number of batches in the migration.\n",
"example": 2
},
"comment": {
"type": "string",
"example": "migration comment."
},
"migrationProgress": {
"type": "object",
"properties": {
"progressPercentage": {
"type": "number",
"example": 0
},
"detailedStatus": {
"type": "object",
"description": "An object containing detailed information about the progress of the migration.\n",
"properties": {
"oldNodes": {
"type": "array",
"description": "An array of objects containing detailed information about old nodes that are being replaced.\n",
"items": {
"type": "object",
"properties": {
"nodeName": {
"type": "string"
},
"nodePoolName": {
"type": "string"
},
"vngId": {
"type": "string"
},
"vngName": {
"type": "string"
},
"status": {
"description": "The status of the node according to the migration.\n",
"type": "string",
"enum": [
"REPLACED",
"TO_BE_REPLACED",
"COULD_NOT_BE_REPLACED",
"NOT_REPLACED_DUE_TO_PDB",
"DID_NOT_REPLACE",
"IN_PROGRESS"
]
},
"podDetails": {
"type": "array",
"description": "An array of objects of all pods currently running on the node that is being replaced.\n",
"items": {
"type": "object",
"properties": {
"podName": {
"type": "string"
}
}
}
},
"runningPods": {
"type": "integer"
}
}
},
"example": [
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000q",
"nodePoolName": "omnpbc2ebdb1",
"status": "REPLACED",
"podDetails": [
{
"podName": "pod-example-name1"
}
],
"runningPods": 1
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss000008",
"nodePoolName": "omnpbc2ebdb1",
"status": "TO_BE_REPLACED",
"podDetails": [
{
"podName": "pod-example-name2"
},
{
"podName": "pod-example-name3"
}
],
"runningPods": 2
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000r",
"nodePoolName": "omnpbc2ebdb1",
"status": "COULD_NOT_BE_REPLACED",
"podDetails": [
{
"podName": "pod-example-name4"
},
{
"podName": "pod-example-name5"
}
],
"runningPods": 2
},
{
"nodeName": "aks-omnpe9429a2f-26725402-vmss00000z",
"nodePoolName": "omnpe9429a2f",
"status": "NOT_REPLACED_DUE_TO_PDB",
"podDetails": [
{
"podName": "pod-example-name6"
}
],
"runningPods": 1
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000001",
"nodePoolName": "omnp0c85c2c2",
"status": "IN_PROGRESS",
"podDetails": [
{
"podName": "pod-example-name7"
}
],
"runningPods": 1
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000003",
"nodePoolName": "omnp0c85c2c2",
"status": "DID_NOT_REPLACE",
"podDetails": [
{
"podName": "pod-example-name8"
}
],
"runningPods": 1
}
]
},
"scaleNodePools": {
"type": "array",
"description": "An array of objects containing detailed information about all node pools that were scaled during the migration process.\n",
"items": {
"type": "object",
"properties": {
"nodePoolName": {
"type": "string"
},
"newNodes": {
"type": "integer"
},
"vngId": {
"type": "string"
},
"vngName": {
"type": "string"
},
"migrationStatus": {
"description": "The status of the node pool's scaling operation according to the migration.\n",
"type": "string",
"enum": [
"SCALING",
"COMPLETED",
"FAILED",
"PARTIAL_SUCCESS"
]
}
}
},
"example": [
{
"nodePoolName": "omnp12340",
"newNodes": 2,
"vngId": "vng-1234",
"vngName": "vng2",
"status": "Scaling"
},
{
"nodePoolName": "omnp12345",
"newNodes": 10,
"vngId": "vng-1234",
"vngName": "vng2",
"status": "Completed"
}
]
}
}
}
}
},
"respectPdb": {
"type": "boolean",
"example": true
},
"respectRestrictScaleDown": {
"type": "boolean",
"example": false
},
"shouldTerminateNodes": {
"type": "boolean",
"example": true
},
"shouldEvictStandalonePods": {
"type": "boolean",
"example": false
},
"batchMinHealthyPercentage": {
"type": "integer",
"example": 70
},
"createdAt": {
"type": "string",
"description": "The creation timestamp of the migration.\n",
"example": "2019-03-24T15:46:09.000Z"
},
"erredAt": {
"type": "string",
"description": "The timestamp of the migration error.\n",
"example": "2019-03-24T15:46:09.000Z"
},
"stoppedAt": {
"type": "string",
"description": "The stopping timestamp of the migration.\n",
"example": "2019-03-24T15:46:09.000Z"
},
"completedAt": {
"type": "string",
"description": "The completion timestamp of the migration.\n",
"example": "2019-03-24T15:46:09.000Z"
}
}
}
},
"kind": {
"example": "spotinst:azure:ocean:workloadMigration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/migration/{migrationId}": {
"summary": "Ocean for AKS",
"get": {
"summary": "Get Migration",
"description": "Get status for a migration of an Ocean cluster.\n",
"operationId": "oceanAksGetMigration",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"in": "path",
"name": "migrationId",
"schema": {
"type": "string"
},
"required": true,
"example": "scr-12345abc",
"description": "Ocean cluster workload migration identifier.\n"
}
],
"responses": {
"200": {
"description": "Ocean AKS Get Migration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/migration/scr-12345abc"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:azure:ocean:workloadMigration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/migration/{migrationId}/stop": {
"summary": "Ocean for AKS",
"put": {
"summary": "Stop Migration",
"description": "Stop a migration of an Ocean cluster.\n\n*Performing the request will stop the next batch in a migration.*\n",
"operationId": "oceanAksMigrationStop",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration~1%7BmigrationId%7D/get/parameters/2"
}
],
"responses": {
"200": {
"description": "Ocean AKS Stop Migration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/migration/scr-12345abc"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1migration/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
},
{
"type": "object",
"properties": {
"status": {
"example": "STOPPED"
},
"progress": {
"example": {
"detailedStatus": {
"progressPercentage": 50,
"oldNodes": [
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000q",
"status": "REPLACED"
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss000008",
"status": "DID_NOT_REPLACE"
},
{
"nodeName": "aks-omnpbc2ebdb1-15563275-vmss00000r",
"status": "DID_NOT_REPLACE"
},
{
"nodeName": "aks-omnpe9429a2f-26725402-vmss00000z",
"status": "REPLACED"
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000001",
"status": "REPLACED"
},
{
"nodeName": "aks-omnp0c85c2c2-26833420-vmss000003",
"status": "DID_NOT_REPLACE"
}
]
}
}
}
}
}
]
}
},
"kind": {
"example": "spotinst:azure:ocean:workloadMigration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/log": {
"summary": "Ocean for AKS",
"get": {
"summary": "Fetch Elastilogs",
"description": "Fetch the log of an Ocean cluster.\n",
"operationId": "oceanAKSClusterFetchLog",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1mcs~1ecs~1cluster~1%7BclusterName%7D~1costs/get/parameters/2"
},
{
"$ref": "#/paths/~1mcs~1ecs~1cluster~1%7BclusterName%7D~1costs/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D~1log/get/parameters/4"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D~1log/get/parameters/5"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D~1log/get/parameters/6"
}
],
"responses": {
"200": {
"description": "Ocean Get Log Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"request": {
"type": "object",
"description": "Original request properties\n",
"properties": {
"id": {
"type": "string",
"example": "3213f42e-455e-4801-a185-cd3eb65fac5f",
"description": "Unique identifier associated with this request\n"
},
"url": {
"type": "string",
"example": "/ocean/azure/np/cluster/o-e0a2bd7c/log?fromDate=2020-10-06&toDate=2020-10-08&severity=ALL&limit=500",
"description": "The URL that was used for the request\n"
},
"method": {
"type": "string",
"example": "GET",
"description": "The HTTP **METHOD** used for the request\n"
},
"timestamp": {
"type": "string",
"example": "2020-10-05T16:20:38.579Z",
"description": "When the request was received by Spot\n"
}
}
},
"response": {
"type": "object",
"description": "Response payload that includes status, type, and any relevant data.\n",
"properties": {
"status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": "200",
"description": "HTTP status code assigned to this response.\n"
},
"message": {
"type": "string",
"example": "OK",
"description": "HTTP status message for the respective status code.\n"
}
}
},
"kind": {
"type": "string",
"example": "spotinst:ocean:azure:k8s:cluster:logs"
},
"items": {
"type": "array",
"description": "Array of data objects\n",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"createdAt": {
"type": "string"
}
}
},
"example": [
{
"message": "Ocean o-e0a2bd7c successfully created.",
"severity": "INFO",
"createdAt": "2020-10-07T09:51:12.000Z"
}
]
},
"count": {
"type": "integer",
"example": "1"
}
}
}
}
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/autoUpgrade": {
"summary": "Ocean for AKS",
"get": {
"summary": "Get all auto-upgrades",
"description": "Returns a list of all auto-upgrade operations for the specified Ocean AKS cluster.\n",
"operationId": "oceanAksGetAutoUpgrades",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "List of auto upgrade.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"oceanId": {
"type": "string",
"description": "The identifier of the ocean cluster being upgraded.\n",
"example": "o-12e31234"
},
"scope": {
"type": "string",
"enum": [
"patch"
],
"example": "Cluster"
},
"rollId": {
"type": "string",
"description": "The identifier of the cluster roll (if created).\n",
"example": "scr-12345abc"
},
"systemNodePoolsOperationId": {
"type": "string",
"description": "The identifier of the system node pool upgrade operation (if created).\n",
"example": "snpo-12345abc"
},
"oldVersion": {
"type": "string",
"description": "The old version of the cluster's control plane.\n",
"example": "1.0.10"
},
"newVersion": {
"type": "string",
"description": "The newest available version.\n",
"example": "1.0.15"
},
"status": {
"type": "string",
"description": "The status of the upgrade.\n",
"enum": [
"START",
"UPGRADE_CONTROL_PLANE",
"VALIDATE_CONTROL_PLANE_UPGRADE",
"CREATE_SYSTEM_NODE_POOLS_UPDATE",
"CREATE_ROLL",
"AWAIT_NODE_POOLS_UPGRADE",
"COMPLETED",
"PARTIALLY_COMPLETED",
"FAILED"
],
"example": "COMPLETED"
},
"description": {
"type": "string",
"description": "The description of the upgrade, including any errors or issues found during the process.\n",
"example": "Failed to upgrade the control plane to the latest patch version. Could not create roll."
},
"createdAt": {
"type": "string",
"description": "The creation timestamp of the upgrade.\n",
"example": "2019-03-24T15:46:09.000Z"
}
}
}
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"post": {
"summary": "Initiate Auto upgrade",
"description": "Update the Ocean AKS cluster's VNGs with the latest version of the control plane's version after upgrading by specifying the scope. Performing this request will update the VNGs with a new version if available and run a cluster roll if set. If the response is successful, the old and new versions will be included in the response along with the updated VNGs. If a cluster roll is set in the request, the first response for a successful request will indicate the start of a roll. In order to check the status of the roll, you can use the GET Roll API.\n",
"operationId": "oceanAksAutoUpgradeInit",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1aks~1import/post/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1aks~1import/post/parameters/2"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"upgradeConfig"
],
"properties": {
"upgradeConfig": {
"type": "object",
"description": "The Configuration for scheduling automatic upgrades of your cluster to ensure it stays updated with the latest version.\n",
"title": "Upgrade Config",
"properties": {
"applyRoll": {
"type": "boolean",
"description": "When set to True, a cluster roll will be initiated if a new version is available to upgrade in the dedicated virtual node groups.\n",
"example": true
},
"scopeVersion": {
"type": "string",
"description": "The scope of the upgrade version.\n",
"enum": [
"patch"
]
},
"rollParameters": {
"type": "object",
"description": "The parameters of the cluster roll that will be initiated.\n",
"properties": {
"batchSizePercentage": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The percentage of the cluster that will be rolled at each batch.\n",
"example": 20
},
"comment": {
"type": "string",
"description": "A comment to be added to the cluster roll.\n",
"example": "Auto-upgrade the control plane to the latest patch version."
},
"respectPdb": {
"type": "boolean",
"description": "During the roll, if the parameter is set to true we honor PDB during the instance replacement.\n",
"example": true
},
"respectRestrictScaleDown": {
"type": "boolean",
"description": "During the roll, if the parameter is set to true we honor Restrict Scale Down label during the nodes replacement.\n",
"example": true
},
"batchMinHealthyPercentage": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The minimum percentage of the scaled nodes that should be healthy at each batch.\n",
"example": 80
}
}
},
"upgradeSystemNodePools": {
"type": "boolean",
"description": "When set to True, the system node pools will be updated with the new Kubernetes version as part of the upgrade.\n",
"example": true
},
"systemNodePools": {
"type": "array",
"description": "List of node pool names to be updated with the new Kubernetes version as part of the upgrade.\n",
"items": {
"type": "string"
},
"example": [
"userpool",
"systemNp1"
]
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean AKS Create Auto Upgrade",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/autoUpgrade"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1autoUpgrade/get/responses/200/content/application~1json/schema/items"
}
]
}
},
"kind": {
"example": "spotinst:ocean:azure:np:autoUpgrade"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/systemNodePool/upgradeVersion": {
"summary": "Ocean for AKS",
"post": {
"summary": "Start system node pool upgrade",
"description": "Initiates a Kubernetes version upgrade for specified system node pools in an Ocean AKS cluster.\n",
"operationId": "oceanAksStartSystemNodePoolUpgrade",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"oceanId",
"scope",
"systemNodePoolNames"
],
"properties": {
"oceanId": {
"type": "string",
"description": "The ID of the Ocean AKS cluster.",
"example": "o-12345abc"
},
"scope": {
"type": "string",
"enum": [
"PATCH"
],
"description": "The scope of the upgrade operation. Currently, only \"PATCH\" is supported.",
"example": "PATCH"
},
"systemNodePoolNames": {
"type": "array",
"description": "List of system node pool names to be upgraded.",
"items": {
"type": "string",
"example": [
"np1",
"np2"
]
},
"minItems": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "Ocean AKS System Node Pool Upgrade Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/np/cluster/o-12345abc/systemNodePool/upgradeVersion/snpo-1234abc"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operationId": {
"type": "string",
"description": "The unique identifier for the system node pool upgrade operation.\n",
"example": "op-12345abc"
},
"upgradedNodePoolNames": {
"type": "array",
"description": "List of system node pool names that were successfully upgraded.\n",
"items": {
"type": "string"
},
"example": [
"np1",
"np2"
]
},
"inProgressNodePoolNames": {
"type": "array",
"description": "List of system node pool names that are currently in progress of being upgraded.\n",
"items": {
"type": "string"
},
"example": [
"np3"
]
},
"failedNodePoolNames": {
"type": "array",
"description": "List of system node pool names that failed to upgrade.\n",
"items": {
"type": "string"
},
"example": [
"np4"
]
},
"newVersion": {
"type": "string",
"description": "The new version to which the system node pools are being upgraded.\n",
"example": "1.28.3"
}
}
}
},
"kind": {
"example": "spotinst:ocean:azure:np:systemNodePoolUpgrade"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/systemNodePool/upgradeVersion/{systemNodePoolsOperationId}": {
"summary": "Ocean for AKS",
"get": {
"summary": "Get system node pool upgrade operation",
"description": "Returns the status of a specific system node pool upgrade operation for the specified Ocean AKS cluster.\n",
"operationId": "oceanAksGetSystemNodePoolUpgradeOperation",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"in": "path",
"name": "systemNodePoolsOperationId",
"schema": {
"type": "string"
},
"required": true,
"example": "snpo-12345abc",
"description": "System node pools operation identifier.\n"
}
],
"responses": {
"200": {
"$ref": "#/paths/~1ocean~1azure~1np~1cluster~1%7BoceanClusterId%7D~1systemNodePool~1upgradeVersion/post/responses/200"
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/k8s/cluster/{oceanClusterId}/aggregatedCosts": {
"post": {
"summary": "Get Cluster Aggregated Detailed Costs",
"description": "Provides Kubernetes cluster resource usage and costs over a time interval which can be grouped and/or filtered by label/annotaion,\\\nfor example - application name (webapp, backend), environment (production, staging), version etc.\\\nThe response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory) and storage.\nThe response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation.\\\nWithin the group, resource costs are broken down per resource kind (Deployment, DaemonSet etc.).\n\nTime Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call.\\\nFor example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.\n",
"operationId": "oceanAksK8sClusterAggregatedDetailedCosts",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"endTime",
"startTime"
],
"properties": {
"startTime": {
"type": "string",
"example": "2023-07-20T11:35:01.745Z",
"description": "Beginning date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"endTime": {
"type": "string",
"example": "2023-07-22T11:30:01.745Z",
"description": "End date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"groupBy": {
"type": "string",
"description": "The parameter we want to group the costs by.\n",
"default": "namespace",
"example": "namespace.label.env",
"enum": [
"namespace",
"namespace.label.${labelKey}",
"resource.label.${labelKey}",
"resource.annotation.${annotationKey}",
"namespace.annotation.${annotationKey}"
]
},
"filter": {
"type": "object",
"description": "Describe how to filter the costs. Optional field.",
"required": [
"scope",
"conditions"
],
"properties": {
"scope": {
"type": "string",
"enum": [
"namespace",
"resource"
]
},
"conditions": {
"type": "object",
"required": [
"anyMatch"
],
"properties": {
"anyMatch": {
"type": "array",
"description": "Array of conditions set that OR operator is applied between them.\n",
"items": {
"type": "object",
"required": [
"allMatch"
],
"properties": {
"allMatch": {
"type": "array",
"description": "Array of conditions that AND operator is applied between them.\\\nFor example, (label env equals prod) AND (label app exists)\n",
"items": {
"type": "object",
"description": "The basic expression of a condition",
"required": [
"type",
"key",
"operator"
],
"properties": {
"type": {
"type": "string",
"enum": [
"label",
"annotation"
]
},
"key": {
"type": "string",
"description": "May be any string, but shouldn't be empty.\n",
"example": "env"
},
"operator": {
"type": "string",
"enum": [
"equals",
"notEquals",
"exists",
"notExists"
]
},
"value": {
"type": "string",
"description": "Required whenever the operator is \"equals\" or \"notEquals\".\n",
"example": "prod"
}
}
}
}
}
},
"example": [
{
"allMatch": [
{
"type": "label",
"key": "env",
"operator": "equals",
"value": "prod"
},
{
"type": "label",
"key": "app",
"operator": "exists"
}
]
},
{
"allMatch": [
{
"type": "annotation",
"key": "meta.data",
"operator": "exists"
}
]
}
]
}
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Cluster Aggregated Detailed Costs Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/k8s/cluster/o-abcd1234/aggregatedCosts"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"totalForDuration": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"example": "2023-07-20T11:35:01.745Z",
"description": "Beginning date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"endTime": {
"type": "string",
"example": "2023-07-22T11:30:01.745Z",
"description": "End date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"summary": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 41772.882658036,
"format": "float",
"description": "The total costs of cluster in a given time range"
},
"compute": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 40668.1299631538,
"format": "float",
"description": "The total compute costs of the cluster in a given time range"
},
"workloads": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 40668.1299631538,
"format": "float"
}
}
},
"headroom": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0,
"format": "float"
}
}
}
}
},
"storage": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819,
"format": "float",
"description": "The total storage costs of the cluster in given time range"
},
"block": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819,
"format": "float"
},
"azureDisk": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819,
"format": "float"
}
}
},
"osDisk": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0,
"format": "float"
}
}
}
}
}
}
},
"networking": {
"type": "object",
"properties": {
"totalCost": {
"type": "number",
"example": 0.00278988928,
"description": "The total costs of cluster's networking in a given time range"
},
"totalUsage": {
"type": "number",
"example": 0.03154064,
"description": "The total usages of cluster's networking in a given time range"
},
"total": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.00139494464
},
"usage": {
"type": "number",
"example": 0.01577032
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.00139494464
},
"usage": {
"type": "number",
"example": 0.01577032
}
}
}
}
},
"internet": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.000693972
},
"usage": {
"type": "number",
"example": 0.0077108
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.000693972
},
"usage": {
"type": "number",
"example": 0.0077108
}
}
}
}
},
"interAZ": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.0000035003200000000003
},
"usage": {
"type": "number",
"example": 0.000175016
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.0000035003200000000003
},
"usage": {
"type": "number",
"example": 0.000175016
}
}
}
}
},
"intraAZ": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.000693972
},
"usage": {
"type": "number",
"example": 0.0077108
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.000693972
},
"usage": {
"type": "number",
"example": 0.0077108
}
}
}
}
},
"interRegion": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.0000035003200000000003
},
"usage": {
"type": "number",
"example": 0.000175016
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.0000035003200000000003
},
"usage": {
"type": "number",
"example": 0.000175016
}
}
}
}
}
}
}
}
},
"detailedCosts": {
"type": "object",
"properties": {
"groupedBy": {
"type": "string",
"example": "n.l.name"
},
"aggregations": {
"type": "object",
"description": "Contains aggregation for each group by value.\n",
"additionalProperties": {
"type": "object",
"description": "For example - if group by is namespace so each property name will a namesapce in the cluster.",
"properties": {
"summary": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 425.23778,
"format": "float"
},
"compute": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 125.23778,
"format": "float"
}
}
},
"storage": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 300,
"format": "float"
},
"block": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 300,
"format": "float"
},
"azureDisk": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 300,
"format": "float"
}
}
},
"osDisk": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0,
"format": "float"
}
}
}
}
}
}
}
}
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "k8s-events"
},
"type": {
"type": "string",
"example": "Deployment"
},
"namespace": {
"type": "string",
"example": "kube-system"
}
}
},
"total": {
"type": "number",
"example": 1.655635222,
"format": "float"
},
"compute": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1.4213600158,
"format": "float"
}
}
},
"storage": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0.2342752062,
"format": "float"
},
"block": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0.2342752062,
"format": "float"
},
"azureDisk": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0,
"format": "float"
}
}
},
"osDisk": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0.2342752062,
"format": "float"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"kind": {
"example": "ocean:k8s:cluster:aggregatedCosts:detailed"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/k8s/cluster/{oceanClusterId}/aggregatedCosts/summary": {
"post": {
"summary": "Get Cluster Aggregated Summary Costs",
"description": "Provides Kubernetes cluster summary usage and costs over a time interval which can be grouped and/or filtered by label/annotaion,\\\nfor example - application name (webapp, backend), environment (production, staging), version etc.\\\nThe response will contain a breakdown of the cluster resource costs($) in terms of compute (CPU, memory), storage (block, file, rootVolume).\nThe response will group the cluster usage costs based on preselected default of application namespace or user selected label or annotation.\n\nTime Rounding Down: The CostAnalysis API applies rounding down to the hours provided during the call.\\\nFor example, the value 1707004799099 (In GMT) representing Saturday, February 3, 2024, 23:59:59.099 is rounded down to Saturday, February 3, 2024, 23:00:00.000, resulting in the omission of one hour of cost.\n",
"operationId": "oceanAksK8sClusterAggregatedSummaryCosts",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"endTime",
"startTime"
],
"properties": {
"startTime": {
"type": "string",
"example": "2023-07-20T11:35:01.745Z",
"description": "Beginning date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"endTime": {
"type": "string",
"example": "2023-07-22T11:30:01.745Z",
"description": "End date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"groupBy": {
"type": "string",
"description": "The parameter we want to group the costs by.\n",
"default": "namespace",
"example": "namespace.label.env",
"enum": [
"namespace",
"namespace.label.${labelKey}",
"resource.label.${labelKey}",
"resource.annotation.${annotationKey}",
"namespace.annotation.${annotationKey}"
]
},
"filter": {
"type": "object",
"description": "Describe how to filter the costs. Optional field.",
"required": [
"scope",
"conditions"
],
"properties": {
"scope": {
"type": "string",
"enum": [
"namespace",
"resource"
]
},
"conditions": {
"type": "object",
"required": [
"anyMatch"
],
"properties": {
"anyMatch": {
"type": "array",
"description": "Array of conditions set that OR operator is applied between them.\n",
"items": {
"type": "object",
"required": [
"allMatch"
],
"properties": {
"allMatch": {
"type": "array",
"description": "Array of conditions that AND operator is applied between them.\\\nFor example, (label env equals prod) AND (label app exists)\n",
"items": {
"type": "object",
"description": "The basic expression of a condition",
"required": [
"type",
"key",
"operator"
],
"properties": {
"type": {
"type": "string",
"enum": [
"label",
"annotation"
]
},
"key": {
"type": "string",
"description": "May be any string, but shouldn't be empty.\n",
"example": "env"
},
"operator": {
"type": "string",
"enum": [
"equals",
"notEquals",
"exists",
"notExists"
]
},
"value": {
"type": "string",
"description": "Required whenever the operator is \"equals\" or \"notEquals\".\n",
"example": "prod"
}
}
}
}
}
},
"example": [
{
"allMatch": [
{
"type": "label",
"key": "env",
"operator": "equals",
"value": "prod"
},
{
"type": "label",
"key": "app",
"operator": "exists"
}
]
},
{
"allMatch": [
{
"type": "annotation",
"key": "meta.data",
"operator": "exists"
}
]
}
]
}
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Cluster Aggregated Summary Costs Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/azure/k8s/cluster/o-abcd1234/aggregatedCosts/summary"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"totalForDuration": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"example": "2023-07-20T11:35:01.745Z",
"description": "Beginning date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"endTime": {
"type": "string",
"example": "2023-07-22T11:30:01.745Z",
"description": "End date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"summary": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 41772.882658035785,
"format": "float",
"description": "The total costs of cluster in a given time range"
},
"compute": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 40668.1299631538,
"format": "float",
"description": "The total compute costs of the cluster in a given time range"
},
"workloads": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 39882.13803327978,
"format": "float"
}
}
},
"headroom": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0,
"format": "float"
}
}
}
}
},
"storage": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819868,
"format": "float",
"description": "The total storage costs of the cluster in given time range"
},
"block": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819868,
"format": "float"
},
"azureDisk": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 1104.7526948819868,
"format": "float"
}
}
},
"osDisk": {
"type": "object",
"properties": {
"total": {
"type": "number",
"example": 0,
"format": "float"
}
}
}
}
}
}
},
"networking": {
"type": "object",
"properties": {
"totalCost": {
"type": "number",
"example": 0.00278988928,
"description": "The total costs of cluster's networking in a given time range"
},
"totalUsage": {
"type": "number",
"example": 0.03154064,
"description": "The total usages of cluster's networking in a given time range"
},
"total": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.00139494464
},
"usage": {
"type": "number",
"example": 0.01577032
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.00139494464
},
"usage": {
"type": "number",
"example": 0.01577032
}
}
}
}
},
"internet": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.000693972
},
"usage": {
"type": "number",
"example": 0.0077108
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.000693972
},
"usage": {
"type": "number",
"example": 0.0077108
}
}
}
}
},
"interAZ": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.0000035003200000000003
},
"usage": {
"type": "number",
"example": 0.000175016
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.0000035003200000000003
},
"usage": {
"type": "number",
"example": 0.000175016
}
}
}
}
},
"intraAZ": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.000693972
},
"usage": {
"type": "number",
"example": 0.0077108
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.000693972
},
"usage": {
"type": "number",
"example": 0.0077108
}
}
}
}
},
"interRegion": {
"type": "object",
"properties": {
"in": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.0000035003200000000003
},
"usage": {
"type": "number",
"example": 0.000175016
}
}
},
"out": {
"type": "object",
"properties": {
"cost": {
"type": "number",
"example": 0.0000035003200000000003
},
"usage": {
"type": "number",
"example": 0.000175016
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"kind": {
"example": "ocean:k8s:cluster:aggregatedCosts:summary"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/azure/np/cluster/{oceanClusterId}/nodes": {
"get": {
"summary": "Get Cluster Nodes",
"description": "Get nodes data of an Ocean AKS cluster.\n",
"operationId": "oceanAKSGetNodes",
"tags": [
"Ocean AKS"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "query",
"name": "virtualNodeGroupId",
"required": false,
"schema": {
"type": "string"
},
"example": "vng-12345abc",
"description": "Filter nodes by Ocean Virtual Node Group identifier."
},
{
"in": "query",
"name": "nodeName",
"schema": {
"type": "string"
},
"example": "vm-123",
"description": "Get a specific node by instance id."
}
],
"responses": {
"200": {
"description": "Ocean Kubernetes AKS Nodes Data Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/azure/ocean/np/aks/cluster/o-7068d7a8/nodes"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Azure Ocean Kubernetes node data",
"description": "Node data of Ocean AKS cluster.",
"properties": {
"nodeId": {
"type": "string",
"example": "550e8400-e29b-41d4-a716-446655440000",
"description": "The unique identifier of this node.\n"
},
"nodeName": {
"type": "string",
"example": "node-abc123def456",
"description": "The kubernetes node name.\n"
},
"nodePoolName": {
"type": "string",
"example": "default-pool",
"description": "The Azure node pool name.\n"
},
"virtualNodeGroupId": {
"type": "string",
"example": "vng-abc123def456",
"description": "The node's Virtual Node Group ID (only for Ocean-managed nodes).\n"
},
"virtualNodeGroupName": {
"type": "string",
"example": "user-pool",
"description": "The node's Virtual Node Group name (only for Ocean-managed nodes).\n"
},
"vmSize": {
"type": "string",
"example": "Standard_D8as_v6",
"description": "The Azure VM size of this node.\n"
},
"lifeCycle": {
"type": "string",
"enum": [
"Spot",
"OnDemand"
],
"example": "Spot",
"description": "The lifecycle of this node (Spot or OnDemand).\n"
},
"availabilityZone": {
"type": "string",
"example": "1",
"description": "The Azure availability zone of this node.\n"
},
"commitmentType": {
"type": "string",
"enum": [
"reservation",
"savingsPlan",
"pay-as-you-go",
"none"
],
"example": "reservations",
"description": "The commitment type of this node.\n"
},
"ipAddress": {
"type": "string",
"example": "10.0.0.1",
"description": "The IP address of this node.\n"
},
"osImage": {
"type": "string",
"example": "Ubuntu",
"description": "The OS image of this node.\n"
},
"operatingSystem": {
"type": "string",
"enum": [
"linux",
"windows"
],
"example": "linux",
"description": "The operating system of this node.\n"
},
"architecture": {
"type": "string",
"example": "amd64",
"description": "The architecture of this node.\n"
},
"nodeStatus": {
"type": "string",
"enum": [
"TRUE",
"FALSE",
"UNKNOWN"
],
"example": "TRUE",
"description": "The status of this node.\n"
},
"registrationStatus": {
"type": "string",
"enum": [
"Registered",
"Unregistered",
"Unknown"
],
"example": "Registered",
"description": "The registration status of this node.\n"
},
"createdAt": {
"type": "string",
"format": "date-time",
"example": "2026-01-15T10:30:45.000Z",
"description": "When was this node's instance was created at.\n"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Kubernetes labels assigned to this node.\n",
"example": {
"pool-type": "default-pool",
"kubernetes.io/hostname": "node-abc123def456"
}
},
"taints": {
"type": "array",
"items": {
"type": "string"
},
"description": "Kubernetes taints assigned to this node.\n",
"example": [
"CriticalAddonsOnly=true:NO_SCHEDULE"
]
},
"workloadRequestedMilliCpu": {
"type": "number",
"example": 0,
"description": "The amount of milli cpus requested by the kubernetes workload.\n"
},
"workloadRequestedMemoryInMiB": {
"type": "number",
"example": 0,
"description": "The amount of memory in MiB requested by the kubernetes workload.\n"
},
"workloadRequestedGpu": {
"type": "number",
"example": 0,
"description": "The amount of gpus requested by the kubernetes workload.\n"
},
"headroomRequestedMilliCpu": {
"type": "number",
"example": 0,
"description": "The amount of milli cpus saved for headroom.\n"
},
"headroomRequestedMemoryInMiB": {
"type": "number",
"example": 0,
"description": "The amount of memory in MiB saved for headroom.\n"
},
"headroomRequestedGpu": {
"type": "number",
"example": 0,
"description": "The amount of gpus saved for headroom.\n"
},
"allocatableMilliCpu": {
"type": "number",
"example": 0,
"description": "The amount of allocatable milli cpus as registered in kubernetes.\n"
},
"allocatableMemoryInMiB": {
"type": "number",
"example": 0,
"description": "The amount of allocatable memory in MiB as registered in kubernetes.\n"
},
"allocatableGpu": {
"type": "number",
"example": 0,
"description": "The amount of allocatable gpus as registered in kubernetes.\n"
}
}
}
},
"kind": {
"example": "spotinst:azure:ocean:clusterNode"
},
"count": {
"type": "integer",
"example": 1,
"description": "Number of nodes returned"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/aws/k8s/launchSpec/{launchSpecId}/launchNodes": {
"put": {
"summary": "Launch Nodes in VNG",
"description": "Launch nodes in Virtual Node Group.\n",
"operationId": "OceanAWSK8sLaunchSpecLaunchNodes",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1launchSpec~1%7BlaunchSpecId%7D/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"launchRequest"
],
"properties": {
"launchRequest": {
"type": "object",
"title": "Ocean AWS Virtual Node Group Launch Request",
"description": "Object specifying the details for the launch request.\n",
"required": [
"amount"
],
"properties": {
"amount": {
"description": "The number of nodes to launch.\n",
"type": "integer",
"example": 5
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Ocean Virtual Node Group Launch Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/aws/k8s/launchSpec/ols-12345abc/launchNodes"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"launchSpecId": {
"type": "string",
"example": "ols-f73821bc"
},
"newInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instanceId": {
"type": "string",
"example": "i-08d53d2a1dcede08f",
"description": "Identifier of the launched instance\n"
},
"availabilityZone": {
"type": "string",
"example": "us-west-2b",
"description": "The availability zone where the instance is launched\n"
},
"instanceType": {
"type": "string",
"example": "c3.xlarge",
"description": "Type of the instance to be launched\n"
},
"lifeCycle": {
"type": "string",
"example": "spot"
}
}
}
}
}
}
},
"kind": {
"example": "spotinst:ocean:aws:k8s:launchSpec:launchNodes"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/aws/ecs/launchSpec/{launchSpecId}/launchContainerInstances": {
"put": {
"summary": "Launch Container Instances In VNG",
"description": "Launch container instances in virtual node group.\n",
"operationId": "OceanAWSEcsLaunchSpecLaunchNodes",
"tags": [
"Ocean ECS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1launchSpec~1%7BlaunchSpecId%7D/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"launchRequest"
],
"properties": {
"launchRequest": {
"type": "object",
"title": "Ocean ECS VNG Launch Request",
"required": [
"amount"
],
"properties": {
"amount": {
"description": "The number of container instances to launch.\n",
"type": "integer",
"example": 5
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Ocean VNG Launch Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/aws/ecs/launchSpec/ols-12345abc/launchContainerInstances"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"launchSpecId": {
"type": "string",
"example": "ols-f73821bc"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"newInstances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"instanceId": {
"type": "string",
"example": "i-08d53d2a1dcede08f",
"description": "identifier of the launched instance.\n"
},
"availabilityZone": {
"type": "string",
"example": "us-west-2b",
"description": "The availability zone that the instance launched in.\n"
},
"instanceType": {
"type": "string",
"example": "c3.xlarge",
"description": "Type of the launched instance.\n"
},
"lifeCycle": {
"type": "string",
"example": "spot",
"description": "Spot or on-demand.\n"
}
}
}
}
}
}
},
"kind": {
"example": "spotinst:ocean:aws:ecs:launchSpec:launchContainerInstances"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/k8s/extendedResourceDefinition": {
"summary": "Ocean extended resource definition",
"post": {
"summary": "Create Extended Resource Definition",
"description": "Creates an Ocean extended resource definition entity.\n",
"operationId": "oceanK8sExtendedResourceDefinitionCreate",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"extendedResourceDefinition"
],
"properties": {
"extendedResourceDefinition": {
"type": "object",
"description": "The Ocean extended resource definition.\n",
"title": "Ocean Extended Resource Definition",
"required": [
"name",
"mapping"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"example": "erd-123abc",
"description": "Ocean extended resource definition identifier.\n"
},
"name": {
"type": "string",
"example": "example.com/name",
"description": "The extended resource name as should be requested by your pods and registered to the nodes. Cannot be updated.\nThe name should be a valid [Kubernetes extended resource name](https://kubernetes.io/docs/tasks/configure-pod-container/extended-resource/#assign-an-extended-resource-to-a-pod).\n"
},
"mapping": {
"type": "object",
"title": "AWS mapping",
"description": "A mapping between AWS instanceType or `*` as default and its value for the given extended resource.\n",
"example": {
"c3.large": "2Ki",
"c3.xlarge": "4Ki",
"c3.2xlarge": "8Mi"
}
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T08:13:08.000Z",
"description": "A timestamp of the extended resource definition creation.\n"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T15:06:13.000Z",
"description": "A timestamp of the latest extended resource definition update.\n"
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Create Extended Resource Definition Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/k8s/extendedResourceDefinition"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1k8s~1extendedResourceDefinition/post/requestBody/content/application~1json/schema/allOf/0/properties/extendedResourceDefinition"
}
},
"kind": {
"example": "spotinst:ocean:k8s:extendedResourceDefinition"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Extended Resource Definitions",
"description": "List the configurations for all Ocean extended resource definitions in the specified account.\n",
"operationId": "oceanK8sExtendedResourceDefinitionList",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"description": "Ocean Extended Resource Definition Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/k8s/extendedResourceDefinition"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1k8s~1extendedResourceDefinition/post/requestBody/content/application~1json/schema/allOf/0/properties/extendedResourceDefinition"
}
},
"kind": {
"example": "spotinst:ocean:k8s:extendedResourceDefinition"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/k8s/extendedResourceDefinition/{oceanExtendedResourceDefinitionId}": {
"get": {
"summary": "Get Extended Resource Definition",
"description": "Get the configurations for a specified Ocean extended resource definition.\n",
"operationId": "oceanK8sExtendedResourceDefinitionGet",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "path",
"name": "oceanExtendedResourceDefinitionId",
"example": "erd-12345abc",
"description": "Identifier of the Ocean extended resource definition.\n",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Ocean Extended Resource Definition Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/k8s/extendedResourceDefinition/erd-12345abc"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1k8s~1extendedResourceDefinition/post/requestBody/content/application~1json/schema/allOf/0/properties/extendedResourceDefinition"
}
},
"kind": {
"example": "spotinst:ocean:k8s:extendedResourceDefinition"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"put": {
"summary": "Update Extended Resource Definition",
"description": "Only the mapping parameter is updatable for extended resource definition.\n",
"operationId": "oceanK8sExtendedResourceDefinitionUpdate",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1k8s~1extendedResourceDefinition~1%7BoceanExtendedResourceDefinitionId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1ocean~1k8s~1extendedResourceDefinition/post/requestBody/content/application~1json/schema/allOf/0"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Update Extended Resource Definition Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/k8s/extendedResourceDefinition/erd-12345abc"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1k8s~1extendedResourceDefinition/post/requestBody/content/application~1json/schema/allOf/0/properties/extendedResourceDefinition"
}
},
"kind": {
"example": "spotinst:ocean:k8s:extendedResourceDefinition"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"delete": {
"summary": "Delete Extended Resource Definition",
"description": "Delete a specified Ocean extended resource definition.\n",
"operationId": "oceanK8sExtendedResourceDefinitionDelete",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1k8s~1extendedResourceDefinition~1%7BoceanExtendedResourceDefinitionId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean Delete Extended Resource Definition Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/k8s/extendedResourceDefinition/erd-12345abc"
},
"method": {
"example": "DELETE"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/aws/k8s/cluster/{oceanClusterId}/migration/discovery": {
"summary": "Ocean for AWS",
"get": {
"summary": "Get Migration Discovery",
"description": "Get information about nodes which can be migrated into Ocean.\n",
"operationId": "oceanAwsGetMigrationDiscovery",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"in": "query",
"name": "shouldFetchPods",
"example": "true",
"description": "Should fetch data about running pods for each node.\n",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Migration Discovery Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "ocean/aws/k8s/cluster/o-abcd1234/migration/discovery"
},
"method": {
"example": "GET"
}
}
},
"response": {
"properties": {
"items": {
"type": "array",
"items": {
"title": "Workload migration discovery details",
"type": "object",
"properties": {
"instances": {
"type": "array",
"description": "List of information about available nodes which can be migrated to the Ocean cluster.",
"items": {
"type": "object",
"properties": {
"k8sNodeName": {
"type": "string",
"description": "The kubernetes node name.",
"example": "ip-111-11-11-111.us-west-1.compute.internal"
},
"asgName": {
"type": "string",
"description": "The ASG name the node belongs.",
"example": "asg-name"
},
"instanceId": {
"type": "string",
"description": "The instance id.",
"example": "i-asdfjk3989"
},
"launchSpecId": {
"type": "string",
"description": "The best match of Virtual Node Group to which the node could belong.",
"example": "ols-1234ascv"
},
"runningPods": {
"type": "integer",
"description": "The number of running pods on the node (appears if shouldFetchPods was true).",
"example": "6"
}
}
}
}
}
}
},
"kind": {
"example": "spotinst:ocean:aws:k8s:cluster:migration:discovery"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/aws/k8s/cluster/{oceanClusterId}/migration": {
"summary": "Ocean for AWS",
"post": {
"summary": "Create Migration",
"description": "Create a migration for a given existing instances.\n",
"operationId": "oceanAwsPostMigration",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"migration"
],
"properties": {
"migration": {
"type": "object",
"description": "Migration update configuration.\n",
"required": [
"instanceIds",
"shouldTerminateDrainedNodes",
"shouldEvictStandAlonePods",
"forcePodEvictionOnPdbFailure",
"batchSizePercentage"
],
"properties": {
"instanceIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of instance ids that should be migrated to the Ocean cluster.",
"example": [
"i-a12345",
"i-b12345"
]
},
"shouldTerminateDrainedNodes": {
"type": "boolean",
"example": true,
"description": "Ocean will terminate the old instances once the pods that reside on them are migrated, and the old instances are fully drained.\n"
},
"shouldEvictStandAlonePods": {
"type": "boolean",
"example": true,
"description": "Ocean will terminate pods that do not belong to a Kubernetes deployment. This means that you would need to launch the pod manually (after the migration) due to the fact that there is no object that would do it automatically.\n"
},
"forcePodEvictionOnPdbFailure": {
"type": "boolean",
"example": true,
"description": "Ocean will force the Pod eviction from the instance, even if the distributed budget is not satisfied.\n"
},
"batchSizePercentage": {
"type": "integer",
"example": 50,
"description": "Indicates (in percentage) the batch size of the migration (meaning, how many nodes to migrate in each batch).\\\nCannot be null.\n",
"minimum": 1,
"maximum": 50
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Migration Create",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "ocean/aws/k8s/cluster/o-1234567/migration"
},
"method": {
"example": "POST"
}
}
},
"response": {
"properties": {
"items": {
"type": "array",
"items": {
"properties": {
"id": {
"example": "owm-6e3819ae",
"description": "The migration identifier of a specific migration.\n",
"type": "string"
}
}
}
},
"kind": {
"example": "spotinst:ocean:aws:k8s:cluster:migration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Migrations summary",
"description": "Get summary of migrations history for an Ocean cluster.\n",
"operationId": "oceanAwsGetMigrations",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Migrations Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "ocean/aws/k8s/cluster/o-1234567/migration"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Workload migration summary",
"description": "Workload migration summary of Ocean cluster.",
"properties": {
"Id": {
"type": "string",
"example": "owm-1234567",
"description": "The migration id.\n"
},
"state": {
"type": "string",
"description": "The latest state of this migration.\n",
"enum": [
"STARTING",
"AWAIT_REPLACEMENTS",
"HANDLE_UNSCHEDULE",
"DRAIN_NODES",
"VALIDATE_DRAIN",
"STOPPING",
"ERROR",
"RESCHEDULE_NODES",
"TERMINATE_NODES",
"AWAIT_TERMINATION",
"FINISHED_ERROR",
"STOPPED",
"FINISHED"
],
"example": "FINISHED"
},
"createdAt": {
"type": "string",
"example": "2021-10-1T05:51:06.000Z",
"description": "When this migration was created.\n"
},
"completedAt": {
"type": "string",
"example": "2021-10-1T05:51:06.000Z",
"description": "When this migration was completed.\n"
}
}
}
},
"kind": {
"example": "spotinst:ocean:aws:k8s:cluster:migration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/aws/k8s/cluster/{oceanClusterId}/migration/{migrationId}": {
"summary": "Ocean for AWS",
"get": {
"summary": "Get Migration Status",
"description": "Get Migration full info and status for an Ocean cluster.\n",
"operationId": "oceanAwsGetMigrationStatus",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"in": "path",
"name": "migrationId",
"example": "owm-6e3819ae",
"description": "The migration identifier of a specific migration.\n",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Migration Status Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "ocean/aws/k8s/cluster/o-abcd1234/migration/owm-abcd1234"
},
"method": {
"example": "GET"
}
}
},
"response": {
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Workload migration",
"description": "Workload migration status of Ocean cluster.",
"properties": {
"Id": {
"type": "string",
"example": "owm-1234567",
"description": "The migration id.\n"
},
"oceanId": {
"type": "string",
"example": "o-abcd1234",
"description": "The Ocean cluster identifier. Required for Virtual Node Group creation.\n"
},
"status": {
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D~1migration/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items/properties/state"
},
"newInstances": {
"type": "array",
"title": "Workload migration details",
"items": {
"type": "object",
"properties": {
"instanceId": {
"type": "string",
"description": "The instance ID.",
"example": "i-asdfjk3989"
},
"k8sNodeName": {
"type": "string",
"description": "The kubernetes node name.",
"example": "ip-111-11-11-111.us-west-1.compute.internal"
},
"asgName": {
"type": "string",
"description": "The ASG name the node belongs.",
"example": "asg-name"
},
"state": {
"type": "string",
"description": "The instance state.",
"example": "RUNNING"
},
"podDetails": {
"type": "array",
"description": "in case migration instance status is \"REQUIRES_MANUAL_MIGRATION\" then the following pod data will appear.",
"items": {
"properties": {
"id": {
"type": "string",
"description": "The pod ID.",
"example": "abc123-abc123-abc123-abc123"
},
"name": {
"type": "string",
"description": "The pod name.",
"example": "podName"
},
"kind": {
"type": "string",
"description": "The pod kind, currently divided into STAND_ALONE_POD & UNKNOWN",
"example": "STAND_ALONE_POD"
}
}
}
},
"runningPods": {
"type": "integer",
"description": "The number of running pods.",
"example": "6"
}
}
}
},
"oldInstances": {
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D~1migration~1%7BmigrationId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items/properties/newInstances"
},
"unscheduledPodIds": {
"type": "string",
"example": "o-abcd1234",
"description": "List of the unscedueled pod ids.\n"
},
"newUnscheduledPodIds": {
"type": "string",
"example": "o-abcd1234",
"description": "List of the new unscedueled pod ids.\n"
},
"migrationConfig": {
"type": "object",
"description": "The object specifying the configuration flags when migration created.\n",
"properties": {
"shouldTerminateDrainedNodes": {
"type": "boolean",
"example": true,
"description": "Ocean will terminate the old instances once the pods that reside on them are migrated, and the old instances are fully drained.\n"
},
"shouldEvictStandAlonePods": {
"type": "boolean",
"example": true,
"description": "Ocean will terminate pods that do not belong to a Kubernetes deployment. This means that you would need to launch the pod manually (after the migration) due to the fact that there is no object that would do it automatically.\n"
}
}
},
"createdAt": {
"type": "string",
"example": "2021-10-1T05:51:06.000Z",
"description": "When this migration was created.\n"
},
"erroredAt": {
"type": "string",
"example": "2021-10-1T05:51:06.000Z",
"description": "When this migration received an error.\n"
},
"stoppedAt": {
"type": "string",
"example": "2021-10-1T05:51:06.000Z",
"description": "When this migration was stopped.\n"
},
"completedAt": {
"type": "string",
"example": "2021-10-1T05:51:06.000Z",
"description": "When this migration was completed.\n"
}
}
}
},
"kind": {
"example": "spotinst:ocean:aws:k8s:cluster:migration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"put": {
"summary": "Stop Migration",
"description": "Stop an ongoing Workload Migration.\n",
"operationId": "oceanAwsPutMigration",
"tags": [
"Ocean AWS"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1aws~1ecs~1cluster~1%7BoceanClusterId%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D~1migration~1%7BmigrationId%7D/get/parameters/2"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"migration"
],
"properties": {
"migration": {
"required": [
"state"
],
"type": "object",
"description": "Migration update configuration.\n",
"properties": {
"shouldTerminateDrainedNodes": {
"type": "boolean",
"example": true,
"default": false,
"description": "Ocean will terminate the old instances once the pods that reside on them are migrated, and the old instances are fully drained.\n"
},
"state": {
"type": "string",
"description": "The only allowed state to update is to \"STOPPED\". This state will stop a running migration.\n",
"example": "STOPPED"
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Migrations Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "ocean/aws/k8s/cluster/o-1234567/migration/owm-abc1234"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"properties": {
"items": {
"type": "array",
"items": {
"properties": {
"id": {
"example": "owm-6e3819ae",
"description": "The migration identifier of a specific migration.\n",
"type": "string"
},
"oceanId": {
"type": "string",
"description": "The identifier of the ocean cluster belong the migration.\n",
"example": "o-12e31234"
},
"state": {
"type": "string",
"description": "if update succeeded, the return value should be \"STOPPED\".\n",
"example": "STOPPED"
}
}
}
},
"kind": {
"example": "spotinst:ocean:aws:k8s:cluster:migration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/insights/k8s/cluster": {
"summary": "Ocean Insights",
"post": {
"summary": "Create Cluster",
"description": "Creates an Ocean Insight entity according to a given specification.\n\nPrerequisite:\n\nThe Ocean Controller is used to monitor the cluster resources and report back to Ocean. The Ocean Controller is required for Ocean Insights.
\n\nTo install the Ocean Controller, complete and run the following script on a machine with the kubectl command line tool installed and configured:\n\n```\n#!/usr/bin/env bash\ncurl -fsSL http://spotinst-public.s3.amazonaws.com/integrations/kubernetes/cluster-controller/scripts/init.sh | \\\nSPOTINST_TOKEN= \\\nSPOTINST_ACCOUNT= \\\nSPOTINST_CLUSTER_IDENTIFIER= \\\nbash\n```\n",
"operationId": "OceanInsightsClusterCreate",
"tags": [
"Ocean Insights"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"cluster"
],
"properties": {
"cluster": {
"type": "object",
"title": "Ocean Insight",
"required": [
"name",
"controllerClusterId"
],
"properties": {
"id": {
"type": "string",
"example": "oic-12345abc",
"readOnly": true,
"description": "Ocean Insight Cluster ID.\n"
},
"name": {
"type": "string",
"example": "Ocean::my-ocean-insight-name",
"description": "Add a name for the Ocean Insight cluster.\n"
},
"controllerClusterId": {
"type": "string",
"example": "oceanInsight.k8s",
"description": "The reporting identifier for the Ocean Controller.\n"
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2019-06-03T08:13:08.000Z",
"description": "A timestamp of the Ocean insight creation.\n"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2019-06-10T15:06:13.000Z",
"description": "A timestamp of the latest Ocean insight update.\n"
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Insight Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/insight/k8s/cluster"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1insights~1k8s~1cluster/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:ocean:insight:k8s"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Clusters",
"description": "Get the configurations for all Ocean Insights clusters in the specified account.\n",
"operationId": "OceanInsightsClusterList",
"tags": [
"Ocean Insights"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"description": "Ocean Insight Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/insight/k8s/cluster"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"description": "The Ocean Insight cluster.\n",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"example": "o-134abcd",
"description": "Ocean Insight cluster ID.\n"
},
"name": {
"type": "string",
"example": "test",
"description": "Ocean Insight cluster name.\n"
},
"controllerClusterId": {
"type": "string",
"example": "test-123124",
"description": "The reporting identifier for the Ocean Controller.\n"
},
"createdAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T08:13:08.000Z",
"description": "A timestamp of the Ocean creation.\n"
},
"updatedAt": {
"type": "string",
"readOnly": true,
"format": "date-time",
"example": "2021-03-17T15:06:13.000Z",
"description": "A timestamp of the latest Ocean update.\n"
}
}
}
},
"kind": {
"example": "spotinst:ocean:insight:k8s"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/insights/k8s/cluster/{OCEAN_INSIGHT_ID}": {
"get": {
"summary": "Get Cluster",
"description": "Get the configurations for a specified Ocean Insight cluster.\n",
"operationId": "OceanInsightsClusterGet",
"tags": [
"Ocean Insights"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "path",
"name": "OCEAN_INSIGHT_ID",
"schema": {
"type": "string"
},
"required": true,
"example": "oic-abcd1234",
"description": "The ID of the Ocean Insight cluster.\n"
}
],
"responses": {
"200": {
"description": "Ocean Insight Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/insight/k8s/cluster/oic-12345abc"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1insights~1k8s~1cluster/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:ocean:insight:k8s"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"delete": {
"summary": "Delete Cluster",
"description": "Delete a specified Ocean Insight cluster.\n",
"operationId": "OceanInsightClusterDelete",
"tags": [
"Ocean Insights"
],
"parameters": [
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1insights~1k8s~1cluster~1%7BOCEAN_INSIGHT_ID%7D/get/parameters/1"
}
],
"responses": {
"200": {
"description": "Ocean Insight Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/insight/k8s/cluster/oic-12345abc"
},
"method": {
"example": "DELETE"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/insights/savings": {
"get": {
"summary": "Get Organization Savings",
"description": "Get the savings of the organization between the input time range.",
"operationId": "organizationSavings",
"tags": [
"Insights Service"
],
"parameters": [
{
"in": "query",
"name": "fromDate",
"example": "2022-06-20",
"description": "Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472).\n*Minimum from date can be one year ago.\n",
"schema": {
"type": "string"
},
"required": false
},
{
"in": "query",
"name": "toDate",
"example": "2022-11-20",
"description": "Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472).\n*Data is shown until the past day (Does not include today's costs)\n",
"schema": {
"type": "string"
},
"required": false
},
{
"in": "query",
"name": "includeVmIds",
"example": "true",
"description": "If set to true, the response will include the VM IDs for each savings entry.\nDefault is false.\n",
"schema": {
"type": "boolean",
"default": false
},
"required": false
}
],
"responses": {
"200": {
"description": "organization savings Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"request": {
"type": "object",
"description": "Original request properties\n",
"properties": {
"id": {
"type": "string",
"example": "67582d0c-108b-4ef7-9fdc-d39678a30844",
"description": "Unique ID associated with this request\n"
},
"url": {
"type": "string",
"example": "/insights/savings",
"description": "The URL that was used for the request\n"
},
"method": {
"type": "string",
"example": "GET",
"description": "The HTTP **METHOD** used for the request\n"
},
"timestamp": {
"type": "string",
"example": "2022-01-10T00:00:00.000Z",
"description": "When the request was received by Spot\n"
}
}
},
"response": {
"type": "object",
"description": "Response package that includes, status, type and any relevant data.\n",
"properties": {
"status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200,
"description": "HTTP status code assigned to this response\n"
},
"message": {
"type": "string",
"example": "OK",
"description": "HTTP status message for the respective status code\n"
}
}
}
}
}
}
},
{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"example": "savings:extended:resource",
"description": "The data type of each item in the response\n"
},
"items": {
"type": "array",
"description": "Array of data objects\n",
"items": {
"type": "object",
"title": "savings:extended:resource",
"properties": {
"resources": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"example": "act-12345678"
},
"accountName": {
"type": "string",
"example": "production account"
},
"resourceId": {
"type": "string",
"example": "o-7dd944535"
},
"resourceName": {
"type": "string",
"example": "Ocean Kubernetes cluster name"
},
"productType": {
"type": "string",
"example": "AWS_KUBERNETES_OCEAN"
},
"runningHours": {
"type": "number",
"format": "float",
"example": 107.3
},
"actualCosts": {
"type": "number",
"format": "float",
"example": 107.3
},
"potentialCosts": {
"type": "number",
"format": "float",
"example": 378.41
},
"amountSaved": {
"type": "number",
"format": "float",
"example": 306.77
}
}
},
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"example": "act-87654321"
},
"accountName": {
"type": "string",
"example": "dev account"
},
"resourceId": {
"type": "string",
"example": "sig-7drr944535"
},
"resourceName": {
"type": "string",
"example": "Elastigroup name"
},
"productType": {
"type": "string",
"example": "AWS_ELASTIGROUP"
},
"runningHours": {
"type": "number",
"format": "float",
"example": 10
},
"actualCosts": {
"type": "number",
"format": "float",
"example": 100
},
"potentialCosts": {
"type": "number",
"format": "float",
"example": 1100
},
"amountSaved": {
"type": "number",
"format": "float",
"example": 1000
}
}
}
]
}
},
"summary": {
"type": "object",
"properties": {
"runningHours": {
"type": "number",
"format": "float",
"example": 117.3
},
"actualCosts": {
"type": "number",
"format": "float",
"example": 207.3
},
"potentialCosts": {
"type": "number",
"format": "float",
"example": 11378.41
},
"amountSaved": {
"type": "number",
"format": "float",
"example": 1306.77
}
}
}
}
}
},
"count": {
"type": "integer",
"example": 1,
"description": "Size of the data object array\n"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/connect/executions/formatted_execution/{exe_id}": {
"get": {
"description": "Get details for the selected workflow execution.",
"operationId": "get_formatted_execution_instance",
"parameters": [
{
"description": "unique execution id",
"in": "path",
"name": "exe_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"AutomationExecutionId": {
"description": "SSM doc automation execution id.",
"type": "string"
},
"AutomationExecutionStatus": {
"description": "Status of execution.",
"type": "string"
},
"DocumentName": {
"description": "Name of the workflow",
"type": "string"
},
"DocumentVersion": {
"description": "Executed version of the workflow.",
"type": "integer"
},
"ExecutedBy": {
"description": "AWS role that executed the workflow.",
"type": "string"
},
"ExecutionEndTime": {
"description": "Time at which execution ended.",
"format": "date-time",
"type": "string"
},
"ExecutionStartTime": {
"description": "Start time of the execution.",
"format": "date-time",
"type": "string"
},
"Mode": {
"type": "string"
},
"Outputs": {
"description": "Outputs of the execution.",
"properties": {},
"type": "object"
},
"Parameters": {
"description": "Runtime parameters for execution.",
"properties": {},
"type": "object"
},
"PostProcessingCompletedAt": {
"description": "Time at which post processing was completed.",
"format": "date-time",
"type": "string"
},
"ResolvedTargets": {
"properties": {},
"type": "object"
},
"StepExecutions": {
"description": "List of steps in workflow execution.",
"items": {
"properties": {
"Action": {
"description": "Action of the step in the workflow.",
"type": "string"
},
"ExecutionEndTime": {
"description": "Time when step execution ended.",
"format": "date-time",
"type": "string"
},
"ExecutionStartTime": {
"description": "Time when execution started.",
"format": "date-time",
"type": "string"
},
"Inputs": {
"description": "Inputs for the step.",
"properties": {},
"type": "object"
},
"IsEnd": {
"description": "Indicator for final step.",
"type": "boolean"
},
"NextStep": {
"description": "Name of the next step.",
"type": "string"
},
"Outputs": {
"description": "Outputs of the step.",
"properties": {},
"type": "object"
},
"OverriddenParameters": {
"description": "Overridden Parameters of the step.",
"properties": {},
"type": "object"
},
"StepExecutionId": {
"description": "Unique execution id of the step.",
"type": "string"
},
"StepName": {
"description": "Name of the step.",
"type": "string"
},
"StepStatus": {
"description": "Status of the step.",
"type": "string"
},
"ValidNextSteps": {
"description": "Valid next steps in the workflow.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"Targets": {
"items": {
"type": "string"
},
"type": "array"
},
"TaskId": {
"description": "Integer id for execution task.",
"type": "integer"
},
"TenantId": {
"description": "Tenant id of the owner of the workflow.",
"type": "string"
},
"Trigger": {
"description": "User who triggered the workflow.",
"type": "string"
},
"WorkflowDeleted": {
"description": "Indicator if workflow is deleted.",
"type": "boolean"
},
"WorkspaceId": {
"description": "ID of workspace this workflow belongs to.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad request"
}
},
"summary": "Get Execution",
"tags": [
"Connect Executions"
]
},
"parameters": []
},
"/connect/executions/formatted_execution/{exe_id}/download": {
"get": {
"description": "Get link to download details for the selected workflow execution.",
"operationId": "get_formatted_execution_instance_download",
"parameters": [
{
"$ref": "#/paths/~1connect~1executions~1formatted_execution~1%7Bexe_id%7D/get/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"redirect_url": {
"description": "Redirect url.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad request"
}
},
"summary": "Get Execution download url",
"tags": [
"Connect Executions"
]
},
"parameters": []
},
"/connect/executions/{name}": {
"parameters": [],
"post": {
"description": "Start the execution of the selected workflow.",
"operationId": "post_workflow_execution",
"parameters": [
{
"description": "DisplayName of a workflow",
"in": "path",
"name": "name",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Selected workflow version",
"in": "query",
"name": "version",
"schema": {
"type": "string"
}
},
{
"description": "Currently selected Workspace ID",
"in": "query",
"name": "workspace_id",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"exe_id": {
"description": "Execution ID",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Created"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Start Execution",
"tags": [
"Connect Executions"
]
}
},
"/connect/schedules": {
"get": {
"description": "List all scheduled workflows of the selected workspace.",
"operationId": "get_schedules_list",
"parameters": [
{
"description": "(optional) filter related schedules to a task",
"in": "query",
"name": "task_id",
"schema": {
"type": "string"
}
},
{
"description": "currently selected Workspace ID",
"in": "query",
"name": "workspace_id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"items": {
"description": "List of workflow schedules.",
"items": {
"properties": {
"created_at": {
"description": "Time when the schedule was created.",
"type": "string"
},
"created_by": {
"description": "Tenant ID for the user who created the schedule.",
"type": "integer"
},
"created_by_username": {
"description": "Name of the user who created the schedule.",
"type": "string"
},
"enabled": {
"description": "Status of the schedule (true for active and false for inactive).",
"type": "boolean"
},
"rule": {
"description": "Rule ID of the schedule",
"type": "string"
},
"schedule_expression": {
"description": "CRON expression for the schedule.",
"type": "string"
},
"task_id": {
"description": "Task ID for the schedule.",
"type": "integer"
},
"workflow": {
"description": "Name of the workflow.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "List Scheduled Workflows",
"tags": [
"Connect Schedules"
]
},
"parameters": []
},
"/connect/schedules/{workflow_name}": {
"delete": {
"description": "Delete a selected execution schedule of the selected workflow.",
"operationId": "delete_workflow_schedules",
"parameters": [
{
"$ref": "#/paths/~1connect~1schedules~1%7Bworkflow_name%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1schedules/get/parameters/1"
},
{
"$ref": "#/paths/~1connect~1schedules~1%7Bworkflow_name%7D/put/parameters/2"
}
],
"responses": {
"200": {
"content": {},
"description": "Deleted"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Delete Schedule",
"tags": [
"Connect Schedules"
]
},
"get": {
"description": "List all execution schedules for the selected workflow.",
"operationId": "get_workflow_schedules",
"parameters": [
{
"description": "unique workflow name only",
"in": "path",
"name": "workflow_name",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1schedules/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1schedules/get/responses/200/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "List Schedules for Workflow",
"tags": [
"Connect Schedules"
]
},
"parameters": [],
"post": {
"description": "Create a new execution schedule for the selected workflow.",
"operationId": "post_workflow_schedules",
"parameters": [
{
"$ref": "#/paths/~1connect~1schedules~1%7Bworkflow_name%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1schedules/get/parameters/1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"expression": {
"description": "CRON expression of the schedule.",
"type": "string"
},
"params": {
"description": "Runtime parameters for the workflow.",
"properties": {},
"type": "object"
},
"version": {
"description": "Version of the workflow.",
"type": "integer"
}
},
"required": [
"expression",
"version"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"rule_name": {
"description": "Rule ID of the schedule.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Created"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Create Schedule",
"tags": [
"Connect Schedules"
],
"x-codegen-request-body-name": "payload"
},
"put": {
"description": "Enable/disable the status of the selected execution schedule.",
"operationId": "put_workflow_schedules",
"parameters": [
{
"$ref": "#/paths/~1connect~1schedules~1%7Bworkflow_name%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1schedules/get/parameters/1"
},
{
"description": "version of workflow in schedule",
"in": "query",
"name": "version",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Update Schedule Status",
"tags": [
"Connect Schedules"
]
}
},
"/connect/settings/apikeys": {
"get": {
"description": "Endpoint to fetch list of API Keys and its values.",
"operationId": "get_settings_api_keys",
"parameters": [
{
"description": "Disable redacting API keys",
"in": "query",
"name": "disable_redact",
"schema": {
"type": "string"
}
},
{
"description": "Currently selected Workspace ID",
"in": "query",
"name": "workspace_id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"apikeys": {
"description": "List of API keys.",
"items": {
"$ref": "#/paths/~1connect~1settings~1apikeys~1%7Bapikey_name%7D/get/responses/200/content/application~1json/schema/properties/body/allOf/0"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "List API Keys",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/apikeys/{apikey_name}": {
"delete": {
"description": "Endpoint to delete an API Key.",
"operationId": "delete_settings_api_key_item",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1apikeys~1%7Bapikey_name%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1settings~1slack~1finish_oauth/post/responses/200/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Delete API Key",
"tags": [
"Connect Settings"
]
},
"get": {
"description": "Endpoint to fetch the selected API key's information from the selected workspace.",
"operationId": "get_settings_api_key_item",
"parameters": [
{
"description": "API key name",
"in": "path",
"name": "apikey_name",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"ApikeyName": {
"description": "API key name.",
"type": "string"
},
"CreatedDate": {
"description": "API key creation date.",
"format": "date-time",
"type": "string"
},
"Value": {
"description": "API key value.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Get API Key",
"tags": [
"Connect Settings"
]
},
"parameters": [],
"post": {
"description": "Endpoint to create a new API Key.",
"operationId": "post_settings_api_key_item",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1apikeys~1%7Bapikey_name%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1slack~1finish_oauth/post/responses/200/content/application~1json/schema/properties/body/allOf/0"
},
{
"properties": {
"value": {
"description": "API key value.",
"type": "string"
}
},
"type": "object"
}
]
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Created"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Create API Key",
"tags": [
"Connect Settings"
]
},
"put": {
"description": "Move the API key to the new workspace.",
"operationId": "put_settings_api_key_item",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1apikeys~1%7Bapikey_name%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1settings~1slack~1finish_oauth/post/responses/200/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Update API Key",
"tags": [
"Connect Settings"
]
}
},
"/connect/settings/available/{service}": {
"parameters": [],
"post": {
"description": "Checks whether given Alias name is available for use\nfor the selected service in the current organization.",
"operationId": "post_setting_check_alias",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"alias": {
"description": "The alias to check availability for.",
"type": "string"
}
},
"required": [
"alias"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"alias": {
"description": "The alias that was checked for availability.",
"type": "string"
},
"available": {
"description": "Whether the alias is available for use. True for available and false for not available.",
"type": "boolean"
},
"message": {
"description": "A message indicating the availability of the alias.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Get Alias Name Availability",
"tags": [
"Connect Settings"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/settings/connectors": {
"get": {
"description": "Retrieve a list of all enabled connectors (integration or resource), excluding those that are\nexclusively trigger-based. For each connector, extract essential settings from its schema and\ndetermine a boolean status indicating whether it's configured or not.",
"operationId": "get_settings_connector_discovery",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"ansible": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "ansible connector details.",
"type": "object"
},
"apikeys": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "apikeys connector details.",
"type": "object"
},
"aws": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "aws connector details.",
"type": "object"
},
"aws_health": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "aws_health connector details.",
"type": "object"
},
"azure": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "azure connector details.",
"type": "object"
},
"azure_openai": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "azure_openai connector details.",
"type": "object"
},
"bitbucket": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "bitbucket connector details.",
"type": "object"
},
"cloudformation": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "cloudformation connector details.",
"type": "object"
},
"datadog": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "datadog connector details.",
"type": "object"
},
"eks": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "eks connector details.",
"type": "object"
},
"elasticsearch": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "elasticsearch connector details.",
"type": "object"
},
"gcp": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "gcp connector details.",
"type": "object"
},
"git": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "git connector details.",
"type": "object"
},
"gke": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "gke connector details.",
"type": "object"
},
"http": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "http connector details.",
"type": "object"
},
"humio": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "humio connector details.",
"type": "object"
},
"instana": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "instana connector details.",
"type": "object"
},
"jenkins": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "jenkins connector details.",
"type": "object"
},
"jira": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "jira connector details.",
"type": "object"
},
"new_relic": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "new_relic connector details.",
"type": "object"
},
"opsgenie": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "opsgenie connector details.",
"type": "object"
},
"pagerduty": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "pagerduty connector details.",
"type": "object"
},
"prometheus": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "prometheus connector details.",
"type": "object"
},
"pulumi": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "pulumi connector details.",
"type": "object"
},
"s3": {
"allOf": [
{
"properties": {
"coming_soon": {
"description": "Whether the connector is coming soon. True for coming soon and false if connector is active.",
"type": "boolean"
},
"connector_type": {
"description": "Type of connector (Integration, Resource, Cloud).",
"type": "string"
},
"connectors": {
"items": {
"description": "List of integrations this connector depends on.",
"type": "string"
},
"type": "array"
},
"display_name": {
"description": "Display name of the connector.",
"type": "string"
},
"is_configured": {
"description": "Whether the connector is configured. True if configured and false for not configured.",
"type": "boolean"
},
"is_trigger": {
"description": "Whether the connector is trigger-based. True for trigger based and false for not trigger based.",
"type": "boolean"
}
},
"type": "object"
}
],
"description": "s3 connector details.",
"type": "object"
},
"servicenow": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "servicenow connector details.",
"type": "object"
},
"slack": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "slack connector details.",
"type": "object"
},
"sns": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "sns connector details.",
"type": "object"
},
"splunk": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "splunk connector details.",
"type": "object"
},
"splunk_on_call": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "splunk_on_call connector details.",
"type": "object"
},
"spot": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "spot connector details.",
"type": "object"
},
"spot_security": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "spot_security connector details.",
"type": "object"
},
"ssh": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "ssh connector details.",
"type": "object"
},
"sumologic": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "sumologic connector details.",
"type": "object"
},
"terraform": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "terraform connector details.",
"type": "object"
},
"terraform_cli": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "terraform_cli connector details.",
"type": "object"
},
"twilio": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "twilio connector details.",
"type": "object"
},
"zendesk": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1connectors/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
}
],
"description": "zendesk connector details.",
"type": "object"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"content": {},
"description": "Not Found"
}
},
"summary": "List Enabled Connectors",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/jira/finish_oauth": {
"parameters": [],
"post": {
"description": "API for status of Jira OAuth approval by Customer (Jira administrator).",
"operationId": "post_jira_auth_settings",
"parameters": [
{
"description": "URL of the Jira instance.",
"in": "query",
"name": "jira_url",
"schema": {
"type": "string"
}
},
{
"description": "The request token provided by Jira for the integration.",
"in": "query",
"name": "req_token",
"schema": {
"type": "string"
}
},
{
"description": "The request token secret provided by Jira for the integration.",
"in": "query",
"name": "req_token_secret",
"schema": {
"type": "string"
}
},
{
"description": "Slack integration alias.",
"in": "query",
"name": "alias",
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1slack~1finish_oauth/post/responses/200/content/application~1json/schema/properties/body/allOf/0"
},
{
"properties": {
"status": {
"description": "Integration status. 'Successful' if the integration was created successfully; otherwise, an error message indicating the failure reason.",
"type": "string"
}
},
"type": "object"
}
]
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
},
"403": {
"content": {},
"description": "Forbidden"
}
},
"summary": "Authenticate Jira Integration",
"tags": [
"Connect Settings"
]
}
},
"/connect/settings/jira/integration_url": {
"get": {
"description": "This API is used to fetch Jira authorization URL.",
"operationId": "get_jira_settings",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1jira~1finish_oauth/post/parameters/3"
},
{
"$ref": "#/paths/~1connect~1settings~1jira~1finish_oauth/post/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"alias": {
"description": "Alias for the Jira integration.",
"type": "string"
},
"jira_url": {
"description": "The URL of your Jira instance.",
"type": "string"
},
"req_token": {
"description": "The request token provided by Jira for the integration.",
"type": "string"
},
"req_token_secret": {
"description": "The request token secret provided by Jira for the integration.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Get Jira Authorization URL",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/plans": {
"get": {
"description": "Fetch various Spot Connect plan details with quotas and pricing.",
"operationId": "get_plan_details",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"commercial": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1plans/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/free/allOf/0"
}
],
"description": "Commercial plan details.",
"type": "object"
},
"free": {
"allOf": [
{
"properties": {
"execution_limit": {
"description": "Execution limit for the plan.",
"type": "integer"
},
"pricing": {
"description": "Pricing for the plan.",
"type": "integer"
},
"workflow_limit": {
"description": "Workflow limit for the plan.",
"type": "integer"
}
},
"type": "object"
}
],
"description": "Free plan details.",
"type": "object"
},
"internal": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1plans/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/free/allOf/0"
}
],
"description": "Internal plan details.",
"type": "object"
},
"team": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1plans/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/free/allOf/0"
}
],
"description": "Team plan details.",
"type": "object"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Get Spot Connect Plans",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/public_ips": {
"get": {
"description": "Returns a list of public IPs for customers to whitelist.",
"operationId": "get_settings_public_i_ps",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"ips": {
"items": {
"description": "List of IP addresses.",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "List Public IPs",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/quotas": {
"get": {
"description": "Fetch quotas for organization and provide information on their limits and current status.",
"operationId": "get_quota_list",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"current_tier": {
"description": "Current plan tier.",
"type": "string"
},
"executions": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1quotas/get/responses/200/content/application~1json/schema/properties/body/allOf/0/properties/workflows/allOf/0"
}
],
"description": "Current plan's execution details.",
"type": "object"
},
"plan_renew": {
"description": "Plan renewal date.",
"format": "date-time",
"type": "string"
},
"workflows": {
"allOf": [
{
"properties": {
"available": {
"description": "Available number of workflows/executions in current plan.",
"type": "integer"
},
"current_usage": {
"description": "Total number of workflows/executions in current plan.",
"type": "integer"
},
"workflow_limit": {
"description": "Total limit of workflows/executions in current plan.",
"type": "integer"
}
},
"type": "object"
}
],
"description": "Current plan's workflow details.",
"type": "object"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Get Quotas",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/schema/{service}": {
"get": {
"description": "Get the JSON schema for the given integration or resource.",
"operationId": "get_setting_schema",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/get/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"schema": {
"description": "The JSON schema for the value.",
"properties": {},
"type": "object"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Get Schema",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/slack/finish_oauth": {
"parameters": [],
"post": {
"description": "After the user installs/authorizes the Spot Connect Slack app in their workspace,\nthey will be redirected back to the Slack integration page in the Fylamynt web app\nwith an authorization code. The web app will then call this API endpoint with that\n'code' in the query parameter. Instead, if the user rejects to authorize the Fylamynt\nSlack app in their workspace, the API request from the web app will contain the\n'error' code (e.g., error=access_denied) returned from Slack. The following code\nprocesses the request and returns success or failure response to the web app.\nSlack instance alias is part of 'state' query parameter, previously 'state' query\nparameter contained subdomain.",
"operationId": "post_slack_o_auth_post_install",
"parameters": [
{
"description": "Error message. Provide either code or an error message, but not both.",
"in": "query",
"name": "error",
"schema": {
"type": "string"
}
},
{
"description": "Slack authorization code. Provide either code or an error message, but not both.",
"in": "query",
"name": "code",
"schema": {
"type": "string"
}
},
{
"description": "Alias of the Slack integration",
"in": "query",
"name": "state",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"message": {
"description": "Success message.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"content": {},
"description": "Not Found"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Authenticate Slack Integration",
"tags": [
"Connect Settings"
]
}
},
"/connect/settings/slack/integration_url": {
"get": {
"description": "This API is used to retrieve the Slack integration URL.\nThe integration_id URI parameter is optional for this API.",
"operationId": "get_slack_integration_url",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1jira~1finish_oauth/post/parameters/3"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"integration_url": {
"description": "Integration URL of the selected integration.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Get Slack Integration URL",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/triggers": {
"get": {
"description": "Endpoint to fetch the list of trigger connectors each containing the name, display name, snippet name, and\nconfiguration status of the respective connector.",
"operationId": "get_trigger_connector_discovery",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"triggers": {
"items": {
"allOf": [
{
"properties": {
"display_name": {
"description": "Display name of the trigger.",
"type": "string"
},
"is_configured": {
"description": "Boolean for the integration status of the connector (This is deprecated and now the value is set to True always).",
"type": "boolean"
},
"name": {
"description": "System name of the trigger service (including the 'manual' option).",
"type": "string"
},
"snippet_name": {
"description": "Name of the associated snippet to load as the first anchor node in the Editor.",
"type": "string"
}
},
"type": "object"
}
],
"description": "List of triggers.",
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "List Trigger Connectors",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/zoom/finish_oauth": {
"parameters": [],
"post": {
"description": "authorization code in the query parameter. Once we receive this request,\nwe will use the auth code and exchange it for an OAuth token with a\nrequest type 'authorization_code' by calling back to Zoom.\nIf we successfully exchange the auth code for a token, we will then save\nthe returned 'refresh_token' to secrets manager.",
"operationId": "post_zoom_o_auth_post_install",
"responses": {
"200": {
"content": {},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "The Fylamynt web app will make a POST request to this endpoint that contains an",
"tags": [
"Connect Settings"
]
}
},
"/connect/settings/zoom/integration_url": {
"get": {
"operationId": "get_zoom_integration_url",
"responses": {
"200": {
"content": {},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "This API is used for fetching the Zoom app integration URL",
"tags": [
"Connect Settings"
]
},
"parameters": []
},
"/connect/settings/{service}": {
"get": {
"description": "Get the list of instances for a given service.",
"operationId": "get_setting_items",
"parameters": [
{
"description": "Name of connector service (value=ansible|apikeys|bitbucket|datadog|git|humio|instana|jira|opsgenie|aws_health|pagerduty|prometheus|pulumi|slack|splunk|splunk_on_call|spot|squadcast|terraform|terraform_cli|twilio|zoom)",
"in": "path",
"name": "service",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"description": "List of integrations. The body contains a list of integration credentials.",
"items": {
"properties": {},
"type": "object"
},
"type": "array"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "List Integration Instances",
"tags": [
"Connect Settings"
]
},
"parameters": [],
"post": {
"description": "Create a new secret for a given service.\n\nThe `Example model` contains models for all services that can be created.\nWhen calling this endpoint for a specific service, only the credentials\nfor that service should be provided in the payload.\n\nThe payload should be structured with the credentials inside a 'credentials' key.\nFor example, for an S3 integration:\n\n{\n \"credentials\": {\n \"alias\": \"my-s3-integration\",\n \"target\": \"my-target\",\n \"name\": \"my-bucket-name\"\n }\n}\n\nNot all fields from all_input_models need to be sent in the payload,\nonly those relevant to the specific service being created.\n\nResponse will be the instance credentials that was created.",
"operationId": "post_setting_items",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"ansible": {
"properties": {
"alias": {
"description": "Alias for Ansible integration instance.",
"type": "string"
},
"logs": {
"description": "Optional S3 bucket for execution logs. If not given, the logs will be uploaded to the same S3 bucket with the playbooks.",
"type": "string"
},
"playbooks": {
"description": "S3 bucket with playbooks directory.",
"type": "string"
},
"s3_access_role": {
"description": "Fylamynt IAM role for bucket policy in target account.",
"type": "string"
},
"ssh_private_key": {
"description": "Ansible Controller Private ssh key.",
"type": "string"
}
},
"type": "object"
},
"azure_openai": {
"properties": {
"alias": {
"description": "Alias for OpenAI integration instance.",
"type": "string"
},
"api_key": {
"description": "API Key for your API.",
"type": "string"
},
"azure_endpoint": {
"description": "Azure Endpoint for your OpenAI service API.",
"type": "string"
},
"model": {
"description": "The deployment Name of the model deployed in user's Azure OpenAI Service.",
"type": "string"
}
},
"type": "object"
},
"bitbucket": {
"properties": {
"access_token": {
"description": "Bitbucket Cloud Access Token for authentication using Access Token.",
"type": "string"
},
"alias": {
"description": "Alias for Bitbucket repo instance.",
"type": "string"
},
"url": {
"description": "Bitbucket repository URL, ex: Bitbucket personal repo -> `https://bitbucket.org//` for Bitbucket workspace repo -> `https://bitbucket.org//`.",
"type": "string"
}
},
"type": "object"
},
"cloudformation": {
"properties": {
"alias": {
"description": "Alias for Cloudformation template.",
"type": "string"
},
"filePath": {
"description": "Absolute filepath of template file.",
"type": "string"
},
"ref": {
"description": "Github commit ref, (ie: main/master).",
"type": "string"
},
"repoId": {
"description": "The GitHub repo as a source for the Cloudformation template.",
"type": "string"
}
},
"type": "object"
},
"datadog": {
"properties": {
"alias": {
"description": "Alias for Datadog integration instance.",
"type": "string"
},
"api_key": {
"description": "Datadog API key for your org.",
"type": "string"
},
"app_key": {
"description": "Datadog application key for your org.",
"type": "string"
}
},
"type": "object"
},
"eks": {
"properties": {
"alias": {
"description": "Alias for EKS Permissions resource instance.",
"type": "string"
},
"role_arn": {
"description": "IAM Role ARN to be used for the EKS cluster.",
"type": "string"
},
"target": {
"description": "AWS Target Account for the EKS Cluster Role.",
"type": "string"
}
},
"type": "object"
},
"elasticsearch": {
"properties": {
"alias": {
"description": "Alias for Datadog integration instance.",
"type": "string"
},
"api_key_id": {
"description": "Elasticsearch API key id.",
"type": "string"
},
"api_key_value": {
"description": "Elasticsearch API key value.",
"type": "string"
},
"cloud_id": {
"description": "Unique Id to configure your client to work with your Elastic Cloud deployment.",
"type": "string"
}
},
"type": "object"
},
"git": {
"properties": {
"access_token": {
"description": "Github Access Token for authentication using Access Token.",
"type": "string"
},
"alias": {
"description": "Alias for GitHub repo instance.",
"type": "string"
},
"url": {
"description": "Git repository URL, ex: GitHub personal repo -> `https://github.com//` for Organization repo -> `https://github.com//`.",
"type": "string"
}
},
"type": "object"
},
"gke": {
"properties": {
"alias": {
"description": "Alias for GKE integration instance.",
"type": "string"
},
"service_account_key": {
"description": "Provide Service Account Key in JSON Format.",
"type": "string"
}
},
"type": "object"
},
"http": {
"properties": {
"alias": {
"description": "Alias for Http Endpoint integration instance.",
"type": "string"
},
"api_key": {
"description": "API Key for authentication.",
"type": "string"
},
"authorization_type": {
"description": "Select a method for HTTP request authorization.",
"type": "string"
},
"password": {
"description": "Password for authentication.",
"type": "string"
},
"token": {
"description": "Bearer token for authentication.",
"type": "string"
},
"url": {
"description": "A valid URL string based on the secure HTTPS protocol is required.",
"type": "string"
},
"username": {
"description": "Username for authentication.",
"type": "string"
}
},
"type": "object"
},
"humio": {
"properties": {
"alias": {
"description": "Alias for Humio integration instance.",
"type": "string"
},
"humio_api_token": {
"description": "API Token obtained from Humio.",
"type": "string"
},
"humio_url": {
"description": "Provide Humio Cloud URL, example: https://cloud.us.humio.com.",
"type": "string"
}
},
"type": "object"
},
"jenkins": {
"properties": {
"alias": {
"description": "Alias for Jenkins integration instance.",
"type": "string"
},
"api_token": {
"description": "API Token from authorized user.",
"type": "string"
},
"server_url": {
"description": "Jenkins server url:port.",
"type": "string"
},
"username": {
"description": "Jenkins Username associated with the token.",
"type": "string"
}
},
"type": "object"
},
"jira": {
"properties": {
"JIRA_ACCESS_TOKEN": {
"description": "Jira Access Token.",
"type": "string"
},
"JIRA_CONSUMER_KEY": {
"description": "Consumer Key for Fylamynt Application in Jira.",
"type": "string"
},
"JIRA_CONSUMER_NAME": {
"description": "Consumer Name for Fylamynt Application in Jira.",
"type": "string"
},
"JIRA_KEY_CERT": {
"description": "Jira Key Certificate.",
"type": "string"
},
"JIRA_PUBLIC_KEY": {
"description": "Public Key for Fylamynt Application in Jira.",
"type": "string"
},
"JIRA_TOKEN_SECRET": {
"description": "Jira Token Secret.",
"type": "string"
},
"JIRA_URL": {
"description": "URL of your Jira account.",
"type": "string"
},
"alias": {
"description": "Alias for Jira integration instance.",
"type": "string"
}
},
"type": "object"
},
"new_relic": {
"properties": {
"account_id": {
"description": "Unique account id to recognize your new relic account.",
"type": "integer"
},
"alias": {
"description": "Alias for New Relic integration instance.",
"type": "string"
},
"api_key": {
"description": "New Relic API key.",
"type": "string"
}
},
"type": "object"
},
"pagerduty": {
"properties": {
"alias": {
"description": "Alias for PagerDuty integration instance.",
"type": "string"
},
"pagerduty_api_token": {
"description": "API Token obtained from PagerDuty.",
"type": "string"
}
},
"type": "object"
},
"pulumi": {
"properties": {
"access_token": {
"description": "Pulumi Access Token.",
"type": "string"
},
"alias": {
"description": "Alias for Pulumi integration instance.",
"type": "string"
},
"backend": {
"description": "S3 bucket with Pulumi Config.",
"type": "string"
},
"passphrase": {
"description": "Passphrase for accessing Pulumi Config.",
"type": "string"
},
"team": {
"description": "Pulumi Organization.",
"type": "string"
}
},
"type": "object"
},
"s3": {
"properties": {
"alias": {
"description": "Alias for S3 integration instance.",
"type": "string"
},
"name": {
"description": "S3 bucket name.",
"type": "string"
},
"target": {
"description": "Select an AWS Target Account for the S3 bucket.",
"type": "string"
}
},
"type": "object"
},
"servicenow": {
"properties": {
"alias": {
"description": "Alias for ServiceNow integration instance.",
"type": "string"
},
"instance_url": {
"description": "ServiceNow instance URL.",
"type": "string"
},
"password": {
"description": "Password for authorized user on ServiceNow instance.",
"type": "string"
},
"username": {
"description": "Username for authorized user on ServiceNow instance.",
"type": "string"
}
},
"type": "object"
},
"slack": {
"properties": {
"access_token": {
"description": "Slack OAuth2 token.",
"type": "string"
},
"alias": {
"description": "Alias for Slack integration instance.",
"type": "string"
},
"expire_time": {
"description": "Slack OAuth2 token expire time.",
"type": "string"
},
"refresh_token": {
"description": "Slack OAuth2 refresh token.",
"type": "string"
},
"scope": {
"description": "Permission scope for the Fylamynt App.",
"type": "string"
},
"slack_client_id": {
"description": "The ID associated with the Slack App.",
"type": "string"
},
"slack_client_secret": {
"description": "Slack App Client Secret.",
"type": "string"
},
"slack_signing_secret": {
"description": "Secret that Slack is signing every request with.",
"type": "string"
},
"slack_team_id": {
"description": "Id of Slack team/workspace that the token belongs to.",
"type": "string"
},
"slack_team_name": {
"description": "Name of Slack team/workspace that the token belongs to.",
"type": "string"
},
"slack_user_id": {
"description": "ID of the Slack user authenticated with Fylamynt.",
"type": "string"
},
"slack_user_name": {
"description": "Real name or username of the Slack user authenticated with Fylamynt.",
"type": "string"
}
},
"type": "object"
},
"splunk": {
"properties": {
"access_token": {
"description": "Token used to access the Splunk instance.",
"type": "string"
},
"alias": {
"description": "Alias for Splunk integration instance.",
"type": "string"
},
"splunk_url": {
"description": "URL of the Splunk instance (e.g. 65.132.55.921). Do not include the port number.",
"type": "string"
}
},
"type": "object"
},
"splunk_on_call": {
"properties": {
"alias": {
"description": "Alias for Splunk On-Call integration instance.",
"type": "string"
},
"api_id": {
"description": "API ID obtained from Splunk On-Call (VictorOps).",
"type": "string"
},
"api_key": {
"description": "API Key obtained from Splunk On-Call (VictorOps).",
"type": "string"
}
},
"type": "object"
},
"spot": {
"properties": {
"alias": {
"description": "Alias for Spot integration instance.",
"type": "string"
},
"api_token": {
"description": "A Spot Programmatic API Token is recommended or you may use a Personal Access Token.",
"type": "string"
}
},
"type": "object"
},
"ssh": {
"properties": {
"alias": {
"description": "Alias for SSH target instance.",
"type": "string"
},
"hostIdentifier": {
"description": "Identifier for SSH target host such as hostname or public IPv4.",
"type": "string"
},
"privateKey": {
"description": "Private RSA key to run command without username/password.",
"type": "string"
}
},
"type": "object"
},
"sumologic": {
"properties": {
"access_id": {
"description": "Unique access_id to access your Sumo Logic account.",
"type": "string"
},
"access_key": {
"description": "API key for authorization.",
"type": "string"
},
"alias": {
"description": "Alias for Sumologic integration instance.",
"type": "string"
}
},
"type": "object"
},
"terraform": {
"properties": {
"alias": {
"description": "Alias for Terraform Cloud integration instance.",
"type": "string"
},
"organization": {
"description": "Terraform Cloud organization.",
"type": "string"
},
"token": {
"description": "Terraform Cloud API token (User or team token only).",
"type": "string"
}
},
"type": "object"
},
"terraform_cli": {
"properties": {
"alias": {
"description": "Alias for Terraform CLI instance.",
"type": "string"
},
"git_repo": {
"description": "The GIT repo as a source for the Terraform module.",
"type": "string"
},
"root": {
"description": "Directory with root module (defaults to .).",
"type": "string"
},
"s3_bucket": {
"description": "An S3 bucket as a source for the Terraform module.",
"type": "string"
},
"source_type": {
"description": "Different terraform source options.",
"type": "string"
}
},
"type": "object"
},
"twilio": {
"properties": {
"accountSid": {
"description": "Account SID from Twilio dashboard to identify user at twilio end.",
"type": "string"
},
"alias": {
"description": "Alias for Twilio integration instance.",
"type": "string"
},
"authToken": {
"description": "Authentication token for Twilio account.",
"type": "string"
}
},
"type": "object"
},
"zendesk": {
"properties": {
"alias": {
"description": "Alias for Zendesk integration instance.",
"type": "string"
},
"api_token": {
"description": "API token for authorization.",
"type": "string"
},
"email": {
"description": "Email id associated with your Zendesk account.",
"type": "string"
},
"subdomain_name": {
"description": "Enter Zendesk Subdomain name - https://.zendesk.com.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"allOf": [
{
"properties": {
"ansible": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"playbooks": {
"description": "S3 bucket with playbooks directory.",
"type": "string"
},
"s3_access_role": {
"description": "Fylamynt IAM role for bucket policy in target account.",
"type": "string"
},
"ssh_private_key": {
"description": "Ansible Controller Private ssh key.",
"type": "string"
}
},
"type": "object"
}
]
},
"azure_openai": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"api_key": {
"description": "API Key for your API.",
"type": "string"
},
"azure_endpoint": {
"description": "Azure Endpoint for your OpenAI serivce API.",
"type": "string"
},
"model": {
"description": "The deployment Name of the model deployed in user's Azure OpenAI Service.",
"type": "string"
}
},
"type": "object"
}
]
},
"bitbucket": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"access_token": {
"description": "Bitbucket Cloud Access Token for authentication using Access Token.",
"type": "string"
},
"url": {
"description": "Bitbucket repository URL, ex: Bitbucket personal repo -> `https://bitbucket.org//` for Bitbucket workspace repo -> `https://bitbucket.org//`.",
"type": "string"
}
},
"type": "object"
}
]
},
"cloudformation": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"filePath": {
"description": "Absolute filepath of template file.",
"type": "string"
},
"ref": {
"description": "Github commit ref, (ie: main/master).",
"type": "string"
},
"repoId": {
"description": "The GitHub repo as a source for the Cloudformation template.",
"type": "string"
}
},
"type": "object"
}
]
},
"datadog": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"api_key": {
"description": "Datadog API key for your org.",
"type": "string"
},
"app_key": {
"description": "Datadog application key for your org.",
"type": "string"
}
},
"type": "object"
}
]
},
"eks": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"role_arn": {
"description": "IAM Role ARN to be used for the EKS cluster.",
"type": "string"
},
"target": {
"description": "AWS Target Account for the EKS Cluster Role.",
"type": "string"
}
},
"type": "object"
}
]
},
"elasticsearch": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"api_key_id": {
"description": "Elasticsearch API key id.",
"type": "string"
},
"api_key_value": {
"description": "Elasticsearch API key value.",
"type": "string"
},
"cloud_id": {
"description": "Unique Id to configure your client to work with your Elastic Cloud deployment.",
"type": "string"
}
},
"type": "object"
}
]
},
"git": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"access_token": {
"description": "Github Access Token for authentication using Access Token.",
"type": "string"
},
"repo_name": {
"description": "Repository name.",
"type": "string"
},
"url": {
"description": "Git repository URL, ex: GitHub personal repo -> `https://github.com//` for Organization repo -> `https://github.com//`.",
"type": "string"
},
"user_name": {
"description": "Git username.",
"type": "string"
}
},
"type": "object"
}
]
},
"gke": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"service_account_key": {
"description": "Provide Service Account Key in JSON Format.",
"type": "string"
}
},
"type": "object"
}
]
},
"http": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"authorization_type": {
"description": "Select a method for HTTP request authorization.",
"type": "string"
},
"token": {
"description": "Bearer token for authentication.",
"type": "string"
},
"url": {
"description": "A valid URL string based on the secure HTTPS protocol is required.",
"type": "string"
}
},
"type": "object"
}
]
},
"humio": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"humio_api_token": {
"description": "API Token obtained from Humio.",
"type": "string"
},
"humio_url": {
"description": "Provide Humio Cloud URL, example: https://cloud.us.humio.com.",
"type": "string"
}
},
"type": "object"
}
]
},
"jenkins": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"api_token": {
"description": "API Token from authorized user.",
"type": "string"
},
"server_url": {
"description": "Jenkins server url:port.",
"type": "string"
},
"username": {
"description": "Jenkins Username associated with the token.",
"type": "string"
}
},
"type": "object"
}
]
},
"jira": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"JIRA_CONSUMER_KEY": {
"description": "Consumer Key for Fylamynt Application in Jira.",
"type": "string"
},
"JIRA_CONSUMER_NAME": {
"description": "Consumer Name for Fylamynt Application in Jira.",
"type": "string"
},
"JIRA_PUBLIC_KEY": {
"description": "Public Key for Fylamynt Application in Jira.",
"items": {
"type": "string"
},
"type": "array"
},
"JIRA_URL": {
"description": "URL of your Jira account.",
"type": "string"
}
},
"type": "object"
}
]
},
"new_relic": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"account_id": {
"description": "Unique account id to recognize your new relic account.",
"type": "integer"
},
"api_key": {
"description": "New Relic API key.",
"type": "string"
}
},
"type": "object"
}
]
},
"pagerduty": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"pagerduty_api_token": {
"description": "API Token obtained from PagerDuty.",
"type": "string"
}
},
"type": "object"
}
]
},
"pulumi": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"access_token": {
"description": "Pulumi Access Token.",
"type": "string"
}
},
"type": "object"
}
]
},
"s3": {
"allOf": [
{
"properties": {
"alias": {
"description": "Alias for the integration.",
"type": "string"
},
"connection_status": {
"description": "Connection status of the integration.",
"type": "boolean"
},
"date_updated": {
"description": "Timestamp of last update.",
"type": "integer"
},
"date_verified": {
"description": "Timestamp of last verification.",
"type": "integer"
},
"integration_id": {
"description": "Unique identifier for the integration.",
"type": "string"
},
"is_default": {
"description": "Default status of the integration.",
"type": "string"
},
"workspace_id": {
"description": "Workspace ID associated with the integration.",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"name": {
"description": "S3 bucket name.",
"type": "string"
},
"target": {
"description": "Select an AWS Target Account for the S3 bucket.",
"type": "string"
}
},
"type": "object"
}
]
},
"servicenow": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"instance_url": {
"description": "ServiceNow instance URL.",
"type": "string"
},
"password": {
"description": "Password for authorized user on ServiceNow instance.",
"type": "string"
},
"username": {
"description": "Username for authorized user on ServiceNow instance.",
"type": "string"
},
"webhook_url": {
"description": "Webhook URL.",
"type": "string"
}
},
"type": "object"
}
]
},
"slack": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"scope": {
"description": "Permission scope for the Fylamynt App.",
"type": "string"
},
"slack_team_id": {
"description": "Id of Slack team/workspace that the token belongs to.",
"type": "string"
},
"slack_team_name": {
"description": "Name of Slack team/workspace that the token belongs to.",
"type": "string"
},
"slack_user_id": {
"description": "ID of the Slack user authenticated with Fylamynt.",
"type": "string"
},
"slack_user_name": {
"description": "Real name or username of the Slack user authenticated with Fylamynt.",
"type": "string"
}
},
"type": "object"
}
]
},
"splunk": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"access_token": {
"description": "Token used to access the Splunk instance.",
"type": "string"
},
"splunk_url": {
"description": "URL of the Splunk instance (e.g. 65.132.55.921). Do not include the port number.",
"type": "string"
}
},
"type": "object"
}
]
},
"splunk_on_call": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"api_id": {
"description": "API ID obtained from Splunk On-Call (VictorOps).",
"type": "string"
},
"api_key": {
"description": "API Key obtained from Splunk On-Call (VictorOps).",
"type": "string"
}
},
"type": "object"
}
]
},
"spot": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"api_token": {
"description": "A Spot Programmatic API Token is recommended or you may use a Personal Access Token.",
"type": "string"
}
},
"type": "object"
}
]
},
"ssh": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"hostIdentifier": {
"description": "Identifier for SSH target host such as hostname or public IPv4.",
"type": "string"
},
"privateKey": {
"description": "Private RSA key to run command without username/password.",
"type": "string"
}
},
"type": "object"
}
]
},
"sumologic": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"access_id": {
"description": "Unique access_id to access your Sumo Logic account.",
"type": "string"
},
"access_key": {
"description": "API key for authorization.",
"type": "string"
}
},
"type": "object"
}
]
},
"terraform": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"organization": {
"description": "Terraform Cloud organization.",
"type": "string"
},
"token": {
"description": "Terraform Cloud API token (User or team token only).",
"type": "string"
}
},
"type": "object"
}
]
},
"terraform_cli": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"s3_bucket": {
"description": "An S3 bucket as a source for the Terraform module.",
"type": "string"
},
"source_type": {
"description": "Different terraform source options.",
"type": "string"
}
},
"type": "object"
}
]
},
"twilio": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"accountSid": {
"description": "Account SID from Twilio dashboard to identify user at twilio end.",
"type": "string"
},
"authToken": {
"description": "Authentication token for Twilio account.",
"type": "string"
}
},
"type": "object"
}
]
},
"zendesk": {
"allOf": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema/properties/body/allOf/0/properties/s3/allOf/0"
},
{
"properties": {
"api_token": {
"description": "API token for authorization.",
"type": "string"
},
"email": {
"description": "Email id associated with your Zendesk account.",
"type": "string"
},
"subdomain_name": {
"description": "Enter Zendesk Subdomain name - https://.zendesk.com.",
"type": "string"
}
},
"type": "object"
}
]
}
},
"type": "object"
}
],
"description": "Response body.",
"type": "object"
},
"statusCode": {
"description": "HTTP status code.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Created"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"content": {},
"description": "Not Found"
},
"409": {
"content": {},
"description": "Conflict"
},
"422": {
"content": {},
"description": "Unprocessable Entity"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Create Secret",
"tags": [
"Connect Settings"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/settings/{service}/{integration_id}": {
"delete": {
"description": "Endpoint handling two use cases for removing connector integration or resource:\n1) For connectors storing secrets in the tenant secrets db, remove the dynamic\n secret keys added during connector integration\n2) For target account oriented resources stored in the Target Settings DB,\n remove the resource associated with one 'alias' account or all accounts",
"operationId": "delete_setting_item",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D~1%7Bintegration_id%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1settings~1slack~1finish_oauth/post/responses/200/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Delete Integration/Resource",
"tags": [
"Connect Settings"
]
},
"get": {
"description": "Get the details of the selected integration/resource instance.\n\nNote: The JSON response will contain credentials specific to the selected service and integration,\nunlike the response model which shows all possible fields for all services. The model is provided\nto illustrate the complete set of fields that may be present in the response, depending on which\nservice and integration is selected.",
"operationId": "get_setting_item",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/get/parameters/0"
},
{
"in": "path",
"name": "integration_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Get Integration/Resource",
"tags": [
"Connect Settings"
]
},
"parameters": [],
"patch": {
"description": "An empty PATCH body \"{}\" will set the instance to default.\n\nTo move an individual instance:\ncall this endpoint with the 'old' workspace_id as the query parameter\nand the 'new' workspace_id in the body.\n\nE.X.:\nPATCH\nhttps:///settings//?workspace_id=cws-movefrom\nbody: {\"workspace_id\": \"cws-moveto\"}",
"operationId": "patch_setting_item",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D~1%7Bintegration_id%7D/get/parameters/1"
}
],
"requestBody": {
"content": {
"application/json": {}
},
"description": "Workspace ID of the workspace to move integration/resource to.",
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1settings~1slack~1finish_oauth/post/responses/200/content/application~1json/schema"
}
}
},
"description": "Success"
},
"201": {
"content": {},
"description": "Created"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Set Default/Move Integration/Resource",
"tags": [
"Connect Settings"
],
"x-codegen-request-body-name": "workspace_id"
},
"put": {
"description": "Update the Integration/Resource secrets for a given service and given integration instance.\n\nNote: The displayed request and response models show the structure for each service. \nWhen calling this endpoint, only the credentials for the specific service being updated \nshould be provided in the payload under the 'credentials' key. The response will contain \nthe newly updated integration information for that service.\n\nFor example, to update a Slack integration:\n\nRequest:\n{\n \"credentials\": {\n \"alias\": \"updated-slack-integration\",\n \"bot_token\": \"xoxb-updated-token\",\n \"signing_secret\": \"updated-secret\"\n }\n}\n\nResponse will contain the updated Slack integration details.",
"operationId": "put_setting_item",
"parameters": [
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D~1%7Bintegration_id%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1settings~1apikeys/get/parameters/1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/requestBody/content/application~1json/schema"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1settings~1%7Bservice%7D/post/responses/201/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"content": {},
"description": "Not Found"
},
"422": {
"content": {},
"description": "Unprocessable Entity"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Update Integration/Resource",
"tags": [
"Connect Settings"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/targets": {
"get": {
"operationId": "get_target_account_list",
"parameters": [
{
"description": "Currently selected Workspace ID",
"in": "query",
"name": "workspace_id",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Gets a list of all accounts",
"tags": [
"Connect Targets"
]
},
"parameters": [],
"post": {
"operationId": "post_target_account_list",
"parameters": [
{
"$ref": "#/paths/~1connect~1targets/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"alias": {
"type": "string"
},
"external_id": {
"type": "string"
},
"is_default": {
"type": "boolean"
},
"preferred_region": {
"type": "string"
},
"role_arn": {
"type": "string"
}
},
"required": [
"alias",
"external_id",
"is_default",
"preferred_region",
"role_arn"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1targets/post/requestBody/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Creates a new entry in the database",
"tags": [
"Connect Targets"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/targets/default": {
"get": {
"description": "It's acceptable to have zero defaults, but more than one should\nbe cleaned up. This can be done by updating an existing entry to set is_default=True.",
"operationId": "get_target_account_get_default",
"parameters": [
{
"$ref": "#/paths/~1connect~1targets/get/parameters/0"
}
],
"responses": {
"200": {
"content": {},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Only return the default entry",
"tags": [
"Connect Targets"
]
},
"parameters": []
},
"/connect/targets/{target_alias}": {
"delete": {
"operationId": "delete_target_account_item",
"parameters": [
{
"$ref": "#/paths/~1connect~1targets~1%7Btarget_alias%7D/get/parameters/0"
}
],
"responses": {
"200": {
"content": {},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "delete the entry",
"tags": [
"Connect Targets"
]
},
"get": {
"operationId": "get_target_account_item",
"parameters": [
{
"description": "Unique alias for the target account",
"in": "path",
"name": "target_alias",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1targets/post/requestBody/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "get all fields of a specific account",
"tags": [
"Connect Targets"
]
},
"parameters": [],
"patch": {
"description": "This will only change the updated fields and will\nleave all other fields in place.",
"operationId": "patch_target_account_item",
"parameters": [
{
"$ref": "#/paths/~1connect~1targets~1%7Btarget_alias%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1targets/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1targets/post/requestBody/content/application~1json/schema"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1targets/post/requestBody/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Update fields on an account",
"tags": [
"Connect Targets"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/workflows": {
"get": {
"operationId": "get_workflow_list",
"parameters": [
{
"description": "Currently selected Workspace ID",
"in": "query",
"name": "workspace_id",
"schema": {
"type": "string"
}
},
{
"description": "SSM document owner (value=Self|Amazon|All, default=All)",
"in": "query",
"name": "owner",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Return all user workflows for a given workspace",
"tags": [
"Connect Workflows"
]
},
"parameters": [],
"post": {
"operationId": "post_workflow_list",
"parameters": [
{
"$ref": "#/paths/~1connect~1workflows/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"Content": {
"allOf": [
{
"properties": {
"assumeRole": {
"type": "string"
},
"description": {
"type": "string"
},
"mainSteps": {
"items": {
"properties": {
"action": {
"type": "string"
},
"inputs": {
"properties": {
"Choices": {
"items": {
"properties": {
"NextStep": {
"type": "string"
},
"Variable": {
"type": "string"
}
},
"required": [
"NextStep",
"Variable"
],
"type": "object"
},
"type": "array"
},
"Default": {
"type": "string"
},
"Duration": {
"type": "string"
},
"FunctionName": {
"type": "string"
},
"Payload": {
"type": "string"
}
},
"type": "object"
},
"isEnd": {
"type": "boolean"
},
"maxAttempts": {
"type": "integer"
},
"name": {
"type": "string"
},
"nextStep": {
"type": "string"
},
"onFailure": {
"type": "string"
},
"outputs": {
"items": {
"properties": {
"Name": {
"type": "string"
},
"Selector": {
"type": "string"
},
"Type": {
"type": "string"
}
},
"required": [
"Name",
"Selector",
"Type"
],
"type": "object"
},
"type": "array"
},
"timeoutSeconds": {
"type": "integer"
}
},
"required": [
"action",
"inputs",
"name"
],
"type": "object"
},
"type": "array"
},
"parameters": {
"properties": {
"AutomationAssumeRole": {
"properties": {
"default": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"description",
"type"
],
"type": "object"
},
"WorkflowSession": {
"properties": {
"default": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"description",
"type"
],
"type": "object"
}
},
"type": "object"
},
"schemaVersion": {
"type": "string"
}
},
"required": [
"description",
"mainSteps",
"schemaVersion"
],
"type": "object"
}
],
"description": "SSM document for the workflow.",
"type": "object"
},
"Name": {
"description": "A unique name for the workflow.",
"type": "string"
},
"StepDocuments": {
"description": "List of step documents used in the SSM document.",
"items": {
"properties": {
"document_id": {
"description": "Document ID from step_store.",
"type": "string"
},
"version": {
"description": "Version of the document.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"Tags": {
"description": "List of tags for the workflow.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Content",
"Name"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1connect~1workflows/post/requestBody/content/application~1json/schema"
},
{
"properties": {
"DocumentFormat": {
"description": "SSM document format",
"type": "string"
},
"DocumentType": {
"description": "SSM document type",
"type": "string"
},
"DocumentVersion": {
"description": "SSM document version",
"type": "string"
},
"Status": {
"description": "SSM document status",
"type": "string"
}
},
"required": [
"DocumentType",
"DocumentVersion",
"Status"
],
"type": "object"
}
]
}
}
},
"description": "Success"
},
"201": {
"content": {},
"description": "Workflow created successfully"
},
"400": {
"content": {},
"description": "Request validation error"
},
"409": {
"content": {},
"description": "Duplicate workflow"
}
},
"summary": "Create a new workflow in the selected workspace.",
"tags": [
"Connect Workflows"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/workflows/{workflow_name}": {
"delete": {
"description": "Delete a selected version of the selected workflow.\nIf no version is specified, delete all versions of the workflow.",
"operationId": "delete_workflow_instance",
"parameters": [
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/put/parameters/0"
},
{
"$ref": "#/paths/~1connect~1workflows/get/parameters/0"
},
{
"description": "Selected workflow version",
"in": "query",
"name": "version",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"status": {
"description": "Status of the task. OK if workflow deleted successfully.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Delete Workflow",
"tags": [
"Connect Workflows"
]
},
"parameters": [],
"put": {
"description": "Update a selected workflow by creating a new version.\nNew workflow is created off of the latest version in SSM.",
"operationId": "put_workflow_instance",
"parameters": [
{
"description": "Unique workflow name",
"in": "path",
"name": "workflow_name",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1workflows/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"Content": {
"allOf": [
{
"$ref": "#/paths/~1connect~1workflows/post/requestBody/content/application~1json/schema/properties/Content/allOf/0"
}
],
"description": "SSM document for the workflow.",
"type": "object"
},
"Tags": {
"description": "List of workflow tags.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"Content"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"Description": {
"description": "Workflow description.",
"type": "string"
},
"DocumentVersion": {
"description": "Version of the SSM document.",
"type": "string"
},
"Editor": {
"description": "Editor of the workflow.",
"type": "string"
},
"EditorId": {
"description": "ID of the workflow editor.",
"type": "string"
},
"Name": {
"description": "Name to display to owner",
"type": "string"
},
"ReadOnly": {
"description": "True for read only workflows else false.",
"type": "boolean"
},
"Tags": {
"description": "List of workflow tags.",
"items": {
"type": "string"
},
"type": "array"
},
"UpdatedDate": {
"description": "Last updated date of the SSM document.",
"type": "string"
},
"WorkflowId": {
"description": "Unique ID for a workflow document version.",
"type": "string"
},
"WorkflowOwner": {
"description": "Owner of the workflow.",
"type": "string"
},
"WorkflowOwnerId": {
"description": "ID of the workflow owner.",
"type": "string"
},
"WorkspaceId": {
"description": "Workspace the workflow belongs to.",
"type": "string"
}
},
"required": [
"Description",
"DocumentVersion",
"Name"
],
"type": "object"
},
{
"properties": {
"CreatedDate": {
"description": "Date when workflow was created.",
"type": "string"
},
"DefaultVersion": {
"description": "Current default version in SSM.",
"type": "string"
},
"DisplayName": {
"description": "Display name of the workflow.",
"type": "string"
},
"DocumentFormat": {
"description": "SSM document format.",
"type": "string"
},
"DocumentType": {
"description": "SSM document type.",
"type": "string"
},
"Editor": {
"description": "Editor of the workflow.",
"type": "string"
},
"HashType": {
"description": "Hash type of the SSM.",
"type": "string"
},
"IsDefault": {
"description": "Tells the default version of the SSM.(true for default version and false for not default version.)",
"type": "boolean"
},
"LatestVersion": {
"description": "Newest version of the document.",
"type": "string"
},
"Parameters": {
"description": "Runtime parameters for the workflow.",
"items": {
"properties": {},
"type": "object"
},
"type": "array"
},
"PlatformTypes": {
"description": "SSM document platforms.",
"type": "string"
},
"SSMDocument": {
"description": "Original SSM document.",
"type": "string"
},
"SchemaVersion": {
"description": "SSM schema.",
"type": "string"
},
"SsmHash": {
"description": "Hash value of the SSM.",
"type": "string"
},
"SsmName": {
"description": "Name of the workflow in ssm.",
"type": "string"
},
"Status": {
"description": "Ssm document status",
"type": "string"
},
"StepDocuments": {
"description": "List of step documents used in the SSM document.",
"items": {
"$ref": "#/paths/~1connect~1workflows/post/requestBody/content/application~1json/schema/properties/StepDocuments/items"
},
"type": "array"
},
"TenantId": {
"description": "Cognito ID of the owner.",
"type": "string"
},
"Versions": {
"description": "List of available versions.",
"items": {
"properties": {},
"type": "object"
},
"type": "array"
},
"WorkflowId": {
"type": "string"
},
"WorkflowOwner": {
"description": "Owner of the workflow.",
"type": "string"
}
},
"required": [
"CreatedDate",
"DefaultVersion",
"DisplayName",
"DocumentFormat",
"DocumentType",
"HashType",
"IsDefault",
"LatestVersion",
"PlatformTypes",
"SSMDocument",
"SchemaVersion",
"SsmHash",
"SsmName",
"Status",
"TenantId"
],
"type": "object"
}
]
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Update Workflow",
"tags": [
"Connect Workflows"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/workflows/{workflow_name}/availability": {
"get": {
"description": "Check if workflow name is available for use.",
"operationId": "get_workflow_name_validation",
"parameters": [
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/put/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"available": {
"description": "Tells if workflow name is available for use.(true for available and false for unavailable.",
"type": "boolean"
},
"message": {
"description": "Helper message.",
"type": "string"
},
"name": {
"description": "Name of the workflow to check.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad request"
}
},
"summary": "Get Workflow Name Availability",
"tags": [
"Connect Workflows"
]
},
"parameters": []
},
"/connect/workflows/{workflow_name}/content": {
"get": {
"description": "Return the content of the default/selected version of the selected workflow.",
"operationId": "get_workflow_content",
"parameters": [
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/put/parameters/0"
},
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/delete/parameters/2"
},
{
"$ref": "#/paths/~1connect~1workflows/get/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"Content": {
"allOf": [
{
"$ref": "#/paths/~1connect~1workflows/post/requestBody/content/application~1json/schema/properties/Content/allOf/0"
}
],
"description": "SSM document for the workflow.",
"type": "object"
},
"Description": {
"description": "Workflow description.",
"type": "string"
},
"Name": {
"description": "Name of the workflow.",
"type": "string"
},
"Parameters": {
"description": "Runtime parameters for the workflow.",
"items": {
"properties": {},
"type": "object"
},
"type": "array"
},
"StepDocuments": {
"description": "List of step documents used in the SSM document.",
"items": {
"$ref": "#/paths/~1connect~1workflows/post/requestBody/content/application~1json/schema/properties/StepDocuments/items"
},
"type": "array"
},
"UpdatedDate": {
"description": "Date when the workflow was updated.",
"type": "string"
},
"WorkflowId": {
"description": "Unique ID for a workflow document version.",
"type": "string"
},
"showModal": {
"description": "Boolean value to show workflow modal.(true for showing and false for not showing.",
"type": "boolean"
}
},
"required": [
"Content",
"Name"
],
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Get Workflow Content",
"tags": [
"Connect Workflows"
]
},
"parameters": []
},
"/connect/workflows/{workflow_name}/duplicate": {
"parameters": [],
"post": {
"description": "Duplicate a specific version of the selected workflow.",
"operationId": "post_workflow_duplicate",
"parameters": [
{
"description": "Name of workflow to be duplicated",
"in": "query",
"name": "name",
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/put/parameters/0"
},
{
"$ref": "#/paths/~1connect~1workflows/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"NewName": {
"description": "Name of new workflow.",
"type": "string"
},
"Version": {
"description": "Version of the workflow to be duplicated.",
"type": "string"
}
},
"required": [
"NewName"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/put/responses/200/content/application~1json/schema"
}
}
},
"description": "Success"
},
"201": {
"content": {},
"description": "Workflow duplicated successfully"
},
"400": {
"content": {},
"description": "Request validation error"
}
},
"summary": "Create Duplicate Workflow",
"tags": [
"Connect Workflows"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/workflows/{workflow_name}/info": {
"get": {
"description": "Return the information for the default/selected version of the selected workflow,\nincluding workflow description and tags.",
"operationId": "get_workflow_info",
"parameters": [
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/put/parameters/0"
},
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/delete/parameters/2"
},
{
"$ref": "#/paths/~1connect~1workflows/get/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/put/responses/200/content/application~1json/schema"
},
{
"properties": {
"Schedules": {
"description": "Schedules of the workflow.",
"properties": {},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad request"
}
},
"summary": "Get Workflow Information",
"tags": [
"Connect Workflows"
]
},
"parameters": [],
"put": {
"description": "Update the default version of the workflow to a specific version.",
"operationId": "put_workflow_info",
"parameters": [
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/put/parameters/0"
},
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/delete/parameters/2"
},
{
"$ref": "#/paths/~1connect~1workflows/get/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D~1info/get/responses/200/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad request"
}
},
"summary": "Update Workflow Version",
"tags": [
"Connect Workflows"
]
}
},
"/connect/workflows/{workflow_name}/integrations": {
"get": {
"description": "Return a list of integration instances for the default/selected version of a selected workflow.",
"operationId": "get_workflow_integration_info",
"parameters": [
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/put/parameters/0"
},
{
"$ref": "#/paths/~1connect~1workflows~1%7Bworkflow_name%7D/delete/parameters/2"
},
{
"description": "Only include integrations that can be moved to new workspace",
"in": "query",
"name": "movable_only",
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1workflows/get/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"integration_type": {
"description": "Names of the integrations used in the workflow.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad request"
}
},
"summary": "List Workflow Integrations",
"tags": [
"Connect Workflows"
]
},
"parameters": []
},
"/connect/workspaces": {
"get": {
"description": "List all workspaces the user is authorized to view.",
"operationId": "get_workspace_list",
"parameters": [
{
"description": "An optional fields mask",
"in": "header",
"name": "X-Fields",
"schema": {
"format": "mask",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/paths/~1connect~1workspaces/post/requestBody/content/application~1json/schema/allOf/0"
},
{
"properties": {
"workspace_id": {
"description": "Unique workspace ID",
"type": "string"
}
},
"type": "object"
}
]
},
{
"properties": {
"permissions": {
"description": "List of permissions for that workspace",
"items": {
"type": "string"
},
"type": "array"
},
"workspace_id": {
"description": "Unique workspace ID",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "List Workspaces",
"tags": [
"Connect Workspaces"
]
},
"parameters": [],
"post": {
"description": "Create a new workspace.",
"operationId": "post_workspace_list",
"parameters": [
{
"$ref": "#/paths/~1connect~1workspaces/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"description": {
"description": "Description of workspace",
"type": "string"
},
"name": {
"description": "Name of workspace",
"type": "string"
},
"owner": {
"description": "Owner of workspace",
"type": "string"
},
"type": {
"description": "Type of workspace",
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"entities": {
"description": "List of entities",
"items": {
"properties": {
"id": {
"description": "Spot ID of the user",
"type": "string"
},
"isGroup": {
"description": "If the user is present in any group",
"type": "boolean"
},
"isOwner": {
"description": "If the user is owner of that workspace",
"type": "boolean"
},
"name": {
"description": "Name of user",
"type": "string"
},
"permissions": {
"description": "List of permissions for that workspace",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1workspaces/get/responses/200/content/application~1json/schema"
}
}
},
"description": "Workspace created successfully"
},
"400": {
"content": {},
"description": "Request validation error"
},
"409": {
"content": {},
"description": "Workspace name already exists"
}
},
"summary": "Create Workspace",
"tags": [
"Connect Workspaces"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/workspaces/name/available": {
"parameters": [],
"post": {
"description": "Check if Workspace name is available for use.",
"operationId": "post_workspace_name_availability_check",
"parameters": [
{
"$ref": "#/paths/~1connect~1workspaces/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"name": {
"description": "Workspace name to check",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1connect~1workspaces~1name~1available/post/requestBody/content/application~1json/schema"
},
{
"properties": {
"available": {
"description": "Check if workspace name is available for use",
"type": "boolean"
},
"message": {
"description": "Response message on availability check",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Request validation error"
}
},
"summary": "Check Workspace Availability",
"tags": [
"Connect Workspaces"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/workspaces/name/{workspace_name}": {
"get": {
"description": "Get details of a specific workspace using workspace name.",
"operationId": "get_workspace_instance_by_name",
"parameters": [
{
"description": "Workspace name",
"in": "path",
"name": "workspace_name",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1workspaces/get/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1connect~1workspaces/post/requestBody/content/application~1json/schema/allOf/0"
},
{
"properties": {
"workspace_id": {
"description": "cws-XXXXXXX",
"type": "string"
}
},
"type": "object"
}
]
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Get Workspace by Name",
"tags": [
"Connect Workspaces"
]
},
"parameters": []
},
"/connect/workspaces/{workspace_id}": {
"delete": {
"description": "Delete a workspace specified by workspace_id",
"operationId": "delete_workspace_instance",
"parameters": [
{
"$ref": "#/paths/~1connect~1workspaces~1%7Bworkspace_id%7D/get/parameters/0"
}
],
"responses": {
"200": {
"content": {},
"description": "Deleted"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Delete Workspace",
"tags": [
"Connect Workspaces"
]
},
"get": {
"description": "Get details of a workspace specified by workspace_id.",
"operationId": "get_workspace_instance",
"parameters": [
{
"description": "Unique workspace ID",
"in": "path",
"name": "workspace_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/paths/~1connect~1workspaces/get/parameters/0"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1workspaces/get/responses/200/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Get Workspace by ID",
"tags": [
"Connect Workspaces"
]
},
"parameters": [],
"put": {
"description": "Update a workspace specified by workspace_id.",
"operationId": "put_workspace_instance",
"parameters": [
{
"$ref": "#/paths/~1connect~1workspaces~1%7Bworkspace_id%7D/get/parameters/0"
},
{
"$ref": "#/paths/~1connect~1workspaces/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1workspaces/post/requestBody/content/application~1json/schema"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1connect~1workspaces/get/responses/200/content/application~1json/schema"
}
}
},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Update Workspace",
"tags": [
"Connect Workspaces"
],
"x-codegen-request-body-name": "payload"
}
},
"/connect/workspaces/{workspace_id}/move-order": {
"parameters": [],
"post": {
"description": "It moves a workflow and all integrations it uses\nin new workspace. Following things are needed -\nPermissions the user needs in both workspaces:\n updateWorkflow\n updateIntegration\n updateSchedule\n updateExecution",
"operationId": "post_move_order_view",
"parameters": [
{
"$ref": "#/paths/~1connect~1workspaces~1%7Bworkspace_id%7D/get/parameters/0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"move_all_integrations": {
"description": "If we need to move all integrations used in that workflow",
"type": "boolean"
},
"workflow_name": {
"description": "Name of the workflow to move to the new workspace",
"type": "string"
},
"workspace_id": {
"description": "Workspace ID to move the workflow into",
"type": "string"
}
},
"type": "object"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {},
"description": "Success"
},
"400": {
"content": {},
"description": "Bad Request"
}
},
"summary": "Move Workflow and its Integrations to Another Workpace",
"tags": [
"Connect Workspaces"
],
"x-codegen-request-body-name": "payload"
}
},
"/ocean/{oceanId}/rightSizing/rule": {
"post": {
"summary": "Create Ocean Rightsizing Rule",
"description": "",
"operationId": "oceanRightsizingRuleCreate",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"title": "Ocean Rightsizing Rule",
"description": "Determines the Ocean Rightsizing rule\n",
"required": [
"recommendationApplicationIntervals"
],
"properties": {
"ruleName": {
"type": "string",
"description": "The unique name of the rule",
"example": "dev-rule"
},
"restartReplicas": {
"type": "string",
"description": "Enable to sequentially restart pod batches according to recommendations, for all pods, only more than 1 replica, or not any pod.",
"enum": [
"MORE_THAN_ONE_REPLICA",
"ALL_MANIFEST",
"NO_RESTART"
],
"example": "ALL_MANIFEST"
},
"excludePreliminaryRecommendations": {
"type": "boolean",
"description": "Exclude preliminary recommendations (recommendations based on less than 4 full days of data).",
"example": false
},
"recommendationApplicationIntervals": {
"description": "Determines the Ocean Rightsizing rule recommendation application intervals",
"type": "array",
"example": [
{
"repetitionBasis": "WEEKLY",
"weeklyRepetitionBasis": {
"intervalDays": [
"MONDAY",
"WEDNESDAY"
],
"intervalHours": {
"startTime": "12:00",
"endTime": "14:00"
}
}
},
{
"repetitionBasis": "MONTHLY",
"monthlyRepetitionBasis": {
"intervalMonths": [
2,
4,
6
],
"weekOfTheMonth": [
"FIRST",
"LAST"
],
"weeklyRepetitionBasis": {
"intervalDays": [
"MONDAY"
],
"intervalHours": {
"startTime": "03:00",
"endTime": "04:00"
}
}
}
}
],
"items": {
"type": "object",
"title": "Ocean Rightsizing Rule Recommendation Application Interval",
"description": "Determines the Ocean Rightsizing rule recommendation application interval\n",
"properties": {
"repetitionBasis": {
"type": "string",
"description": "The repetition basis",
"enum": [
"WEEKLY",
"MONTHLY"
]
},
"monthlyRepetitionBasis": {
"type": "object",
"title": "Ocean Rightsizing Rule Monthly Repetition Basis",
"description": "Determines the Ocean Rightsizing rule monthly repetition basis\n",
"properties": {
"intervalMonths": {
"type": "array",
"description": "Array of the months (in number), when we want to trigger the apply recommendations.\n",
"items": {
"type": "integer",
"example": 2
}
},
"weekOfTheMonth": {
"type": "string",
"description": "Array of the weeks in the month, when we want to trigger the apply recommendations.\n",
"enum": [
"FIRST",
"SECOND",
"THIRD",
"FOURTH",
"LAST"
]
},
"weeklyRepetitionBasis": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationIntervals/items/properties/weeklyRepetitionBasis"
}
}
},
"weeklyRepetitionBasis": {
"type": "object",
"title": "Ocean Rightsizing Rule Weekly Repetition Basis",
"description": "Determines the Ocean Rightsizing rule weekly repetition basis\n",
"properties": {
"intervalDays": {
"type": "array",
"description": "Array of the days of the week, when we want to trigger the apply recommendations.\n",
"items": {
"type": "string",
"enum": [
"SUNDAY",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY"
],
"example": "MONDAY"
}
},
"intervalHours": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"example": "12:00"
},
"endTime": {
"type": "string",
"example": "14:00"
}
}
}
}
}
}
}
},
"recommendationApplicationMinThreshold": {
"type": "object",
"title": "Ocean Rightsizing Rule Recommendation Application Min Threshold",
"description": "Determines the extent of difference between current request and recommendation to trigger a change in percentage\n",
"properties": {
"cpuPercentage": {
"type": "number",
"minimum": 0.05,
"maximum": 1,
"default": 0.05,
"example": 0.412
},
"memoryPercentage": {
"type": "number",
"minimum": 0.05,
"maximum": 1,
"default": 0.05,
"example": 0.36
}
}
},
"recommendationApplicationBoundaries": {
"type": "object",
"title": "Ocean Rightsizing Rule Recommendation Application Boundaries",
"description": "Determines the Ocean Rightsizing rule recommendation application boundaries.\n",
"properties": {
"cpu": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"description": "the minimal value of cpu in vCpu",
"example": 0
},
"max": {
"type": "integer",
"description": "the maximal value of cpu in vCpu",
"example": 100
}
}
},
"memory": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"description": "the minimal value of memory in Gib",
"minimum": 0,
"example": 1
},
"max": {
"type": "integer",
"description": "the maximal value of memory in Gib",
"minimum": 0,
"example": 80
}
}
}
}
},
"recommendationApplicationOverheadValues": {
"type": "object",
"title": "Ocean Rightsizing Rule Recommendation Application Overhead Values",
"description": "Determines the Ocean Rightsizing rule recommendation application overhead values\n",
"properties": {
"cpuPercentage": {
"type": "number",
"minimum": 0.1,
"maximum": 1,
"default": 0.1,
"example": 0.8
},
"memoryPercentage": {
"type": "number",
"minimum": 0.1,
"maximum": 1,
"default": 0.1,
"example": 0.5
}
}
},
"recommendationApplicationHPA": {
"type": "object",
"title": "Ocean Rightsizing Rule Recommendation Application For HPA",
"description": "HPA Rightsizing Rule Recommendation Configuration",
"properties": {
"allowHPARecommendations": {
"type": "boolean",
"description": "Determines by the rule if recommendation application is allowed for workloads with HPA definition.",
"example": true
}
}
},
"autoApplyDefinition": {
"type": "object",
"title": "Ocean Rightsizing Rule Auto Apply Definition",
"description": "Ocean Rightsizing Rule Auto Apply Configuration",
"properties": {
"enabled": {
"type": "boolean",
"description": "Determines if auto apply is enabled.",
"example": true
},
"namespaces": {
"type": "array",
"description": "A list of namespaces that match the auto-apply rule.",
"items": {
"type": "string"
},
"example": [
"namespace1",
"namespace2",
"namespace3"
]
},
"labels": {
"type": "object",
"description": "A set of key-value label pairs used to automatically apply this rule to all workloads in the cluster that match these labels.\n",
"example": {
"app": "my-app",
"environment": "production"
}
}
}
},
"cpuPercentile": {
"type": "integer",
"description": "vCPU percentile for calculating recommendations.",
"example": 95
},
"memoryPercentile": {
"type": "integer",
"description": "Memory percentile for calculating recommendations.",
"example": 90
},
"downsideOnly": {
"type": "boolean",
"description": "When set to 'true', only downscale recommendations will be applied.",
"default": false
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Rightsizing Rule Create Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/{oceanId}/rightSizing/rule"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "mcs:ocean:rightsizing:rule"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "List Ocean Rightsizing Rules",
"description": "",
"operationId": "oceanRightsizingRulesList",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"in": "path",
"name": "oceanId",
"schema": {
"type": "string"
},
"required": true,
"example": "o-abcd1234",
"description": "Identifier of the Ocean cluster.\n"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"description": "Ocean Rightsizing Rules Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/{oceanId}/rightSizing/rule"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"description": "Rightsizing rule",
"type": "object",
"properties": {
"oceanId": {
"type": "string",
"example": "o-482d9d26"
},
"clusterIdentifier": {
"type": "string",
"example": "dev-cluster"
},
"ruleName": {
"type": "string",
"example": "dev-rule"
},
"restartReplicas": {
"type": "string",
"description": "Enable to sequentially restart pod batches according to recommendations, for all pods, only more than 1 replica, or not any pod.",
"enum": [
"MORE_THAN_ONE_REPLICA",
"ALL_MANIFEST",
"NO_RESTART"
],
"example": "ALL_MANIFEST"
},
"excludePreliminaryRecommendations": {
"type": "boolean",
"description": "Exclude preliminary recommendations (recommendations based on less than 4 full days of data).",
"example": false
},
"recommendationApplicationIntervals": {
"type": "array",
"example": [
{
"repetitionBasis": "WEEKLY",
"weeklyRepetitionBasis": {
"intervalDays": [
"MONDAY",
"WEDNESDAY"
],
"intervalHours": {
"startTime": "12:00",
"endTime": "14:00"
}
}
},
{
"repetitionBasis": "MONTHLY",
"monthlyRepetitionBasis": {
"intervalMonths": [
2,
4,
6
],
"weekOfTheMonth": [
"FIRST",
"LAST"
],
"weeklyRepetitionBasis": {
"intervalDays": [
"MONDAY"
],
"intervalHours": {
"startTime": "03:00",
"endTime": "04:00"
}
}
}
}
],
"items": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationIntervals/items"
}
},
"recommendationApplicationMinThreshold": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationMinThreshold"
},
"recommendationApplicationBoundaries": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationBoundaries"
},
"recommendationApplicationOverheadValues": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationOverheadValues"
},
"recommendationApplicationHPA": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationHPA"
},
"autoApplyDefinition": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/autoApplyDefinition"
},
"cpuPercentile": {
"type": "integer",
"description": "vCPU percentile for calculating recommendations.",
"example": 95
},
"memoryPercentile": {
"type": "integer",
"description": "Memory percentile for calculating recommendations.",
"example": 90
},
"downsideOnly": {
"type": "boolean",
"description": "When set to 'true', only downscale recommendations will be applied.",
"example": false
}
}
}
},
"kind": {
"example": "mcs:ocean:rightsizing:rule"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"delete": {
"summary": "Delete Ocean Rightsizing Rules",
"description": "",
"operationId": "oceanRightsizingRuleDelete",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"title": "Ocean Rightsizing Rule Names",
"description": "Rightsizing Rule Names to delete.\n",
"properties": {
"ruleNames": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"dev-rule",
"test-rule"
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Rightsizing Deleted Rule Names Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/{oceanId}/rightSizing/rule"
},
"method": {
"example": "DELETE"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ruleNames": {
"type": "array",
"example": [
"dev-rule",
"test-rule"
],
"items": {
"type": "string"
}
}
}
}
},
"kind": {
"example": "mcs:ocean:rightsizing:rule"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/rule/{ruleName}": {
"get": {
"summary": "Get Ocean Rightsizing Rule",
"description": "",
"operationId": "oceanRightsizingRuleGet",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"in": "path",
"name": "ruleName",
"schema": {
"type": "string"
},
"required": true,
"example": "dev-rule",
"description": "Identifier of rightsizing rule.\n"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/responses/200"
},
"400": {
"description": "Bad Request"
}
}
},
"put": {
"summary": "Update Ocean Rightsizing Rule",
"description": "",
"operationId": "oceanRightsizingRuleUpdate",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule~1%7BruleName%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"title": "Ocean Rightsizing Rule",
"description": "Determines the Ocean Rightsizing rule\n",
"required": [
"recommendationApplicationIntervals"
],
"properties": {
"restartReplicas": {
"type": "string",
"description": "Enable to sequentially restart pod batches according to recommendations, for all pods, only more than 1 replica, or not any pod.",
"enum": [
"MORE_THAN_ONE_REPLICA",
"ALL_MANIFEST",
"NO_RESTART"
],
"example": "ALL_MANIFEST"
},
"excludePreliminaryRecommendations": {
"type": "boolean",
"description": "Exclude preliminary recommendations (recommendations based on less than 4 full days of data).",
"example": false
},
"recommendationApplicationIntervals": {
"description": "Determines the Ocean Rightsizing rule recommendation application intervals",
"type": "array",
"example": [
{
"repetitionBasis": "WEEKLY",
"weeklyRepetitionBasis": {
"intervalDays": [
"MONDAY",
"WEDNESDAY"
],
"intervalHours": {
"startTime": "12:00",
"endTime": "14:00"
}
}
},
{
"repetitionBasis": "MONTHLY",
"monthlyRepetitionBasis": {
"intervalMonths": [
2,
4,
6
],
"weekOfTheMonth": [
"FIRST",
"LAST"
],
"weeklyRepetitionBasis": {
"intervalDays": [
"MONDAY"
],
"intervalHours": {
"startTime": "03:00",
"endTime": "04:00"
}
}
}
}
],
"items": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationIntervals/items"
}
},
"recommendationApplicationMinThreshold": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationMinThreshold"
},
"recommendationApplicationBoundaries": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationBoundaries"
},
"recommendationApplicationOverheadValues": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationOverheadValues"
},
"recommendationApplicationHPA": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/recommendationApplicationHPA"
},
"autoApplyDefinition": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/post/requestBody/content/application~1json/schema/allOf/0/properties/autoApplyDefinition"
},
"cpuPercentile": {
"type": "integer",
"description": "vCPU percentile for calculating recommendations.",
"example": 95
},
"memoryPercentile": {
"type": "integer",
"description": "Memory percentile for calculating recommendations.",
"example": 90
},
"downsideOnly": {
"type": "boolean",
"description": "When set to 'true', only downscale recommendations will be applied.",
"default": false
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Rightsizing Rule Update Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/{oceanId}/rightSizing/rule/{ruleName]"
},
"method": {
"example": "PUT"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "mcs:ocean:rightsizing:rule"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/rule/{ruleName}/attachment": {
"post": {
"summary": "Attach Ocean Rightsizing Rule",
"description": "",
"operationId": "oceanRightsizingRuleMatchingAttachment",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule~1%7BruleName%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"namespaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"namespaceName": {
"type": "string",
"description": "List of namespaces",
"example": "kube-system"
},
"workloads": {
"type": "array",
"description": "List of workloads",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the workload",
"example": "kube-proxy"
},
"workloadType": {
"type": "string",
"description": "The type of the workload",
"example": "Deployment"
},
"regexName": {
"type": "string",
"description": "The regex for the workload name",
"example": "spotinst*"
}
}
},
"example": [
{
"name": "kube-proxy",
"workloadType": "DaemonSet"
},
{
"regexName": "spotinst*",
"workloadType": "Deployment"
}
]
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Rightsizing Rule Attachment Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/{oceanId}/rightSizing/rule/{ruleName}/attachment"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"example": "mcs:ocean:rightsizing:ruleMatching"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rulesMatchings": {
"type": "array",
"example": [
{
"oceanId": "o-6ea3032a",
"clusterIdentifier": "dev-cluster",
"namespace": "kube-system",
"resourceType": "Deployment",
"name": "kube-proxy",
"ruleName": "dev-rule",
"ruleMatching": "workloadName:kube-proxy"
},
{
"oceanId": "o-6ea3032a",
"clusterIdentifier": "dev-cluster",
"namespace": "kube-system",
"resourceType": "Deployment",
"name": "spotinst-controller",
"ruleName": "dev-rule",
"ruleMatching": "regexName:spotinst*"
}
],
"items": {
"description": "Rightsizing rule matching of rule to workload",
"type": "object",
"properties": {
"oceanId": {
"type": "string"
},
"clusterIdentifier": {
"type": "string"
},
"namespace": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"name": {
"type": "string"
},
"ruleName": {
"type": "string"
},
"ruleMatching": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/rule/{ruleName}/detachment": {
"post": {
"summary": "Detach Ocean Rightsizing Rule",
"description": "",
"operationId": "oceanRightsizingRuleMatchingDetachment",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule~1%7BruleName%7D/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule~1%7BruleName%7D~1attachment/post/requestBody/content/application~1json/schema/allOf/0"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Rightsizing Rule Detached Workload Names Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/{oceanId}/rightSizing/rule/{ruleName}/detachment"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"workloadNames": {
"type": "array",
"example": [
"kube-proxy",
"spotinst-controller"
],
"items": {
"type": "string"
}
}
}
}
},
"kind": {
"example": "mcs:ocean:rightsizing:rule"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/recommendations": {
"post": {
"summary": "Get Ocean Rightsizing Recommendations",
"description": "Get right-sizing recommendations for an Ocean cluster.\n",
"operationId": "oceanRightsizingRecommendations",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"title": "Ocean Rightsizing Recommendations",
"description": "Determines the Ocean Rightsizing recommendations\n",
"required": [
"clusterResources OR clusterLabels"
],
"properties": {
"clusterResources": {
"type": "object",
"title": "Ocean Rightsizing Recommendation Cluster Resources",
"description": "Determines the Ocean Recommendation filtering by the combinations of namespace::workload::containers\n",
"properties": {
"namespaceName": {
"description": "Determines the namespace to filter by with objects of it's workloads",
"type": "object",
"properties": {
"workloadName": {
"description": "Determines the workload to filter by with List of it's containers",
"type": "array",
"items": {
"type": "string",
"properties": {
"containerName": {
"type": "string",
"description": "container name",
"example": "workloadContainer1"
}
}
}
}
}
}
},
"example": {
"namespaceName1": {
"workloadName1": [
"workloadContainer1",
"workloadContainer2"
],
"workloadName2": [
"workloadContainer2",
"workloadContainer3"
]
},
"namespaceName2": {
"workloadName1": [
"workloadContainer1",
"workloadContainer2"
]
}
}
},
"clusterLabels": {
"type": "object",
"title": "Ocean Rightsizing Recommendation Cluster Labels",
"description": "Determines the Ocean Recommendation filtering by the combinations of namespace::workloadsLabels\n",
"properties": {
"namespaceName": {
"description": "Determines the namespace to filter by with List of it's workloads labels",
"type": "array",
"properties": {
"containerName": {
"type": "string",
"description": "container name",
"example": "workloadContainer1"
}
}
}
},
"example": {
"namespaceName1": [
"workloadLabel1",
"workloadLabel2",
"workloadLabel3"
],
"namespaceName2": [
"workloadLabel1",
"workloadLabel2"
]
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Rightsizing Recommendation Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/o-abcd1234/rightSizing/recommendations"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Ocean Rightsizing Recommendation",
"description": "Rightsizing Resource Container Recommendation.\n",
"properties": {
"namespace": {
"type": "string",
"description": "The namespace of the workload"
},
"workloadName": {
"type": "string",
"description": "The name of the workload"
},
"workloadType": {
"type": "string",
"description": "The type of the workload"
},
"requestedCPU": {
"type": "number",
"description": "The requested cpu"
},
"suggestedCPU": {
"type": "integer",
"description": "The suggested cpu"
},
"requestedMemory": {
"type": "number",
"description": "The requested memory"
},
"suggestedMemory": {
"type": "integer",
"description": "The requested memory"
},
"monthlyMaxSavings\"": {
"type": "number",
"description": "The monthly potential savings"
},
"ruleName": {
"type": "string",
"description": "The name of the attached rule"
},
"optimizationStatus": {
"type": "string",
"description": "The optimization status of the workload"
},
"reasonsForPartialOptimized": {
"type": "array",
"description": "The reasons for the partly optimized status",
"items": {
"type": "string"
}
},
"containers": {
"type": "array",
"description": "The containers of the workload",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the container"
},
"requestedCPU": {
"type": "number",
"description": "The requested cpu"
},
"suggestedCPU": {
"type": "integer",
"description": "The suggested cpu"
},
"requestedMemory": {
"type": "number",
"description": "The requested memory"
},
"suggestedMemory": {
"type": "integer",
"description": "The requested memory"
},
"preliminary": {
"type": "boolean",
"description": "The recommendation is preliminary"
},
"appliedAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp at which the recommendation was applied"
}
}
}
},
"appliedAt": {
"type": "string",
"format": "date-time",
"description": "The timestamp at which the recommendation was last applied"
}
}
},
"example": [
{
"namespace": "kube-system",
"workloadName": "redis-controller",
"workloadType": "deployment",
"requestedCPU": 50,
"suggestedCPU": 4,
"requestedMemory": 50,
"suggestedMemory": 19,
"monthlyMaxSavings\"": 17.312044994154263,
"ruleName": "attachedRule",
"optimizationStatus": "PARTLY_OPTIMIZED",
"reasonsForPartialOptimized": [
"Threshold did not allow us to apply the recommendation",
"The ranges of the rule prevent the apply of the recommendations",
"Recommendation did not perform due to preliminary exclusion"
],
"containers": [
{
"name": "dnsmasq",
"requestedCPU": 10,
"suggestedCPU": 2,
"requestedMemory": 40,
"suggestedMemory": 15,
"preliminary": false,
"appliedAt": "2026-04-24T04:55:22.043813"
},
{
"name": "sidecar",
"requestedCPU": 40,
"suggestedCPU": 2,
"requestedMemory": 10,
"suggestedMemory": 4,
"preliminary": true,
"appliedAt": "2026-04-24T04:55:22.043813"
}
],
"appliedAt": "2026-04-24T04:55:22.043813"
},
{
"namespace": "sparkSpace",
"workloadName": "test-redis",
"workloadType": "deployment",
"requestedCPU": 50,
"suggestedCPU": 2,
"requestedMemory": 30,
"suggestedMemory": 20,
"monthlyMaxSavings": 28.258386736965104,
"ruleName": null,
"optimizationStatus": "NOT_OPTIMIZED",
"containers": [
{
"name": "dns-controller",
"requestedCPU": 20,
"suggestedCPU": 1,
"requestedMemory": 20,
"suggestedMemory": 15,
"preliminary": false,
"appliedAt": "2026-04-24T04:55:22.043813"
},
{
"name": "kubedns",
"requestedCPU": 30,
"suggestedCPU": 1,
"requestedMemory": 10,
"suggestedMemory": 5,
"preliminary": true,
"appliedAt": "2026-04-24T04:55:22.043813"
}
],
"appliedAt": "2026-04-24T04:55:22.043813"
}
]
},
"count": {
"example": 2
},
"kind": {
"example": "mcs:ocean:rightSizing:recommendations"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/namespaces/{namespace}/{workloadType}/{workloadName}/recommendation-history": {
"get": {
"summary": "Get Ocean Rightsizing Recommendation History",
"description": "Get right-sizing recommendation history for a specific workload in an Ocean cluster.\n",
"operationId": "oceanRightsizingRecommendationHistory",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"in": "path",
"name": "namespace",
"schema": {
"type": "string"
},
"required": true,
"example": "default",
"description": "Namespace of the workload.\n"
},
{
"in": "path",
"name": "workloadType",
"schema": {
"type": "string",
"enum": [
"deployment",
"daemonSet",
"statefulSet",
"rollout"
]
},
"required": true,
"example": "deployment",
"description": "Type of the workload.\n"
},
{
"in": "path",
"name": "workloadName",
"schema": {
"type": "string"
},
"required": true,
"example": "checkout-service",
"description": "Name of the workload.\n"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "query",
"name": "clusterIdentifier",
"schema": {
"type": "string"
},
"required": false,
"example": "dev-cluster",
"description": "Identifier of the cluster from which recommendation history should be retrieved.\n"
},
{
"in": "query",
"name": "fromDate",
"schema": {
"type": "integer",
"format": "int64"
},
"required": true,
"example": 1717200000000,
"description": "Start time filter as Unix epoch timestamp in milliseconds.\n"
},
{
"in": "query",
"name": "toDate",
"schema": {
"type": "integer",
"format": "int64"
},
"required": false,
"example": 1719800000000,
"description": "End time filter as Unix epoch timestamp in milliseconds.\n"
},
{
"in": "query",
"name": "containerNames",
"required": true,
"description": "List of container names to filter by.\n",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"app",
"sidecar"
]
}
],
"responses": {
"200": {
"description": "Ocean Rightsizing Recommendation History Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/o-abcd1234/rightSizing/namespaces/default/deployment/checkout-service/recommendation-history?accountId=act-123456789&fromDate=1717200000000&clusterIdentifier=dev-cluster"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"recommendations": {
"type": "array",
"items": {
"type": "object",
"title": "Ocean Rightsizing Recommendation History Item",
"description": "Recommendation snapshot for a workload at a specific point in time.\n",
"properties": {
"podCount": {
"type": "integer",
"description": "Number of pods in the workload at recommendation time."
},
"cpu": {
"type": "object",
"description": "CPU recommendation details.",
"properties": {
"requested": {
"type": "number"
},
"recommended": {
"type": "number"
},
"limit": {
"type": "number"
},
"p99": {
"type": "number"
},
"p95": {
"type": "number"
},
"p90": {
"type": "number"
},
"p85": {
"type": "number"
}
}
},
"memory": {
"type": "object",
"description": "Memory recommendation details.",
"properties": {
"requested": {
"type": "number"
},
"recommended": {
"type": "number"
},
"limit": {
"type": "number"
},
"p100": {
"type": "number"
},
"p95": {
"type": "number"
},
"p90": {
"type": "number"
},
"p85": {
"type": "number"
}
}
},
"recommendedAt": {
"type": "integer",
"format": "int64",
"description": "Unix epoch timestamp in milliseconds when the recommendation was generated."
}
}
}
}
}
},
"example": [
{
"recommendations": [
{
"podCount": 1,
"cpu": {
"requested": 0.01,
"recommended": 0.01,
"limit": 0.02,
"p99": 0,
"p95": 0,
"p90": 0,
"p85": 0
},
"memory": {
"requested": 32,
"recommended": 32,
"limit": 64,
"p100": 7.59,
"p95": 7.56,
"p90": 7.56,
"p85": 7.53
},
"recommendedAt": 1783313815984
}
]
}
]
},
"count": {
"example": 1
},
"kind": {
"example": "mcs:ocean:rightSizing:clusterResourceRecommendationsHistory"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/rollbacks": {
"get": {
"summary": "List Ocean Rightsizing Rollbacks",
"description": "List the rightsizing rollback for ocean cluster.",
"operationId": "oceanRightsizingRollbackList",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"description": "Ocean Rightsizing Rollbacks Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/{oceanId}/rightSizing/rollbacks"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clusterIdentifier": {
"type": "string",
"description": "The cluster identifier",
"example": "test-k8s"
},
"namespace": {
"type": "string",
"description": "The namespace of the workload",
"example": "kube-system"
},
"resourceType": {
"type": "string",
"description": "The type of the resource",
"example": "deployment"
},
"resourceName": {
"type": "string",
"description": "The name of the resource",
"example": "resource-name"
},
"rollbackType": {
"type": "string",
"description": "The type of the rollback",
"example": "OUT_OF_MEMORY"
},
"rollbackTime": {
"type": "string",
"format": "date-time",
"description": "The time of the rollback",
"example": "2024-11-01T10:50:29.000+0000"
},
"cpuAtRollback": {
"type": "number",
"description": "The cpu at the time of the rollback",
"example": 0.23
},
"cpuAfterRollback": {
"type": "number",
"description": "The cpu after the rollback",
"example": 0.33
},
"memoryAtRollback": {
"type": "number",
"description": "The memory at the time of the rollback",
"example": 128
},
"memoryAfterRollback": {
"type": "number",
"description": "The memory after the rollback",
"example": 185
}
}
}
},
"kind": {
"example": "mcs:ocean:rightsizing:rollback"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/rollbacks/acknowledge": {
"post": {
"summary": "Acknowledge Rightsizing Rollbacks",
"description": "Acknowledge rightsizing rollbacks For ocean cluster.\n",
"operationId": "AcknowledgeRightsizingRollbacks",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1cluster~1configuration/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"acknowledgeRollbacks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"namespace": {
"type": "string",
"description": "The namespace of the workload",
"example": "kube-system"
},
"resourceType": {
"type": "string",
"description": "The type of the resource",
"example": "deployment"
},
"resourceName": {
"type": "string",
"description": "The name of the resource",
"example": "resource-name"
}
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Rightsizing Acknowledge Rollbacks Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/cluster/configuration": {
"post": {
"summary": "Set Rightsizing Cluster configuration",
"description": "Set Cluster Configuration for the Ocean Cluster.\n
\n
\n**This action can take a few minutes to complete.**\n",
"operationId": "SetClusterConfiguration",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1cluster~1configuration/get/parameters/1"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"required": [
"config"
],
"properties": {
"config": {
"type": "object",
"minProperties": 1,
"properties": {
"recommendationsCpuPercentile": {
"type": "integer",
"description": "Change the cpu percentile that the right-sizing recommendations calculation will take into account.",
"example": 85,
"enum": [
85,
90,
95,
99
]
},
"recommendationsMemoryPercentile": {
"type": "integer",
"description": "Change the memory percentile that the right-sizing recommendations calculation will take into account.",
"example": 85,
"enum": [
85,
90,
95,
100
]
},
"downsideOnly": {
"type": "boolean",
"description": "When set to 'true', only downscale recommendations will be applied.",
"example": false,
"default": false
},
"adjustLimitOnDownsize": {
"type": "boolean",
"description": "When set to 'true', the limit will be adjusted when downscale recommendations are applied.",
"example": true,
"default": false
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean Cluster configuration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/{oceanId}/rightSizing/cluster/configuration"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"oceanId": {
"type": "string",
"example": "o-abcd1234"
},
"clusterIdentifier": {
"type": "string",
"example": "dev-cluster"
},
"config": {
"type": "object",
"properties": {
"recommendationsCpuPercentile": {
"type": "integer",
"example": 85
},
"recommendationsMemoryPercentile": {
"type": "integer",
"example": 85
},
"downsideOnly": {
"type": "boolean",
"example": false
},
"adjustLimitOnDownsize": {
"type": "boolean",
"example": true
}
}
}
}
}
},
"kind": {
"example": "mcs:ocean:rightSizing:clusterConfiguration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"get": {
"summary": "Get Rightsizing Cluster configuration",
"description": "Get Cluster Configuration for the Ocean Cluster.\n
\n
\n**This action can take a few minutes to complete.**\n",
"operationId": "GetClusterConfiguration",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"in": "query",
"name": "clusterIdentifier",
"schema": {
"type": "string"
},
"required": true,
"example": "dev-cluster",
"description": "Identifier of cluster.\n"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"responses": {
"200": {
"description": "Ocean Cluster configuration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/{oceanId}/rightSizing/cluster/configuration"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"oceanId": {
"type": "string",
"example": "o-abcd1234"
},
"clusterIdentifier": {
"type": "string",
"example": "dev-cluster"
},
"config": {
"type": "object",
"properties": {
"recommendationsCpuPercentile": {
"type": "integer",
"example": 85
},
"recommendationsMemoryPercentile": {
"type": "integer",
"example": 85
},
"downsideOnly": {
"type": "boolean",
"example": false
},
"adjustLimitOnDownsize": {
"type": "boolean",
"example": true
}
}
}
}
}
},
"kind": {
"example": "mcs:ocean:rightSizing:clusterConfiguration"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/savings": {
"post": {
"summary": "Get Ocean Right-Sizing Savings",
"description": "Get right-sizing savings from downsizing operations for an Ocean cluster.\n",
"operationId": "oceanRightsizingSavings",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"title": "Ocean Right-Sizing Savings",
"description": "Determines the Ocean right-sizing savings\n",
"required": [
"clusterIdentifier",
"endTime",
"startTime",
"workloads"
],
"properties": {
"clusterIdentifier": {
"type": "string",
"example": "my-cluster",
"description": "Identifier of the Ocean cluster.\n"
},
"startTime": {
"type": "string",
"example": "2025-01-20T11:35:02.745Z",
"description": "Start date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"endTime": {
"type": "string",
"example": "2025-01-30T11:30:01.745Z",
"description": "End date value using either the date format \"yyyy-MM-dd'T'HH:mm:ss'Z'\" or ms \"1494751821472\".\n"
},
"workloads": {
"title": "Ocean Right-Sizing Savings Workloads",
"description": "Determines the Ocean Savings filtering by the combinations of namespace::workload\n",
"type": "object",
"properties": {
"namespaceName": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the workload"
},
"workloadType": {
"type": "string",
"description": "The type of the workload (e.g., Deployment, DaemonSet, StatefulSet)"
}
}
}
}
}
},
"example": {
"namespaceName1": [
{
"name": "workloadName1",
"workloadType": "Deployment"
},
{
"name": "workloadName2",
"workloadType": "DaemonSet"
}
],
"namespaceName2": [
{
"name": "workloadName3",
"workloadType": "StatefulSet"
},
{
"name": "workloadName4",
"workloadType": "Deployment"
}
]
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Ocean right-sizing savings response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/o-abcd1234/rightSizing/savings"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Ocean Right-Sizing Savings Response",
"description": "Right-sizing savings response object\n",
"properties": {
"totalSavingsSummary": {
"type": "object",
"description": "A summary of the savings for all the workloads in the response",
"properties": {
"cpuWithOcean": {
"type": "number"
},
"memoryWithOcean": {
"type": "number"
},
"savings": {
"type": "number"
},
"percentage": {
"type": "number"
}
}
},
"namespacesSavingsSummary": {
"type": "array",
"description": "A summary of the savings for each namespace in the response",
"items": {
"type": "object",
"properties": {
"namespace": {
"type": "string"
},
"savings": {
"type": "number"
}
}
}
},
"workloadSavings": {
"type": "array",
"description": "A list of the savings for each workload in the response",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"workloadType": {
"type": "string"
},
"namespace": {
"type": "string"
},
"cpuWithOcean": {
"type": "number"
},
"cpuWithoutOcean": {
"type": "number"
},
"memoryWithOcean": {
"type": "number"
},
"memoryWithoutOcean": {
"type": "number"
},
"savings": {
"type": "number"
},
"workloadDeleted": {
"type": "boolean"
}
}
}
}
}
},
"example": [
{
"totalSavingsSummary": {
"cpuWithOcean": "100,",
"memoryWithOcean": "128,",
"savings": "1000,",
"percentage": 0.75
},
"namespacesSavingsSummary": [
{
"namespace": "kube-system",
"savings": 500
},
{
"namespace": "default",
"savings": 500
}
],
"workloadSavings": [
{
"name": "coredns",
"workloadType": "Deployment",
"namespace": "kube-system",
"cpuWithOcean": 25,
"cpuWithoutOcean": 50,
"memoryWithOcean": 32,
"memoryWithoutOcean": 64,
"savings": 250,
"workloadDeleted": true
},
{
"name": "aws-node",
"workloadType": "DaemonSet",
"namespace": "kube-system",
"cpuWithOcean": 25,
"cpuWithoutOcean": 50,
"memoryWithOcean": 32,
"memoryWithoutOcean": 64,
"savings": 250,
"workloadDeleted": false
}
]
}
]
},
"count": {
"example": 1
},
"kind": {
"example": "mcs:ocean:rightSizing:savings"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/ocean/{oceanId}/rightSizing/namespaces/{namespace}/{workloadType}/{workloadName}/recommendation-application-history": {
"get": {
"summary": "Get Workload Recommendation Application History",
"description": "Returns a set of recommendation application history records associated with workload.\n",
"operationId": "getWorkloadRecommendationApplicationHistory",
"tags": [
"Ocean Automatic Rightsizing"
],
"parameters": [
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1rule/get/parameters/0"
},
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1namespaces~1%7Bnamespace%7D~1%7BworkloadType%7D~1%7BworkloadName%7D~1recommendation-history/get/parameters/1"
},
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1namespaces~1%7Bnamespace%7D~1%7BworkloadType%7D~1%7BworkloadName%7D~1recommendation-history/get/parameters/2"
},
{
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1namespaces~1%7Bnamespace%7D~1%7BworkloadType%7D~1%7BworkloadName%7D~1recommendation-history/get/parameters/3"
},
{
"$ref": "#/paths/~1azure~1costs/get/parameters/0"
},
{
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"format": "int16",
"default": 0,
"minimum": 0,
"example": 0
},
"required": false,
"description": "Number of entries to skip before returning page.\n"
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int16",
"default": 100,
"minimum": 1,
"maximum": 200
},
"required": false,
"example": 100,
"description": "Number of entries to return.\n"
}
],
"responses": {
"200": {
"description": "Ocean Rightsizing Recommendation Application History Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/ocean/o-abcd1234/rightSizing/namespaces/kube-system/deployment/redis-controller/recommendation-application-history"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"kind": {
"example": "mcs:ocean:rightSizing:recommendationApplicationHistory"
},
"items": {
"type": "array",
"items": {
"type": "object",
"title": "Recommendation Application History",
"description": "A page of recommendation application history records.\n",
"properties": {
"page": {
"type": "array",
"items": {
"type": "object",
"title": "Recommendation Application Item",
"description": "A single recommendation application history record for a container.\n",
"properties": {
"containerName": {
"type": "string",
"description": "Name of the container.",
"example": "my-app-container"
},
"actionType": {
"type": "string",
"description": "The type of action that was taken or the reason it was not applied.",
"enum": [
"APPLIED",
"CPU_ONLY_APPLIED",
"MEMORY_ONLY_APPLIED",
"OUTSIDE_OF_TIME_WINDOW",
"THRESHOLD_NOT_MET",
"HPA_RESTRICTED",
"UNSUPPORTED_HPA",
"INVALID_HPA",
"PRELIMINARY_RESTRICTED"
],
"example": "APPLIED"
},
"currentResources": {
"type": "object",
"title": "Compute Resource",
"description": "Represents CPU and memory resource values.\n",
"properties": {
"cpu": {
"type": "integer",
"format": "int32",
"description": "CPU resource value in millicores.",
"example": 4000
},
"memory": {
"type": "integer",
"format": "int32",
"description": "Memory resource value in MiB.",
"example": 16000
}
}
},
"recommendedResources": {
"$ref": "#/paths/~1ocean~1%7BoceanId%7D~1rightSizing~1namespaces~1%7Bnamespace%7D~1%7BworkloadType%7D~1%7BworkloadName%7D~1recommendation-application-history/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items/properties/page/items/properties/currentResources"
},
"occurredAt": {
"type": "integer",
"format": "int64",
"description": "Timestamp (epoch millis) when the action occurred.",
"example": 1776178797289
},
"ruleName": {
"type": "string",
"description": "Name of the rightsizing rule that triggered this action.",
"example": "my-app-rule"
}
}
}
}
}
},
"example": [
{
"page": [
{
"containerName": "my-app-container",
"actionType": "APPLIED",
"currentResources": {
"cpu": 4000,
"memory": 16000
},
"recommendedResources": {
"cpu": 2000,
"memory": 8000
},
"occurredAt": 1776178797289,
"ruleName": "my-app-rule"
}
]
}
]
},
"count": {
"example": 1
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Invalid request provided"
},
"404": {
"description": "Non existent resource has been queried"
},
"422": {
"description": "Business rule violated"
}
}
}
},
"/security/v1/compliances": {
"get": {
"description": "A cyber security compliance determines how compliant an asset is. It checks against specific security standards.\nThis API returns list of all compliances supported in Spot.\nA compliance consists of one or more controls.",
"operationId": "get_compliances_v1_compliances_get",
"parameters": [
{
"description": "Token of the page to return.",
"in": "query",
"name": "paginationKey",
"required": false,
"schema": {
"description": "Token of the page to return.",
"title": "Paginationkey",
"type": "string"
}
},
{
"description": "Number of items to return per page.",
"in": "query",
"name": "paginationSize",
"required": false,
"schema": {
"default": 100,
"description": "Number of items to return per page.",
"maximum": 100,
"minimum": 1,
"title": "Paginationsize",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"allOf": [
{
"properties": {
"code": {
"title": "Code",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
}
},
"required": [
"code",
"message"
],
"title": "ErrorModel",
"type": "object"
}
],
"title": "Error"
},
"request": {
"properties": {
"body": {
"title": "Body",
"type": "object"
},
"id": {
"title": "Id",
"type": "string"
},
"method": {
"title": "Method",
"type": "string"
},
"queryParameters": {
"title": "Queryparameters",
"type": "object"
},
"timestamp": {
"title": "Timestamp",
"type": "string"
},
"url": {
"title": "Url",
"type": "string"
}
},
"required": [
"id",
"url",
"method",
"queryParameters",
"body",
"timestamp"
],
"title": "RequestModel",
"type": "object"
},
"response": {
"allOf": [
{
"properties": {
"count": {
"default": 0,
"description": "The number of items.",
"title": "Count",
"type": "integer"
},
"items": {
"description": "The array of objects in this response. The length of the array is according to the 'count' attribute.",
"items": {
"properties": {
"complianceName": {
"title": "Compliancename",
"type": "string"
}
},
"title": "ComplianceModel",
"type": "object"
},
"title": "Items",
"type": "array"
},
"paginationInfo": {
"properties": {
"nextKey": {
"description": "Each API call has a unique token. This is the token for the next page of results.",
"title": "Nextkey",
"type": "string"
},
"paginationSize": {
"description": "The maximum number of items in the page. The attribute 'item' indicates the actual number of items in the page.",
"title": "Paginationsize",
"type": "integer"
},
"previousKey": {
"description": "Each API call has a unique token. This is the token for the previous page of results.",
"title": "Previouskey",
"type": "string"
}
},
"title": "PaginationModel",
"type": "object"
},
"status": {
"properties": {
"code": {
"title": "Code",
"type": "integer"
},
"message": {
"title": "Message",
"type": "string"
}
},
"required": [
"code",
"message"
],
"title": "StatusModel",
"type": "object"
}
},
"required": [
"status",
"items",
"paginationInfo"
],
"title": "PaginatedResponse[ComplianceModel]",
"type": "object"
}
]
},
"responseTime": {
"title": "Responsetime",
"type": "number"
}
},
"required": [
"request"
],
"title": "SpotResponse[PaginatedResponse[ComplianceModel]]",
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"422": {
"content": {
"application/json": {
"schema": {
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Compliances",
"tags": [
"Compliance"
]
},
"parameters": []
},
"/security/v1/compliances/count": {
"get": {
"description": "Get the total number of compliances.",
"operationId": "get_compliance_count_v1_compliances_count_get",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"allOf": [
{
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/error/allOf/0"
}
],
"title": "Error"
},
"request": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/request"
},
"response": {
"allOf": [
{
"properties": {
"count": {
"default": 0,
"description": "The number of items.",
"title": "Count",
"type": "integer"
},
"items": {
"description": "The array of objects in this response. The length of the array is according to the 'count' attribute.",
"items": {
"properties": {
"value": {
"description": "The number of items.",
"title": "Value",
"type": "integer"
}
},
"required": [
"value"
],
"title": "CountModel",
"type": "object"
},
"title": "Items",
"type": "array"
},
"status": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/response/allOf/0/properties/status"
}
},
"required": [
"status",
"items"
],
"title": "BaseResponse[CountModel]",
"type": "object"
}
]
},
"responseTime": {
"title": "Responsetime",
"type": "number"
}
},
"required": [
"request"
],
"title": "SpotResponse[BaseResponse[CountModel]]",
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"description": "Not Found"
}
},
"summary": "Get Compliance Count",
"tags": [
"Compliance"
]
},
"parameters": []
},
"/security/v1/compliances/{complianceName}/controls": {
"get": {
"description": "A control is countermeasures to avoid, detect, counteract, or minimize security risks of cloud assets.\nA control may be part of one or more compliances. A control is verified in one or more rules.\nThis API returns the list of controls mapped to a specific compliance.",
"operationId": "get_compliance_controls_v1_compliances__complianceName__controls_get",
"parameters": [
{
"description": "The name of the cyber security compliance.",
"example": "SOC_2",
"in": "path",
"name": "complianceName",
"required": true,
"schema": {
"description": "The name of the cyber security compliance.",
"title": "Compliancename",
"type": "string"
}
},
{
"description": "If this is not a manual control, the value is True.",
"in": "query",
"name": "isAutomated",
"required": false,
"schema": {
"description": "If this is not a manual control, the value is True.",
"title": "Isautomated",
"type": "boolean"
}
},
{
"$ref": "#/paths/~1security~1v1~1compliances/get/parameters/0"
},
{
"$ref": "#/paths/~1security~1v1~1compliances/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"allOf": [
{
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/error/allOf/0"
}
],
"title": "Error"
},
"request": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/request"
},
"response": {
"allOf": [
{
"properties": {
"count": {
"default": 0,
"description": "The number of items.",
"title": "Count",
"type": "integer"
},
"items": {
"description": "The array of objects in this response. The length of the array is according to the 'count' attribute.",
"items": {
"properties": {
"controlId": {
"title": "Controlid",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"isAutomated": {
"title": "Isautomated",
"type": "boolean"
}
},
"title": "ControlModel",
"type": "object"
},
"title": "Items",
"type": "array"
},
"paginationInfo": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/response/allOf/0/properties/paginationInfo"
},
"status": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/response/allOf/0/properties/status"
}
},
"required": [
"status",
"items",
"paginationInfo"
],
"title": "PaginatedResponse[ControlModel]",
"type": "object"
}
]
},
"responseTime": {
"title": "Responsetime",
"type": "number"
}
},
"required": [
"request"
],
"title": "SpotResponse[PaginatedResponse[ControlModel]]",
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/422/content/application~1json/schema"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Compliance Controls",
"tags": [
"Compliance"
]
},
"parameters": []
},
"/security/v1/compliances/{complianceName}/controls/count": {
"get": {
"description": "Get the total number of controls for the selected compliance.",
"operationId": "get_compliance_controls_count_v1_compliances__complianceName__controls_count_get",
"parameters": [
{
"$ref": "#/paths/~1security~1v1~1compliances~1%7BcomplianceName%7D~1controls/get/parameters/0"
},
{
"$ref": "#/paths/~1security~1v1~1compliances~1%7BcomplianceName%7D~1controls/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances~1count/get/responses/200/content/application~1json/schema"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/422/content/application~1json/schema"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Compliance Controls Count",
"tags": [
"Compliance"
]
},
"parameters": []
},
"/security/v1/misconfigurations": {
"get": {
"description": "This API returns the list of assets that have misconfigurations.",
"operationId": "get_misconfigurations_v1_misconfigurations_get",
"parameters": [
{
"in": "query",
"name": "cloud",
"required": true,
"schema": {
"description": "Enumeration of supported cloud providers.",
"enum": [
"aws",
"azure"
],
"title": "CloudProvider",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud account IDs. For AWS this is the account ID. For Azure, this is the subscription ID.",
"in": "query",
"name": "accountId",
"required": false,
"schema": {
"description": "A comma-separated list of cloud account IDs. For AWS this is the account ID. For Azure, this is the subscription ID.",
"title": "Accountid",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud account IDs to exclude. For AWS this is the account ID. For Azure, this is the subscription ID.",
"in": "query",
"name": "notAccountId",
"required": false,
"schema": {
"description": "A comma-separated list of cloud account IDs to exclude. For AWS this is the account ID. For Azure, this is the subscription ID.",
"title": "Notaccountid",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud account names.",
"in": "query",
"name": "accountName",
"required": false,
"schema": {
"description": "A comma-separated list of cloud account names.",
"title": "Accountname",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud account names to exclude",
"in": "query",
"name": "notAccountName",
"required": false,
"schema": {
"description": "A comma-separated list of cloud account names to exclude",
"title": "Notaccountname",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud regions.",
"example": "us-east-1",
"in": "query",
"name": "region",
"required": false,
"schema": {
"description": "A comma-separated list of cloud regions.",
"title": "Region",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud regions to exclude.",
"example": "us-east-1",
"in": "query",
"name": "notRegion",
"required": false,
"schema": {
"description": "A comma-separated list of cloud regions to exclude.",
"title": "Notregion",
"type": "string"
}
},
{
"description": "The date the finding was most recently found (YYYY-MM-DD).",
"example": "1997-11-11",
"in": "query",
"name": "date",
"required": false,
"schema": {
"description": "The date the finding was most recently found (YYYY-MM-DD).",
"format": "date",
"title": "Date",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud services.",
"in": "query",
"name": "service",
"required": false,
"schema": {
"description": "A comma-separated list of cloud services.",
"title": "Service",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud services to exclude.",
"in": "query",
"name": "notService",
"required": false,
"schema": {
"description": "A comma-separated list of cloud services to exclude.",
"title": "Notservice",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud resources for the service.",
"in": "query",
"name": "assetType",
"required": false,
"schema": {
"description": "A comma-separated list of cloud resources for the service.",
"title": "Assettype",
"type": "string"
}
},
{
"description": "A comma-separated list of cloud resources for the service to exclude.",
"in": "query",
"name": "notAssetType",
"required": false,
"schema": {
"description": "A comma-separated list of cloud resources for the service to exclude.",
"title": "Notassettype",
"type": "string"
}
},
{
"description": "The unique name of the rule.",
"in": "query",
"name": "ruleName",
"required": false,
"schema": {
"description": "The unique name of the rule.",
"title": "Rulename",
"type": "string"
}
},
{
"description": "The asset's ID (a cloud resource).",
"in": "query",
"name": "assetId",
"required": false,
"schema": {
"description": "The asset's ID (a cloud resource).",
"title": "Assetid",
"type": "string"
}
},
{
"$ref": "#/paths/~1security~1v1~1compliances/get/parameters/0"
},
{
"$ref": "#/paths/~1security~1v1~1compliances/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"allOf": [
{
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/error/allOf/0"
}
],
"title": "Error"
},
"request": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/request"
},
"response": {
"allOf": [
{
"properties": {
"count": {
"default": 0,
"description": "The number of items.",
"title": "Count",
"type": "integer"
},
"items": {
"description": "The array of objects in this response. The length of the array is according to the 'count' attribute.",
"items": {
"properties": {
"organizationId": {
"description": "The Spot Organization ID.",
"title": "Organizationid",
"type": "string"
},
"what": {
"properties": {
"args": {
"description": "Certain misconfiguration rules have arguments. This field contains the arguments in the form of an comma separated array. Example: [\"MongoDB\", \"TCP\", \"27017\"]",
"items": {
"type": "string"
},
"title": "Args",
"type": "array"
},
"isSuppressed": {
"description": "If this finding is suppressed, the value is True.",
"title": "Issuppressed",
"type": "boolean"
},
"ruleDescription": {
"description": "Description of the rule.",
"title": "Ruledescription",
"type": "string"
},
"ruleName": {
"description": "The unique name of the rule.",
"title": "Rulename",
"type": "string"
},
"ruleTitle": {
"description": "The name of the rule.",
"title": "Ruletitle",
"type": "string"
},
"severity": {
"description": "The severity of the rule.",
"title": "Severity",
"type": "string"
},
"state": {
"description": "The state of the misconfiguration. It is either open or closed.",
"title": "State",
"type": "string"
}
},
"required": [
"ruleName",
"ruleTitle",
"ruleDescription",
"args",
"severity",
"state",
"isSuppressed"
],
"title": "MisconfigurationWhatModel",
"type": "object"
},
"when": {
"properties": {
"lastSeen": {
"description": "The date the finding was most recently found (YYYY-MM-DD).",
"title": "Lastseen",
"type": "string"
},
"suppressedAt": {
"description": "When the finding was suppressed.",
"format": "date-time",
"title": "Suppressedat",
"type": "string"
}
},
"required": [
"lastSeen",
"suppressedAt"
],
"title": "MisconfigurationWhenModel",
"type": "object"
},
"where": {
"properties": {
"accountId": {
"description": "A comma-separated list of cloud account IDs. For AWS this is the account ID. For Azure, this is the subscription ID.",
"title": "Accountid",
"type": "string"
},
"assetId": {
"description": "The asset's ID (a cloud resource).",
"title": "Assetid",
"type": "string"
},
"assetName": {
"description": "The name of the asset ID.",
"title": "Assetname",
"type": "string"
},
"assetType": {
"description": "A comma-separated list of cloud resources for the service.",
"title": "Assettype",
"type": "string"
},
"findingLocation": {
"description": "For a misconfiguration: the cloud resource or a subelement of the cloud resource. For a vulnerability: the cloud resource, an OS image, or a filename.",
"title": "Findinglocation",
"type": "string"
},
"region": {
"description": "A comma-separated list of cloud regions.",
"title": "Region",
"type": "string"
},
"service": {
"description": "The cloud service.",
"title": "Service",
"type": "string"
}
},
"required": [
"accountId",
"service",
"assetId",
"assetName",
"assetType",
"region",
"findingLocation"
],
"title": "MisconfigurationWhereModel",
"type": "object"
},
"who": {
"properties": {
"suppressedBy": {
"description": "The user who suppressed the finding.",
"title": "Suppressedby",
"type": "string"
}
},
"required": [
"suppressedBy"
],
"title": "MisconfigurationWhoModel",
"type": "object"
}
},
"required": [
"organizationId",
"when",
"what",
"where",
"who"
],
"title": "MisconfigurationModel",
"type": "object"
},
"title": "Items",
"type": "array"
},
"paginationInfo": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/response/allOf/0/properties/paginationInfo"
},
"status": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/response/allOf/0/properties/status"
}
},
"required": [
"status",
"items",
"paginationInfo"
],
"title": "PaginatedResponse[MisconfigurationModel]",
"type": "object"
}
]
},
"responseTime": {
"title": "Responsetime",
"type": "number"
}
},
"required": [
"request"
],
"title": "SpotResponse[PaginatedResponse[MisconfigurationModel]]",
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/422/content/application~1json/schema"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Misconfigurations",
"tags": [
"Misconfiguration"
]
},
"parameters": []
},
"/security/v1/misconfigurations/count": {
"get": {
"description": "This API returns a count of assets that have misconfigurations.",
"operationId": "get_misconfigurations_count_v1_misconfigurations_count_get",
"parameters": [
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/0"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/1"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/2"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/3"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/4"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/5"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/6"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/7"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/8"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/9"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/10"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/11"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/12"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/13"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances~1count/get/responses/200/content/application~1json/schema"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/422/content/application~1json/schema"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Misconfigurations Count",
"tags": [
"Misconfiguration"
]
},
"parameters": []
},
"/security/v1/misconfigurations/rules": {
"get": {
"description": "Rules are configuration checks that detect misconfigurations in your cloud environment.\nRules are cloud service provider specific. A rule is mapped to one or more controls.\nThis API returns the list of rules that can determine the state of a specific control.",
"operationId": "get_rules_v1_misconfigurations_rules_get",
"parameters": [
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/0"
},
{
"description": "The name of the cyber security compliance.",
"example": "SOC_2",
"in": "query",
"name": "complianceName",
"required": false,
"schema": {
"description": "The name of the cyber security compliance.",
"title": "Compliancename",
"type": "string"
}
},
{
"description": "The ID of the control defined in the compliance.",
"example": "A1.2",
"in": "query",
"name": "controlId",
"required": false,
"schema": {
"description": "The ID of the control defined in the compliance.",
"title": "Controlid",
"type": "string"
}
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/8"
},
{
"$ref": "#/paths/~1security~1v1~1compliances/get/parameters/0"
},
{
"$ref": "#/paths/~1security~1v1~1compliances/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"allOf": [
{
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/error/allOf/0"
}
],
"title": "Error"
},
"request": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/request"
},
"response": {
"allOf": [
{
"properties": {
"count": {
"default": 0,
"description": "The number of items.",
"title": "Count",
"type": "integer"
},
"items": {
"description": "The array of objects in this response. The length of the array is according to the 'count' attribute.",
"items": {
"properties": {
"args": {
"description": "Certain misconfiguration rules have arguments. This field contains the arguments in the form of an comma separated array. Example: [\"MongoDB\", \"TCP\", \"27017\"]",
"items": {
"type": "string"
},
"title": "Args",
"type": "array"
},
"cloud": {
"description": "The name of the cloud.",
"title": "Cloud",
"type": "string"
},
"complianceName": {
"description": "The name of the cyber security compliance.",
"items": {
"type": "string"
},
"title": "Compliancename",
"type": "array"
},
"controls": {
"description": "The ID of the control defined in the compliance.",
"items": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"title": "Controls",
"type": "array"
},
"description": {
"description": "Description of the rule.",
"title": "Description",
"type": "string"
},
"effort": {
"allOf": [
{
"enum": [
"High",
"Medium",
"Low",
""
],
"title": "Effort",
"type": "string"
}
],
"description": "The effort required to fix the finding."
},
"ruleName": {
"description": "The unique name of the rule.",
"title": "Rulename",
"type": "string"
},
"ruleTitle": {
"description": "The name of the rule.",
"title": "Ruletitle",
"type": "string"
},
"service": {
"description": "The cloud service.",
"title": "Service",
"type": "string"
},
"severity": {
"allOf": [
{
"enum": [
"Critical",
"High",
"Medium",
"Low"
],
"title": "Severity",
"type": "string"
}
],
"description": "The severity of the rule."
}
},
"required": [
"ruleName",
"ruleTitle",
"description",
"cloud",
"service",
"args",
"severity",
"effort",
"complianceName",
"controls"
],
"title": "RulesModel",
"type": "object"
},
"title": "Items",
"type": "array"
},
"paginationInfo": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/response/allOf/0/properties/paginationInfo"
},
"status": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/response/allOf/0/properties/status"
}
},
"required": [
"status",
"items",
"paginationInfo"
],
"title": "PaginatedResponse[RulesModel]",
"type": "object"
}
]
},
"responseTime": {
"title": "Responsetime",
"type": "number"
}
},
"required": [
"request"
],
"title": "SpotResponse[PaginatedResponse[RulesModel]]",
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/422/content/application~1json/schema"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Rules",
"tags": [
"Misconfiguration"
]
},
"parameters": []
},
"/security/v1/misconfigurations/rules/count": {
"get": {
"description": "Rules are configuration checks that detect misconfigurations in your cloud environment.\nRules are cloud service provider specific. A rule is mapped to one or more controls.\nThis API returns the list of rules that can determine the state of a specific control.",
"operationId": "get_rules_count_v1_misconfigurations_rules_count_get",
"parameters": [
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/0"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations~1rules/get/parameters/1"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations~1rules/get/parameters/2"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/8"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances~1count/get/responses/200/content/application~1json/schema"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/422/content/application~1json/schema"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Rules Count",
"tags": [
"Misconfiguration"
]
},
"parameters": []
},
"/security/v1/assets/filters/{filterKey}": {
"get": {
"description": "Get a list of values in your organization for a specific filter type.\nFor example, if you select accountId, you'll get a list of all the account IDs in your organization.",
"operationId": "get_asset_sim_filter_v1_assets_filters__filterKey__get",
"parameters": [
{
"description": "The name of the filter.",
"in": "path",
"name": "filterKey",
"required": true,
"schema": {
"allOf": [
{
"description": "The list of filter types, for example accountId, region, assetName.",
"enum": [
"accountId",
"accountName",
"region",
"assetId",
"assetName",
"service",
"assetType"
],
"title": "AssetFilters",
"type": "string"
}
],
"description": "The name of the filter.",
"title": "Filterkey"
}
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/0"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/1"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/2"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/3"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/4"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/5"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/6"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/7"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/8"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/9"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/10"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/11"
},
{
"$ref": "#/paths/~1security~1v1~1misconfigurations/get/parameters/13"
},
{
"description": "The name of the asset ID.",
"in": "query",
"name": "assetName",
"required": false,
"schema": {
"description": "The name of the asset ID.",
"title": "Assetname",
"type": "string"
}
},
{
"description": "If there are findings for the assets, the value is True.",
"example": "true",
"in": "query",
"name": "isRisky",
"required": false,
"schema": {
"description": "If there are findings for the assets, the value is True.",
"title": "Isrisky",
"type": "boolean"
}
},
{
"description": "The sum of misconfigurations and vulnerabilities for today's date, and threats and anomalies identified that are still applicable today.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "allFindingsCount",
"required": false,
"schema": {
"description": "The sum of misconfigurations and vulnerabilities for today's date, and threats and anomalies identified that are still applicable today.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Allfindingscount",
"type": "string"
}
},
{
"description": "The total number of vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "allVulnCount",
"required": false,
"schema": {
"description": "The total number of vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Allvulncount",
"type": "string"
}
},
{
"description": "The number of critical vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "criticalVulnCount",
"required": false,
"schema": {
"description": "The number of critical vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Criticalvulncount",
"type": "string"
}
},
{
"description": "The number of high vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "highVulnCount",
"required": false,
"schema": {
"description": "The number of high vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Highvulncount",
"type": "string"
}
},
{
"description": "The number of medium vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "mediumVulnCount",
"required": false,
"schema": {
"description": "The number of medium vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Mediumvulncount",
"type": "string"
}
},
{
"description": "The number of low vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "lowVulnCount",
"required": false,
"schema": {
"description": "The number of low vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Lowvulncount",
"type": "string"
}
},
{
"description": "The number of informational vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "infoVulnCount",
"required": false,
"schema": {
"description": "The number of informational vulnerabilities found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Infovulncount",
"type": "string"
}
},
{
"description": "The total number of misconfigurations found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "allMisconfigCount",
"required": false,
"schema": {
"description": "The total number of misconfigurations found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Allmisconfigcount",
"type": "string"
}
},
{
"description": "The number of high misconfigurations found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "highMisconfigCount",
"required": false,
"schema": {
"description": "The number of high misconfigurations found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Highmisconfigcount",
"type": "string"
}
},
{
"description": "The number of medium misconfigurations found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "mediumMisconfigCount",
"required": false,
"schema": {
"description": "The number of medium misconfigurations found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Mediummisconfigcount",
"type": "string"
}
},
{
"description": "The number of low misconfigurations found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "lowMisconfigCount",
"required": false,
"schema": {
"description": "The number of low misconfigurations found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Lowmisconfigcount",
"type": "string"
}
},
{
"description": "The total number of events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "allEventsCount",
"required": false,
"schema": {
"description": "The total number of events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Alleventscount",
"type": "string"
}
},
{
"description": "The number of configuration events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "configEventsCount",
"required": false,
"schema": {
"description": "The number of configuration events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Configeventscount",
"type": "string"
}
},
{
"description": "The number of critical events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "criticalEventsCount",
"required": false,
"schema": {
"description": "The number of critical events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Criticaleventscount",
"type": "string"
}
},
{
"description": "The number of data change events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "dataChangeEventsCount",
"required": false,
"schema": {
"description": "The number of data change events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Datachangeeventscount",
"type": "string"
}
},
{
"description": "The number of IAM change events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "iamChangeEventsCount",
"required": false,
"schema": {
"description": "The number of IAM change events found for the asset.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Iamchangeeventscount",
"type": "string"
}
},
{
"description": "The number of related assets affected by the finding.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "affectedAssetsCount",
"required": false,
"schema": {
"description": "The number of related assets affected by the finding.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Affectedassetscount",
"type": "string"
}
},
{
"description": "The total number of anomalies found for the asset identified that are still applicable today.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "allAnomaliesCount",
"required": false,
"schema": {
"description": "The total number of anomalies found for the asset identified that are still applicable today.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Allanomaliescount",
"type": "string"
}
},
{
"description": "The total number of threats found for the asset identified that are still applicable today.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"in": "query",
"name": "allThreatsCount",
"required": false,
"schema": {
"description": "The total number of threats found for the asset identified that are still applicable today.\n
\n Enter either a number or prefix it with one of these operators:\n \n \n | Operator | \n Notation | \n Example | \n
\n \n | Equals | \n No prefix or \\~eq\\~ | \n 10 or \\~eq\\~10 | \n
\n \n | Not equals | \n \\~neq\\~ | \n \\~neq\\~10 | \n
\n \n | Greater than | \n \\~gt\\~ | \n \\~gt\\~10 | \n
\n \n | Greater than equals | \n \\~gte\\~ | \n \\~gte\\~10 | \n
\n \n | Less than | \n \\~lt\\~ | \n \\~lt\\~10 | \n
\n \n | Less than equals | \n \\~lte\\~ | \n \\~lte\\~10 | \n
\n \n | Between two numbers | \n \\~bt\\~ | \n \\~bt\\~10,20 | \n
\n
\n ",
"title": "Allthreatscount",
"type": "string"
}
},
{
"description": "The field to sort the results by.",
"in": "query",
"name": "ordering",
"required": false,
"schema": {
"allOf": [
{
"description": "The order you want to sort the assets.",
"enum": [
"item",
"-item",
"accId",
"-accId",
"service",
"-service",
"assetType",
"-assetType",
"isRisky",
"-isRisky",
"colDate",
"-colDate",
"region",
"-region",
"allFindingsCount",
"-allFindingsCount",
"allVulnCount",
"-allVulnCount",
"criticalVulnCount",
"-criticalVulnCount",
"highVulnCount",
"-highVulnCount",
"mediumVulnCount",
"-mediumVulnCount",
"lowVulnCount",
"-lowVulnCount",
"infoVulnCount",
"-infoVulnCount",
"allMisconfigCount",
"-allMisconfigCount",
"highMisconfigCount",
"-highMisconfigCount",
"mediumMisconfigCount",
"-mediumMisconfigCount",
"lowMisconfigCount",
"-lowMisconfigCount",
"allEventsCount",
"-allEventsCount",
"configEventsCount",
"-configEventsCount",
"criticalEventsCount",
"-criticalEventsCount",
"dataChangeEventsCount",
"-dataChangeEventsCount",
"iamChangeEventsCount",
"-iamChangeEventsCount",
"affectedAssetsCount",
"-affectedAssetsCount",
"allAnomaliesCount",
"-allAnomaliesCount",
"allThreatsCount"
],
"title": "Ordering",
"type": "string"
}
],
"default": "-allMisconfigCount",
"description": "The field to sort the results by.",
"title": "Ordering"
}
},
{
"$ref": "#/paths/~1security~1v1~1compliances/get/parameters/0"
},
{
"$ref": "#/paths/~1security~1v1~1compliances/get/parameters/1"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"allOf": [
{
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/error/allOf/0"
}
],
"title": "Error"
},
"request": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/request"
},
"response": {
"allOf": [
{
"properties": {
"count": {
"default": 0,
"description": "The number of items.",
"title": "Count",
"type": "integer"
},
"items": {
"description": "The array of objects in this response. The length of the array is according to the 'count' attribute.",
"items": {
"properties": {
"value": {
"description": "The list of values in your organization for the filter type you selected.",
"title": "Value",
"type": "string"
}
},
"title": "AssetSimFilterResponseModel",
"type": "object"
},
"title": "Items",
"type": "array"
},
"paginationInfo": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/response/allOf/0/properties/paginationInfo"
},
"status": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/200/content/application~1json/schema/properties/response/allOf/0/properties/status"
}
},
"required": [
"status",
"items",
"paginationInfo"
],
"title": "PaginatedResponse[AssetSimFilterResponseModel]",
"type": "object"
}
]
},
"responseTime": {
"title": "Responsetime",
"type": "number"
}
},
"required": [
"request"
],
"title": "SpotResponse[PaginatedResponse[AssetSimFilterResponseModel]]",
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {},
"description": "Bad Request"
},
"404": {
"description": "Not Found"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1security~1v1~1compliances/get/responses/422/content/application~1json/schema"
}
}
},
"description": "Validation Error"
}
},
"summary": "Get Asset Sim Filter",
"tags": [
"Assets"
]
},
"parameters": []
},
"/cbi/v1/access/policy": {
"get": {
"tags": [
"Organizations"
],
"summary": "Get FinOps Authorization Policies",
"description": "Get all available FinOps authorization policies.",
"parameters": [
{
"name": "targetOrganizationId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "paginationSize",
"in": "query",
"description": "number of items to include in the response",
"schema": {
"type": "integer"
}
},
{
"name": "paginationKey",
"in": "query",
"description": "key used to fetch the next page of items",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 1,
"description": "Size of the data object array.\n"
},
"kind": {
"type": "string",
"description": "The data type of each item in the response.\n"
},
"paginationInfo": {
"nullable": true,
"properties": {
"totalCount": {
"type": "integer",
"nullable": true,
"description": "[Optional/Not supported on all APIs] Total number of items (for all pages)."
},
"nextKey": {
"type": "string",
"nullable": true,
"description": "Key used to fetch next page of data (if any)."
},
"previousKey": {
"type": "string",
"nullable": true,
"description": "Key used to fetch previous page of data (if any)."
}
},
"type": "object",
"title": "PaginationInfo"
}
}
}
}
}
]
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/cbi/v1/access/policy"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"policyId": {
"type": "string",
"description": "Policy's unique ID.",
"nullable": true,
"example": "BE-ViewAllOnly"
},
"policyName": {
"type": "string",
"description": "Policy's name.",
"nullable": true,
"example": "Billing Engine View All Only"
},
"policyDescription": {
"type": "string",
"description": "Policy's description.",
"nullable": true,
"example": "Grants authorization to view all features in Billing Engine. This policy requires and will automatically grant access to all accounts within Billing Engine."
},
"requiresAccessToAllAccounts": {
"type": "boolean",
"description": "True if the policy requires the caller to have access to all accounts.",
"example": true
}
},
"additionalProperties": false,
"description": "The authorization policy response model. [kind/spotinst:cbi:authorization:policy]"
}
},
"kind": {
"example": "spotinst:cbi:authorization:policy"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Invalid request error response. Adjust the request before retrying.",
"content": {
"application/json": {
"schema": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1azure~1compute~1vm~1signal/post/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "List of errors.",
"items": {
"properties": {
"code": {
"type": "string",
"description": "Error code."
},
"message": {
"type": "string",
"description": "Error message."
}
},
"type": "object",
"required": [
"message"
],
"title": "ErrorModel"
}
}
}
}
}
}
]
}
}
}
},
"403": {
"description": "Forbidden error response. Not permitted to call this API.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
},
"500": {
"description": "Internal error response. Please try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
}
}
}
},
"/cbi/v1/access/user/{userId}": {
"get": {
"tags": [
"Organizations"
],
"summary": "Get FinOps Authorization For User",
"description": "Get the user-level FinOps authorization configuration for the specified user.",
"parameters": [
{
"name": "userId",
"in": "path",
"description": "The userId to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "includeChildOrgs",
"in": "query",
"description": "Include the configurations for child organizations.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/cbi/v1/access/user/{userId}"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "User's Spot organization ID.",
"nullable": true,
"example": "11111111111111"
},
"userId": {
"type": "string",
"description": "User's unique ID.",
"nullable": true,
"example": "u-12345678"
},
"costTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Cost type's unique ID.",
"nullable": true,
"example": "Effective"
},
"name": {
"type": "string",
"description": "Cost type's name.",
"nullable": true,
"example": "Effective Cost"
}
},
"additionalProperties": false,
"description": "A FinOps cost type."
},
"description": "Cost types assigned to this user.",
"nullable": true
},
"accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Provider account ID. This is the unique ID from the service provider, such as AWS, Azure.",
"nullable": true,
"example": "aws~11111111111111"
},
"name": {
"type": "string",
"description": "Provider account's Name.",
"nullable": true,
"example": "Test"
}
},
"additionalProperties": false,
"description": "A cloud provider account ID."
},
"description": "Provider account IDs assigned to this user.",
"nullable": true,
"example": [
{
"id": "aws~11111111111111",
"name": "Test"
}
]
},
"policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Policy's unique ID.",
"nullable": true,
"example": "BE-ViewAllOnly"
},
"name": {
"type": "string",
"description": "Policy's name.",
"nullable": true,
"example": "Billing Engine View All Only"
}
},
"additionalProperties": false,
"description": "A FinOps authorization policy."
},
"description": "Authorization policies assigned to this user.",
"nullable": true,
"example": [
{
"id": "BE-ViewAllOnly",
"name": "Billing Engine View All Only"
}
]
}
},
"additionalProperties": false,
"description": "The user's FinOps authorization configuration response model. [kind/spotinst:cbi:authorization:user]"
}
},
"kind": {
"example": "spotinst:cbi:authorization:user"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Invalid request error response. Adjust the request before retrying.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
},
"403": {
"description": "Forbidden error response. Not permitted to call this API.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
},
"404": {
"description": "Not found error response. The requested resource does not exist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
},
"500": {
"description": "Internal error response. Please try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
}
}
},
"post": {
"tags": [
"Organizations"
],
"summary": "Update FinOps Authorization For User",
"description": "Update the FinOps authorization configuration for a user.",
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1user~1%7BuserId%7D/post/requestBody/content/text~1json/schema"
}
},
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1user~1%7BuserId%7D/post/requestBody/content/text~1json/schema"
}
},
"text/json": {
"schema": {
"type": "object",
"properties": {
"authChanges": {
"type": "object",
"properties": {
"resetCostTypes": {
"type": "boolean",
"description": "If true, the existing list of cost types is emptied prior to performing the changes requested."
},
"costTypeChanges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"enum": [
"None",
"Provider",
"List",
"Billed",
"Effective"
],
"type": "string"
},
"action": {
"$ref": "#/paths/~1cbi~1v1~1access~1user~1%7BuserId%7D/post/requestBody/content/text~1json/schema/properties/authChanges/properties/policyChanges/items/properties/action"
}
},
"additionalProperties": false,
"description": "The information for a cost type list modification."
},
"description": "List of cost types to add/remove.\r\nCost type applies to all accounts assigned to the user (regardless of how the user has access to the account).\r\nIf the user already has an existing list of cost types, the requested actions are applied to this existing\r\nlist unless resetCostTypes is true (which will clear all existing cost types first).",
"nullable": true
},
"organizationId": {
"type": "string",
"description": "ID of the target Spot organization where the authorization configuration should be applied.\r\nOptional: Defaults to the caller's current Spot organization.\r\nIf specified, the ID must be one of these:\r\n- The caller's current Spot organization\r\n- A child Spot organization of the caller's current Spot organization",
"nullable": true
},
"resetAccounts": {
"type": "boolean",
"description": "If true, the existing list of accounts is emptied prior to performing the \r\nchanges requested."
},
"accountChanges": {
"type": "array",
"items": {
"$ref": "#/paths/~1cbi~1v1~1access~1user~1%7BuserId%7D/post/requestBody/content/text~1json/schema/properties/authChanges/properties/policyChanges/items"
},
"description": "List of accounts to add/remove.\r\nIf user or group already has an existing list of accounts, the requested actions will be applied to this existing \r\nlist unless resetAccounts is true (which will clear all existing accounts first).",
"nullable": true
},
"resetPolicies": {
"type": "boolean",
"description": "If true, the existing list of policies is emptied prior to performing the changes requested."
},
"policyChanges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The entity's ID.",
"nullable": true
},
"action": {
"enum": [
"Add",
"Remove"
],
"type": "string",
"description": "An action for managing items in a list."
}
},
"additionalProperties": false,
"description": "Represents the basic information for a list modification."
},
"description": "List of policies to add/remove.\r\nIf user or group already has an existing list of policies, the requested actions will be applied to this existing \r\nlist unless resetPolicies is true (which will clear all existing policies first).",
"nullable": true
}
},
"additionalProperties": false,
"description": "The FinOps authorization changes for a user."
}
},
"additionalProperties": false,
"description": "Request to update the FinOps authorization configuration for a specific user."
}
},
"application/*+json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1user~1%7BuserId%7D/post/requestBody/content/text~1json/schema"
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/cbi/v1/access/user/{userId}"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User's unique ID.",
"nullable": true,
"example": "u-12345678"
},
"beforeChanges": {
"$ref": "#/paths/~1cbi~1v1~1access~1user~1%7BuserId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
},
"afterChanges": {
"$ref": "#/paths/~1cbi~1v1~1access~1user~1%7BuserId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"additionalProperties": false,
"description": "The FinOps authorization configuration for a specific user (before and after changes). [kind/spotinst:cbi:authorization:user]"
}
},
"kind": {
"example": "spotinst:cbi:authorization:user"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Invalid request error response. Adjust the request before retrying.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
},
"403": {
"description": "Forbidden error response. Not permitted to call this API.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
},
"404": {
"description": "Not found error response. The requested resource does not exist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
},
"500": {
"description": "Internal error response. Please try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
}
}
}
},
"/cbi/v1/setup/account": {
"post": {
"tags": [
"Accounts"
],
"summary": "Setup Cost Intelligence",
"description": "Sets up and enables Cost Intelligence functionality on a Spot account. The Spot account must already have credentials and be linked to a valid cloud provider account (e.g. AWS account, Azure subscription, etc).",
"operationId": "setupAccountCbiV1SetupAccountPost",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"account": {
"properties": {
"accountId": {
"type": "string",
"description": "Spot account ID"
}
},
"type": "object",
"required": [
"accountId"
],
"title": "Account"
}
},
"type": "object",
"required": [
"account"
],
"title": "CreateCIRegisteredAccountModel"
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/cbi/v1/setup/account"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"properties": {
"organizationId": {
"type": "string",
"description": "Spot Organization ID.",
"example": "60100100100100"
},
"accountId": {
"type": "string",
"description": "Spot Account ID.",
"example": "act-012345"
},
"providerName": {
"$ref": "#/paths/~1cbi~1v1~1setup~1account/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items/properties/providerName",
"description": "Cloud provider of setup account.",
"example": "aws"
},
"externalProviderId": {
"type": "string",
"description": "Cloud provider of setup account.",
"example": "012345678901"
},
"enabledDate": {
"type": "string",
"format": "date-time",
"description": "Date/time when Cost Intelligence was registered on the Spot account."
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "Date/time when the Cost Intelligence registration was updated on the Spot account."
}
},
"type": "object",
"required": [
"organizationId",
"accountId",
"providerName",
"externalProviderId",
"enabledDate",
"updatedDate"
],
"title": "CIRegisteredAccountResponse",
"description": "Represents a Spot account on which Cost Intelligence has been registered / enabled. [kind/spotinst:cbi:inventory:ciRegisteredAccount]"
}
},
"kind": {
"example": "spotinst:cbi:inventory:ciRegisteredAccount"
}
}
}
}
}
]
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Invalid request error response. Adjust the request before retrying."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Not found error response. The requested resource does not exist."
},
"422": {
"description": "Error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
}
}
},
"get": {
"tags": [
"Accounts"
],
"summary": "Get Cost Intelligence Registered Accounts",
"description": "Get list of Spot accounts where Cost Intelligence has been setup.",
"operationId": "getAccountsCbiV1SetupAccountGet",
"parameters": [
{
"name": "paginationSize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"description": "Number of items to include in the response"
},
"description": "Number of items to include in the response"
},
{
"name": "paginationKey",
"in": "query",
"required": false,
"schema": {
"type": "string",
"description": "Key used to fetch a specific page of items"
},
"description": "Key used to fetch a specific page of items"
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/cbi/v1/setup/account"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"properties": {
"organizationId": {
"type": "string",
"description": "Spot Organization ID.",
"example": "60100100100100"
},
"accountId": {
"type": "string",
"description": "Spot Account ID.",
"example": "act-012345"
},
"providerName": {
"description": "Cloud provider of setup account.",
"example": "aws",
"type": "string",
"enum": [
"aws",
"azure",
"gcp"
],
"title": "CloudProvider"
},
"externalProviderId": {
"type": "string",
"description": "Cloud provider of setup account.",
"example": "012345678901"
},
"enabledDate": {
"type": "string",
"format": "date-time",
"description": "Date/time when Cost Intelligence was registered on the Spot account."
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "Date/time when the Cost Intelligence registration was updated on the Spot account."
},
"statusSummary": {
"description": "Account status summary.",
"type": "string",
"enum": [
"connected",
"notConnected",
"partiallyConnected"
],
"title": "AccountStatusSummary"
},
"status": {
"description": "Account status",
"type": "array",
"items": {
"properties": {
"productOffering": {
"description": "Product offering.",
"type": "string",
"enum": [
"common",
"cloudBilling",
"cbi"
],
"title": "ProductOfferingEnum"
},
"statusType": {
"type": "string",
"description": "Status type."
},
"statusCode": {
"type": "string",
"description": "Status code."
},
"statusMessage": {
"description": "Status message.",
"type": "string",
"nullable": true
},
"statistics": {
"description": "Status statistics.",
"nullable": true,
"properties": {
"totalResourceTypeCount": {
"type": "integer",
"description": "Total number of resource types."
},
"failedResourceTypeCount": {
"type": "integer",
"description": "Failed number of resource types."
},
"successfulResourceTypes": {
"description": "Successful resource types.",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"failedResourceTypes": {
"description": "Failed resource types.",
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"type": "object",
"required": [
"totalResourceTypeCount",
"failedResourceTypeCount"
],
"title": "AccountStatusStatistic"
},
"statusTimestamp": {
"type": "string",
"format": "date-time",
"description": "Status timestamp."
}
},
"type": "object",
"required": [
"productOffering",
"statusType",
"statusCode",
"statusTimestamp"
],
"title": "AccountStatusItem"
},
"nullable": true
}
},
"type": "object",
"required": [
"organizationId",
"accountId",
"providerName",
"externalProviderId",
"enabledDate",
"updatedDate",
"statusSummary"
],
"title": "CIRegisteredAccountWithStatusResponse"
}
},
"kind": {
"example": "string"
}
}
}
}
}
]
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Invalid request error response. Adjust the request before retrying."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Not found error response. The requested resource does not exist."
},
"422": {
"description": "Error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
}
}
}
},
"/cbi/v1/setup/account/validation": {
"post": {
"tags": [
"Accounts"
],
"summary": "Perform Cost Intelligence Setup Validations",
"description": "Validate that Cost Intelligence can be setup on the specified Spot Account.",
"operationId": "validateSetupAccountCbiV1SetupAccountValidationPost",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1setup~1account/post/requestBody/content/application~1json/schema"
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/cbi/v1/setup/account/validation"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the validation step that was performed."
},
"description": {
"description": "Summary of the validation step (i.e. what validation check was performed).",
"type": "string",
"nullable": true
},
"status": {
"description": "Overall status of the validation step.",
"type": "string",
"enum": [
"success",
"failed",
"warning",
"skipped"
],
"title": "ValidationStatus"
},
"validationInfo": {
"description": "Additional information about the reason the validation step failed.",
"type": "string",
"nullable": true
},
"validationInfoDetails": {
"description": "Validation info details",
"type": "object",
"nullable": true
}
},
"type": "object",
"required": [
"id",
"status"
],
"title": "ValidationModelResponse",
"description": "[kind/spotinst:cbi:accountRegistrationValidation]"
}
},
"kind": {
"example": "spotinst:cbi:accountRegistrationValidation"
}
}
}
}
}
]
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Invalid request error response. Adjust the request before retrying."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Not found error response. The requested resource does not exist."
},
"422": {
"description": "Error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
}
}
}
},
"/cloudBilling/v1/setup/account": {
"get": {
"tags": [
"Accounts"
],
"summary": "Get Billing Engine Registered Accounts",
"description": "Get list of Spot accounts where Billing Engine has been setup.",
"operationId": "listAccountsCloudBillingV1SetupAccountGet",
"parameters": [
{
"name": "paginationSize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"description": "Number of items to include in the response"
},
"description": "Number of items to include in the response"
},
{
"name": "paginationKey",
"in": "query",
"required": false,
"schema": {
"type": "string",
"description": "Key used to fetch a specific page of items"
},
"description": "Key used to fetch a specific page of items"
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/cloudBilling/v1/setup/account"
},
"method": {
"example": "GET"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"properties": {
"accountId": {
"type": "string",
"description": "Spot Account ID.",
"example": "act-23432"
},
"organizationId": {
"description": "Spot Organization ID.",
"example": "634563908342",
"type": "string",
"nullable": true
},
"cloudProvider": {
"type": "string",
"description": "Cloud provider.",
"example": "aws"
},
"externalProviderId": {
"type": "string",
"description": "Cloud provider account ID.",
"example": "435345634"
},
"externalProviderName": {
"description": "Cloud provider account name.",
"example": "Provider account name 1",
"type": "string",
"nullable": true
},
"enabledDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the Spot account was onboarded to Billing Engine.",
"example": "2019-08-24T14:15:22Z"
},
"updatedDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp when Billing Engine config was last modified.",
"example": "2019-08-24T14:15:22Z"
},
"statusSummary": {
"$ref": "#/paths/~1cbi~1v1~1setup~1account/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items/properties/statusSummary",
"description": "Billing Engine account connection status."
},
"status": {
"description": "Billing Engine account status info.",
"type": "array",
"items": {
"$ref": "#/paths/~1cbi~1v1~1setup~1account/get/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items/properties/status/items"
},
"nullable": true
}
},
"type": "object",
"required": [
"accountId",
"organizationId",
"cloudProvider",
"externalProviderId",
"externalProviderName",
"enabledDate",
"updatedDate",
"statusSummary"
],
"title": "SetupBERegisteredAccountWithStatusResponse",
"description": "Represents a Spot account on which Billing Engine has been registered / enabled. [kind/spotinst:cloudBilling:beRegisteredAccount]"
}
},
"kind": {
"example": "spotinst:cloudBilling:beRegisteredAccount"
}
}
}
}
}
]
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Invalid request error response. Adjust the request before retrying."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Not found error response. The requested resource does not exist."
},
"422": {
"description": "Error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
}
}
},
"post": {
"tags": [
"Accounts"
],
"summary": "Setup Billing Engine",
"description": "Sets up and enables Billing Engine functionality on a Spot account. The Spot account must already have credentials and be linked to a valid cloud provider account (e.g. AWS account, Azure billing account, etc).",
"operationId": "setupAccountCloudBillingV1SetupAccountPost",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"accountId": {
"type": "string",
"description": "Spot Account ID.",
"example": "act-23432"
},
"config": {
"anyOf": [
{
"type": "object"
},
{
"properties": {
"billingSource": {
"description": "Configuration settings used to collect AWS billing data.",
"properties": {
"bucket": {
"type": "string",
"description": "The name of the AWS S3 bucket where the AWS CUR is stored."
},
"region": {
"type": "string",
"description": "The AWS buckets AWS region (e.g. us-east-1)."
},
"pathPrefix": {
"type": "string",
"description": "The prefix path and report name generated for the AWS CUR you configured."
}
},
"type": "object",
"required": [
"bucket",
"region",
"pathPrefix"
],
"title": "BERegisteredSetupAccountAwsConfigBillingSource"
}
},
"type": "object",
"required": [
"billingSource"
],
"title": "BERegisteredSetupAccountAwsConfig",
"description": "Configuration settings used to collect AWS billing data. The target Spot account must be linked to an AWS account with billing data (e.g. master payer account)."
},
{
"properties": {},
"type": "object",
"title": "BERegisteredSetupAccountAzureConfig",
"description": "Configuration settings used to collect Azure billing data. The target Spot account must be linked to an Azure billing account."
},
{
"properties": {
"googleBillingConfiguration": {
"description": "Configuration settings used to collect Google billing data.",
"properties": {
"tableId": {
"type": "string",
"description": "The BigQuery table ID that is used to export the billing data."
},
"datasetId": {
"type": "string",
"description": "The BigQuery dataset ID that is used to export the billing data."
},
"projectId": {
"type": "string",
"description": "The Google project ID that is used to export the billing data."
}
},
"type": "object",
"required": [
"tableId",
"datasetId",
"projectId"
],
"title": "BERegisteredSetupAccountGcpBillingConfig"
}
},
"type": "object",
"required": [
"googleBillingConfiguration"
],
"title": "BERegisteredSetupAccountGcpConfig",
"description": "Configuration settings used to collect Google billing data. The target Spot account must be linked to a Google project where the billing data is exported."
}
],
"description": "Configuration for the Billing Engine (e.g. location of the billing data)",
"nullable": true
}
},
"type": "object",
"required": [
"accountId"
],
"title": "BERegisteredSetupAccountUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/cloudBilling/v1/setup/account"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"properties": {
"accountId": {
"type": "string",
"description": "Spot Account ID.",
"example": "act-23432"
},
"organizationId": {
"description": "Spot Organization ID",
"example": "634563908342",
"type": "string",
"nullable": true
},
"cloudProvider": {
"type": "string",
"description": "Cloud provider",
"example": "aws"
},
"externalProviderId": {
"type": "string",
"description": "Cloud provider account ID",
"example": "435345634"
},
"isBillingAccount": {
"type": "boolean",
"description": "True if Spot account is a billing account."
},
"enabledDate": {
"type": "string",
"description": "Timestamp when the Spot account was onboarded to Billing Engine.",
"example": "2019-08-24T14:15:22Z"
},
"updatedDate": {
"type": "string",
"description": "Timestamp when Billing Engine config was last modified.",
"example": "2019-08-24T14:15:22Z"
},
"config": {
"description": "Provider-specific configuration.",
"type": "object",
"nullable": true
}
},
"type": "object",
"required": [
"accountId",
"organizationId",
"cloudProvider",
"externalProviderId",
"isBillingAccount",
"enabledDate",
"updatedDate"
],
"title": "SetupCreateBERegisteredAccountResponse",
"description": "Represents a Spot account on which Billing Engine has been registered / enabled. [kind/spotinst:cloudBilling:beRegisteredAccount]"
}
},
"kind": {
"example": "spotinst:cloudBilling:beRegisteredAccount"
}
}
}
}
}
]
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Invalid request error response. Adjust the request before retrying."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Not found error response. The requested resource does not exist."
},
"422": {
"description": "Error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
}
}
}
},
"/cloudBilling/v1/setup/account/validation": {
"post": {
"tags": [
"Accounts"
],
"summary": "Perform Billing Engine Setup Validations",
"description": "Validate that Billing Engine can be setup on the specified Spot Account.",
"operationId": "validateSetupAccountCloudBillingV1SetupAccountValidationPost",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cloudBilling~1v1~1setup~1account/post/requestBody/content/application~1json/schema"
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1healthCheck/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"url": {
"example": "/cloudBilling/v1/setup/account/validation"
},
"method": {
"example": "POST"
}
}
},
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1cbi~1v1~1setup~1account~1validation/post/responses/200/content/application~1json/schema/allOf/1/properties/response/properties/items/items"
}
},
"kind": {
"example": "spotinst:cbi:accountRegistrationValidation"
}
}
}
}
}
]
}
}
}
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Invalid request error response. Adjust the request before retrying."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
},
"description": "Not found error response. The requested resource does not exist."
},
"422": {
"description": "Error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1cbi~1v1~1access~1policy/get/responses/400/content/application~1json/schema"
}
}
}
}
}
}
},
"/ccoUsageExporter/flexeraIntegration": {
"get": {
"summary": "Get CCO Integration",
"description": "Get details for the selected Flexera CCO integration\n",
"operationId": "getFlexeraCcoIntegration",
"tags": [
"Flexera CCO Integration"
],
"security": [
{
"authWithoutAccount": []
}
],
"responses": {
"200": {
"description": "Get Flexera CCO Integration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"request": {
"type": "object",
"description": "Original request properties\n",
"properties": {
"id": {
"type": "string",
"example": "46642c7d-bc29-417d-8ce4-79626f00c63c",
"description": "Unique ID associated with this request\n"
},
"url": {
"type": "string",
"example": "/ccoUsageExporter/flexeraIntegration",
"description": "The URL that was used for the request\n"
},
"method": {
"type": "string",
"description": "The HTTP **METHOD** used for the request\n"
},
"timestamp": {
"type": "string",
"example": "2018-11-19T13:49:11.911Z",
"description": "When the request was received by Spot\n"
}
}
},
"response": {
"type": "object",
"description": "Response package that includes the status, type, and any relevant data\n",
"properties": {
"status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200,
"description": "HTTP status code associated with this response\n"
},
"message": {
"type": "string",
"example": "OK",
"description": "HTTP status message associated with the status code\n"
}
}
},
"kind": {
"type": "string",
"example": "mcs:ocean:ccoUsageExporter:flexeraIntegration",
"description": "Specifies the data type for each object returned in the response\n"
}
}
}
}
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"method": {
"example": "GET"
}
}
}
}
},
{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "Array of data objects\n",
"items": {
"type": "object",
"properties": {
"spotOrganizationId": {
"type": "integer",
"description": "Spot Organization ID\n",
"example": 172012381312
},
"flexeraOrganizationId": {
"type": "integer",
"description": "Flexera Organization ID\n",
"example": 9921
},
"flexeraBillConnectId": {
"type": "string",
"description": "Flexera Bill Connect ID\n",
"example": "cbi-oi-ocean-bill-connect"
}
}
}
},
"count": {
"type": "integer",
"example": 1,
"description": "Size of the data object array\n"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"post": {
"summary": "Create CCO Integration",
"description": "Create Flexera CCO integration\n",
"operationId": "createFlexeraCcoIntegration",
"tags": [
"Flexera CCO Integration"
],
"security": [
{
"authWithoutAccount": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1ccoUsageExporter~1flexeraIntegration/put/requestBody/content/application~1json/schema/allOf/0"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Create Flexera CCO Integration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1ccoUsageExporter~1flexeraIntegration/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"method": {
"example": "POST"
}
}
}
}
},
{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "Array of data objects\n",
"items": {
"$ref": "#/paths/~1ccoUsageExporter~1flexeraIntegration/get/responses/200/content/application~1json/schema/allOf/2/properties/response/properties/items/items"
}
},
"count": {
"type": "integer",
"example": 1,
"description": "Size of the data object array\n"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"put": {
"summary": "Update CCO Integration",
"description": "Update Flexera CCO integration.\n\nFlexera CCO integration API supports partial updates, allowing specific fields to be updated without sending the entire resource.\n",
"operationId": "updateFlexeraCcoIntegration",
"tags": [
"Flexera CCO Integration"
],
"security": [
{
"authWithoutAccount": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"flexeraOrganizationId": {
"type": "integer",
"description": "Flexera Organization ID\n",
"example": 9921
},
"flexeraRefreshToken": {
"type": "string",
"description": "Flexera Refresh Token\n",
"example": "token"
},
"flexeraBillConnectId": {
"type": "string",
"description": "Flexera Bill Connect ID\n",
"example": "cbi-oi-ocean-container-cost"
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "Update Flexera CCO Integration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1ccoUsageExporter~1flexeraIntegration/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"method": {
"example": "PUT"
}
}
}
}
},
{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "Array of data objects\n",
"items": {
"$ref": "#/paths/~1ccoUsageExporter~1flexeraIntegration/get/responses/200/content/application~1json/schema/allOf/2/properties/response/properties/items/items"
}
},
"count": {
"type": "integer",
"example": 1,
"description": "Size of the data object array\n"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
},
"delete": {
"summary": "Delete CCO Integration",
"description": "Delete Flexera CCO integration\n",
"operationId": "deleteFlexeraCcoIntegration",
"tags": [
"Flexera CCO Integration"
],
"security": [
{
"authWithoutAccount": []
}
],
"responses": {
"200": {
"description": "Delete Flexera CCO Integration Response",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/paths/~1ccoUsageExporter~1flexeraIntegration/get/responses/200/content/application~1json/schema/allOf/0"
},
{
"type": "object",
"properties": {
"request": {
"type": "object",
"properties": {
"method": {
"example": "DELETE"
}
}
}
}
},
{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"removed": {
"type": "boolean",
"example": true,
"description": "Response is `true` if the Flexera CCO integration was successfully deleted\n"
}
}
}
}
}
]
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
}
}
}