{"components":{"schemas":{"Anonymous05e51a84":{"description":"Defines the initial OS login credentials. If specified, both username and password must be provided.","nullable":true,"properties":{"password":{"$ref":"#/components/schemas/Anonymous7d0f7a1e"},"sshAuthorizedKeys":{"description":"List of SSH public keys to authorize for this user account","items":{"type":"string"},"type":"array"},"username":{"description":"Operating system username for the initial user account. Must follow Linux username requirements.","type":"string"}},"required":["username","password"],"type":"object"},"Anonymous0e3cbd18":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","type":"string"},"items":{"$ref":"#/components/schemas/Anonymousd9e93299"},"kind":{"description":"The string value 'InstanceList' that identifies the schema","enum":["InstanceList"],"example":"InstanceList","type":"string"},"metadata":{"$ref":"#/components/schemas/Anonymousa84d7754"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"Anonymous119c7e70":{"description":"List of conditions representing the current state of various instance subsystems","properties":{"lastProbeTime":{"$ref":"#/components/schemas/v1Time"},"lastTransitionTime":{"$ref":"#/components/schemas/v1Time"},"message":{"type":"string"},"reason":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"}},"required":["type","status"],"type":"object"},"Anonymous14b4d106":{"description":"Current observed state and conditions of the image","properties":{"creationFailed":{"description":"Indicates if the image creation has failed.","type":"boolean"},"size":{"description":"The size of the image in bytes.","format":"int64","type":"integer"}},"type":"object"},"Anonymous3fd4cf92":{"description":"Reference to a placement group that influences instance scheduling for anti-affinity.","nullable":true,"properties":{"name":{"type":"string"}},"type":"object"},"Anonymous5cc7c86e":{"description":"List of network interfaces to attach to the instance. Each interface defines network connectivity.","properties":{"link":{"description":"Name of the Link resource that defines the network this interface connects to","type":"string"},"name":{"description":"Unique identifier for this network interface within the instance","type":"string"}},"required":["name","link"],"type":"object"},"Anonymous65ea3717":{"description":"Contains the current runtime configuration settings for the instance, including CPU, memory and other resources","nullable":true,"properties":{"cpu":{"$ref":"#/components/schemas/resourceQuantity"},"memory":{"$ref":"#/components/schemas/resourceQuantity"}},"required":["cpu","memory"],"type":"object"},"Anonymous6a739324":{"description":"Collection of Image resources","properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["compute/v2"],"example":"compute/v2","type":"string"},"kind":{"description":"The string value 'Image' that identifies the schema","enum":["Image"],"example":"Image","type":"string"},"metadata":{"$ref":"#/components/schemas/Anonymousaa7ac512"},"spec":{"$ref":"#/components/schemas/Anonymousc7d6e5c2"},"status":{"$ref":"#/components/schemas/Anonymous14b4d106"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"Anonymous6efd6cb9":{"description":"References to other resources that own or manage the resource","properties":{"apiVersion":{"type":"string"},"blockOwnerDeletion":{"nullable":true,"type":"boolean"},"controller":{"nullable":true,"type":"boolean"},"kind":{"type":"string"},"name":{"type":"string"},"uid":{"type":"string"}},"required":["apiVersion","kind","name","uid"],"type":"object"},"Anonymous7d0f7a1e":{"description":"Password configuration for the user account, specified either through a secret or file source","properties":{"fromSecret":{"$ref":"#/components/schemas/Anonymouse785c8dc"}},"type":"object"},"Anonymous87bd8cdd":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","type":"string"},"items":{"$ref":"#/components/schemas/Anonymous6a739324"},"kind":{"description":"The string value 'ImageList' that identifies the schema","enum":["ImageList"],"example":"ImageList","type":"string"},"metadata":{"$ref":"#/components/schemas/Anonymousa84d7754"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"Anonymousa57259ba":{"description":"Reference to a PersistentVolumeClaim to use as a volume source. Cannot be used together with localDisk.","nullable":true,"properties":{"claimName":{"type":"string"},"readOnly":{"type":"boolean"}},"required":["claimName"],"type":"object"},"Anonymousa84d7754":{"description":"Standard metadata fields for the list","properties":{"continue":{"type":"string"},"remainingItemCount":{"format":"int64","nullable":true,"type":"integer"},"resourceVersion":{"type":"string"},"selfLink":{"type":"string"}},"type":"object"},"Anonymousaa160065":{"description":"Specifies the base operating system image used to boot the instance. Must specify either an image or customImage, but not both.","properties":{"customImage":{"description":"Name of the custom image to boot the instance from. Must be a valid custom image name. Cannot be modified after instance creation. Cannot be used together with image.","type":"string"},"image":{"description":"Name of the base operating system image to boot the instance from. Must be a valid image name. Cannot be modified after instance creation. Cannot be used together with customImage.","example":"ubuntu-22.04","type":"string"}},"type":"object"},"Anonymousaa7ac512":{"description":"Standard resource metadata fields","properties":{"annotations":{"additionalProperties":{"type":"string"},"description":"Annotations are key-value pairs storing additional metadata about resources","type":"object"},"creationTimestamp":{"$ref":"#/components/schemas/v1Time"},"deletionTimestamp":{"$ref":"#/components/schemas/v1Time"},"labels":{"additionalProperties":{"type":"string"},"description":"Labels are key-value pairs attached to resources for organization and categorization","type":"object"},"name":{"description":"User-provided name that uniquely identifies the resource within its workspace and type","type":"string"},"ownerReferences":{"$ref":"#/components/schemas/Anonymous6efd6cb9"},"resourceVersion":{"description":"An opaque value representing the internal version of this object that can be used for optimistic concurrency and change detection","example":"519597875","type":"string"},"uid":{"description":"System-generated unique identifier for the resource","example":"00000000-0000-0000-0000-000000000000","type":"string"},"workspace":{"description":"Unique identifier of the workspace where the resource belongs","example":"00000000-0000-0000-0000-000000000000","type":"string"}},"required":["workspace","labels","deletionTimestamp","creationTimestamp","uid","name","annotations","ownerReferences"],"type":"object"},"Anonymousac21b6e1":{"properties":{"detail":{"type":"string"}},"required":["detail"],"type":"object"},"Anonymousb84b264f":{"description":"Contains details about all storage volumes currently attached to this instance","properties":{"Size":{"$ref":"#/components/schemas/resourceQuantity"},"name":{"description":"Name of the attached volume, corresponding to the PersistentVolume name for persistent volumes or the local disk name for local disks","type":"string"},"volumeID":{"description":"Unique identifier of the volume resource, used for mapping volumes to block devices","type":"string"},"volumeType":{"description":"Type of the attached volume - either 'persistentvolume' or 'localdisk'","type":"string"}},"required":["volumeType"],"type":"object"},"Anonymousc7d6e5c2":{"description":"Desired configuration and characteristics for the image","properties":{"description":{"description":"A brief description of the image.","type":"string"},"distributionName":{"description":"The distribution name of the operating system.","example":"ubuntu","type":"string"},"osType":{"description":"The operating system of the image.","enum":["linux","windows"],"example":"linux","type":"string"},"osVersion":{"description":"The version of the operating system.","example":"22.04","type":"string"},"public":{"description":"Indicates whether the image is public.","type":"boolean"}},"required":["public"],"type":"object"},"Anonymousc90cbf69":{"description":"Defines the storage volume containing the operating system. Must specify either persistentVolumeClaim or localDisk (localDisk settings are ignored).","properties":{"localDisk":{"$ref":"#/components/schemas/Anonymousf86d64f7"},"persistentVolumeClaim":{"$ref":"#/components/schemas/Anonymousa57259ba"}},"type":"object"},"Anonymousd0ba8611":{"description":"Current observed state and conditions of the instance","properties":{"attachedVolumes":{"$ref":"#/components/schemas/Anonymousb84b264f"},"conditions":{"$ref":"#/components/schemas/Anonymous119c7e70"},"ready":{"description":"Indicates whether the instance is fully configured and operational","type":"boolean"},"resizing":{"description":"Indicates whether the instance is currently being resized to a different instance type","type":"boolean"},"restartRequired":{"description":"Indicates whether the instance requires a restart to apply pending changes","type":"boolean"},"restarting":{"description":"Indicates whether the instance is currently in the process of restarting","type":"boolean"},"running":{"description":"Indicates whether the instance's operating system is currently running","type":"boolean"},"runtimeConfiguration":{"$ref":"#/components/schemas/Anonymous65ea3717"},"type":{"description":"The current instance type that defines the cpu, memory and storage capacity","type":"string"}},"required":["ready","running"],"type":"object"},"Anonymousd9e93299":{"description":"Collection of Instance resources","properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["compute/v2"],"example":"compute/v2","type":"string"},"kind":{"description":"The string value 'Instance' that identifies the schema","enum":["Instance"],"example":"Instance","type":"string"},"metadata":{"$ref":"#/components/schemas/Anonymousaa7ac512"},"spec":{"$ref":"#/components/schemas/Anonymousf98c6805"},"status":{"$ref":"#/components/schemas/Anonymousd0ba8611"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"Anonymouse785c8dc":{"description":"Reference to a secret containing the password value. The secret must exist in the same namespace as the instance.","properties":{"key":{"description":"Key within the secret containing the desired value. If not specified, defaults to the instance name","type":"string"},"name":{"description":"Name of the secret in the instance's namespace. If not specified, defaults to \u003cInstance.Name\u003e-login. Must be 1-220 characters long and contain only lowercase alphanumeric characters, - and .","type":"string"},"optional":{"description":"When true, the referenced secret and key are optional and will be filled automatically. When false or unset, they must exist","nullable":true,"type":"boolean"}},"type":"object"},"Anonymousf86d64f7":{"description":"Specification for a local disk volume to create and attach to the instance. Cannot be used together with persistentVolumeClaim.","nullable":true,"properties":{"name":{"description":"Name of the local disk. This field is automatically populated based on the instance type configuration and should not be set by users.","type":"string"},"size":{"$ref":"#/components/schemas/resourceQuantity"}},"required":["name","size"],"type":"object"},"Anonymousf98c6805":{"description":"Desired configuration and characteristics for the instance","properties":{"iamEnabled":{"description":"When enabled, SSH access to this instance will be authenticated through Sotoon IAM.","type":"boolean"},"imageSource":{"$ref":"#/components/schemas/Anonymousaa160065"},"initialUser":{"$ref":"#/components/schemas/Anonymous05e51a84"},"interfaces":{"$ref":"#/components/schemas/Anonymous5cc7c86e"},"osVolume":{"$ref":"#/components/schemas/Anonymousc90cbf69"},"placementGroupRef":{"$ref":"#/components/schemas/Anonymous3fd4cf92"},"poweredOn":{"description":"Controls the power state of the instance. True means the instance is powered on, false means powered off.","type":"boolean"},"restartedAt":{"$ref":"#/components/schemas/v1Time"},"type":{"description":"Specifies the instance type that determines CPU, memory and other resource allocations. Must match an existing Instance Type name. Can be modified to resize the instance.","example":"g1d60-1","type":"string"},"userData":{"description":"Cloud-init configuration data provided in base64 encoded format. Used to customize instance on first boot.","type":"string"},"volumes":{"$ref":"#/components/schemas/Anonymousc90cbf69"}},"required":["imageSource","type","poweredOn"],"type":"object"},"Time":{"format":"date-time","type":"string"},"containerClusterInfrastructureSpec":{"description":"Infrastructure configuration for the cluster","properties":{"VPC":{"description":"Virtual Private Cloud Network that the cluster is created in","example":"default","type":"string"},"subnet":{"description":"Engine sub-network that the cluster is created in","example":"default","type":"string"},"version":{"$ref":"#/components/schemas/containerSKEVersion"}},"required":["VPC","subnet","version"],"type":"object"},"containerClusterNetwork":{"description":"Network configuration for the cluster","nullable":true,"properties":{"pods":{"$ref":"#/components/schemas/containerNetworkRanges"},"services":{"$ref":"#/components/schemas/containerNetworkRanges"}},"type":"object"},"containerLocalObjectRef":{"description":"Reference to the kubeconfig secret","nullable":true,"properties":{"name":{"description":"Name of the referenced object","example":"my-cluster-kubeconfig","type":"string"}},"required":["name"],"type":"object"},"containerNetworkRanges":{"description":"Network ranges from which Pod networks are allocated","nullable":true,"properties":{"cidrBlocks":{"description":"List of CIDR blocks","example":"10.96.0.0/12","items":{"type":"string"},"type":"array"}},"required":["cidrBlocks"],"type":"object"},"containerNodeCRIConfig":{"description":"Container runtime configuration","nullable":true,"properties":{"runtime":{"description":"Container runtime to use","enum":["containerd","docker"],"example":"containerd","type":"string"}},"required":["runtime"],"type":"object"},"containerNodepoolPatchRequest":{"properties":{"spec":{"$ref":"#/components/schemas/containerNodepoolPatchSpec"}},"required":["spec"],"type":"object"},"containerNodepoolPatchSpec":{"description":"Specification for nodepool updates","properties":{"replicas":{"description":"Number of worker nodes desired (0 or greater)","example":"5","format":"int32","nullable":true,"type":"integer"}},"type":"object"},"containerObjectMeta":{"description":"Standard resource metadata fields","properties":{"annotations":{"additionalProperties":{"type":"string"},"description":"Annotations store additional metadata about the resource","type":"object"},"creationTimestamp":{"$ref":"#/components/schemas/v1Time"},"deletionTimestamp":{"$ref":"#/components/schemas/v1Time"},"labels":{"additionalProperties":{"type":"string"},"description":"Labels are key-value pairs attached to resources for organization and categorization","type":"object"},"name":{"description":"User-provided name that uniquely identifies the resource within its workspace","type":"string"},"resourceVersion":{"description":"Internal version for optimistic concurrency control","example":"12345","type":"string"},"uid":{"description":"System-generated unique identifier for the resource","example":"550e8400-e29b-41d4-a716-446655440000","type":"string"},"workspace":{"description":"Unique identifier of the workspace where the resource belongs","example":"550e8400-e29b-41d4-a716-446655440000","type":"string"}},"required":["workspace","labels","deletionTimestamp","creationTimestamp","uid","name","annotations"],"type":"object"},"containerSKEVersion":{"description":"Control-plane version configuration","properties":{"kubernetesVersion":{"description":"Kubernetes version","example":"v1.28.4","type":"string"},"patchVersion":{"description":"SKE patch version","example":"ske-1.0.2","type":"string"}},"required":["kubernetesVersion","patchVersion"],"type":"object"},"containerSotoonCluster":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["ske.sotoon.ir/v1alpha1"],"example":"ske.sotoon.ir/v1alpha1","type":"string"},"kind":{"description":"The string value 'SotoonCluster' that identifies the schema","enum":["SotoonCluster"],"example":"SotoonCluster","type":"string"},"metadata":{"$ref":"#/components/schemas/containerObjectMeta"},"spec":{"$ref":"#/components/schemas/containerSotoonClusterSpec"},"status":{"$ref":"#/components/schemas/containerSotoonClusterStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"containerSotoonClusterList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","type":"string"},"items":{"description":"Collection of SotoonCluster resources","items":{"$ref":"#/components/schemas/containerSotoonCluster"},"type":"array"},"kind":{"description":"The string value 'SotoonClusterList'","enum":["SotoonClusterList"],"example":"SotoonClusterList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"containerSotoonClusterSpec":{"description":"Desired configuration for the Kubernetes cluster","properties":{"clusterNetwork":{"$ref":"#/components/schemas/containerClusterNetwork"},"infra":{"$ref":"#/components/schemas/containerClusterInfrastructureSpec"}},"required":["infra"],"type":"object"},"containerSotoonClusterStatus":{"description":"Current observed state of the cluster","properties":{"conditions":{"description":"Current conditions of the cluster","items":{"$ref":"#/components/schemas/v1Condition"},"type":"array"},"kubeconfigSecretName":{"$ref":"#/components/schemas/containerLocalObjectRef"},"phase":{"description":"Current phase of the cluster","enum":["Provisioned","Provisioning","Initialized","Ready","Failed","Upgrading","Deleting","HighlyAvailable","Unknown"],"example":"Ready","type":"string"},"ready":{"description":"Indicates if the cluster is ready for use","type":"boolean"},"readyReplicas":{"description":"Number of ready replicas","example":"1","format":"int32","type":"integer"},"replicas":{"description":"Total number of replicas","example":"1","format":"int32","type":"integer"},"unavailableReplicas":{"description":"Number of unavailable replicas","example":"0","format":"int32","type":"integer"},"updatedReplicas":{"description":"Number of updated replicas","example":"1","format":"int32","type":"integer"}},"required":["ready","phase","unavailableReplicas","readyReplicas","updatedReplicas","replicas"],"type":"object"},"containerSotoonMachineTemplate":{"description":"Template configuration for worker nodes","properties":{"iamEnabled":{"description":"Enable IAM integration for nodes","type":"boolean"},"instanceType":{"description":"Instance type for worker nodes in Engine","example":"g1d-2","type":"string"}},"required":["instanceType","iamEnabled"],"type":"object"},"containerSotoonNodepool":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["ske.sotoon.ir/v1alpha1"],"example":"ske.sotoon.ir/v1alpha1","type":"string"},"kind":{"description":"The string value 'SotoonNodepool' that identifies the schema","enum":["SotoonNodepool"],"example":"SotoonNodepool","type":"string"},"metadata":{"$ref":"#/components/schemas/containerObjectMeta"},"spec":{"$ref":"#/components/schemas/containerSotoonNodepoolSpec"},"status":{"$ref":"#/components/schemas/containerSotoonNodepoolStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"containerSotoonNodepoolList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","type":"string"},"items":{"description":"Collection of SotoonNodepool resources","items":{"$ref":"#/components/schemas/containerSotoonNodepool"},"type":"array"},"kind":{"description":"The string value 'SotoonNodepoolList'","enum":["SotoonNodepoolList"],"example":"SotoonNodepoolList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"containerSotoonNodepoolSpec":{"description":"Desired configuration for the nodepool","properties":{"allowedUnsafeSysctls":{"description":"List of allowed unsafe sysctls","items":{"type":"string"},"type":"array"},"clusterName":{"description":"Name of the cluster this nodepool belongs to","example":"my-cluster","type":"string"},"cri":{"$ref":"#/components/schemas/containerNodeCRIConfig"},"labels":{"additionalProperties":{"type":"string"},"description":"Labels to apply to worker nodes","type":"object"},"replicas":{"description":"Number of worker nodes desired in the nodepool","example":"3","format":"int32","type":"integer"},"template":{"$ref":"#/components/schemas/containerSotoonMachineTemplate"},"version":{"$ref":"#/components/schemas/containerSKEVersion"}},"required":["clusterName","replicas","version","template"],"type":"object"},"containerSotoonNodepoolStatus":{"description":"Current observed state of the nodepool","properties":{"availableReplicas":{"description":"Number of replicas available for scheduling","example":"3","format":"int32","type":"integer"},"conditions":{"description":"Current conditions of the nodepool","items":{"$ref":"#/components/schemas/v1Condition"},"type":"array"},"phase":{"description":"Current phase of scaling operation","enum":["ScalingUp","ScalingDown","Running","Failed","Provisioning","Unknown"],"example":"Running","type":"string"},"ready":{"description":"Indicates if the nodepool is ready","type":"boolean"},"readyReplicas":{"description":"Number of replicas that are ready to serve traffic","example":"3","format":"int32","type":"integer"},"replicas":{"description":"Current total number of replicas","example":"3","format":"int32","type":"integer"},"unavailableReplicas":{"description":"Number of replicas currently unavailable","example":"0","format":"int32","type":"integer"},"updatedReplicas":{"description":"Number of replicas updated to the latest spec","example":"3","format":"int32","type":"integer"}},"required":["ready","phase","replicas","readyReplicas","availableReplicas","unavailableReplicas","updatedReplicas"],"type":"object"},"containerStatus":{"properties":{"apiVersion":{"description":"Version of the Status kind","enum":["ske.sotoon.ir/v1alpha1"],"example":"ske.sotoon.ir/v1alpha1","type":"string"},"code":{"description":"HTTP status code corresponding to this status","example":"400","format":"int32","type":"integer"},"kind":{"description":"Value is always 'Status'","enum":["Status"],"example":"Status","type":"string"},"message":{"description":"Human-readable description of the status","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"},"reason":{"description":"Machine-readable description of the cause","type":"string"},"status":{"description":"Status of the operation","enum":["Success","Failure"],"example":"Success","type":"string"}},"required":["kind","apiVersion","status","code"],"type":"object"},"engineExternalIP":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["compute/v2"],"example":"compute/v2","type":"string"},"kind":{"description":"The string value 'ExternalIP' that identifies the schema","enum":["ExternalIP"],"example":"ExternalIP","type":"string"},"metadata":{"$ref":"#/components/schemas/engineObjectMeta"},"spec":{"$ref":"#/components/schemas/v1alpha2ExternalIPSpec"},"status":{"$ref":"#/components/schemas/v1alpha2ExternalIPStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"engineExternalIPList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["compute/v2"],"example":"compute/v2","type":"string"},"items":{"description":"Collection of ExternalIP resources","items":{"$ref":"#/components/schemas/engineExternalIP"},"type":"array"},"kind":{"description":"The string value 'ExternalIPList' that identifies the schema","enum":["ExternalIPList"],"example":"ExternalIPList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"engineInstanceType":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["compute/v2"],"example":"compute/v2","type":"string"},"kind":{"description":"The string value 'InstanceType' that identifies the schema","enum":["InstanceType"],"example":"InstanceType","type":"string"},"metadata":{"$ref":"#/components/schemas/engineObjectMeta"},"spec":{"$ref":"#/components/schemas/v1alpha2InstanceTypeSpec"},"status":{"$ref":"#/components/schemas/v1alpha2InstanceTypeStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"engineInstanceTypeList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","type":"string"},"items":{"description":"Collection of InstanceType resources","items":{"$ref":"#/components/schemas/engineInstanceType"},"type":"array"},"kind":{"description":"The string value 'InstanceTypeList' that identifies the schema","enum":["InstanceTypeList"],"example":"InstanceTypeList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"engineLink":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["compute/v2"],"example":"compute/v2","type":"string"},"kind":{"description":"The string value 'Link' that identifies the schema","enum":["Link"],"example":"Link","type":"string"},"metadata":{"$ref":"#/components/schemas/engineObjectMeta"},"spec":{"$ref":"#/components/schemas/v1alpha2LinkSpec"},"status":{"$ref":"#/components/schemas/v1alpha2LinkStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"engineLinkList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","type":"string"},"items":{"description":"Collection of Link resources","items":{"$ref":"#/components/schemas/engineLink"},"type":"array"},"kind":{"description":"The string value 'LinkList' that identifies the schema","enum":["LinkList"],"example":"LinkList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"engineObjectMeta":{"description":"Standard resource metadata fields","properties":{"annotations":{"additionalProperties":{"type":"string"},"description":"Annotations are key-value pairs storing additional metadata about resources","type":"object"},"creationTimestamp":{"$ref":"#/components/schemas/v1Time"},"deletionTimestamp":{"$ref":"#/components/schemas/v1Time"},"labels":{"additionalProperties":{"type":"string"},"description":"Labels are key-value pairs attached to resources for organization and categorization","type":"object"},"name":{"description":"User-provided name that uniquely identifies the resource within its workspace and type","type":"string"},"ownerReferences":{"description":"References to other resources that own or manage the resource","items":{"$ref":"#/components/schemas/v1OwnerReference"},"type":"array"},"resourceVersion":{"description":"An opaque value representing the internal version of this object that can be used for optimistic concurrency and change detection","example":"519597875","type":"string"},"uid":{"description":"System-generated unique identifier for the resource","example":"00000000-0000-0000-0000-000000000000","type":"string"},"workspace":{"description":"Unique identifier of the workspace where the resource belongs","example":"00000000-0000-0000-0000-000000000000","type":"string"}},"required":["workspace","labels","deletionTimestamp","creationTimestamp","uid","name","annotations","ownerReferences"],"type":"object"},"engineSecret":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["compute/v2"],"example":"compute/v2","type":"string"},"data":{"additionalProperties":{"format":"byte","type":"string"},"description":"Contains the secret data as base64 encoded strings","type":"object"},"immutable":{"description":"If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified)","nullable":true,"type":"boolean"},"kind":{"description":"The string value 'Secret' that identifies the schema","enum":["Secret"],"example":"Secret","type":"string"},"metadata":{"$ref":"#/components/schemas/engineObjectMeta"},"stringData":{"additionalProperties":{"type":"string"},"description":"Allows specifying non-binary secret data in string form, merged into the data field on write","type":"object"},"type":{"description":"Used to facilitate programmatic handling of secret data","type":"string"}},"required":["kind","apiVersion","metadata"],"type":"object"},"engineSecretList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["compute/v2"],"example":"compute/v2","type":"string"},"items":{"description":"Collection of Secret resources","items":{"$ref":"#/components/schemas/engineSecret"},"type":"array"},"kind":{"description":"The string value 'SecretList' that identifies the schema","enum":["SecretList"],"example":"SecretList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"engineStatus":{"properties":{"apiVersion":{"description":"Version of the Status kind","enum":["compute/v2"],"example":"compute/v2","type":"string"},"code":{"description":"HTTP status code corresponding to this status","format":"int32","type":"integer"},"details":{"$ref":"#/components/schemas/engineStatusDetails"},"kind":{"description":"Value is always 'Status'","enum":["Status"],"example":"Status","type":"string"},"message":{"description":"Human-readable description of the status","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"},"reason":{"description":"Machine-readable description of the cause of the error","type":"string"},"status":{"description":"Status of the operation","enum":["Success","Failure"],"example":"Success","type":"string"}},"required":["kind","apiVersion","status","code"],"type":"object"},"engineStatusCause":{"properties":{"field":{"description":"Field of the resource that caused the error","type":"string"},"message":{"description":"Human-readable description of the cause of the error","type":"string"},"reason":{"description":"Machine-readable description of the cause of the error","type":"string"}},"required":["reason","message"],"type":"object"},"engineStatusDetails":{"description":"Extended details about the error","nullable":true,"properties":{"causes":{"description":"List of problems that caused the error","items":{"$ref":"#/components/schemas/engineStatusCause"},"type":"array"},"group":{"description":"API group of the resource in the status details","type":"string"},"kind":{"description":"Kind of the resource in the status details","type":"string"},"name":{"description":"Name of the resource in the status details","type":"string"},"retryAfterSeconds":{"description":"Number of seconds to wait before retrying","format":"int32","type":"integer"}},"type":"object"},"iamBackupKey":{"properties":{"created_at":{"description":"Timestamp when the backup key was created","format":"date-time","type":"string"},"deleted_at":{"description":"Timestamp when the backup key was deleted","format":"date-time","type":"string"},"key":{"description":"The SSH key content in SSH format","type":"string"},"public_key":{"type":"string"},"title":{"description":"Title or name for the backup key","type":"string"},"type":{"type":"string"},"uuid":{"description":"Unique identifier for the backup key","type":"string"},"workspace":{"description":"The workspace this backup key belongs to","type":"string"}},"required":["public_key","type","uuid","title","key","workspace","created_at","deleted_at"],"type":"object"},"iamBulkAddRolesRequest":{"properties":{"roles":{"description":"List of roles to assign to the group","items":{"$ref":"#/components/schemas/iamRoleItem"},"type":"array"}},"required":["roles"],"type":"object"},"iamBulkAddRulesRequest":{"properties":{"rules_uuid_list":{"description":"List of UUIDs of the Rule objects to add to the role","items":{"type":"string"},"type":"array"}},"required":["rules_uuid_list"],"type":"object"},"iamBulkAddServiceUsersRequest":{"properties":{"service_users":{"description":"List of service user UUIDs to add to the group","format":"uuid","items":{"type":"string"},"type":"array"}},"required":["service_users"],"type":"object"},"iamBulkAddServiceUsersToRoleRequest":{"properties":{"items":{"description":"List of items needed for role bindings","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"service_users":{"description":"List of service user UUIDs to assign to the role","format":"uuid","items":{"type":"string"},"type":"array"}},"required":["service_users"],"type":"object"},"iamBulkAddUsersRequest":{"properties":{"users":{"description":"List of user UUIDs to add to the group","format":"uuid","items":{"type":"string"},"type":"array"}},"required":["users"],"type":"object"},"iamBulkAddUsersToRoleRequest":{"properties":{"items":{"description":"List of items needed for role bindings","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"users":{"description":"List of user UUIDs to assign to the role","format":"uuid","items":{"type":"string"},"type":"array"}},"required":["users"],"type":"object"},"iamChallenge":{"properties":{"challenge_answer":{"type":"string"},"challenge_token":{"description":"Token to be used when responding to the challenge","type":"string"},"challenge_type":{"description":"Type of challenge (e.g., 'otp', 'sms')","type":"string"}},"required":["challenge_token","challenge_type","challenge_answer"],"type":"object"},"iamChallengeRequest":{"properties":{"challenge_answer":{"description":"Answer to the challenge","type":"string"},"challenge_token":{"description":"Token received from the challenge request","type":"string"},"remember":{"description":"Whether to create a long-lived token","type":"boolean"}},"required":["challenge_token","challenge_answer","remember"],"type":"object"},"iamChangePasswordRequest":{"properties":{"password":{"description":"New password for the user","type":"string"}},"required":["password"],"type":"object"},"iamCreateRole":{"properties":{"description_en":{"type":"string"},"description_fa":{"type":"string"},"name":{"type":"string"},"service":{"type":"string"},"warning_en":{"type":"string"},"warning_fa":{"type":"string"},"workspace":{"type":"string"}},"required":["name","workspace","description_fa","description_en","warning_fa","warning_en","service"],"type":"object"},"iamCreateUser":{"properties":{"birthday":{"description":"Birthday of the user","type":"string"},"email":{"description":"Email address of the user","type":"string"},"email_verified":{"description":"Whether the email address is verified","type":"boolean"},"first_name":{"description":"First name of the user","type":"string"},"is_suspended":{"description":"Whether the user is suspended","type":"boolean"},"last_name":{"description":"Last name of the user","type":"string"},"name":{"description":"Full name of the user","type":"string"},"phone_number":{"description":"Phone number of the user","type":"string"},"phone_number_verified":{"description":"Whether the phone number is verified","type":"boolean"}},"required":["name","email","email_verified","phone_number","phone_number_verified","first_name","last_name","birthday","is_suspended"],"type":"object"},"iamCreateUserKiseKey":{"properties":{"access_key":{"type":"string"},"description":{"type":"string"},"is_encrypted":{"type":"boolean"},"user":{"$ref":"#/components/schemas/iamUser"},"workspace":{"description":"The workspace this KISE key belongs to","type":"string"}},"required":["is_encrypted","access_key","description","user","workspace"],"type":"object"},"iamError":{"properties":{"code":{"type":"integer"},"message":{"$ref":"#/components/schemas/Anonymousac21b6e1"},"reason":{"type":"string"},"status":{"type":"string"}},"required":["status","code","reason","message"],"type":"object"},"iamGroup":{"properties":{"created_at":{"description":"Timestamp when the group was created","format":"date-time","type":"string"},"description":{"description":"Optional description of the group's purpose","type":"string"},"name":{"description":"Name of the group","type":"string"},"updated_at":{"description":"Timestamp when the group was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the group","type":"string"},"workspace":{"$ref":"#/components/schemas/iamWorkspace"}},"required":["uuid","name","created_at","updated_at","workspace"],"type":"object"},"iamGroupDetail":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"name":{"type":"string"},"roles":{"items":{"$ref":"#/components/schemas/iamRoleMinimal"},"type":"array"},"service_users_number":{"format":"int32","type":"integer"},"updated_at":{"format":"date-time","type":"string"},"users_number":{"description":"number of this group members","format":"int32","type":"integer"},"uuid":{"type":"string"},"workspace":{"$ref":"#/components/schemas/iamWorkspace"}},"required":["uuid","name","description","workspace","roles","users_number","service_users_number","created_at","updated_at"],"type":"object"},"iamGroupMinimal":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"}},"required":["uuid","name","description"],"type":"object"},"iamGroupWithMinimalRole":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"roles":{"items":{"$ref":"#/components/schemas/iamRoleMinimal"},"type":"array"},"uuid":{"type":"string"}},"required":["uuid","name","description","roles"],"type":"object"},"iamHealthzResponse":{"properties":{"caches":{"items":{"$ref":"#/components/schemas/iamHealthzResponseDefault"},"type":"array"},"databases":{"items":{"$ref":"#/components/schemas/iamHealthzResponseDefault"},"type":"array"},"storage":{"$ref":"#/components/schemas/iamHealthzResponseDefault"}},"required":["databases","caches","storage"],"type":"object"},"iamHealthzResponseDefault":{"properties":{"default":{"$ref":"#/components/schemas/iamHealthzResponseStatus"}},"required":["default"],"type":"object"},"iamHealthzResponseStatus":{"properties":{"ok":{"type":"boolean"}},"required":["ok"],"type":"object"},"iamInviteRequest":{"properties":{"emails":{"description":"List of email addresses to invite to the workspace","format":"email","items":{"type":"string"},"type":"array"}},"required":["emails"],"type":"object"},"iamLoginRequest":{"properties":{"captcha":{"description":"Captcha response if required","type":"string"},"email":{"description":"Email address of the user","format":"email","type":"string"},"password":{"description":"User's password","type":"string"},"remember":{"description":"Whether to create a long-lived token","type":"boolean"}},"required":["email","password","remember"],"type":"object"},"iamMinimalRoleWithTime":{"properties":{"created_at":{"description":"Timestamp when the role was created","format":"date-time","type":"string"},"description_en":{"description":"Description of the role's purpose and permissions","type":"string"},"description_fa":{"description":"Description of the role's purpose and permissions","type":"string"},"name":{"description":"Name of the role","type":"string"},"updated_at":{"description":"Timestamp when the role was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the role","type":"string"},"workspace":{"description":"Workspace this role applies to","type":"string"}},"required":["created_at","name","updated_at","uuid","workspace"],"type":"object"},"iamOpenIdTokenRequest":{"properties":{"client_id":{"description":"OAuth 2.0 client identifier","type":"string"},"client_secret":{"description":"OAuth 2.0 client secret","type":"string"},"code":{"description":"Authorization code for authorization_code grant type","type":"string"},"grant_type":{"description":"OAuth 2.0 grant type","type":"string"},"password":{"description":"Password for password grant type","type":"string"},"redirect_uri":{"description":"Redirect URI for authorization_code grant type","type":"string"},"refresh_token":{"description":"Refresh token for refresh_token grant type","type":"string"},"scope":{"description":"OAuth 2.0 scope","type":"string"},"username":{"description":"Username for password grant type","type":"string"}},"required":["grant_type","client_id","client_secret","username","password","scope","refresh_token","code","redirect_uri"],"type":"object"},"iamOpenIdTokenResponse":{"properties":{"access_token":{"description":"OAuth 2.0 access token","type":"string"},"expires_in":{"description":"Number of seconds until the token expires","type":"integer"},"id_token":{"description":"OpenID Connect ID token","type":"string"},"refresh_token":{"description":"OAuth 2.0 refresh token","type":"string"},"token_type":{"description":"Type of token, typically 'Bearer'","type":"string"}},"required":["access_token","token_type","expires_in"],"type":"object"},"iamOrganization":{"properties":{"address":{"type":"string"},"city":{"type":"string"},"created_at":{"type":"string"},"economic_code":{"type":"string"},"enterprise_name":{"type":"string"},"fax_no":{"type":"string"},"is_internal":{"type":"boolean"},"is_suspended":{"type":"boolean"},"name":{"type":"string"},"name_en":{"type":"string"},"national_id":{"type":"string"},"province":{"type":"string"},"registration_no":{"type":"string"},"telephone_no":{"type":"string"},"updated_at":{"type":"string"},"uuid":{"type":"string"},"zip_code":{"type":"string"}},"required":["uuid","name","name_en","enterprise_name","economic_code","national_id","province","city","zip_code","registration_no","address","telephone_no","fax_no","created_at","updated_at","is_suspended","is_internal"],"type":"object"},"iamOtpEnabled":{"properties":{"enabled":{"description":"Whether OTP is enabled for the user","type":"boolean"}},"required":["enabled"],"type":"object"},"iamPasswordResetRequest":{"properties":{"email":{"description":"Email address of the user account to reset password for","type":"string"}},"required":["email"],"type":"object"},"iamPublicKeyPolicy":{"properties":{"force_fido_ssh_key":{"description":"Whether the user's organization forces FIDO SSH keys","type":"boolean"},"required_public_key_types":{"description":"List of required public key types","items":{"type":"string"},"type":"array"}},"required":["force_fido_ssh_key","required_public_key_types"],"type":"object"},"iamRefreshTokenReq":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"role_items":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["name","description","role","role_items"],"type":"object"},"iamRefreshTokenResp":{"properties":{"name":{"type":"string"},"refresh_token":{"type":"string"}},"required":["name","refresh_token"],"type":"object"},"iamRequestCreateBackupKey":{"properties":{"key":{"description":"The SSH key content in SSH format","type":"string"},"title":{"description":"Title or name for the backup key","type":"string"}},"required":["title","key"],"type":"object"},"iamRequestCreateGroup":{"properties":{"description":{"description":"Optional description of the group's purpose","type":"string"},"name":{"description":"Name of the group","type":"string"},"workspace":{"$ref":"#/components/schemas/iamWorkspaceMinimal"}},"required":["name","workspace"],"type":"object"},"iamRequestCreateUserPublicKey":{"properties":{"key":{"description":"The public key content in SSH format","type":"string"},"title":{"description":"Title or name for the public key","type":"string"}},"required":["title","key"],"type":"object"},"iamRequestRuleCreate":{"properties":{"actions":{"items":{"type":"string"},"type":"array"},"deny":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"possible_items":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"}},"required":["name","actions","deny","object","possible_items"],"type":"object"},"iamReuqestUserTokenCreate":{"properties":{"active":{"type":"boolean"},"expires_at":{"description":"Token expiration timestamp","format":"date-time","type":"string"},"is_hashed":{"type":"boolean"},"name":{"type":"string"},"secret":{"type":"string"},"user":{"description":"UUID of the authenticated user","type":"string"}},"required":["name","user","secret","is_hashed","active","expires_at"],"type":"object"},"iamRole":{"properties":{"created_at":{"description":"Timestamp when the role was created","format":"date-time","type":"string"},"description":{"description":"Description of the role's purpose and permissions","type":"string"},"description_en":{"type":"string"},"description_fa":{"type":"string"},"items":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"name":{"description":"Name of the role","type":"string"},"possible_items":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"service":{"description":"Service this role applies to","type":"string"},"updated_at":{"description":"Timestamp when the role was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the role","type":"string"},"warning_en":{"type":"string"},"warning_fa":{"type":"string"},"workspace":{"$ref":"#/components/schemas/iamWorkspace"}},"required":["uuid","name","service","created_at","updated_at","workspace","description_fa","description_en","items","warning_fa","warning_en"],"type":"object"},"iamRoleBinding":{"properties":{"created_at":{"description":"Timestamp when the role binding was created","format":"date-time","type":"string"},"group":{"$ref":"#/components/schemas/iamGroup"},"items":{"description":"Optional items associated with this role binding","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"role":{"$ref":"#/components/schemas/iamRole"},"updated_at":{"description":"Timestamp when the role binding was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the role binding","type":"string"}},"required":["uuid","role","group","created_at","updated_at"],"type":"object"},"iamRoleBindingItems":{"properties":{"items":{"description":"Optional items associated with this role binding","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"}},"type":"object"},"iamRoleItem":{"properties":{"items_list":{"description":"List of items for this role","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"role_uuid":{"description":"UUID of the role to assign","type":"string"}},"required":["role_uuid"],"type":"object"},"iamRoleMinimal":{"properties":{"description_en":{"type":"string"},"description_fa":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"workspace":{"type":"string"}},"required":["uuid","name","workspace","description_fa","description_en"],"type":"object"},"iamRoleRule":{"properties":{"created_at":{"description":"Timestamp when the role-rule binding was created","format":"date-time","type":"string"},"role":{"$ref":"#/components/schemas/iamRole"},"rule":{"$ref":"#/components/schemas/iamRule"},"updated_at":{"description":"Timestamp when the role-rule binding was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the role-rule binding","type":"string"}},"required":["uuid","role","rule","created_at","updated_at"],"type":"object"},"iamRoleWorkspaceMinimal":{"properties":{"description_en":{"type":"string"},"description_fa":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"workspace":{"type":"string"}},"required":["uuid","name","workspace","description_fa","description_en"],"type":"object"},"iamRule":{"properties":{"actions":{"description":"Actions this rule controls (eg: GET,PUT...)","items":{"type":"string"},"type":"array"},"created_at":{"description":"Timestamp when the rule was created","format":"date-time","type":"string"},"deny":{"type":"boolean"},"description":{"description":"Description of the rule's purpose","type":"string"},"is_accessible_by_user_defined_roles":{"type":"boolean"},"name":{"description":"Name of the rule","type":"string"},"object":{"description":"Resource this rule applies to","type":"string"},"possible_items":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"service_object":{"description":"Service this rule applies to","type":"string"},"updated_at":{"description":"Timestamp when the rule was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the rule","type":"string"},"workspace":{"type":"string"}},"required":["uuid","name","service_object","object","actions","created_at","updated_at","workspace","deny","is_accessible_by_user_defined_roles","possible_items"],"type":"object"},"iamService":{"properties":{"actions":{"items":{"type":"string"},"type":"array"},"is_user_customizable":{"type":"boolean"},"name":{"type":"string"},"title":{"type":"string"},"workspace":{"type":"string"}},"required":["title","name","actions","workspace","is_user_customizable"],"type":"object"},"iamServiceUser":{"properties":{"created_at":{"description":"Timestamp when the service user was created","format":"date-time","type":"string"},"description":{"description":"description about this service user","type":"string"},"name":{"description":"Name of the service user","type":"string"},"updated_at":{"description":"Timestamp when the service user was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the service user","type":"string"},"workspace":{"type":"string"}},"required":["workspace","uuid","name","created_at","updated_at","description"],"type":"object"},"iamServiceUserCreate":{"properties":{"description":{"description":"Optional description of the service user","type":"string"},"name":{"description":"Name of the service user","type":"string"}},"required":["name"],"type":"object"},"iamServiceUserDetailed":{"properties":{"created_at":{"description":"Timestamp when the service user was created","format":"date-time","type":"string"},"description":{"description":"Description of the service user","type":"string"},"groups":{"description":"Groups this service user belongs to","items":{"$ref":"#/components/schemas/iamGroupMinimal"},"type":"array"},"name":{"description":"Name of the service user","type":"string"},"roles":{"description":"Roles assigned to this service user","items":{"$ref":"#/components/schemas/iamRoleWorkspaceMinimal"},"type":"array"},"third_party":{"$ref":"#/components/schemas/iamThirdPartyForOcean"},"updated_at":{"description":"Timestamp when the service user was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the service user","type":"string"},"workspace":{"type":"string"}},"required":["workspace","third_party","uuid","name","roles","groups","created_at","updated_at"],"type":"object"},"iamServiceUserGroup":{"properties":{"group":{"$ref":"#/components/schemas/iamGroupWithMinimalRole"},"service_user":{"$ref":"#/components/schemas/iamServiceUser"}},"required":["service_user","group"],"type":"object"},"iamServiceUserGroupResponse":{"properties":{"created_at":{"description":"Timestamp when the service user was added to the group","format":"date-time","type":"string"},"group":{"$ref":"#/components/schemas/iamGroup"},"service_user":{"$ref":"#/components/schemas/iamServiceUser"},"uuid":{"description":"Unique identifier for the service-user-group association","type":"string"}},"required":["uuid","service_user","group","created_at"],"type":"object"},"iamServiceUserKiseKey":{"properties":{"access_key":{"type":"string"},"created_at":{"description":"Timestamp when the KISE key was created","format":"date-time","type":"string"},"description":{"type":"string"},"is_encrypted":{"type":"boolean"},"secret_key":{"type":"string"},"service_user":{"description":"The service user this KISE key belongs to","type":"string"},"updated_at":{"description":"Timestamp when the KISE key was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the KISE key","type":"string"}},"required":["uuid","service_user","created_at","updated_at","secret_key","is_encrypted","access_key","description"],"type":"object"},"iamServiceUserPublicKey":{"properties":{"created_at":{"description":"Timestamp when the public key was created","format":"date-time","type":"string"},"key":{"description":"The public key content in SSH format","type":"string"},"public_key":{"type":"string"},"service_user":{"$ref":"#/components/schemas/iamServiceUser"},"title":{"description":"Title or name for the public key","type":"string"},"type":{"type":"string"},"updated_at":{"description":"Timestamp when the public key was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the public key","type":"string"}},"required":["public_key","type","uuid","title","key","service_user","created_at","updated_at"],"type":"object"},"iamServiceUserPublicKeyCreate":{"properties":{"key":{"description":"The public key content in SSH format","type":"string"},"title":{"description":"Title or name for the public key","type":"string"}},"required":["title","key"],"type":"object"},"iamServiceUserRoleBindingMinimal":{"properties":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"role":{"type":"string"},"service_user":{"type":"string"},"workspace":{"type":"string"}},"required":["service_user","role","workspace","items"],"type":"object"},"iamServiceUserToken":{"properties":{"created_at":{"description":"Timestamp when the token was created","format":"date-time","type":"string"},"expires_at":{"description":"Timestamp when the token will expire","format":"date-time","type":"string"},"is_hashed":{"type":"boolean"},"name":{"description":"Name of the token","type":"string"},"service_user":{"description":"The service user this token belongs to","type":"string"},"updated_at":{"description":"Timestamp when the token was updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the token","type":"string"}},"required":["uuid","name","service_user","is_hashed","created_at"],"type":"object"},"iamServiceUserTokenWithSecret":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"expires_at":{"description":"Timestamp when the token will expire","format":"date-time","type":"string"},"is_hashed":{"type":"boolean"},"name":{"description":"Name of the token","type":"string"},"secret":{"readOnly":true,"type":"string"},"updated_at":{"format":"date-time","readOnly":true,"type":"string"},"uuid":{"readOnly":true,"type":"string"}},"required":["uuid","secret","created_at","updated_at","is_hashed","name"],"type":"object"},"iamServiceUserWithRoleItems":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"items":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"uuid":{"type":"string"}},"required":["uuid","name","description","created_at","updated_at","items"],"type":"object"},"iamThirdPartyForOcean":{"properties":{"name":{"type":"string"},"uuid":{"type":"string"}},"required":["uuid","name"],"type":"object"},"iamThirdPartyTokenRequest":{"properties":{"refresh_token":{"type":"string"}},"required":["refresh_token"],"type":"object"},"iamThirdPartyTokenResponse":{"properties":{"expires_at":{"description":"Number of seconds until the token expires","format":"date-time","type":"string"},"refresh_token":{"description":"Refresh token for the third-party service","format":"date-time","type":"string"},"secret":{"type":"string"}},"required":["refresh_token","secret"],"type":"object"},"iamUser":{"properties":{"birthday":{"description":"Birthday of the user","type":"string"},"created_at":{"description":"Timestamp when the user was created","format":"date-time","type":"string"},"email":{"description":"Email address of the user","type":"string"},"email_verified":{"description":"Whether the email address is verified","type":"boolean"},"first_name":{"description":"First name of the user","type":"string"},"is_otp_enabled":{"description":"Whether the user has OTP enabled","type":"boolean"},"is_suspended":{"description":"Whether the user is suspended","type":"boolean"},"last_name":{"description":"Last name of the user","type":"string"},"name":{"description":"Full name of the user","type":"string"},"phone_number":{"description":"Phone number of the user","type":"string"},"phone_number_verified":{"description":"Whether the phone number is verified","type":"boolean"},"updated_at":{"description":"Timestamp when the user was last updated","format":"date-time","type":"string"},"user_type":{"description":"Type of the user (exactly one of 'user' or 'service-user')","type":"string"},"uuid":{"description":"UUID of the user","type":"string"}},"required":["uuid","name","email","email_verified","phone_number","phone_number_verified","first_name","last_name","birthday","is_suspended","created_at","updated_at","user_type","is_otp_enabled"],"type":"object"},"iamUserAcceptInvitation":{"properties":{"name":{"description":"Full name of the user","type":"string"},"password":{"description":"Password for the new account","type":"string"}},"required":["name","password"],"type":"object"},"iamUserBulkCanRequestItem":{"properties":{"actions":{"description":"List of actions to check permissions for","example":"[\"list\", \"create\", \"delete\"]","items":{"type":"string"},"type":"array"},"path":{"description":"The path within the service to check permissions for","type":"string"},"service":{"description":"The service name to check permissions for","example":"compute","type":"string"}},"required":["service","path","actions"],"type":"object"},"iamUserBulkCanResponseItem":{"properties":{"actions":{"description":"List of actions that were checked","items":{"type":"string"},"type":"array"},"allowed":{"description":"Whether the user is allowed to perform the actions on the specified service and path","type":"boolean"},"path":{"description":"The path within the service that was checked","type":"string"},"service":{"description":"The service name that was checked","type":"string"}},"required":["service","path","actions","allowed"],"type":"object"},"iamUserGroup":{"properties":{"group":{"$ref":"#/components/schemas/iamGroupWithMinimalRole"},"user":{"$ref":"#/components/schemas/iamUser"}},"required":["user","group"],"type":"object"},"iamUserInvitation":{"properties":{"created_at":{"format":"date-time","type":"string"},"email":{"type":"string"},"invitation_token":{"type":"string"},"is_suspended":{"type":"boolean"},"name":{"type":"string"},"uuid":{"type":"string"}},"required":["uuid","name","email","is_suspended","created_at","invitation_token"],"type":"object"},"iamUserKiseKey":{"properties":{"access_key":{"type":"string"},"created_at":{"description":"Timestamp when the KISE key was created","format":"date-time","type":"string"},"description":{"type":"string"},"is_encrypted":{"type":"boolean"},"secret_key":{"type":"string"},"updated_at":{"description":"Timestamp when the KISE key was last updated","format":"date-time","type":"string"},"user":{"$ref":"#/components/schemas/iamUser"},"uuid":{"description":"Unique identifier for the KISE key","type":"string"},"workspace":{"description":"The workspace this KISE key belongs to","type":"string"}},"required":["secret_key","is_encrypted","access_key","description","uuid","user","workspace","created_at","updated_at"],"type":"object"},"iamUserOTP":{"properties":{"secret":{"description":"OTP secret","type":"string"},"verification_code":{"description":"Verification code to confirm OTP setup","type":"string"}},"required":["secret","verification_code"],"type":"object"},"iamUserPublicKey":{"properties":{"created_at":{"description":"Timestamp when the public key was created","format":"date-time","type":"string"},"key":{"description":"The public key content in SSH format","type":"string"},"public_key":{"type":"string"},"title":{"description":"Title or name for the public key","type":"string"},"type":{"type":"string"},"updated_at":{"description":"Timestamp when the public key was last updated","format":"date-time","type":"string"},"user":{"description":"The user uuid this public key belongs to","type":"string"},"uuid":{"description":"Unique identifier for the public key","type":"string"}},"required":["type","public_key","uuid","title","key","user","created_at","updated_at"],"type":"object"},"iamUserRoleBindingMinimal":{"properties":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"role":{"type":"string"},"user":{"type":"string"},"workspace":{"type":"string"}},"required":["user","role","workspace","items"],"type":"object"},"iamUserToken":{"properties":{"active":{"type":"boolean"},"created_at":{"type":"string"},"expires_at":{"description":"Token expiration timestamp","format":"date-time","type":"string"},"is_hashed":{"type":"boolean"},"name":{"type":"string"},"secret":{"type":"string"},"token":{"description":"Authentication token","type":"string"},"updated_at":{"type":"string"},"user":{"description":"UUID of the authenticated user","type":"string"},"uuid":{"type":"string"}},"required":["uuid","name","secret","is_hashed","active","created_at","updated_at","expires_at","user"],"type":"object"},"iamUserTokenWithCredCreate":{"properties":{"active":{"description":"is token active","type":"boolean"},"created_at":{"description":"Timestamp when the user was created","format":"date-time","type":"string"},"deleted_at":{"description":"Timestamp when the user was deleted","format":"date-time","type":"string"},"secret":{"description":"user uuid","type":"string"},"updated_at":{"description":"Timestamp when the user was last updated","format":"date-time","type":"string"},"user":{"description":"user uuid","type":"string"},"uuid":{"description":"uuid of token","type":"string"}},"required":["uuid","user","secret","active","created_at","updated_at","deleted_at"],"type":"object"},"iamUserWithRoleItems":{"properties":{"created_at":{"format":"date-time","type":"string"},"email":{"type":"string"},"is_suspended":{"type":"boolean"},"items":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"uuid":{"description":"The userUUID","type":"string"}},"required":["uuid","name","email","is_suspended","created_at","updated_at","items"],"type":"object"},"iamUserWorkspace":{"properties":{"created_at":{"format":"date-time","type":"string"},"is_master":{"type":"boolean"},"is_suspended":{"type":"boolean"},"name":{"type":"string"},"namespace":{"type":"string"},"organization":{"$ref":"#/components/schemas/iamOrganization"},"updated_at":{"format":"date-time","type":"string"},"uuid":{"type":"string"}},"required":["uuid","name","namespace","organization","created_at","updated_at","is_master","is_suspended"],"type":"object"},"iamUserWorkspaceDetailedUser":{"properties":{"birthday":{"type":"string"},"created_at":{"type":"string"},"email":{"type":"string"},"email_verified":{"type":"boolean"},"first_name":{"type":"string"},"groups":{"description":"Groups this user belongs to in the workspace","items":{"$ref":"#/components/schemas/iamGroupWithMinimalRole"},"type":"array"},"is_otp_enabled":{"type":"boolean"},"is_suspended":{"type":"boolean"},"last_name":{"type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"},"phone_number_verified":{"type":"boolean"},"roles":{"description":"Roles assigned to this user in the workspace","items":{"$ref":"#/components/schemas/iamRoleMinimal"},"type":"array"},"updated_at":{"type":"string"},"user_type":{"type":"string"},"uuid":{"type":"string"}},"required":["roles","groups"],"type":"object"},"iamWorkspace":{"properties":{"created_at":{"description":"Timestamp when the workspace was created","format":"date-time","type":"string"},"description":{"description":"Description of the workspace","type":"string"},"is_suspended":{"type":"boolean"},"name":{"description":"Name of the workspace","type":"string"},"namespace":{"type":"string"},"organization":{"type":"string"},"updated_at":{"description":"Timestamp when the workspace was last updated","format":"date-time","type":"string"},"uuid":{"description":"Unique identifier for the workspace","type":"string"}},"required":["namespace","organization","is_suspended","uuid","name","created_at","updated_at"],"type":"object"},"iamWorkspaceMinimal":{"properties":{"is_suspended":{"type":"boolean"},"name":{"type":"string"},"namespace":{"type":"string"},"organization":{"type":"string"}},"required":["name","namespace","organization","is_suspended"],"type":"object"},"resourceQuantity":{"format":"string","type":"string"},"v1AmqpOpts":{"description":"Specifies the AMQP options to send the logs to.","nullable":true,"properties":{"address":{"description":"Specifies the AMQP address to send the logs to.","example":"amqp://username:password@hostname:5672","type":"string"},"exchange":{"description":"Specifies the AMQP exchange to send the logs to.","example":"exchange-name","type":"string"},"host":{"description":"Specifies the AMQP host to send the logs to.","example":"hostname","type":"string"},"name":{"description":"Specifies the AMQP queue name to send the logs to.","example":"queue-name","type":"string"},"password":{"description":"Specifies the AMQP password to use.","example":"password","type":"string"},"port":{"description":"Specifies the AMQP port to send the logs to.","example":"5672","type":"integer"},"scheme":{"description":"Specifies the AMQP scheme to use. supported schemes are amqp, amqps.","example":"amqp","type":"string"},"username":{"description":"Specifies the AMQP username to use.","example":"username","type":"string"}},"required":["exchange","scheme","host","port","name","address"],"type":"object"},"v1Audio":{"properties":{"enabled":{"description":"Whether this audio track should be processed and included in the transcoded output.","type":"boolean"},"input":{"$ref":"#/components/schemas/v1Input"},"language":{"description":"ISO 639-2 language code for the audio track (e.g., 'eng' for English, 'spa' for Spanish), used by FFmpeg for metadata.","type":"string"},"title":{"description":"Optional title/description for the audio track, displayed in media players that support multi-audio selection.","example":"English Audio","type":"string"}},"required":["enabled","input","language","title"],"type":"object"},"v1Condition":{"properties":{"lastTransitionTime":{"$ref":"#/components/schemas/v1Time"},"message":{"type":"string"},"observedGeneration":{"format":"int64","type":"integer"},"reason":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"}},"required":["type","status","lastTransitionTime","reason","message"],"type":"object"},"v1Duration":{"description":"Duration in Go format (e.g., '5s', '1h30m', '100ms')","type":"string"},"v1ElasticOpts":{"description":"Specifies the Elasticsearch options to send the logs to.","nullable":true,"properties":{"addresses":{"description":"Specifies the Elasticsearch addresses to send the logs to.","example":"https://localhost:9200","items":{"type":"string"},"type":"array"},"compatibilityMode":{"description":"Specifies if the Elasticsearch compatibility mode is enabled.","example":"true","type":"boolean"},"index":{"description":"Specifies the Elasticsearch index to send the logs to.","example":"index-name","type":"string"},"password":{"description":"Specifies the Elasticsearch password to send the logs to.","example":"password","type":"string"},"username":{"description":"Specifies the Elasticsearch username to send the logs to.","example":"username","type":"string"}},"required":["addresses","index"],"type":"object"},"v1Encryption":{"description":"Specifies the encryption to apply to the forwarded logs.","nullable":true,"properties":{"enabled":{"description":"Specifies if the encryption is enabled.","type":"boolean"},"key":{"description":"Specifies the encryption key to use. must be 16 bytes long.","example":"your-strong-secret-key","type":"string"},"mode":{"description":"Specifies the encryption mode to use. supported modes are AES-128-CFB, AES-128-OFB, AES-128-CTR-LE.","example":"AES-128-CFB","type":"string"}},"required":["enabled","mode","key"],"type":"object"},"v1HTTPInput":{"description":"HTTP input configuration when protocol is 'http', contains the URL to retrieve the file from.","nullable":true,"properties":{"url":{"description":"HTTP or HTTPS URL of the input file to download, supports direct video/audio/subtitle file downloads from web servers.","example":"https://example.com/video.mp4","type":"string"}},"required":["url"],"type":"object"},"v1HeaderFilter":{"description":"The request and response headers filter to apply while forwarding the logs in order to include or exclude specified headers from log entries.","nullable":true,"properties":{"includeAllRequest":{"description":"Specifies if all request headers should be included in the log entries.","type":"boolean"},"includeAllResponse":{"description":"Specifies if all response headers should be included in the log entries.","type":"boolean"},"request":{"description":"Specifies the request headers to include in the log entries.","items":{"type":"string"},"type":"array"},"response":{"description":"Specifies the response headers to include in the log entries.","items":{"type":"string"},"type":"array"}},"required":["includeAllRequest","includeAllResponse"],"type":"object"},"v1Input":{"description":"Source location of the watermark image file (supports PNG with transparency for best results).","nullable":true,"properties":{"default":{"description":"When true, marks this input as the default track (used for audio/subtitle tracks to indicate the primary or preferred track)","example":"false","type":"boolean"},"http":{"$ref":"#/components/schemas/v1HTTPInput"},"protocol":{"description":"Specifies the source protocol to use for retrieving the input file (s3 or http)","example":"s3","type":"string"},"s3":{"$ref":"#/components/schemas/v1S3Input"}},"required":["protocol"],"type":"object"},"v1KafkaOpts":{"description":"Specifies the Kafka options to send the logs to.","nullable":true,"properties":{"bootstrapServers":{"description":"Specifies the Kafka bootstrap servers to use.","example":"hostname:9092","items":{"type":"string"},"type":"array"},"topic":{"description":"Specifies the Kafka topic to send the logs to.","example":"topic-name","type":"string"}},"required":["bootstrapServers","topic"],"type":"object"},"v1ListMeta":{"description":"Standard resource metadata fields","properties":{"continue":{"type":"string"},"remainingItemCount":{"format":"int64","nullable":true,"type":"integer"},"resourceVersion":{"type":"string"},"selfLink":{"type":"string"}},"type":"object"},"v1LocalObjectReference":{"description":"Reference to the external IP resource. If empty, this link does not have an external IP address.","nullable":true,"properties":{"name":{"type":"string"}},"type":"object"},"v1LogForwarderConstraint":{"properties":{"args":{"$ref":"#/components/schemas/v1LogForwarderConstraintArgs"},"asn":{"$ref":"#/components/schemas/v1LogForwarderConstraintASN"},"cache_status":{"$ref":"#/components/schemas/v1LogForwarderConstraintCacheStatus"},"cookie":{"$ref":"#/components/schemas/v1LogForwarderConstraintCookie"},"country":{"$ref":"#/components/schemas/v1LogForwarderConstraintCountry"},"header":{"$ref":"#/components/schemas/v1LogForwarderConstraintHeader"},"host":{"$ref":"#/components/schemas/v1LogForwarderConstraintHost"},"http_version":{"$ref":"#/components/schemas/v1LogForwarderConstraintHTTPVersion"},"ip":{"$ref":"#/components/schemas/v1LogForwarderConstraintIP"},"known_bots":{"$ref":"#/components/schemas/v1LogForwarderConstraintKnownBots"},"method":{"$ref":"#/components/schemas/v1LogForwarderConstraintMethod"},"negate":{"description":"Indicates whether to invert the constraint condition.","type":"boolean"},"path":{"$ref":"#/components/schemas/v1LogForwarderConstraintPath"},"port":{"$ref":"#/components/schemas/v1LogForwarderConstraintPort"},"status":{"$ref":"#/components/schemas/v1LogForwarderConstraintStatus"},"tls":{"$ref":"#/components/schemas/v1LogForwarderConstraintTLS"},"type":{"description":"Specifies the constraint type. One of: asn, cookie, country, header, ip, host, port, method, uri, path, args, http_version, tls, known_bots, status, upstream_status, cache_status, user_agent, upstream_address.","type":"string"},"upstream_address":{"$ref":"#/components/schemas/v1LogForwarderConstraintUpstreamAddress"},"upstream_status":{"$ref":"#/components/schemas/v1LogForwarderConstraintUpstreamStatus"},"uri":{"$ref":"#/components/schemas/v1LogForwarderConstraintURI"},"user_agent":{"$ref":"#/components/schemas/v1LogForwarderConstraintUserAgent"}},"required":["type"],"type":"object"},"v1LogForwarderConstraintASN":{"description":"Constraint based on the ASN.","nullable":true,"properties":{"expected":{"description":"ASN values used for comparison.","example":"12345","items":{"format":"int32","type":"integer"},"type":"array"},"operator":{"description":"Specifies the comparison operator for ASN. One of: equals, lesser, greater.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintArgs":{"description":"Constraint based on query parameters.","nullable":true,"properties":{"expected":{"description":"Query string values used for comparison.","example":"a=10, b=20","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the target query string.","type":"string"},"operator":{"description":"Specifies the comparison operator for the query strings. One of: equals, contains, starts_with, ends_with, matches, exists.","type":"string"}},"required":["operator","name","expected"],"type":"object"},"v1LogForwarderConstraintCacheStatus":{"description":"Constraint based on the cache status of the request.","nullable":true,"properties":{"expected":{"description":"Cache status values used for comparison.","example":"HIT, MISS, BYPASS","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the cache status. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintCookie":{"description":"Constraint based on cookie values.","nullable":true,"properties":{"expected":{"description":"Cookie values used for comparison.","example":"session_id, user_id","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the target cookie.","type":"string"},"operator":{"description":"Specifies the comparison operator for the cookie. One of: equals, contains, starts_with, ends_with, matches, exists.","type":"string"}},"required":["operator","name","expected"],"type":"object"},"v1LogForwarderConstraintCountry":{"description":"Constraint based on the request’s country.","nullable":true,"properties":{"expected":{"description":"Country codes used for comparison.","example":"IR, US","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the country. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintHTTPVersion":{"description":"Constraint based on the HTTP version.","nullable":true,"properties":{"expected":{"description":"HTTP version values used for comparison.","example":"HTTP/1.0, HTTP/1.1, HTTP/1.2, HTTP/2, HTTP/3","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the HTTP version. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintHeader":{"description":"Constraint based on HTTP headers.","nullable":true,"properties":{"expected":{"description":"Header values used for comparison.","example":"value1, value2","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the target header.","type":"string"},"operator":{"description":"Specifies the comparison operator for the header. One of: equals, contains, starts_with, ends_with, matches, exists.","type":"string"}},"required":["operator","name","expected"],"type":"object"},"v1LogForwarderConstraintHost":{"description":"Constraint based on the request host.","nullable":true,"properties":{"expected":{"description":"Host values used for comparison.","example":"example.com, www.example.com, example.org","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the host. One of: equals, contains, starts_with, ends_with, matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintIP":{"description":"Constraint based on IP addresses.","nullable":true,"properties":{"expected":{"description":"IP addresses used for comparison.","example":"8.8.8.8/32, 192.168.1.0/24, 10.0.0.0/8","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for IP addresses. One of: ip_matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintKnownBots":{"description":"Constraint targeting known bot traffic.","nullable":true,"properties":{"expected":{"description":"Indicates whether the request is from a known bot.","example":"true","type":"boolean"},"operator":{"description":"Specifies the comparison operator for known bots. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintMethod":{"description":"Constraint based on the HTTP method.","nullable":true,"properties":{"expected":{"description":"Method values used for comparison.","example":"GET, POST, PUT, HEAD, OPTIONS, DELETE, PATCH","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the method. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintPath":{"description":"Constraint based on the request path.","nullable":true,"properties":{"expected":{"description":"Path values used for comparison.","example":"/path/to/some/where, /path/to/some/where?a=10","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the path. One of: equals, contains, starts_with, ends_with, matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintPort":{"description":"Constraint based on the request port.","nullable":true,"properties":{"expected":{"description":"Port values used for comparison.","example":"80, 443","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the port. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintStatus":{"description":"Constraint based on the status of the request.","nullable":true,"properties":{"expected":{"description":"Status values used for comparison.","example":"200, 404","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the status. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintTLS":{"description":"Constraint based on TLS attributes.","nullable":true,"properties":{"expected":{"description":"Indicates whether TLS should be enabled.","example":"true","type":"boolean"},"operator":{"description":"Specifies the comparison operator for TLS. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintURI":{"description":"Constraint based on the request URI.","nullable":true,"properties":{"expected":{"description":"URI values used for comparison.","example":"/path/to/some/where, /path/to/some/where?a=10","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the URI. One of: equals, contains, starts_with, ends_with, matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintUpstreamAddress":{"description":"Constraint based on the upstream address of the request.","nullable":true,"properties":{"expected":{"description":"Upstream address values used for comparison.","example":"8.8.8.8/32, 192.168.1.0/24, 10.0.0.0/8","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the upstream address. One of: ip_matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintUpstreamStatus":{"description":"Constraint based on the status of the request from the upstream.","nullable":true,"properties":{"expected":{"description":"Upstream status values used for comparison.","example":"200, 404","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the upstream status. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderConstraintUserAgent":{"description":"Constraint based on the user agent of the request.","nullable":true,"properties":{"expected":{"description":"User agent values used for comparison.","example":"Mozilla/5.0, Googlebot/2.1","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the user agent. One of: equals, contains, starts_with, ends_with, matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1LogForwarderSpec":{"description":"Desired configuration for the LogForwarder","properties":{"constraints":{"description":"Specifies the constraints to filter request logs before forwarding them to the sink.","items":{"items":{"$ref":"#/components/schemas/v1LogForwarderConstraint"},"type":"array"},"type":"array"},"enabled":{"description":"Enable or disable the log forwarder.","example":"true","type":"boolean"},"encryption":{"$ref":"#/components/schemas/v1Encryption"},"headerFilter":{"$ref":"#/components/schemas/v1HeaderFilter"},"ratelimit":{"$ref":"#/components/schemas/v1Ratelimit"},"selector":{"$ref":"#/components/schemas/v1Selector"},"sink":{"$ref":"#/components/schemas/v1Sink"}},"required":["enabled","selector","sink"],"type":"object"},"v1LogForwarderStatus":{"description":"Current observed state of the LogForwarder","properties":{"buffer":{"description":"Specifies the buffered logs.","example":"100","type":"string"},"status":{"description":"Specifies the status of the log forwarder.","type":"string"}},"required":["buffer"],"type":"object"},"v1LokiOpts":{"description":"Specifies the Loki options to send the logs to.","nullable":true,"properties":{"compression":{"description":"Specifies the Loki compression to use. supported compressions are gzip, none, snappy, zlib, zstd.","example":"none","type":"string"},"endpoint":{"description":"Specifies the Loki endpoint to send the logs to.","example":"http://localhost:3100","type":"string"},"password":{"description":"Specifies the Loki password to send the logs to.","example":"password","type":"string"},"path":{"description":"Specifies the Loki path to send the logs to.","example":"/loki/api/v1/push","type":"string"},"tenant_id":{"description":"Specifies the Loki tenant ID to send the logs to.","example":"fake","type":"string"},"username":{"description":"Specifies the Loki username to send the logs to.","example":"username","type":"string"}},"required":["endpoint","compression","path","tenant_id"],"type":"object"},"v1ObjectReference":{"description":"Reference to the instance that this link is connected to.","nullable":true,"properties":{"apiVersion":{"type":"string"},"fieldPath":{"type":"string"},"kind":{"type":"string"},"name":{"type":"string"},"namespace":{"type":"string"},"resourceVersion":{"type":"string"},"uid":{"type":"string"}},"type":"object"},"v1Output":{"description":"The output configuration to store the transcoded video.","nullable":true,"properties":{"bucket":{"description":"Target S3 bucket name where transcoded video files will be stored (3-64 characters).","type":"string"},"endpoint":{"$ref":"#/components/schemas/v1S3Endpoint"},"prefix":{"description":"Optional object key prefix (folder path) within the bucket for organizing transcoded outputs.","type":"string"}},"required":["endpoint","bucket"],"type":"object"},"v1OutputSize":{"properties":{"compressionRatio":{"description":"Compression ratio achieved compared to the original input (e.g., '0.45' means 45% of original size), indicating encoding efficiency.","type":"string"},"key":{"description":"S3 object key (file path) of the transcoded output file, uniquely identifying each quality variant or format.","type":"string"},"size":{"description":"File size of the transcoded output in human-readable format (e.g., '125.5 MB'), useful for storage and bandwidth planning.","type":"string"}},"required":["key","size","compressionRatio"],"type":"object"},"v1OwnerReference":{"properties":{"apiVersion":{"type":"string"},"blockOwnerDeletion":{"nullable":true,"type":"boolean"},"controller":{"nullable":true,"type":"boolean"},"kind":{"type":"string"},"name":{"type":"string"},"uid":{"type":"string"}},"required":["apiVersion","kind","name","uid"],"type":"object"},"v1PipelineOutput":{"properties":{"excludeFromPlaylist":{"description":"When true, excludes this output from being included in adaptive bitrate playlists (e.g., HLS master playlist).","type":"boolean"},"excludeFromThumbs":{"description":"When true, skips thumbnail generation for this specific output, useful for audio-only or low-quality variants.","type":"boolean"},"key":{"description":"Unique identifier for this output variant (1-64 characters), used as part of the output filename and for referencing in playlists.","type":"string"},"presetName":{"description":"Reference to an existing Preset resource by name, the PresetSpec will be automatically populated from this preset at runtime.","type":"string"},"presetSpec":{"$ref":"#/components/schemas/v1PresetSpec"}},"required":["key"],"type":"object"},"v1PipelinePlaylist":{"description":"Optional adaptive bitrate playlist configuration (e.g., HLS master playlist), combines multiple quality outputs for adaptive streaming.","nullable":true,"properties":{"enabled":{"description":"Whether to generate an adaptive bitrate playlist that combines multiple output qualities for seamless quality switching.","type":"boolean"},"format":{"description":"Playlist format type, currently supports 'hls' (HTTP Live Streaming) for Apple-compatible adaptive streaming.","type":"string"},"hls":{"$ref":"#/components/schemas/v1PipelinePlaylistHLS"},"name":{"description":"Name of the playlist file to be generated (e.g., 'master.m3u8' for HLS), used as the entry point for video playback.","type":"string"}},"required":["enabled","name","format"],"type":"object"},"v1PipelinePlaylistHLS":{"description":"HLS-specific configuration parameters when format is 'hls', defines segmentation and playlist generation settings","nullable":true,"properties":{"segmentDuration":{"description":"Duration of each HLS segment in seconds, FFmpeg splits the video into chunks of this length for adaptive streaming (typical values: 2-10 seconds).","example":"15","type":"integer"}},"required":["segmentDuration"],"type":"object"},"v1PipelineSpec":{"description":"Desired configuration for the Pipeline","properties":{"autoPresets":{"description":"When true, automatically generates outputs for all video presets in the namespace, eliminating the need to manually specify Outputs array.","type":"boolean"},"outputs":{"description":"List of output configurations with their associated presets (1-5 outputs), required when AutoPresets is false, each defining a quality/format variant.","items":{"$ref":"#/components/schemas/v1PipelineOutput"},"type":"array"},"playlist":{"$ref":"#/components/schemas/v1PipelinePlaylist"},"playlistOnly":{"description":"When true, only generates the playlist file without individual output files, useful for post-processing or external transcoding workflows.","type":"boolean"},"thumbs":{"$ref":"#/components/schemas/v1PipelineThumbs"},"watermarks":{"description":"Optional watermark overlays to apply to the video outputs, supports multiple watermarks with different positions and sizes.","items":{"$ref":"#/components/schemas/v1PipelineWatermark"},"type":"array"}},"type":"object"},"v1PipelineThumbs":{"description":"Optional thumbnail generation configuration, extracts still images from the video at specified intervals using FFmpeg.","nullable":true,"properties":{"format":{"description":"Image format for generated thumbnails (jpg or png), jpg provides smaller file sizes while png supports transparency.","example":"jpg","type":"string"},"interval":{"description":"Time interval in seconds between thumbnail extractions, FFmpeg captures a frame every N seconds throughout the video duration.","example":"1","type":"integer"},"tile":{"description":"When true, combines multiple thumbnails into a single tiled sprite sheet image, reducing HTTP requests and improving preview performance.","example":"false","type":"boolean"}},"required":["format","interval"],"type":"object"},"v1PipelineWatermark":{"properties":{"enabled":{"description":"Whether to apply this watermark overlay to the transcoded video output.","type":"boolean"},"height":{"description":"Height of the watermark overlay in pixels (0-4096), maintains aspect ratio when combined with width.","type":"integer"},"input":{"$ref":"#/components/schemas/v1Input"},"padding":{"$ref":"#/components/schemas/v1WatermarkPadding"},"width":{"description":"Width of the watermark overlay in pixels (0-7680), used by FFmpeg's overlay filter to scale the watermark.","type":"integer"}},"required":["enabled","input","width","height","padding"],"type":"object"},"v1PresetAudio":{"description":"Audio encoding configuration including codec, bitrate, and sample rate, required unless SkipAudio is true","nullable":true,"properties":{"bitrate":{"description":"Target audio bitrate (e.g., '64k', '128k', '192k', '320k', '1m'), higher bitrates provide better quality but larger file sizes, typical range 96k-320k.","example":"128k","type":"string"},"codec":{"description":"Audio codec for encoding (aac, mp3, vorbis, opus, copy), 'copy' streams without re-encoding for faster processing, aac recommended for broad compatibility.","example":"aac","type":"string"},"sampleRate":{"description":"Audio sample rate of input audio to produce output audio in Hz (22050, 32000, 44100, 48000, 96000), 44100/48000 are standard for most content, higher rates for professional audio.","example":"44100","type":"integer"}},"required":["codec"],"type":"object"},"v1PresetSpec":{"description":"Desired configuration for the Preset","properties":{"audio":{"$ref":"#/components/schemas/v1PresetAudio"},"container":{"description":"Output container format (mp4, m4v, mov, avi, flv), determines the file wrapper format that FFmpeg will mux the encoded streams into.","example":"mp4","type":"string"},"description":{"description":"Human-readable description of this preset's purpose (max 128 characters), useful for identifying preset characteristics like '720p High Quality'.","type":"string"},"noFragment":{"description":"When true, disables MP4 fragmentation (faststart/moov atom relocation), may impact progressive playback but reduces processing overhead.","type":"boolean"},"pixelFormat":{"description":"FFmpeg pixel format for video output, yuv420p is the most compatible format for H.264/H.265 ensuring broad device support.","type":"string"},"skipAudio":{"description":"When true, removes all audio streams from the output, creating a video-only file useful for silent videos or separate audio processing","type":"boolean"},"skipSubtitle":{"description":"When true, removes all subtitle streams from the output, useful when subtitles should be handled separately or not included.","type":"boolean"},"skipVideo":{"description":"When true, removes all video streams from the output, creating an audio-only file for music or podcast extraction.","type":"boolean"},"speed":{"description":"FFmpeg encoding speed preset (medium, veryfast, ultrafast), trades encoding time for compression efficiency - faster speeds produce larger files but good quality.","example":"medium","type":"string"},"video":{"$ref":"#/components/schemas/v1PresetVideo"}},"required":["container"],"type":"object"},"v1PresetVideo":{"description":"Video encoding configuration including codec, resolution, bitrate, and quality settings, required unless SkipVideo is true","nullable":true,"properties":{"bitrate":{"description":"Target video bitrate (e.g., '1000k', '5M'), used for constant/average bitrate encoding, mutually exclusive with CRF for rate control.","example":"1000k","type":"string"},"bufferSize":{"description":"Video buffer verifier (VBV) buffer size (e.g., '2M'), controls bitrate variability, typically 1-2x MaxBitrate for streaming.","example":"2M","type":"string"},"codec":{"description":"Video codec for encoding (h264, h265/HEVC, vp9), h264 offers best compatibility, h265 better compression, vp9 for WebM/VP9 workflows.","example":"h264","type":"string"},"crf":{"description":"Constant Rate Factor for quality-based encoding (0-51), lower values = higher quality, 18-28 typical range, 23 is default for h264.","example":"23","type":"integer"},"fixedGOP":{"description":"When true, enforces fixed Group of Pictures size disabling scene change detection, ensures consistent segment sizes for HLS/DASH.","example":"false","type":"boolean"},"frameRate":{"description":"Target frame rate in fps (1-120), FFmpeg drops or duplicates frames to match, common values: 24, 25, 30, 50, 60, omit to preserve source fps.","example":"30","type":"integer"},"height":{"description":"Target height in pixels (0-2400), used with autoHeight or unconstrained ResizeType, common values: 360, 480, 720, 1080, 1440, 2160.","example":"720","type":"integer"},"keyframeInterval":{"description":"Maximum frames between keyframes/I-frames (1-1000), recommended default 250, lower values improve seeking but increase file size, critical for HLS segment alignment.","example":"250","type":"integer"},"maxBitrate":{"description":"Maximum allowed bitrate for variable bitrate encoding (e.g., '2M'), prevents bitrate spikes, requires BufferSize to be set.","example":"2M","type":"string"},"minBitrate":{"description":"Minimum allowed bitrate for variable bitrate encoding (e.g., '500k'), ensures minimum quality in low-complexity scenes.","example":"500k","type":"string"},"percentage":{"description":"Scaling percentage (1-1000), used when ResizeType is 'percentage', 50 = half size, 100 = same size, 200 = double size.","example":"100","type":"integer"},"resizeType":{"description":"Video scaling strategy: empty (no resize), autoHeight (set width), autoWidth (set height), unconstrained (set both), percentage (scale by %).","example":"autoHeight","type":"string"},"sceneChangeThreshold":{"description":"FFmpeg scene change detection sensitivity (0-1000), 0 disables scene detection, higher values require more significant changes to insert keyframe.","example":"100","type":"integer"},"width":{"description":"Target width in pixels (0-2400), used with autoWidth or unconstrained ResizeType, FFmpeg scales video maintaining or ignoring aspect ratio.","example":"1280","type":"integer"}},"required":["codec","resizeType"],"type":"object"},"v1Ratelimit":{"description":"Specifies the rate limit to apply to the forwarded logs.","nullable":true,"properties":{"enabled":{"description":"Specifies if the rate limit is enabled.","type":"boolean"},"period":{"$ref":"#/components/schemas/v1Duration"},"rate":{"description":"Specifies the rate of access logs per period.","type":"integer"}},"required":["enabled","rate","period"],"type":"object"},"v1S3Endpoint":{"description":"Optional S3-compatible storage endpoint configuration, defaults to system-configured endpoint if omitted.","nullable":true,"properties":{"accessKey":{"description":"S3 access key ID for authentication, required for non-Kise endpoints that need explicit credentials.","example":"your-access-key","type":"string"},"address":{"description":"S3-compatible endpoint URL (e.g., 's3.amazonaws.com' or custom MinIO endpoint), defines where to connect for S3 operations.","example":"s3.amazonaws.com","type":"string"},"kise":{"description":"When true, uses Kise internal S3 service for storage operations, bypassing S3 credentials.","type":"boolean"},"secretKey":{"description":"S3 secret access key for authentication, paired with AccessKey for secure S3 API access.","example":"your-secret-key","type":"string"}},"required":["kise","address"],"type":"object"},"v1S3Input":{"description":"S3 input configuration when protocol is 's3', contains bucket, object key, and optional endpoint credentials.","nullable":true,"properties":{"bucket":{"description":"S3 bucket name where the input file is stored (3-64 characters).","type":"string"},"endpoint":{"$ref":"#/components/schemas/v1S3Endpoint"},"object":{"description":"S3 object key (file name) of the input file to be retrieved, combined with prefix to form the full object path.","type":"string"},"prefix":{"description":"Optional directory path prefix within the bucket, used to organize objects in folder-like structures.","type":"string"}},"required":["endpoint","bucket","object"],"type":"object"},"v1Selector":{"description":"Specifies the selector to associate the log forwarder with specific CDN.","nullable":true,"properties":{"name":{"description":"Specifies the name of the CDN to associate the log forwarder with.","type":"string"},"namespace":{"description":"Specifies the namespace of the CDN to associate the log forwarder with.","type":"string"}},"required":["name","namespace"],"type":"object"},"v1Sink":{"description":"Specifies the sink to send the logs to.","nullable":true,"properties":{"amqp":{"$ref":"#/components/schemas/v1AmqpOpts"},"elastic":{"$ref":"#/components/schemas/v1ElasticOpts"},"kafka":{"$ref":"#/components/schemas/v1KafkaOpts"},"kind":{"description":"Specifies the kind of the sink to send the logs to. supported kinds are Kafka, Amqp, Websocket, Elastic, Loki.","example":"Kafka","type":"string"},"loki":{"$ref":"#/components/schemas/v1LokiOpts"},"websocket":{"$ref":"#/components/schemas/v1WebsocketOpts"}},"required":["kind"],"type":"object"},"v1Subtitle":{"properties":{"enabled":{"description":"Whether this subtitle track should be processed and included in the transcoded output.","type":"boolean"},"input":{"$ref":"#/components/schemas/v1Input"},"language":{"description":"ISO 639-2 language code for the subtitle track (e.g., 'eng' for English, 'fra' for French)","type":"string"},"name":{"description":"Optional display name for the subtitle track, useful for identifying the track in multi-subtitle videos","example":"English Subtitles","type":"string"}},"required":["enabled","input","language"],"type":"object"},"v1Time":{"format":"date-time","type":"string"},"v1TranscodeSpec":{"description":"Desired configuration for the Transcode","properties":{"audios":{"description":"Optional additional audio tracks to include in the transcoded output (max 4), each with language and title metadata.","items":{"$ref":"#/components/schemas/v1Audio"},"type":"array"},"input":{"$ref":"#/components/schemas/v1VideoInput"},"output":{"$ref":"#/components/schemas/v1Output"},"pipelineName":{"description":"Reference to an existing Pipeline resource by name for reusable transcode configurations.","example":"my-pipeline","type":"string"},"pipelineSpec":{"$ref":"#/components/schemas/v1PipelineSpec"},"subtitles":{"description":"Optional subtitle tracks to embed or burn into the transcoded video (max 4), supports SRT, VTT, ASS, and other FFmpeg-compatible subtitle formats.","items":{"$ref":"#/components/schemas/v1Subtitle"},"type":"array"}},"required":["input","output"],"type":"object"},"v1TranscodeStatus":{"description":"Current observed state of the Transcode","properties":{"changedOn":{"$ref":"#/components/schemas/v1Time"},"lastError":{"description":"Most recent error message encountered during transcoding, preserved across retries for troubleshooting.","type":"string"},"message":{"description":"Human-readable status message providing additional context about the current state.","type":"string"},"outputBucket":{"description":"S3 bucket where the transcoded output was stored, recorded for audit and tracking purposes.","type":"string"},"outputPrefix":{"description":"S3 object key prefix (folder path) where the transcoded files were stored.","type":"string"},"outputSizes":{"description":"List of output files with their sizes and compression ratios for each quality variant or format produced.","items":{"$ref":"#/components/schemas/v1OutputSize"},"type":"array"},"outputUrl":{"description":"Public URL or path to access the transcoded video output after successful completion.","type":"string"},"progress":{"description":"FFmpeg transcoding progress indicator (e.g., percentage or time processed), updated during the Transcoding state.","type":"string"},"retries":{"description":"Number of retry attempts for this transcode job in case of transient failures","type":"integer"},"speed":{"description":"FFmpeg transcoding speed multiplier (e.g., '2.5x' means processing 2.5 seconds of video per second of real time)","type":"string"},"state":{"description":"Current state of the transcode job (Scheduled, Preparing, Downloading, Transcoding, Completed, Failed, etc.).","type":"string"},"worker":{"description":"Identifier of the worker pod/node processing this transcode job, useful for debugging and load distribution.","type":"string"}},"type":"object"},"v1VideoInput":{"description":"The input video to be transcoded.","nullable":true,"properties":{"audioLanguage":{"description":"ISO 639-2 language code for the input audio track (e.g., 'eng', 'fra'), used by FFmpeg for audio stream identification.","example":"eng","type":"string"},"audioTitle":{"description":"Optional title metadata for the audio track in the input video, displayed in media players supporting audio track selection","example":"English Audio","type":"string"},"http":{"$ref":"#/components/schemas/v1HTTPInput"},"protocol":{"description":"Specifies the source protocol to use for getting the video (s3 or http)","example":"s3","type":"string"},"s3":{"$ref":"#/components/schemas/v1S3Input"},"skipAudio":{"description":"When true, skips processing audio streams from the input video, useful for video-only transcoding or when replacing audio entirely","example":"false","type":"boolean"},"skipSubtitle":{"description":"When true, skips processing subtitle streams from the input video, used when subtitles should not be carried over to the output","example":"false","type":"boolean"}},"required":["protocol"],"type":"object"},"v1WatermarkPadding":{"description":"Positioning and padding configuration for placing the watermark on the video frame.","nullable":true,"properties":{"h":{"description":"Vertical padding in pixels from the edge of the video frame, determines the distance between the watermark and top/bottom edge.","type":"integer"},"position":{"description":"Corner position where the watermark will be placed (top_left, top_right, bottom_left, or bottom_right).","type":"string"},"w":{"description":"Horizontal padding in pixels from the edge of the video frame, determines the distance between the watermark and left/right edge.","type":"integer"}},"required":["w","h","position"],"type":"object"},"v1WebsocketHeader":{"nullable":true,"properties":{"name":{"description":"Specifies the WebSocket header name to send the logs to.","example":"Origin","type":"string"},"value":{"description":"Specifies the WebSocket header value to send the logs to.","example":"domain.ir","type":"string"}},"required":["name","value"],"type":"object"},"v1WebsocketOpts":{"description":"Specifies the WebSocket options to send the logs to.","nullable":true,"properties":{"address":{"description":"Specifies the WebSocket address to send the logs to.","example":"wss://hostname:port/uri\u0026token=secret","type":"string"},"headers":{"items":{"$ref":"#/components/schemas/v1WebsocketHeader"},"type":"array"}},"required":["address"],"type":"object"},"v1alpha1ForwardableAddress":{"properties":{"cidr":{"description":"Specifies the IP range in CIDR notation that can be forwarded through this link","example":"192.168.2.0/24","type":"string"},"mac":{"description":"The MAC address associated with this forwardable address. If not specified, the link's MAC address will be used.","example":"00:11:22:33:44:55","type":"string"}},"required":["cidr"],"type":"object"},"v1alpha1IOBandwidthLimits":{"properties":{"bandwidth":{"additionalProperties":{"$ref":"#/components/schemas/resourceQuantity"},"type":"object"},"io":{"additionalProperties":{"$ref":"#/components/schemas/resourceQuantity"},"type":"object"}},"required":["io","bandwidth"],"type":"object"},"v1alpha1InstanceTypeLimits":{"description":"The limits for the instance type, including disk I/O bandwidth.","properties":{"disk":{"$ref":"#/components/schemas/v1alpha1IOBandwidthLimits"}},"required":["disk"],"type":"object"},"v1alpha2ExternalIPSpec":{"description":"Desired configuration and characteristics for the external ip","properties":{"boundTo":{"$ref":"#/components/schemas/v1ObjectReference"},"ip":{"description":"The allocated external IPv4 address.","example":"192.168.1.100","type":"string"},"poolName":{"type":"string"},"reserved":{"description":"When set to true, prevents the external IP from being garbage collected even if the target object is removed.","type":"boolean"}},"type":"object"},"v1alpha2ExternalIPState":{"description":"Details of the external IP associated with this link. This field will not be set if the link has no external IP.","properties":{"gateway":{"type":"string"},"ip":{"type":"string"},"name":{"type":"string"}},"type":"object"},"v1alpha2ExternalIPStatus":{"description":"Current observed state and conditions of the external ip","properties":{"gateway":{"description":"The IPv4 gateway address used for routing outgoing traffic from this external IP.","example":"192.168.1.1","type":"string"},"operational":{"description":"Indicates whether the bound target is running and able to receive traffic.","type":"boolean"},"ready":{"description":"Indicates whether the external IP is fully configured and ready to use.","type":"boolean"}},"type":"object"},"v1alpha2InstanceTypeSpec":{"description":"Desired configuration and characteristics for the instance type","properties":{"dedicated":{"description":"Indicates whether the instance type is dedicated or shared.","type":"boolean"},"family":{"description":"The family of the instance type.","enum":["Economy","General Purpose","Compute Optimized","Memory Optimized"],"example":"Economy","type":"string"},"limits":{"$ref":"#/components/schemas/v1alpha1InstanceTypeLimits"},"public":{"description":"Indicates whether the instance type is publicly available.","type":"boolean"},"resources":{"additionalProperties":{"$ref":"#/components/schemas/resourceQuantity"},"description":"The resource specifications for the instance type, including CPU and memory.","type":"object"},"series":{"description":"The specific series of the instance type.","example":"c1d30","type":"string"}},"required":["family","series","dedicated","resources","limits","public"],"type":"object"},"v1alpha2InstanceTypeStatus":{"description":"Current observed state and conditions of the instance type","properties":{"resizableTo":{"description":"A list of other instance types to which a compute instance with this instance type can be resized.","items":{"type":"string"},"type":"array"}},"type":"object"},"v1alpha2LinkSpec":{"description":"Desired configuration and characteristics for the link","properties":{"boundTo":{"$ref":"#/components/schemas/v1ObjectReference"},"externalIPRef":{"$ref":"#/components/schemas/v1LocalObjectReference"},"forwardableAddresses":{"description":"List of addresses that can forward traffic through this link.","example":"[{\"cidr\":\"192.168.2.0/24\",\"mac\":\"00:11:22:33:44:55\"}]","items":{"$ref":"#/components/schemas/v1alpha1ForwardableAddress"},"type":"array"},"ip":{"description":"The IP address assigned to this link. If not specified, a unique IP address will be automatically allocated from the subnet CIDR.","example":"192.168.2.100/24","type":"string"},"subnetName":{"description":"The name of the subnet where this link is placed.","type":"string"},"vpcName":{"description":"Name of the VPC containing this link's subnet.","type":"string"}},"type":"object"},"v1alpha2LinkStatus":{"description":"Current observed state and conditions of the link","properties":{"configured":{"description":"Indicates if the link is properly configured.","type":"boolean"},"created":{"description":"Indicates if the network device has been created.","type":"boolean"},"externalIP":{"$ref":"#/components/schemas/v1alpha2ExternalIPState"},"gatewayIP":{"description":"Gateway IP address of the subnet.","example":"192.168.1.1","type":"string"},"mac":{"description":"MAC address assigned to this link.","example":"00:11:22:33:44:55","type":"string"},"mtu":{"description":"Maximum Transmission Unit (MTU) configured on the network device.","example":"1500","type":"integer"},"operational":{"description":"Indicates if the link is operational.","type":"boolean"},"ready":{"description":"Indicates if the link is ready for use.","type":"boolean"}},"type":"object"},"v1beta1CAA":{"description":"Certificate Authority Authorization record specifying which CAs can issue certificates.","nullable":true,"properties":{"issuerCritical":{"description":"Indicates whether the record must be understood by all CAs (0 = not critical).","type":"integer"},"tag":{"description":"Specifies the CAA tag type: issue, issuewild, or iodef.","type":"string"},"value":{"description":"Tag value defining the CA domain or contact URL.","type":"string"}},"required":["issuerCritical","tag","value"],"type":"object"},"v1beta1CDNCache":{"description":"The cache configuration for the CDN.","nullable":true,"properties":{"version":{"description":"The version of the cache configuration.","example":"1","format":"int32","type":"integer"}},"required":["version"],"type":"object"},"v1beta1CDNCanonicalRedirect":{"description":"The canonical redirect configuration for the CDN.","nullable":true,"properties":{"excludedCidrBlocks":{"description":"The CIDR blocks to exclude from the canonical redirect.","example":"192.168.1.0/24, 10.0.0.0/8","items":{"type":"string"},"type":"array"},"includedCidrBlocks":{"description":"The CIDR blocks to include in the canonical redirect.","example":"192.168.1.0/24, 10.0.0.0/8","items":{"type":"string"},"type":"array"},"matchingFilters":{"description":"The matching filters to canonical redirect.","items":{"$ref":"#/components/schemas/v1beta1MatchingFilter"},"type":"array"},"redirect":{"description":"Whether to redirect matched filters to the canonical hostname.","example":"true","type":"boolean"},"servers":{"description":"The servers to serve the canonical redirect.","example":"mci1, asiatech1","items":{"type":"string"},"type":"array"}},"type":"object"},"v1beta1CDNCustomPage":{"properties":{"content":{"description":"The content of the custom page.","example":"\u003cb\u003eHi\u003c/b\u003e","type":"string"},"statusCode":{"description":"The status code to use for the custom page.","example":"404","format":"int32","type":"integer"}},"required":["statusCode"],"type":"object"},"v1beta1CDNFirewall":{"description":"The firewall field lets you enable security features by creating rules that control access for specific users. Define the rule conditions in constraints, and specify the outcome in action when a request meets those conditions.","nullable":true,"properties":{"enabled":{"description":"Indicates if the firewall is active.","type":"boolean"},"iran_access":{"description":"Specifies whether access from Iran is allowed.","type":"boolean"},"rules":{"description":"List of firewall rules that define access conditions and actions.","items":{"$ref":"#/components/schemas/v1beta1CDNFirewallRule"},"type":"array"}},"type":"object"},"v1beta1CDNFirewallAction":{"description":"The action to take when the rule matches.","nullable":true,"properties":{"basic":{"$ref":"#/components/schemas/v1beta1CDNFirewallBasicAction"},"block":{"$ref":"#/components/schemas/v1beta1CDNFirewallBlockAction"},"captcha":{"$ref":"#/components/schemas/v1beta1CDNFirewallCaptchaAction"},"cookie":{"$ref":"#/components/schemas/v1beta1CDNFirewallCookieAction"},"js":{"$ref":"#/components/schemas/v1beta1CDNFirewallJSAction"},"ratelimit":{"$ref":"#/components/schemas/v1beta1CDNFirewallRatelimitAction"},"redirect":{"$ref":"#/components/schemas/v1beta1CDNFirewallRedirectAction"},"staticPage":{"$ref":"#/components/schemas/v1beta1CDNFirewallStaticPageAction"},"type":{"description":"Specifies the action to take when the rule matches. One of: allow, block, js, captcha, bypass, cookie, ratelimit, basic, redirect, staticPage, waf, cacheBypass, forceTLS. The 'allow' action permits the request regardless of subsequent operations. The 'cacheBypass' action bypasses caching for the request.","example":"block","type":"string"},"waf":{"$ref":"#/components/schemas/v1beta1CDNFirewallWAFAction"}},"required":["type"],"type":"object"},"v1beta1CDNFirewallBasicAction":{"description":"Require basic authentication for the requests.","nullable":true,"properties":{"message":{"description":"Message to return when the basic authentication failed.","example":"Basic authentication required","type":"string"},"password":{"description":"Password for the basic authentication action.","example":"password","type":"string"},"username":{"description":"Username for the basic authentication action.","example":"admin","type":"string"}},"type":"object"},"v1beta1CDNFirewallBlockAction":{"description":"Blocks requests that match the rule.","nullable":true,"properties":{"responseHeaders":{"description":"Response headers to return when the block action is triggered.","items":{"$ref":"#/components/schemas/v1beta1CDNFirewallResponseHeaders"},"type":"array"},"statusCode":{"description":"Status code to return when the block action is triggered.","example":"403","type":"integer"},"template":{"description":"Template to return when the block action is triggered.","example":"default","type":"string"}},"type":"object"},"v1beta1CDNFirewallCaptchaAction":{"description":"Used to differentiate humans from bots, except search engine crawlers.","nullable":true,"properties":{"backend":{"description":"Backend used for the captcha action.","example":"recaptcha","type":"string"},"name":{"description":"Name of the cookie which is used by browser after solving captcha challenge.","example":"captcha_challenge","type":"string"},"recaptcha":{"$ref":"#/components/schemas/v1beta1CDNFirewallRecaptchaBackend"},"salt":{"description":"Salt used for the captcha action when computing hash.","example":"strong_random_string","type":"string"},"template":{"description":"Template used for the captcha action.","example":"default","type":"string"},"ttl":{"description":"Time to live for the captcha action in seconds.","example":"1200","format":"int32","type":"integer"}},"required":["backend"],"type":"object"},"v1beta1CDNFirewallConstraint":{"properties":{"args":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintArgs"},"asn":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintASN"},"cookie":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintCookie"},"country":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintCountry"},"edge":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintEdge"},"header":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintHeader"},"host":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintHost"},"http_version":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintHTTPVersion"},"ip":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintIP"},"known_bots":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintKnownBots"},"method":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintMethod"},"negate":{"description":"Indicates whether to invert the constraint condition.","type":"boolean"},"path":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintPath"},"port":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintPort"},"tls":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintTLS"},"type":{"description":"Specifies the constraint type. One of: asn, cookie, country, header, ip, host, port, method, uri, path, args, http_version, tls, known_bots.","type":"string"},"uri":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraintURI"}},"required":["type"],"type":"object"},"v1beta1CDNFirewallConstraintASN":{"description":"Constraint based on the ASN.","nullable":true,"properties":{"expected":{"description":"ASN values used for comparison.","example":"12345","items":{"format":"int32","type":"integer"},"type":"array"},"operator":{"description":"Specifies the comparison operator for ASN. One of: equals, lesser, greater.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintArgs":{"description":"Constraint based on query parameters.","nullable":true,"properties":{"expected":{"description":"Query string values used for comparison.","example":"a=10, b=20","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the target query string.","type":"string"},"operator":{"description":"Specifies the comparison operator for the query strings. One of: equals, contains, starts_with, ends_with, matches, exists.","type":"string"}},"required":["operator","name"],"type":"object"},"v1beta1CDNFirewallConstraintCookie":{"description":"Constraint based on cookie values.","nullable":true,"properties":{"expected":{"description":"Cookie values used for comparison.","example":"session_id, user_id","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the target cookie.","type":"string"},"operator":{"description":"Specifies the comparison operator for the cookie. One of: equals, contains, starts_with, ends_with, matches, exists.","type":"string"}},"required":["operator","name"],"type":"object"},"v1beta1CDNFirewallConstraintCountry":{"description":"Constraint based on the request’s country.","nullable":true,"properties":{"expected":{"description":"Country codes used for comparison.","example":"IR, US","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the country. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintEdge":{"description":"Constraint based on Edge server.","nullable":true,"properties":{"expected":{"description":"Edge names used for comparison.","example":"afrashn1, mci2","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for edge server name. One of: equals, contains, starts_with, ends_with, matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintHTTPVersion":{"description":"Constraint based on the HTTP version.","nullable":true,"properties":{"expected":{"description":"HTTP version values used for comparison.","example":"HTTP/1.0, HTTP/1.1, HTTP/1.2, HTTP/2, HTTP/3","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the HTTP version. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintHeader":{"description":"Constraint based on HTTP headers.","nullable":true,"properties":{"expected":{"description":"Header values used for comparison.","example":"value1, value2","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the target header.","type":"string"},"operator":{"description":"Specifies the comparison operator for the header. One of: equals, contains, starts_with, ends_with, matches, exists.","type":"string"}},"required":["operator","name"],"type":"object"},"v1beta1CDNFirewallConstraintHost":{"description":"Constraint based on the request host.","nullable":true,"properties":{"expected":{"description":"Host values used for comparison.","example":"example.com, www.example.com, example.org","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the host. One of: equals, contains, starts_with, ends_with, matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintIP":{"description":"Constraint based on IP addresses.","nullable":true,"properties":{"expected":{"description":"IP addresses used for comparison.","example":"8.8.8.8/32, 192.168.1.0/24, 10.0.0.0/8","items":{"type":"string"},"type":"array"},"ipSet":{"description":"IP set name used for comparison.","example":"banned_ips","type":"string"},"operator":{"description":"Specifies the comparison operator for IP addresses. One of: ip_matches.","type":"string"}},"required":["operator"],"type":"object"},"v1beta1CDNFirewallConstraintKnownBots":{"description":"Constraint targeting known bot traffic.","nullable":true,"properties":{"expected":{"description":"Indicates whether the request is from a known bot.","example":"true","type":"boolean"},"operator":{"description":"Specifies the comparison operator for known bots. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintMethod":{"description":"Constraint based on the HTTP method.","nullable":true,"properties":{"expected":{"description":"Method values used for comparison.","example":"GET, POST, PUT, HEAD, OPTIONS, DELETE, PATCH","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the method. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintPath":{"description":"Constraint based on the request path.","nullable":true,"properties":{"expected":{"description":"Path values used for comparison.","example":"/path/to/some/where, /path/to/some/where?a=10","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the path. One of: equals, contains, starts_with, ends_with, matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintPort":{"description":"Constraint based on the request port.","nullable":true,"properties":{"expected":{"description":"Port values used for comparison.","example":"80, 443","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the port. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintTLS":{"description":"Constraint based on TLS attributes.","nullable":true,"properties":{"expected":{"description":"Indicates whether TLS should be enabled.","example":"true","type":"boolean"},"operator":{"description":"Specifies the comparison operator for TLS. One of: equals.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallConstraintURI":{"description":"Constraint based on the request URI.","nullable":true,"properties":{"expected":{"description":"URI values used for comparison.","example":"/path/to/some/where, /path/to/some/where?a=10","items":{"type":"string"},"type":"array"},"operator":{"description":"Specifies the comparison operator for the URI. One of: equals, contains, starts_with, ends_with, matches.","type":"string"}},"required":["operator","expected"],"type":"object"},"v1beta1CDNFirewallCookieAction":{"description":"Checks if requests contain specific cookie.","nullable":true,"properties":{"name":{"description":"Target cookie name.","example":"session_id","type":"string"},"salt":{"description":"Salt value used for the cookie when computing hash.","example":"strong_random_string","type":"string"},"ttl":{"description":"Cookie time-to-live in seconds.","example":"1200","format":"int32","type":"integer"}},"type":"object"},"v1beta1CDNFirewallJSAction":{"description":"Requires users to run a script to detect bots, except search engine crawlers.","nullable":true,"properties":{"name":{"description":"Name of the cookie which is used by browser after solving JS challenge.","example":"js_challenge","type":"string"},"salt":{"description":"Salt used for the JS action when computing hash.","example":"strong_random_string","type":"string"},"template":{"description":"Template used for the JS action.","example":"default","type":"string"},"ttl":{"description":"Time to live for the JS action in seconds.","example":"1200","format":"int32","type":"integer"}},"type":"object"},"v1beta1CDNFirewallQueryStringRecord":{"properties":{"name":{"description":"Name of the query string.","example":"a","type":"string"},"value":{"description":"Value of the query string.","example":"10","type":"string"}},"required":["name","value"],"type":"object"},"v1beta1CDNFirewallRatelimitAction":{"description":"Prevents abuse by limiting the number of requests based on identifiers like ja4, jwt, or ip.","nullable":true,"properties":{"algorithm":{"description":"Algorithm used for the ratelimit action. One of: sliding_window, token_bucket.","example":"sliding_window","type":"string"},"burst":{"description":"Burst of requests.","example":"100","format":"int32","type":"integer"},"identifier":{"$ref":"#/components/schemas/v1beta1CDNFirewallRatelimitIdentifier"},"penalty_period":{"description":"Period of time in seconds that the penalty is applied to when the request exceeds the rate limit.","example":"10","format":"int32","type":"integer"},"period":{"description":"Period of time in seconds that the rate limit is applied to.","example":"3600","format":"int32","type":"integer"},"rate":{"description":"Rate of incoming requests per period that are considered allowed.","example":"100","format":"int32","type":"integer"},"responseHeaders":{"description":"Optional response headers to return when the request exceeds the rate limit.","items":{"$ref":"#/components/schemas/v1beta1CDNFirewallResponseHeaders"},"type":"array"},"statusCode":{"description":"Status code to return when the request exceeds the rate limit.","example":"429","type":"integer"},"template":{"description":"Template to return when the request exceeds the rate limit.","example":"default","type":"string"},"validationStatusCode":{"description":"Status code to return when identifying user by the ratelimit identifier failed.","example":"429","type":"integer"},"validationTemplate":{"description":"Template to return when identifying user by the ratelimit identifier failed.","example":"default","type":"string"}},"required":["rate","identifier"],"type":"object"},"v1beta1CDNFirewallRatelimitIdentifier":{"description":"Identifier used for the ratelimit action.","nullable":true,"properties":{"jwt":{"$ref":"#/components/schemas/v1beta1CDNFirewallRatelimitIdentifierJWT"},"type":{"description":"Type of the ratelimit identifier. One of: ip, jwt, ja4.","example":"ip","type":"string"}},"type":"object"},"v1beta1CDNFirewallRatelimitIdentifierJWT":{"description":"RSA256 JWT Verification for the ratelimit identifier.","example":"your_public_key_here","nullable":true,"properties":{"headerName":{"description":"Header name for the JWT signature verification.","example":"Authorization","type":"string"},"payloadKey":{"description":"Payload key for the JWT signature verification.","example":"sub","type":"string"},"secret":{"description":"Public key for the JWT signature verification.","example":"strong_random_string","type":"string"}},"required":["secret","payloadKey","headerName"],"type":"object"},"v1beta1CDNFirewallRecaptchaBackend":{"description":"Recaptcha backend used for the captcha action.","example":"recaptcha","nullable":true,"properties":{"secret_key":{"description":"Secret key for the recaptcha backend.","example":"6LcWjS4UAAAAAABX-Npi-8nUmriyWY2y67oAM1Y2","type":"string"},"site_key":{"description":"Site key for the recaptcha backend.","example":"6LcWjS4UAAAAAABX-Npi-8nUmriyWY2y67oAM1Y2","type":"string"}},"required":["secret_key","site_key"],"type":"object"},"v1beta1CDNFirewallRedirectAction":{"description":"Redirects requests that match the rule to a target URL.","nullable":true,"properties":{"extraHeaders":{"description":"Extra headers to add to the http redirect response.","items":{"$ref":"#/components/schemas/v1beta1CDNLocationHeader"},"type":"array"},"extraQueryString":{"description":"Extra query strings to add to the redirect URL.","example":"a=10, b=20","items":{"$ref":"#/components/schemas/v1beta1CDNFirewallQueryStringRecord"},"type":"array"},"preservePath":{"description":"Preserves the path in the redirect URL.","example":"true","type":"boolean"},"preserveQueryString":{"description":"Preserves the query string in the redirect URL.","example":"true","type":"boolean"},"referrer":{"description":"Preserves the referrer in the redirect URL.","example":"true","type":"boolean"},"statusCode":{"description":"Status code to return when the redirect action is triggered.","example":"302","type":"integer"},"target":{"description":"Target URL to redirect to.","example":"https://example.com","type":"string"}},"required":["target","statusCode","preserveQueryString","preservePath","referrer"],"type":"object"},"v1beta1CDNFirewallResponseHeaders":{"properties":{"name":{"description":"Name of the response header.","example":"Content-Type","type":"string"},"values":{"description":"Values of the response header.","example":"text/html","items":{"type":"string"},"type":"array"}},"required":["name","values"],"type":"object"},"v1beta1CDNFirewallRule":{"properties":{"action":{"$ref":"#/components/schemas/v1beta1CDNFirewallAction"},"constraints":{"description":"List of constraints that define the conditions for the rule to match. Constraints are evaluated as a Disjunctive Normal Form (DNF) expression, members of each inner array get AND-ed and members of the outer array get OR-ed.","items":{"items":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraint"},"type":"array"},"type":"array"},"description":{"description":"A brief description of the firewall rule.","type":"string"},"enabled":{"description":"Indicates if the firewall rule is active.","type":"boolean"},"name":{"description":"The name of the firewall rule.","type":"string"}},"required":["name","constraints","action"],"type":"object"},"v1beta1CDNFirewallStaticPageAction":{"description":"Serves a static page when the request is blocked.","nullable":true,"properties":{"content":{"description":"Content of the static page.","example":"\u003cp\u003enot found!\u003c/p\u003e","type":"string"},"responseHeaders":{"description":"Response headers to return when the static page action is triggered.","items":{"$ref":"#/components/schemas/v1beta1CDNFirewallResponseHeaders"},"type":"array"},"statusCode":{"description":"Status code to return when the static page action is triggered.","example":"404","type":"integer"}},"required":["statusCode"],"type":"object"},"v1beta1CDNFirewallWAFAction":{"description":"Uses WAF to block requests that match the rule.","nullable":true,"properties":{"name":{"description":"Name of the WAF rule.","example":"waf_rule_1","type":"string"}},"required":["name"],"type":"object"},"v1beta1CDNLocation":{"nullable":true,"properties":{"action":{"description":"The action to take when the request matches the location. One of: proxy_http (proxy the request to the upstream), proxy_grpc (proxy the request to the upstream using gRPC), redirect (redirect the request to the target URL). The 'proxy_http' action proxies the request to the upstream server. The 'proxy_grpc' action proxies the request to the upstream server using gRPC. The 'redirect' action redirects the request to the target URL.","example":"proxy_http","type":"string"},"cache":{"$ref":"#/components/schemas/v1beta1CDNLocationCache"},"cors":{"$ref":"#/components/schemas/v1beta1CDNLocationCORS"},"description":{"description":"A brief description of the location.","example":"This location is used to serve the static files.","type":"string"},"headers":{"$ref":"#/components/schemas/v1beta1CDNLocationHeaders"},"host":{"description":"The host to match the request.","example":"example.com, www.example.com","type":"string"},"imgsvc":{"$ref":"#/components/schemas/v1beta1CDNLocationImageService"},"path":{"description":"The path to match the request.","example":"/*, /api/*, /static/*","type":"string"},"quickcdnIntegrity":{"description":"The QuickCDN integrity for the location.","example":"1234567890","type":"string"},"redirect":{"$ref":"#/components/schemas/v1beta1CDNLocationRedirect"},"rewrite":{"$ref":"#/components/schemas/v1beta1CDNLocationRewrite"},"secureLink":{"description":"Whether to enable secure link for the location.","example":"true","type":"boolean"},"timeout":{"description":"The timeout in seconds for the request.","example":"10","format":"int32","type":"integer"},"upstream":{"description":"The upstream to proxy the request to.","example":"default","type":"string"}},"required":["path"],"type":"object"},"v1beta1CDNLocationCORS":{"description":"The CORS configuration for the location.","nullable":true,"properties":{"allowCredentials":{"description":"Whether to allow credentials for the location.","example":"true","type":"boolean"},"allowHeaders":{"description":"List of headers to allow.","example":"Content-Type, Authorization","items":{"type":"string"},"type":"array"},"allowMethods":{"description":"List of methods to allow.","example":"GET, POST, PUT, DELETE, OPTIONS","items":{"type":"string"},"type":"array"},"allowOrigins":{"description":"List of origins to allow.","example":"https://example.com, https://www.example.com","items":{"type":"string"},"type":"array"},"enabled":{"description":"Whether to enable CORS for the location.","example":"true","type":"boolean"},"exposeHeaders":{"description":"List of headers to expose.","example":"Content-Type, Authorization","items":{"type":"string"},"type":"array"},"maxAge":{"description":"Max age in seconds for the CORS policy.","example":"10","format":"int32","type":"integer"}},"type":"object"},"v1beta1CDNLocationCache":{"description":"The cache configuration for the location.","nullable":true,"properties":{"browserTTL":{"description":"Time-to-live (TTL) in seconds for browser cache.","example":"10","format":"int32","type":"integer"},"cookieKeys":{"description":"List of cookie keys to consider when caching.","example":"session_id, user_id","items":{"type":"string"},"type":"array"},"detectCountry":{"description":"Enable country detection for country-specific caching. If enabled, the content will be cached based on the country.","example":"true","type":"boolean"},"detectDevice":{"description":"Enable device detection for device-specific caching. If enabled, the content will be cached based on the device type.","example":"true","type":"boolean"},"edgeTTL":{"description":"TTL in seconds for edge cache.","example":"10","format":"int32","type":"integer"},"ignoreUpstreamTTL":{"description":"Whether to ignore the cache-control settings set by the upstream server. If enabled, the TTL settings from the upstream server will not be applied.","example":"true","type":"boolean"},"immutable":{"description":"In Immutable mode, the browser does not check for updates on cached content that hasn’t expired, reducing extra requests and improving performance. However, enabling this may risk serving outdated data to users.","example":"true","type":"boolean"},"level":{"description":"Cache level for the location. Options: bypass (skip cache), standard (use standard cache), ignore-query-string (cache ignores query strings).","type":"string"},"noStaleWhileUpdating":{"description":"Disables serving stale cached responses while the cache is being refreshed in the background. When false, stale content may be served during updates.","example":"true","type":"boolean"},"nonSuccessTTL":{"description":"TTL in seconds for caching non-successful responses.","example":"10","format":"int32","type":"integer"},"private":{"description":"Enable private caching for this location.","example":"true","type":"boolean"},"staleTTL":{"description":"TTL in seconds for serving stale content while refreshing cache.","example":"10","format":"int32","type":"integer"},"ttlTimeUnit":{"description":"Time unit for TTL values.","example":"second","type":"string"}},"required":["level"],"type":"object"},"v1beta1CDNLocationHeader":{"properties":{"name":{"description":"The name of the header.","example":"Content-Type","type":"string"},"value":{"description":"The value of the header.","example":"application/json","type":"string"}},"required":["name","value"],"type":"object"},"v1beta1CDNLocationHeaders":{"description":"The headers configuration for the location.","nullable":true,"properties":{"downstream":{"description":"The headers to add to the downstream response. Use can prevent sending some headers by setting the value to an empty string.","items":{"$ref":"#/components/schemas/v1beta1CDNLocationHeader"},"type":"array"},"upstream":{"description":"The headers to add to the upstream response. Use can prevent sending some headers by setting the value to an empty string.","items":{"$ref":"#/components/schemas/v1beta1CDNLocationHeader"},"type":"array"}},"type":"object"},"v1beta1CDNLocationImageService":{"description":"The image service configuration for the location.","nullable":true,"properties":{"defaultPreset":{"description":"The name of the default preset for the image service.","example":"default_preset","type":"string"},"enabled":{"description":"Whether to enable image service for the location.","example":"true","type":"boolean"},"forcedFilter":{"$ref":"#/components/schemas/v1beta1CDNLocationImageServiceForcedFilter"}},"required":["enabled"],"type":"object"},"v1beta1CDNLocationImageServiceForcedFilter":{"description":"The forced filter for the image service.","nullable":true,"properties":{"enabled":{"type":"boolean"},"filter":{"type":"string"}},"required":["enabled"],"type":"object"},"v1beta1CDNLocationRedirect":{"description":"The redirect configuration for the location.","nullable":true,"properties":{"preserveQueryString":{"description":"Whether to preserve the query string when redirecting the request.","example":"true","type":"boolean"},"referrer":{"description":"Whether to preserve the referrer header when redirecting the request.","example":"true","type":"boolean"},"statusCode":{"description":"The status code to return when redirecting the request.","example":"302","type":"integer"},"target":{"description":"The target URL to redirect the request to.","example":"https://example.com","type":"string"}},"required":["target","statusCode","preserveQueryString","referrer"],"type":"object"},"v1beta1CDNLocationRewrite":{"description":"The rewrite configuration for the location.","nullable":true,"properties":{"prefix":{"description":"The prefix to rewrite the request. PCRE expressions are supported.","example":"/salam","type":"string"},"replaceWith":{"description":"The new path to replace the prefix with.","example":"/","type":"string"}},"type":"object"},"v1beta1CDNRoutingAction":{"properties":{"setUpstream":{"$ref":"#/components/schemas/v1beta1CDNSetUpstreamAction"},"type":{"description":"Name of the action. One of: setUpstream","type":"string"}},"required":["type"],"type":"object"},"v1beta1CDNRoutingRule":{"nullable":true,"properties":{"actions":{"description":"List of actions to take when the rule matches.","items":{"$ref":"#/components/schemas/v1beta1CDNRoutingAction"},"type":"array"},"constraints":{"description":"List of constraints that define the conditions for the rule to match. Constraints are evaluated as a Disjunctive Normal Form (DNF) expression, members of each inner array get AND-ed and members of the outer array get OR-ed.","items":{"items":{"$ref":"#/components/schemas/v1beta1CDNFirewallConstraint"},"type":"array"},"type":"array"},"enabled":{"description":"Indicates if the rule is active.","type":"boolean"},"name":{"description":"Name of the rule.","type":"string"}},"required":["name","constraints","actions"],"type":"object"},"v1beta1CDNSecureLink":{"description":"The secure link configuration for the CDN.","nullable":true,"properties":{"considerIP":{"description":"Whether to consider the IP address when generating the secure link.","example":"true","type":"boolean"},"expireName":{"description":"The name of the expire query-string parameter to use for the secure link.","example":"expire","type":"string"},"ignorePath":{"description":"Whether to ignore the path when generating the secure link.","example":"true","type":"boolean"},"secrets":{"description":"The secrets to use for the secure link. The secrets must be 16-32 characters long.","example":"secret1, secret2, secret3","items":{"type":"string"},"type":"array"},"tokenName":{"description":"The name of the token query-string parameter to use for the secure link.","example":"token","type":"string"}},"type":"object"},"v1beta1CDNSetUpstreamAction":{"description":"Set the request's upstream. Note that upstream has to be defined within the same website, otherwise the action won't take effect.","nullable":true,"properties":{"upstreamName":{"description":"Name of the upstream.","type":"string"}},"required":["upstreamName"],"type":"object"},"v1beta1CDNSpec":{"description":"Desired configuration for the CDN","properties":{"authorizeByConfigMap":{"description":"Whether to authorize the CDN by config map. This is just for Sotoon internal usage.","example":"true","type":"boolean"},"cache":{"$ref":"#/components/schemas/v1beta1CDNCache"},"canonicalHostname":{"description":"The canonical hostname of the CDN","example":"example.com","type":"string"},"canonicalRedirect":{"$ref":"#/components/schemas/v1beta1CDNCanonicalRedirect"},"customPages":{"description":"The custom error pages configuration for the CDN.","items":{"$ref":"#/components/schemas/v1beta1CDNCustomPage"},"type":"array"},"defaultHostname":{"description":"The default hostname of the CDN","example":"example.com","type":"string"},"description":{"description":"A brief description of the CDN.","example":"This CDN is used to serve the website for example.com","type":"string"},"development_mode":{"description":"Whether to enable development mode to disable caching mechanism for 3 hours.","example":"true","type":"boolean"},"firewall":{"$ref":"#/components/schemas/v1beta1CDNFirewall"},"hostname":{"description":"The domain name that will be served through the CDN. Can be the root domain or a subdomain.","example":"example.com, www.example.com","type":"string"},"locations":{"description":"The request paths that clients can access and that the CDN proxies to the upstream servers.","items":{"$ref":"#/components/schemas/v1beta1CDNLocation"},"type":"array"},"routingRules":{"description":"Routing rules allow you to rewrite cdn configurations based on constraints, similar to firewall. Each request will be evaluated with each one of the rules in order and the configuration (e.g upstream, cache) will be changed accordingly.","items":{"$ref":"#/components/schemas/v1beta1CDNRoutingRule"},"type":"array"},"secureLink":{"$ref":"#/components/schemas/v1beta1CDNSecureLink"},"tls":{"$ref":"#/components/schemas/v1beta1CDNTLS"},"upstreams":{"description":"The origin servers behind the CDN that provide your website’s content.","items":{"$ref":"#/components/schemas/v1beta1CDNUpstream"},"type":"array"},"wsid":{"description":"The workspace id of the CDN","example":"a4f1902b-3796-147d-afd0-a482090b6bae","type":"string"}},"type":"object"},"v1beta1CDNStatus":{"description":"Current observed state of the CDN","properties":{"conditions":{"description":"Conditions of the CDN resource.","items":{"$ref":"#/components/schemas/v1Condition"},"type":"array"},"desc":{"description":"The description of the CDN.","example":"This CDN is used to serve the website for example.com","type":"string"},"development_mode_disable_timestamp":{"description":"The time when the development mode will be disabled.","example":"1718851200","format":"int64","type":"integer"},"log_forwarders":{"description":"The log forwarders of the CDN.","items":{"$ref":"#/components/schemas/v1beta1LogForwarder"},"type":"array"},"purges":{"description":"The purges of the CDN.","items":{"$ref":"#/components/schemas/v1beta1PurgeRequest"},"type":"array"},"status":{"description":"The status of the CDN.","example":"active","type":"string"},"status_code":{"description":"The status code of the CDN.","example":"200","type":"integer"}},"required":["status","status_code"],"type":"object"},"v1beta1CDNTLS":{"description":"The TLS configuration for the CDN.","nullable":true,"properties":{"auto":{"description":"Automatically generate a TLS certificate for the CDN.","example":"true","type":"boolean"},"clockSkewOffsetHours":{"description":"Hours to account for client clock skew when validating certificates. If a certificate's NotBefore date is within this offset, an older certificate may be used.","example":"1","type":"integer"},"crt":{"description":"TLS certificate in PEM format.","format":"byte","type":"string"},"disableOCSP":{"description":"Disable OCSP stapling for the CDN.","example":"true","type":"boolean"},"dnsNames":{"description":"DNS names to include in the TLS certificate.","example":"example.com, www.example.com","items":{"type":"string"},"type":"array"},"enabled":{"description":"Enable TLS for the CDN.","example":"true","type":"boolean"},"forced":{"description":"Force TLS; the CDN will serve only HTTPS traffic.","example":"true","type":"boolean"},"key":{"description":"Private key in PEM format.","format":"byte","type":"string"},"minVersion":{"description":"Minimum TLS version to enforce.","example":"TLSv1.2","type":"string"},"ocsp":{"description":"OCSP response in PEM format.","format":"byte","type":"string"},"secretName":{"description":"Name of the secret where the TLS certificate is stored.","example":"example-tls","type":"string"},"wildcard":{"description":"Enable wildcard certificate for the CDN (e.g., *.example.com). Requires the domain to be hosted by Sotoon DNS.","example":"true","type":"boolean"}},"type":"object"},"v1beta1CDNUpstream":{"nullable":true,"properties":{"description":{"description":"The description of the upstream.","type":"string"},"haRouting":{"$ref":"#/components/schemas/v1beta1HARouting"},"hc":{"$ref":"#/components/schemas/v1beta1CDNUpstreamHealthCheck"},"hc2":{"$ref":"#/components/schemas/v1beta1CDNUpstreamHealthCheck2"},"hostHeader":{"description":"Specifies a custom Host header to send in requests to the upstream server. If not set, the CDN uses the origin domain if defined, or otherwise (if origin is defined by IP address) the CDN’s own hostname.","example":"example.com","type":"string"},"loadBalancer":{"$ref":"#/components/schemas/v1beta1CDNUpstreamLoadBalancer"},"name":{"description":"The name of the upstream.","example":"upstream1","type":"string"},"passiveThreshold":{"description":"The passive threshold for the upstream. Servers with passive set to true will receive traffic only when the number of available upstream servers reaches or falls below the passiveThreshold value.","type":"integer"},"preferredHealthCheckVersion":{"description":"Specifies the preferred health check version for this upstream.","example":"2","type":"integer"},"quickcdnIntegrity":{"description":"The quickcdn integrity for the upstream.","type":"string"},"scheme":{"description":"The protocol scheme used by the upstream.","example":"http","type":"string"},"servers":{"description":"The servers that make up the upstream.","items":{"$ref":"#/components/schemas/v1beta1CDNUpstreamServer"},"type":"array"},"smartRouting":{"description":"Whether to enable SEO optimizations through smart routing for the upstream.","type":"boolean"}},"required":["name"],"type":"object"},"v1beta1CDNUpstreamHealthCheck":{"description":"The legacy health check configuration for the upstream.","nullable":true,"properties":{"path":{"description":"The path to check the health of the upstream.","example":"/healthz","type":"string"}},"required":["path"],"type":"object"},"v1beta1CDNUpstreamHealthCheck2":{"description":"The modern health check configuration for the upstream.","nullable":true,"properties":{"downThreshold":{"description":"The number of consecutive failed health checks required to mark the server as down.","example":"3","type":"integer"},"http":{"$ref":"#/components/schemas/v1beta1CDNUpstreamHealthCheckHTTP"},"protocol":{"description":"The protocol to use for the health check. One of: http, tcp.","example":"http","type":"string"},"timeoutSeconds":{"description":"The timeout in seconds for the health check.","example":"10","type":"integer"}},"type":"object"},"v1beta1CDNUpstreamHealthCheckHTTP":{"description":"The HTTP health check configuration.","nullable":true,"properties":{"hostHeader":{"description":"The host header to use for the health check.","example":"example.com","type":"string"},"uri":{"description":"The URI to check the health of the upstream.","example":"/healthz","type":"string"}},"required":["uri"],"type":"object"},"v1beta1CDNUpstreamLoadBalancer":{"description":"The load balancer configuration for the upstream.","nullable":true,"properties":{"hashType":{"description":"The hash type to use for the hash load balancing strategy. One of: ip (IP-based hashing), header (header-based hashing).","example":"ip","type":"string"},"headers":{"description":"The headers to use for the hash load balancing strategy.","example":"User-Agent, Referer","items":{"type":"string"},"type":"array"},"strategy":{"description":"The load balancing strategy to use. One of: wrr (weighted round-robin), hash (consistent hashing).","example":"wrr","type":"string"}},"type":"object"},"v1beta1CDNUpstreamServer":{"properties":{"host":{"description":"The host name or IP address of the upstream server.","example":"example.com, 1.2.3.4","type":"string"},"passive":{"description":"Whether to mark the server as passive. Servers with passive set to true will receive traffic only when the number of available upstream servers reaches or falls below the passiveThreshold value.","example":"true","type":"boolean"},"port":{"description":"The port number of the upstream server.","example":"80","format":"int32","type":"integer"},"resolvedIP":{"description":"The resolved IP address of the upstream server. This is just for Sotoon internal usages.","example":"1.2.3.4","type":"string"},"weight":{"description":"The weight of the upstream server used for load balancing such as weighted round-robin or consistent hashing.","example":"100","format":"int32","type":"integer"}},"required":["host","port","weight"],"type":"object"},"v1beta1DS":{"description":"Delegation Signer record for DNSSEC validation.","nullable":true,"properties":{"algorithm":{"description":"DNSSEC algorithm used for signing (0–255).","type":"integer"},"digest":{"description":"Hexadecimal digest string computed from the DNSKEY record.","type":"string"},"digestType":{"type":"integer"},"keyTag":{"description":"Identifier for the referenced DNSKEY record (0–65535).","type":"integer"}},"required":["keyTag","algorithm","digestType","digest"],"type":"object"},"v1beta1DomainZoneSpec":{"description":"Desired configuration for the DomainZone","properties":{"NSDomain":{"description":"(Deprecated) Randomly assigned nameserver domain used in earlier versions.","type":"string"},"authorizeByConfigMap":{"description":"If true, verifies DNS ownership using a predefined ConfigMap. This is used for Sotoon internal usages.","type":"boolean"},"customNameservers":{"description":"Optional user-defined nameservers overriding the system defaults.","items":{"type":"string"},"type":"array"},"dnssec":{"description":"Enables DNSSEC for cryptographic validation of DNS data.","type":"boolean"},"email":{"description":"Administrative contact email associated with the domain (used in SOA records).","example":"info@example.com","type":"string"},"nameservers":{"description":"(Deprecated) Randomly assigned nameserver domain used in earlier versions.","items":{"type":"string"},"type":"array"},"nameserversV4":{"description":"Authoritative nameservers (version 4) from the format [a-z].ns.sotoon53.com.","items":{"type":"string"},"type":"array"},"nsNameserver":{"description":"Shared nameserver name used across the entire Kubernetes namespace.","type":"string"},"origin":{"description":"The base domain or subdomain name this zone manages.","example":"example.com","type":"string"},"records":{"additionalProperties":{"items":{"$ref":"#/components/schemas/v1beta1Record"},"type":"array"},"description":"A collection of DNS record sets, organized by subdomain (e.g., @, *, or api).","type":"object"},"ttl":{"description":"Default record lifetime (in seconds). Determines how long DNS resolvers cache responses.","example":"3600","type":"integer"},"wsid":{"description":"Unique workspace identifier (UUID) used for internal resource association.","example":"4f47fa2b-e72b-4f78-b3b5-c1e1d50b30a7","type":"string"}},"required":["origin"],"type":"object"},"v1beta1DomainZoneStatus":{"description":"Current observed state of the DomainZone","properties":{"reason":{"description":"Human-readable message explaining the current status or failure cause.","type":"string"},"status":{"description":"Current operational state of the domain zone (e.g., Active, Pending, Error).","type":"string"}},"required":["status"],"type":"object"},"v1beta1GeoLocation":{"nullable":true,"properties":{"continent":{"description":"Two-letter continent code (e.g., AS, EU) based on ISO 3166-1.","example":"AS","type":"string"},"country":{"description":"Two-letter country code (e.g., IR, JP) based on ISO 3166-1 alpha-2.","example":"IR","type":"string"}},"required":["continent","country"],"type":"object"},"v1beta1HARouting":{"description":"The high-availability routing configuration for this upstream.","nullable":true,"properties":{"enabled":{"description":"Whether to enable high-availability routing.","example":"true","type":"boolean"},"expiries":{"additionalProperties":{"type":"string"},"description":"The expiries to use for the high-availability routing. Expiries are used for automatic mode and after these times, the routes will be truncated. This is just for Sotoon internal usages.","type":"object"},"expiries_unix":{"additionalProperties":{"format":"int64","type":"integer"},"description":"The expiries to use for the high-availability routing. Expiries are used for automatic mode and after these times, the routes will be truncated. This is just for Sotoon internal usages.","type":"object"},"manual":{"description":"Whether to enable manual high-availability routing. This is just for Sotoon internal usages.","example":"false","type":"boolean"},"routes":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The routes to use for the high-availability routing.","type":"object"}},"type":"object"},"v1beta1HealthCheck":{"description":"Optional probe configuration to check record health using TCP, HTTP, or HTTPS.","nullable":true,"properties":{"enabled":{"description":"Enables or disables health checks for this record.","example":"true","type":"boolean"},"host":{"description":"Hostname used for HTTPS handshake or HTTP header validation (RFC 952 compliant).","example":"example.com","type":"string"},"path":{"description":"Request path for HTTP/HTTPS health checks (max 128 characters).","example":"/health","type":"string"},"port":{"description":"Target port for the check (1–65535).","example":"80","type":"integer"},"protocol":{"description":"Protocol used for the check: tcp, http, or https.","example":"http","type":"string"}},"required":["enabled","protocol","port","host","path"],"type":"object"},"v1beta1IpSetSpec":{"description":"Desired configuration for the IpSet","properties":{"cidrs":{"items":{"type":"string"},"type":"array"}},"required":["cidrs"],"type":"object"},"v1beta1LogForwarder":{"properties":{"constraints":{"description":"The constraints of the log forwarder.","items":{"items":{"$ref":"#/components/schemas/v1LogForwarderConstraint"},"type":"array"},"type":"array"},"name":{"description":"The name of the log forwarder.","example":"example-log-forwarder","type":"string"}},"required":["name"],"type":"object"},"v1beta1MX":{"description":"Mail exchanger record defining priority and mail server hostname.","nullable":true,"properties":{"host":{"description":"Mail server hostname or IP address handling emails for the domain.","type":"string"},"priority":{"description":"Delivery priority; lower values indicate higher preference.","type":"integer"}},"required":["priority","host"],"type":"object"},"v1beta1MatchingFilter":{"nullable":true,"properties":{"hostSuffix":{"description":"The host suffix to match for canonical redirect.","example":"a.example.com","type":"string"},"pathParts":{"description":"The parts of the path to match for canonical redirect.","example":"/path1, /path2","items":{"type":"string"},"type":"array"}},"type":"object"},"v1beta1Opts":{"nullable":true,"properties":{"allowedGeo":{"description":"List of explicitly allowed locations for this option.","items":{"$ref":"#/components/schemas/v1beta1GeoLocation"},"type":"array"},"blockedGeo":{"description":"List of excluded locations for this option.","items":{"$ref":"#/components/schemas/v1beta1GeoLocation"},"type":"array"},"geo":{"description":"List of locations to serve this option from.","items":{"$ref":"#/components/schemas/v1beta1GeoLocation"},"type":"array"},"hc":{"$ref":"#/components/schemas/v1beta1HealthCheck"},"weight":{"description":"Weight for load balancing across multiple endpoints.","nullable":true,"type":"integer"}},"type":"object"},"v1beta1PurgeRequest":{"properties":{"hosts":{"description":"The hosts to purge.","example":"example.com, www.example.com","items":{"type":"string"},"type":"array"},"paths":{"description":"The paths to purge.","example":"/path1/a.png, /path2/a.*, or /path3/*","items":{"type":"string"},"type":"array"},"timestamp":{"description":"The timestamp of the purge request.","example":"1718851200","format":"int64","type":"integer"}},"required":["hosts","paths","timestamp"],"type":"object"},"v1beta1PurgeSpec":{"description":"Desired configuration for the Purge","properties":{"hostname":{"description":"The domain name for which the CDN is created.","example":"example.com","type":"string"},"paths":{"description":"The absolute or prefix paths to purge. Paths ending with * are treated as prefix paths. Limited to 20k specific paths and 1k prefix paths across all purges within a namespace.","example":"/path1/a.png, /path2/a.*, or /path3/*","items":{"type":"string"},"type":"array"},"subdomains":{"description":"The subdomains of the CDN to purge.","example":"sub1.example.com, sub2.example.com, or *.example.com","items":{"type":"string"},"type":"array"}},"required":["hostname","paths"],"type":"object"},"v1beta1PurgeStatus":{"description":"Current observed state of the Purge","properties":{"appliedCDNs":{"items":{"type":"string"},"type":"array"},"status":{"type":"string"}},"required":["status"],"type":"object"},"v1beta1Record":{"properties":{"A":{"description":"List of IPv4 addresses for the record.","items":{"type":"string"},"type":"array"},"AAAA":{"description":"List of IPv6 addresses for the record.","items":{"type":"string"},"type":"array"},"AAAAFallback":{"description":"Fallback IPv6 addresses used when primary ones fail.","items":{"type":"string"},"type":"array"},"AFallback":{"description":"Fallback IPv4 addresses used when primary ones fail.","items":{"type":"string"},"type":"array"},"ALIAS":{"description":"Virtual alias record pointing to another hostname, resolving like a CNAME but at root.","type":"string"},"CAA":{"$ref":"#/components/schemas/v1beta1CAA"},"CNAME":{"description":"Canonical name pointing to another domain.","type":"string"},"DS":{"$ref":"#/components/schemas/v1beta1DS"},"MX":{"$ref":"#/components/schemas/v1beta1MX"},"NS":{"description":"List of authoritative nameservers for the subdomain.","items":{"type":"string"},"type":"array"},"PTR":{"description":"Reverse DNS record mapping IP addresses to domain names.","type":"string"},"SPF":{"description":"Sender Policy Framework record defining mail sender authorization rules.","type":"string"},"SRV":{"$ref":"#/components/schemas/v1beta1SRV"},"TXT":{"description":"Arbitrary text data, often used for verification or configuration keys.","type":"string"},"URI":{"$ref":"#/components/schemas/v1beta1URI"},"allowedGeo":{"description":"Specifies geographic locations explicitly allowed to access this record.","items":{"$ref":"#/components/schemas/v1beta1GeoLocation"},"type":"array"},"blockedGeo":{"description":"Specifies geographic locations where this record should be excluded.","items":{"$ref":"#/components/schemas/v1beta1GeoLocation"},"type":"array"},"geo":{"description":"List of locations (by country or continent) where this record should be served.","items":{"$ref":"#/components/schemas/v1beta1GeoLocation"},"type":"array"},"hc":{"$ref":"#/components/schemas/v1beta1HealthCheck"},"opts":{"description":"Optional settings (geo, weight, and health check) for advanced load balancing options.","items":{"$ref":"#/components/schemas/v1beta1Opts"},"type":"array"},"quickcdn":{"description":"Enables CDN acceleration for this record via the QuickCDN system.","example":"true","type":"boolean"},"ttl":{"description":"Record-specific lifetime in seconds. Overrides spec.ttl when provided.","type":"integer"},"type":{"description":"?","type":"string"},"weight":{"description":"The weight for load balancing; used for shuffling while responding to DNS queries.","nullable":true,"type":"integer"}},"type":"object"},"v1beta1SRV":{"description":"Service locator record defining host and port of specific services (e.g., SIP, LDAP).","nullable":true,"properties":{"port":{"description":"Service port number (1–65535).","type":"integer"},"priority":{"description":"Record priority; lower values are preferred.","type":"integer"},"target":{"description":"Target hostname offering the service.","type":"string"},"weight":{"description":"Load balancing weight among records with the same priority.","type":"integer"}},"required":["priority","weight","port","target"],"type":"object"},"v1beta1URI":{"description":"Uniform Resource Identifier record mapping to a target URI.","nullable":true,"properties":{"priority":{"description":"Record priority; lower numbers are preferred.","type":"integer"},"target":{"description":"URI target (e.g., ftp://ftp.domain.ir).","type":"string"},"weight":{"description":"Load balancing weight for multiple targets.","type":"integer"}},"required":["priority","weight","target"],"type":"object"},"v2CDN":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"kind":{"description":"The string value 'CDN' that identifies the schema","enum":["CDN"],"example":"CDN","type":"string"},"metadata":{"$ref":"#/components/schemas/v2ObjectMeta"},"spec":{"$ref":"#/components/schemas/v1beta1CDNSpec"},"status":{"$ref":"#/components/schemas/v1beta1CDNStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"v2CDNList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"items":{"description":"List of CDN resources","items":{"$ref":"#/components/schemas/v2CDN"},"type":"array"},"kind":{"description":"The string value 'CDNList' that identifies the schema","enum":["CDNList"],"example":"CDNList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"v2DomainZone":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"kind":{"description":"The string value 'DomainZone' that identifies the schema","enum":["DomainZone"],"example":"DomainZone","type":"string"},"metadata":{"$ref":"#/components/schemas/v2ObjectMeta"},"spec":{"$ref":"#/components/schemas/v1beta1DomainZoneSpec"},"status":{"$ref":"#/components/schemas/v1beta1DomainZoneStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"v2DomainZoneList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"items":{"description":"List of DomainZone resources","items":{"$ref":"#/components/schemas/v2DomainZone"},"type":"array"},"kind":{"description":"The string value 'DomainZoneList' that identifies the schema","enum":["DomainZoneList"],"example":"DomainZoneList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"v2IpSet":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"kind":{"description":"The string value 'IpSet' that identifies the schema","enum":["IpSet"],"example":"IpSet","type":"string"},"metadata":{"$ref":"#/components/schemas/v2ObjectMeta"},"spec":{"$ref":"#/components/schemas/v1beta1IpSetSpec"}},"required":["kind","apiVersion","metadata","spec"],"type":"object"},"v2IpSetList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"items":{"description":"List of IpSet resources","items":{"$ref":"#/components/schemas/v2IpSet"},"type":"array"},"kind":{"description":"The string value 'IpSetList' that identifies the schema","enum":["IpSetList"],"example":"IpSetList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"v2LogForwarder":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"kind":{"description":"The string value 'LogForwarder' that identifies the schema","enum":["LogForwarder"],"example":"LogForwarder","type":"string"},"metadata":{"$ref":"#/components/schemas/v2ObjectMeta"},"spec":{"$ref":"#/components/schemas/v1LogForwarderSpec"},"status":{"$ref":"#/components/schemas/v1LogForwarderStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"v2LogForwarderList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"items":{"description":"List of LogForwarder resources","items":{"$ref":"#/components/schemas/v2LogForwarder"},"type":"array"},"kind":{"description":"The string value 'LogForwarderList' that identifies the schema","enum":["LogForwarderList"],"example":"LogForwarderList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"v2ObjectMeta":{"description":"Standard resource metadata fields","properties":{"creationTimestamp":{"$ref":"#/components/schemas/v1Time"},"labels":{"additionalProperties":{"type":"string"},"description":"Labels are key-value pairs attached to resources for organization and categorization","type":"object"},"name":{"description":"User-provided name that uniquely identifies the resource within its workspace","type":"string"},"namespace":{"description":"Namespace is the namespace in which the resource exists","type":"string"},"uid":{"description":"System-generated unique identifier for the resource","example":"00000000-0000-0000-0000-000000000000","type":"string"}},"required":["labels","creationTimestamp","uid","name","namespace"],"type":"object"},"v2Pipeline":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"kind":{"description":"The string value 'Pipeline' that identifies the schema","enum":["Pipeline"],"example":"Pipeline","type":"string"},"metadata":{"$ref":"#/components/schemas/v2ObjectMeta"},"spec":{"$ref":"#/components/schemas/v1PipelineSpec"}},"required":["kind","apiVersion","metadata","spec"],"type":"object"},"v2PipelineList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"items":{"description":"List of Pipeline resources","items":{"$ref":"#/components/schemas/v2Pipeline"},"type":"array"},"kind":{"description":"The string value 'PipelineList' that identifies the schema","enum":["PipelineList"],"example":"PipelineList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"v2Preset":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"kind":{"description":"The string value 'Preset' that identifies the schema","enum":["Preset"],"example":"Preset","type":"string"},"metadata":{"$ref":"#/components/schemas/v2ObjectMeta"},"spec":{"$ref":"#/components/schemas/v1PresetSpec"}},"required":["kind","apiVersion","metadata","spec"],"type":"object"},"v2PresetList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"items":{"description":"List of Preset resources","items":{"$ref":"#/components/schemas/v2Preset"},"type":"array"},"kind":{"description":"The string value 'PresetList' that identifies the schema","enum":["PresetList"],"example":"PresetList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"v2Purge":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"kind":{"description":"The string value 'Purge' that identifies the schema","enum":["Purge"],"example":"Purge","type":"string"},"metadata":{"$ref":"#/components/schemas/v2ObjectMeta"},"spec":{"$ref":"#/components/schemas/v1beta1PurgeSpec"},"status":{"$ref":"#/components/schemas/v1beta1PurgeStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"v2PurgeList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"items":{"description":"List of Purge resources","items":{"$ref":"#/components/schemas/v2Purge"},"type":"array"},"kind":{"description":"The string value 'PurgeList' that identifies the schema","enum":["PurgeList"],"example":"PurgeList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"},"v2Transcode":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"kind":{"description":"The string value 'Transcode' that identifies the schema","enum":["Transcode"],"example":"Transcode","type":"string"},"metadata":{"$ref":"#/components/schemas/v2ObjectMeta"},"spec":{"$ref":"#/components/schemas/v1TranscodeSpec"},"status":{"$ref":"#/components/schemas/v1TranscodeStatus"}},"required":["kind","apiVersion","metadata","spec","status"],"type":"object"},"v2TranscodeList":{"properties":{"apiVersion":{"description":"Version identifier of the API schema","enum":["delivery/v2","delivery/v2.1"],"example":"delivery/v2","type":"string"},"items":{"description":"List of Transcode resources","items":{"$ref":"#/components/schemas/v2Transcode"},"type":"array"},"kind":{"description":"The string value 'TranscodeList' that identifies the schema","enum":["TranscodeList"],"example":"TranscodeList","type":"string"},"metadata":{"$ref":"#/components/schemas/v1ListMeta"}},"required":["kind","apiVersion","metadata","items"],"type":"object"}},"securitySchemes":{"Bearer Token":{"scheme":"bearer","type":"http"}}},"info":{"title":"Sotoon API","version":"0.1.0","x-logo":{"url":"statics/sotoon.svg"}},"openapi":"3.0.3","paths":{"/compute/v2/thr1/images":{"get":{"description":"Retrieves a list of all available operating system images that can be used when creating compute instances.\nImages define the base operating system and pre-installed software that will be deployed on your instances.\n","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymous87bd8cdd"}}},"description":"Successfully retrieved the list of available images. The response includes details about each image\nsuch as the operating system type, version, and other specifications to help you choose the appropriate \nbase system for your workloads.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Images","tags":["Compute"]}},"/compute/v2/thr1/instance-types":{"get":{"description":"Retrieves a list of all available instance types that can be used when creating or updating compute instances.\nInstance types define the hardware specifications including CPU, memory, disk size (for types with local disk),\nand other resources allocated to instances.\n","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineInstanceTypeList"}}},"description":"Successfully retrieved the list of available instance types. The response includes details about each instance type\nsuch as CPU cores, memory size, disk size (if the instance type includes local storage), and other specifications\nto help you choose the appropriate configuration for your workloads.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Instance Types","tags":["Compute"]}},"/compute/v2/thr1/workspaces/{workspaceUUID}/external-ips":{"get":{"description":"Retrieves a list of all external IP addresses in your workspace. External IPs are public IP addresses that can be \nattached to links or load balancers, making your resources accessible from the internet.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIPList"}}},"description":"Successfully retrieved the list of external IP addresses in your workspace. The response includes details about each IP\nsuch as its address, status, and the resource it's attached to (link or load balancer).\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List External IPs","tags":["Compute"]},"post":{"description":"Allocates a new external IP address that can be attached to a link or load balancer. This enables your resources \nto be accessible from the internet with a dedicated public IP address.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"The external IP was successfully created and is being provisioned. \nThe response contains the complete external IP details including the assigned unique identifier and IP address.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Conflict - resource with the same name already exists"}},"summary":"Create External IP","tags":["Compute"]}},"/compute/v2/thr1/workspaces/{workspaceUUID}/external-ips/{resourceId}":{"delete":{"description":"Releases an external IP address. Note that this operation does not automatically detach the IP from associated \nresources (links or load balancers). You must manually detach the IP from any associated resources before deletion.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"The external IP address was successfully released. Before deleting, ensure you have manually detached this IP \nfrom any associated resources (links or load balancers), as this is not done automatically during deletion.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete External IP","tags":["Compute"]},"get":{"description":"Retrieves detailed information about a specific external IP address. External IPs provide public internet access \nto your resources by attaching to links or load balancers.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"Successfully retrieved the details of the specified external IP address, including its configuration, status, \nand the resource it's attached to (link or load balancer).\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get External IP","tags":["Compute"]},"put":{"description":"Updates the configuration of an existing external IP address. This allows you to modify how your external IP \nis configured.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"The external IP configuration was successfully updated. The response contains\nthe complete updated details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update External IP","tags":["Compute"]}},"/compute/v2/thr1/workspaces/{workspaceUUID}/instances":{"get":{"description":"Retrieves a paginated list of all compute instances in the specified workspace. \nThe response includes details about each instance such as its configuration, \nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymous0e3cbd18"}}},"description":"Successfully retrieved the list of compute instances. The response includes\nbasic instance information like name, creation time, specs, and current status.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Instances","tags":["Compute"]},"post":{"description":"Creates a new compute instance in the specified workspace with the provided configuration.\nThe request must include instance specifications like CPU, memory, disk, and networking details.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"description":"The instance was successfully created and is being provisioned. \nThe response contains the complete instance details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Conflict - resource with the same name already exists"}},"summary":"Create Instance","tags":["Compute"]}},"/compute/v2/thr1/workspaces/{workspaceUUID}/instances/{resourceId}":{"delete":{"description":"Permanently removes the specified compute instance from the workspace.\nThis action will stop the instance if running and delete all associated resources.\nThis operation cannot be undone.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The instance and all its associated resources were successfully deleted.\nThe system will clean up any remaining artifacts.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Instance","tags":["Compute"]},"get":{"description":"Retrieves detailed information about a specific compute instance in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"description":"Successfully retrieved the details of the specified compute instance.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Instance","tags":["Compute"]},"put":{"description":"Updates an existing compute instance's configuration. This can include \nmodifications to resources, metadata, or other mutable properties. Some \nchanges may require instance restart to take effect.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"description":"The instance configuration was successfully updated. The response contains\nthe complete updated instance details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update Instance","tags":["Compute"]}},"/compute/v2/thr1/workspaces/{workspaceUUID}/links":{"get":{"description":"Retrieves a list of all network links in your workspace. Links are network interfaces that connect compute instances to subnets, \nenabling network connectivity between your instances and other resources within your virtual network infrastructure.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLinkList"}}},"description":"Successfully retrieved the list of network links in your workspace. The response includes details about each link\nsuch as its name, status, associated instance, and the subnet it connects to.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Links","tags":["Compute"]},"post":{"description":"Creates a new network link to connect a compute instance to a subnet. This enables the instance to communicate \nwith other resources within your virtual network infrastructure.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"description":"The link was successfully created and is being provisioned. \nThe response contains the complete link details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Conflict - resource with the same name already exists"}},"summary":"Create Link","tags":["Compute"]}},"/compute/v2/thr1/workspaces/{workspaceUUID}/links/{resourceId}":{"delete":{"description":"Removes a network link, disconnecting the compute instance from the associated subnet. This operation \nwill terminate network connectivity for the instance through this particular link.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The network link was successfully deleted. The compute instance is no longer connected to the \nassociated subnet through this link.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Link","tags":["Compute"]},"get":{"description":"Retrieves detailed information about a specific network link. A link is a network interface that connects a compute instance \nto a subnet, allowing the instance to communicate with other resources in your virtual network.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"description":"Successfully retrieved the details of the specified network link, including its configuration, status, \nassociated instance, and the subnet it connects to.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Link","tags":["Compute"]},"put":{"description":"Updates the configuration of an existing network link. This allows you to modify how your compute instance \nconnects to your virtual network infrastructure.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"description":"The link configuration was successfully updated. The response contains\nthe complete updated instance details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update Link","tags":["Compute"]}},"/compute/v2/thr1/workspaces/{workspaceUUID}/secrets":{"get":{"description":"Retrieves a list of all secrets available in the specified workspace.\nSecrets are used to store sensitive information such as default password\nof compute instances.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineSecretList"}}},"description":"Successfully retrieved the list of secrets in the workspace.\nThe response includes metadata about each secret but not the actual secret values.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Secrets","tags":["Compute"]}},"/compute/v2/thr1/workspaces/{workspaceUUID}/secrets/{resourceId}":{"get":{"description":"Retrieves detailed information about a specific secret in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineSecret"}}},"description":"Successfully retrieved the details of the specified secret.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Secret","tags":["Compute"]}},"/compute/v2/thr3/images":{"get":{"description":"Retrieves a list of all available operating system images that can be used when creating compute instances.\nImages define the base operating system and pre-installed software that will be deployed on your instances.\n","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymous87bd8cdd"}}},"description":"Successfully retrieved the list of available images. The response includes details about each image\nsuch as the operating system type, version, and other specifications to help you choose the appropriate \nbase system for your workloads.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Images","tags":["Compute"]}},"/compute/v2/thr3/instance-types":{"get":{"description":"Retrieves a list of all available instance types that can be used when creating or updating compute instances.\nInstance types define the hardware specifications including CPU, memory, disk size (for types with local disk),\nand other resources allocated to instances.\n","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineInstanceTypeList"}}},"description":"Successfully retrieved the list of available instance types. The response includes details about each instance type\nsuch as CPU cores, memory size, disk size (if the instance type includes local storage), and other specifications\nto help you choose the appropriate configuration for your workloads.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Instance Types","tags":["Compute"]}},"/compute/v2/thr3/workspaces/{workspaceUUID}/external-ips":{"get":{"description":"Retrieves a list of all external IP addresses in your workspace. External IPs are public IP addresses that can be \nattached to links or load balancers, making your resources accessible from the internet.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIPList"}}},"description":"Successfully retrieved the list of external IP addresses in your workspace. The response includes details about each IP\nsuch as its address, status, and the resource it's attached to (link or load balancer).\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List External IPs","tags":["Compute"]},"post":{"description":"Allocates a new external IP address that can be attached to a link or load balancer. This enables your resources \nto be accessible from the internet with a dedicated public IP address.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"The external IP was successfully created and is being provisioned. \nThe response contains the complete external IP details including the assigned unique identifier and IP address.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Conflict - resource with the same name already exists"}},"summary":"Create External IP","tags":["Compute"]}},"/compute/v2/thr3/workspaces/{workspaceUUID}/external-ips/{resourceId}":{"delete":{"description":"Releases an external IP address. Note that this operation does not automatically detach the IP from associated \nresources (links or load balancers). You must manually detach the IP from any associated resources before deletion.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"The external IP address was successfully released. Before deleting, ensure you have manually detached this IP \nfrom any associated resources (links or load balancers), as this is not done automatically during deletion.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete External IP","tags":["Compute"]},"get":{"description":"Retrieves detailed information about a specific external IP address. External IPs provide public internet access \nto your resources by attaching to links or load balancers.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"Successfully retrieved the details of the specified external IP address, including its configuration, status, \nand the resource it's attached to (link or load balancer).\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get External IP","tags":["Compute"]},"put":{"description":"Updates the configuration of an existing external IP address. This allows you to modify how your external IP \nis configured.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"The external IP configuration was successfully updated. The response contains\nthe complete updated details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update External IP","tags":["Compute"]}},"/compute/v2/thr3/workspaces/{workspaceUUID}/instances":{"get":{"description":"Retrieves a paginated list of all compute instances in the specified workspace. \nThe response includes details about each instance such as its configuration, \nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymous0e3cbd18"}}},"description":"Successfully retrieved the list of compute instances. The response includes\nbasic instance information like name, creation time, specs, and current status.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Instances","tags":["Compute"]},"post":{"description":"Creates a new compute instance in the specified workspace with the provided configuration.\nThe request must include instance specifications like CPU, memory, disk, and networking details.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"description":"The instance was successfully created and is being provisioned. \nThe response contains the complete instance details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Conflict - resource with the same name already exists"}},"summary":"Create Instance","tags":["Compute"]}},"/compute/v2/thr3/workspaces/{workspaceUUID}/instances/{resourceId}":{"delete":{"description":"Permanently removes the specified compute instance from the workspace.\nThis action will stop the instance if running and delete all associated resources.\nThis operation cannot be undone.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The instance and all its associated resources were successfully deleted.\nThe system will clean up any remaining artifacts.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Instance","tags":["Compute"]},"get":{"description":"Retrieves detailed information about a specific compute instance in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"description":"Successfully retrieved the details of the specified compute instance.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Instance","tags":["Compute"]},"put":{"description":"Updates an existing compute instance's configuration. This can include \nmodifications to resources, metadata, or other mutable properties. Some \nchanges may require instance restart to take effect.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"description":"The instance configuration was successfully updated. The response contains\nthe complete updated instance details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update Instance","tags":["Compute"]}},"/compute/v2/thr3/workspaces/{workspaceUUID}/links":{"get":{"description":"Retrieves a list of all network links in your workspace. Links are network interfaces that connect compute instances to subnets, \nenabling network connectivity between your instances and other resources within your virtual network infrastructure.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLinkList"}}},"description":"Successfully retrieved the list of network links in your workspace. The response includes details about each link\nsuch as its name, status, associated instance, and the subnet it connects to.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Links","tags":["Compute"]},"post":{"description":"Creates a new network link to connect a compute instance to a subnet. This enables the instance to communicate \nwith other resources within your virtual network infrastructure.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"description":"The link was successfully created and is being provisioned. \nThe response contains the complete link details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Conflict - resource with the same name already exists"}},"summary":"Create Link","tags":["Compute"]}},"/compute/v2/thr3/workspaces/{workspaceUUID}/links/{resourceId}":{"delete":{"description":"Removes a network link, disconnecting the compute instance from the associated subnet. This operation \nwill terminate network connectivity for the instance through this particular link.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The network link was successfully deleted. The compute instance is no longer connected to the \nassociated subnet through this link.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Link","tags":["Compute"]},"get":{"description":"Retrieves detailed information about a specific network link. A link is a network interface that connects a compute instance \nto a subnet, allowing the instance to communicate with other resources in your virtual network.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"description":"Successfully retrieved the details of the specified network link, including its configuration, status, \nassociated instance, and the subnet it connects to.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Link","tags":["Compute"]},"put":{"description":"Updates the configuration of an existing network link. This allows you to modify how your compute instance \nconnects to your virtual network infrastructure.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"description":"The link configuration was successfully updated. The response contains\nthe complete updated instance details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update Link","tags":["Compute"]}},"/compute/v2/thr3/workspaces/{workspaceUUID}/secrets":{"get":{"description":"Retrieves a list of all secrets available in the specified workspace.\nSecrets are used to store sensitive information such as default password\nof compute instances.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineSecretList"}}},"description":"Successfully retrieved the list of secrets in the workspace.\nThe response includes metadata about each secret but not the actual secret values.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Secrets","tags":["Compute"]}},"/compute/v2/thr3/workspaces/{workspaceUUID}/secrets/{resourceId}":{"get":{"description":"Retrieves detailed information about a specific secret in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineSecret"}}},"description":"Successfully retrieved the details of the specified secret.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Secret","tags":["Compute"]}},"/compute/v2/thr4/images":{"get":{"description":"Retrieves a list of all available operating system images that can be used when creating compute instances.\nImages define the base operating system and pre-installed software that will be deployed on your instances.\n","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymous87bd8cdd"}}},"description":"Successfully retrieved the list of available images. The response includes details about each image\nsuch as the operating system type, version, and other specifications to help you choose the appropriate \nbase system for your workloads.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Images","tags":["Compute"]}},"/compute/v2/thr4/instance-types":{"get":{"description":"Retrieves a list of all available instance types that can be used when creating or updating compute instances.\nInstance types define the hardware specifications including CPU, memory, disk size (for types with local disk),\nand other resources allocated to instances.\n","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineInstanceTypeList"}}},"description":"Successfully retrieved the list of available instance types. The response includes details about each instance type\nsuch as CPU cores, memory size, disk size (if the instance type includes local storage), and other specifications\nto help you choose the appropriate configuration for your workloads.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Instance Types","tags":["Compute"]}},"/compute/v2/thr4/workspaces/{workspaceUUID}/external-ips":{"get":{"description":"Retrieves a list of all external IP addresses in your workspace. External IPs are public IP addresses that can be \nattached to links or load balancers, making your resources accessible from the internet.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIPList"}}},"description":"Successfully retrieved the list of external IP addresses in your workspace. The response includes details about each IP\nsuch as its address, status, and the resource it's attached to (link or load balancer).\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List External IPs","tags":["Compute"]},"post":{"description":"Allocates a new external IP address that can be attached to a link or load balancer. This enables your resources \nto be accessible from the internet with a dedicated public IP address.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"The external IP was successfully created and is being provisioned. \nThe response contains the complete external IP details including the assigned unique identifier and IP address.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Conflict - resource with the same name already exists"}},"summary":"Create External IP","tags":["Compute"]}},"/compute/v2/thr4/workspaces/{workspaceUUID}/external-ips/{resourceId}":{"delete":{"description":"Releases an external IP address. Note that this operation does not automatically detach the IP from associated \nresources (links or load balancers). You must manually detach the IP from any associated resources before deletion.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"The external IP address was successfully released. Before deleting, ensure you have manually detached this IP \nfrom any associated resources (links or load balancers), as this is not done automatically during deletion.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete External IP","tags":["Compute"]},"get":{"description":"Retrieves detailed information about a specific external IP address. External IPs provide public internet access \nto your resources by attaching to links or load balancers.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"Successfully retrieved the details of the specified external IP address, including its configuration, status, \nand the resource it's attached to (link or load balancer).\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get External IP","tags":["Compute"]},"put":{"description":"Updates the configuration of an existing external IP address. This allows you to modify how your external IP \nis configured.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineExternalIP"}}},"description":"The external IP configuration was successfully updated. The response contains\nthe complete updated details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update External IP","tags":["Compute"]}},"/compute/v2/thr4/workspaces/{workspaceUUID}/instances":{"get":{"description":"Retrieves a paginated list of all compute instances in the specified workspace. \nThe response includes details about each instance such as its configuration, \nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymous0e3cbd18"}}},"description":"Successfully retrieved the list of compute instances. The response includes\nbasic instance information like name, creation time, specs, and current status.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Instances","tags":["Compute"]},"post":{"description":"Creates a new compute instance in the specified workspace with the provided configuration.\nThe request must include instance specifications like CPU, memory, disk, and networking details.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"description":"The instance was successfully created and is being provisioned. \nThe response contains the complete instance details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Conflict - resource with the same name already exists"}},"summary":"Create Instance","tags":["Compute"]}},"/compute/v2/thr4/workspaces/{workspaceUUID}/instances/{resourceId}":{"delete":{"description":"Permanently removes the specified compute instance from the workspace.\nThis action will stop the instance if running and delete all associated resources.\nThis operation cannot be undone.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The instance and all its associated resources were successfully deleted.\nThe system will clean up any remaining artifacts.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Instance","tags":["Compute"]},"get":{"description":"Retrieves detailed information about a specific compute instance in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"description":"Successfully retrieved the details of the specified compute instance.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Instance","tags":["Compute"]},"put":{"description":"Updates an existing compute instance's configuration. This can include \nmodifications to resources, metadata, or other mutable properties. Some \nchanges may require instance restart to take effect.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Anonymousd9e93299"}}},"description":"The instance configuration was successfully updated. The response contains\nthe complete updated instance details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update Instance","tags":["Compute"]}},"/compute/v2/thr4/workspaces/{workspaceUUID}/links":{"get":{"description":"Retrieves a list of all network links in your workspace. Links are network interfaces that connect compute instances to subnets, \nenabling network connectivity between your instances and other resources within your virtual network infrastructure.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLinkList"}}},"description":"Successfully retrieved the list of network links in your workspace. The response includes details about each link\nsuch as its name, status, associated instance, and the subnet it connects to.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Links","tags":["Compute"]},"post":{"description":"Creates a new network link to connect a compute instance to a subnet. This enables the instance to communicate \nwith other resources within your virtual network infrastructure.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"description":"The link was successfully created and is being provisioned. \nThe response contains the complete link details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Conflict - resource with the same name already exists"}},"summary":"Create Link","tags":["Compute"]}},"/compute/v2/thr4/workspaces/{workspaceUUID}/links/{resourceId}":{"delete":{"description":"Removes a network link, disconnecting the compute instance from the associated subnet. This operation \nwill terminate network connectivity for the instance through this particular link.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The network link was successfully deleted. The compute instance is no longer connected to the \nassociated subnet through this link.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Link","tags":["Compute"]},"get":{"description":"Retrieves detailed information about a specific network link. A link is a network interface that connects a compute instance \nto a subnet, allowing the instance to communicate with other resources in your virtual network.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"description":"Successfully retrieved the details of the specified network link, including its configuration, status, \nassociated instance, and the subnet it connects to.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Link","tags":["Compute"]},"put":{"description":"Updates the configuration of an existing network link. This allows you to modify how your compute instance \nconnects to your virtual network infrastructure.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineLink"}}},"description":"The link configuration was successfully updated. The response contains\nthe complete updated instance details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update Link","tags":["Compute"]}},"/compute/v2/thr4/workspaces/{workspaceUUID}/secrets":{"get":{"description":"Retrieves a list of all secrets available in the specified workspace.\nSecrets are used to store sensitive information such as default password\nof compute instances.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineSecretList"}}},"description":"Successfully retrieved the list of secrets in the workspace.\nThe response includes metadata about each secret but not the actual secret values.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Secrets","tags":["Compute"]}},"/compute/v2/thr4/workspaces/{workspaceUUID}/secrets/{resourceId}":{"get":{"description":"Retrieves detailed information about a specific secret in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineSecret"}}},"description":"Successfully retrieved the details of the specified secret.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Bad request - invalid configuration provided"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/engineStatus"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Secret","tags":["Compute"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/cdns":{"get":{"description":"Retrieves a paginated list of all CDN objects in the specified workspace.\nThe response includes details about each CDN such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDNList"}}},"description":"Successfully retrieved the list of CDN objects. The response includes\nbasic CDN information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List CDNs","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new CDN object in the specified workspace with the provided configuration.\nThe request must include CDN specifications like name, type, and other configuration details.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"description":"The cdn was successfully created and is being provisioned. \nThe response contains the complete cdn details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create CDN","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/cdns/{resourceId}":{"delete":{"description":"Deletes an existing CDN object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete CDN","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific CDN object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get CDN","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing CDN object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"description":"The cdn was successfully partially updated. \nThe response contains the complete cdn details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update CDN","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing CDN object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"description":"The cdn was successfully updated. \nThe response contains the complete cdn details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update CDN","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/dnssecs":{"get":{"description":"Retrieves a paginated list of all DNSSEC objects in the specified workspace.\nThe response includes details about each DNSSEC such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"List DNSSEC","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new DNSSEC object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Create DNSSEC","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/dnssecs/{resourceId}":{"delete":{"description":"Deletes an existing DNSSEC object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete DNSSEC","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific DNSSEC object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get DNSSEC","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing DNSSEC object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Partial Update DNSSEC","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing DNSSEC object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update DNSSEC","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/domainzones":{"get":{"description":"Retrieves a paginated list of all DomainZone objects in the specified workspace.\nThe response includes details about each DomainZone such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZoneList"}}},"description":"Successfully retrieved the list of DomainZone objects. The response includes\nbasic DomainZone information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List DomainZones","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new DomainZone object in the specified workspace with the provided configuration.\nThe request must include CDN specifications like name, type, and other configuration details.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"description":"The cdn was successfully created and is being provisioned. \nThe response contains the complete domainzone details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create DomainZone","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/domainzones/{resourceId}":{"delete":{"description":"Deletes an existing DomainZone object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete DomainZone","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific DomainZone object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get DomainZone","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing DomainZone object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"description":"The domainzone was successfully partially updated. \nThe response contains the complete domainzone details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update DomainZone","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing DomainZone object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"description":"The domainzone was successfully updated. \nThe response contains the complete domainzone details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update DomainZone","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/ipsets":{"get":{"description":"Retrieves a paginated list of all IpSet objects in the specified workspace.\nThe response includes details about each IpSet such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSetList"}}},"description":"Successfully retrieved the list of IpSet objects. The response includes\nbasic IpSet information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List IpSets","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new IpSet object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"description":"The IpSet was successfully created and is being provisioned. \nThe response contains the complete IpSet details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create IpSet","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/ipsets/{resourceId}":{"delete":{"description":"Deletes an existing IpSet object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete IpSet","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific IpSet object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get IpSet","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing IpSet object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"description":"The IpSet was successfully partially updated. \nThe response contains the complete IpSet details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update IpSet","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing IpSet object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"description":"The IpSet was successfully updated. \nThe response contains the complete IpSet details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update IpSet","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/logforwarders":{"get":{"description":"Retrieves a paginated list of all LogForwarder objects in the specified workspace.\nThe response includes details about each LogForwarder such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarderList"}}},"description":"Successfully retrieved the list of LogForwarder objects. The response includes\nbasic LogForwarder information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List LogForwarders","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new LogForwarder object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"description":"The logForwarder was successfully created and is being provisioned. \nThe response contains the complete logForwarder details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create LogForwarder","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/logforwarders/{resourceId}":{"delete":{"description":"Deletes an existing LogForwarder object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete LogForwarder","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific LogForwarder object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get LogForwarder","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing LogForwarder object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"description":"The logForwarder was successfully partially updated. \nThe response contains the complete logForwarder details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update LogForwarder","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing LogForwarder object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"description":"The logForwarder was successfully updated. \nThe response contains the complete logForwarder details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update LogForwarder","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/pipelines":{"get":{"description":"Retrieves a paginated list of all Pipeline objects in the specified workspace.\nThe response includes details about each Pipeline such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2PipelineList"}}},"description":"Successfully retrieved the list of Pipeline objects. The response includes\nPipeline information like name, creation time and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List Pipelines","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new Pipeline object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"description":"The pipeline was successfully created. \nThe response contains the complete pipeline details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create Pipeline","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/pipelines/{resourceId}":{"delete":{"description":"Deletes an existing Pipeline object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Pipeline","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific Pipeline object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Pipeline","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing Pipeline object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"description":"The pipeline was successfully partially updated. \nThe response contains the complete pipeline details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update Pipeline","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing Pipeline object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"description":"The pipeline was successfully updated. \nThe response contains the complete pipeline details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update Pipeline","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/pixels":{"get":{"description":"Retrieves detailed information about a specific Pixel object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Pixel","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new Pixel object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Create Pixel","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/pixels/{resourceId}":{"delete":{"description":"Deletes an existing Pixel object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Pixel","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific Pixel object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Pixel","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing Pixel object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Partial Update Pixel","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing Pixel object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Pixel","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/presets":{"get":{"description":"Retrieves a paginated list of all Preset objects in the specified workspace.\nThe response includes details about each Preset such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2PresetList"}}},"description":"Successfully retrieved the list of Preset objects. The response includes\nPreset information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List Presets","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new Preset object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"description":"The preset was successfully created. \nThe response contains the complete preset details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create Preset","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/presets/{resourceId}":{"delete":{"description":"Deletes an existing Preset object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Preset","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific Preset object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Preset","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing Preset object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"description":"The preset was successfully partially updated. \nThe response contains the complete preset details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update Preset","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing Preset object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"description":"The preset was successfully updated. \nThe response contains the complete preset details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update Preset","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/purges":{"get":{"description":"Retrieves a paginated list of all Purge objects in the specified workspace.\nThe response includes details about each Purge such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2PurgeList"}}},"description":"Successfully retrieved the list of Purge objects. The response includes\nPurge information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List Purges","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new Purge object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"description":"The purge was successfully created. \nThe response contains the complete purge details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create Purge","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/purges/{resourceId}":{"delete":{"description":"Deletes an existing Purge object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Purge","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific Purge object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Purge","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing Purge object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"description":"The purge was successfully partially updated. \nThe response contains the complete purge details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update Purge","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing Purge object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"description":"The purge was successfully updated. \nThe response contains the complete purge details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update Purge","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/secrets":{"get":{"description":"Retrieves detailed information about a specific Secret object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Secret","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new Secret object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Create Secret","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/secrets/{resourceId}":{"delete":{"description":"Deletes an existing Secret object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Secret","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific Secret object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Secret","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing Secret object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Partial Update Secret","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing Secret object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Secret","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/transcodes":{"get":{"description":"Retrieves a paginated list of all Transcode objects in the specified workspace.\nThe response includes details about each Transcode such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2TranscodeList"}}},"description":"Successfully retrieved the list of Transcode objects. The response includes\nTranscode information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List Transcode","tags":["CDN and DNS (v2.1)"]},"post":{"description":"Creates a new Transcode object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"description":"The transcode was successfully created. \nThe response contains the complete transcode details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create Transcode","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2.1/global/workspaces/{workspaceUUID}/transcodes/{resourceId}":{"delete":{"description":"Deletes an existing Transcode object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Transcode","tags":["CDN and DNS (v2.1)"]},"get":{"description":"Retrieves detailed information about a specific Transcode object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Transcode","tags":["CDN and DNS (v2.1)"]},"patch":{"description":"Partially updates an existing Transcode object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"description":"The transcode was successfully partially updated. \nThe response contains the complete transcode details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update Transcode","tags":["CDN and DNS (v2.1)"]},"put":{"description":"Updates an existing Transcode object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"description":"The transcode was successfully updated. \nThe response contains the complete transcode details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update Transcode","tags":["CDN and DNS (v2.1)"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/cdns":{"get":{"description":"Retrieves a paginated list of all CDN objects in the specified workspace.\nThe response includes details about each CDN such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDNList"}}},"description":"Successfully retrieved the list of CDN objects. The response includes\nbasic CDN information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List CDNs","tags":["CDN and DNS"]},"post":{"description":"Creates a new CDN object in the specified workspace with the provided configuration.\nThe request must include CDN specifications like name, type, and other configuration details.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"description":"The cdn was successfully created and is being provisioned. \nThe response contains the complete cdn details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create CDN","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/cdns/{resourceId}":{"delete":{"description":"Deletes an existing CDN object in the specified workspace.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete CDN","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific CDN object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get CDN","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing CDN object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"description":"The cdn was successfully partially updated. \nThe response contains the complete cdn details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update CDN","tags":["CDN and DNS"]},"put":{"description":"Updates an existing CDN object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2CDN"}}},"description":"The cdn was successfully updated. \nThe response contains the complete cdn details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update CDN","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/dnssecs":{"get":{"description":"Retrieves a paginated list of all DNSSEC objects in the specified workspace.\nThe response includes details about each DNSSEC such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"List DNSSEC","tags":["CDN and DNS"]},"post":{"description":"Creates a new DNSSEC object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Create DNSSEC","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/dnssecs/{resourceId}":{"delete":{"description":"Deletes an existing DNSSEC object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete DNSSEC","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific DNSSEC object in the specified workspace.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get DNSSEC","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing DNSSEC object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Partial Update DNSSEC","tags":["CDN and DNS"]},"put":{"description":"Updates an existing DNSSEC object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update DNSSEC","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/domainzones":{"get":{"description":"Retrieves a paginated list of all DomainZone objects in the specified workspace.\nThe response includes details about each DomainZone such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZoneList"}}},"description":"Successfully retrieved the list of DomainZone objects. The response includes\nbasic DomainZone information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List DomainZones","tags":["CDN and DNS"]},"post":{"description":"Creates a new DomainZone object in the specified workspace with the provided configuration.\nThe request must include CDN specifications like name, type, and other configuration details.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"description":"The cdn was successfully created and is being provisioned. \nThe response contains the complete domainzone details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create DomainZone","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/domainzones/{resourceId}":{"delete":{"description":"Deletes an existing DomainZone object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete DomainZone","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific DomainZone object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get DomainZone","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing DomainZone object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"description":"The domainzone was successfully partially updated. \nThe response contains the complete domainzone details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update DomainZone","tags":["CDN and DNS"]},"put":{"description":"Updates an existing DomainZone object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2DomainZone"}}},"description":"The domainzone was successfully updated. \nThe response contains the complete domainzone details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update DomainZone","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/ipsets":{"get":{"description":"Retrieves a paginated list of all IpSet objects in the specified workspace.\nThe response includes details about each IpSet such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSetList"}}},"description":"Successfully retrieved the list of IpSet objects. The response includes\nbasic IpSet information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List IpSets","tags":["CDN and DNS"]},"post":{"description":"Creates a new IpSet object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"description":"The IpSet was successfully created and is being provisioned. \nThe response contains the complete IpSet details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create IpSet","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/ipsets/{resourceId}":{"delete":{"description":"Deletes an existing IpSet object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete IpSet","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific IpSet object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get IpSet","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing IpSet object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"description":"The IpSet was successfully partially updated. \nThe response contains the complete IpSet details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update IpSet","tags":["CDN and DNS"]},"put":{"description":"Updates an existing IpSet object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2IpSet"}}},"description":"The IpSet was successfully updated. \nThe response contains the complete IpSet details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update IpSet","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/logforwarders":{"get":{"description":"Retrieves a paginated list of all LogForwarder objects in the specified workspace.\nThe response includes details about each LogForwarder such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarderList"}}},"description":"Successfully retrieved the list of LogForwarder objects. The response includes\nbasic LogForwarder information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List LogForwarders","tags":["CDN and DNS"]},"post":{"description":"Creates a new LogForwarder object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"description":"The logForwarder was successfully created and is being provisioned. \nThe response contains the complete logForwarder details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create LogForwarder","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/logforwarders/{resourceId}":{"delete":{"description":"Deletes an existing LogForwarder object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete LogForwarder","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific LogForwarder object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get LogForwarder","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing LogForwarder object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"description":"The logForwarder was successfully partially updated. \nThe response contains the complete logForwarder details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update LogForwarder","tags":["CDN and DNS"]},"put":{"description":"Updates an existing LogForwarder object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2LogForwarder"}}},"description":"The logForwarder was successfully updated. \nThe response contains the complete logForwarder details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update LogForwarder","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/pipelines":{"get":{"description":"Retrieves a paginated list of all Pipeline objects in the specified workspace.\nThe response includes details about each Pipeline such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2PipelineList"}}},"description":"Successfully retrieved the list of Pipeline objects. The response includes\nPipeline information like name, creation time and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List Pipelines","tags":["CDN and DNS"]},"post":{"description":"Creates a new Pipeline object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"description":"The pipeline was successfully created. \nThe response contains the complete pipeline details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create Pipeline","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/pipelines/{resourceId}":{"delete":{"description":"Deletes an existing Pipeline object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Pipeline","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific Pipeline object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Pipeline","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing Pipeline object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"description":"The pipeline was successfully partially updated. \nThe response contains the complete pipeline details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update Pipeline","tags":["CDN and DNS"]},"put":{"description":"Updates an existing Pipeline object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Pipeline"}}},"description":"The pipeline was successfully updated. \nThe response contains the complete pipeline details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update Pipeline","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/pixels":{"get":{"description":"Retrieves detailed information about a specific Pixel object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Pixel","tags":["CDN and DNS"]},"post":{"description":"Creates a new Pixel object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Create Pixel","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/pixels/{resourceId}":{"delete":{"description":"Deletes an existing Pixel object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Pixel","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific Pixel object in the specified workspace.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Pixel","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing Pixel object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Partial Update Pixel","tags":["CDN and DNS"]},"put":{"description":"Updates an existing Pixel object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Pixel","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/presets":{"get":{"description":"Retrieves a paginated list of all Preset objects in the specified workspace.\nThe response includes details about each Preset such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2PresetList"}}},"description":"Successfully retrieved the list of Preset objects. The response includes\nPreset information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List Presets","tags":["CDN and DNS"]},"post":{"description":"Creates a new Preset object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"description":"The preset was successfully created. \nThe response contains the complete preset details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create Preset","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/presets/{resourceId}":{"delete":{"description":"Deletes an existing Preset object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Preset","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific Preset object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Preset","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing Preset object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"description":"The preset was successfully partially updated. \nThe response contains the complete preset details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update Preset","tags":["CDN and DNS"]},"put":{"description":"Updates an existing Preset object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Preset"}}},"description":"The preset was successfully updated. \nThe response contains the complete preset details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update Preset","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/purges":{"get":{"description":"Retrieves a paginated list of all Purge objects in the specified workspace.\nThe response includes details about each Purge such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2PurgeList"}}},"description":"Successfully retrieved the list of Purge objects. The response includes\nPurge information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List Purges","tags":["CDN and DNS"]},"post":{"description":"Creates a new Purge object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"description":"The purge was successfully created. \nThe response contains the complete purge details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create Purge","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/purges/{resourceId}":{"delete":{"description":"Deletes an existing Purge object in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Purge","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific Purge object in the specified workspace.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Purge","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing Purge object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"description":"The purge was successfully partially updated. \nThe response contains the complete purge details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update Purge","tags":["CDN and DNS"]},"put":{"description":"Updates an existing Purge object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Purge"}}},"description":"The purge was successfully updated. \nThe response contains the complete purge details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update Purge","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/secrets":{"get":{"description":"Retrieves detailed information about a specific Secret object in the specified workspace.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Secret","tags":["CDN and DNS"]},"post":{"description":"Creates a new Secret object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Create Secret","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/secrets/{resourceId}":{"delete":{"description":"Deletes an existing Secret object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Secret","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific Secret object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Secret","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing Secret object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Partial Update Secret","tags":["CDN and DNS"]},"put":{"description":"Updates an existing Secret object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Secret","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/transcodes":{"get":{"description":"Retrieves a paginated list of all Transcode objects in the specified workspace.\nThe response includes details about each Transcode such as its configuration,\nstatus, and metadata. Results can be filtered using query parameters.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2TranscodeList"}}},"description":"Successfully retrieved the list of Transcode objects. The response includes\nTranscode information like name, creation time, and status.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"List Transcode","tags":["CDN and DNS"]},"post":{"description":"Creates a new Transcode object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"description":"The transcode was successfully created. \nThe response contains the complete transcode details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"},"409":{"description":"Conflict - resource with the same name already exists"}},"summary":"Create Transcode","tags":["CDN and DNS"]}},"/delivery/v2/global/workspaces/{workspaceUUID}/namespaces/{workspaceName}/transcodes/{resourceId}":{"delete":{"description":"Deletes an existing Transcode object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Transcode","tags":["CDN and DNS"]},"get":{"description":"Retrieves detailed information about a specific Transcode object in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Transcode","tags":["CDN and DNS"]},"patch":{"description":"Partially updates an existing Transcode object in the specified workspace with the provided configuration.\n","parameters":[{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"description":"The transcode was successfully partially updated. \nThe response contains the complete transcode details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Partial Update Transcode","tags":["CDN and DNS"]},"put":{"description":"Updates an existing Transcode object in the specified workspace with the provided configuration.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"Name of the workspace","example":"","in":"path","name":"workspaceName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2Transcode"}}},"description":"The transcode was successfully updated. \nThe response contains the complete transcode details including the assigned unique identifier.\n"},"400":{"description":"Bad Request - invalid request payload or parameters"},"401":{"description":"Unauthorized - invalid or expired authentication token"},"403":{"description":"Forbidden - insufficient permissions"}},"summary":"Update Transcode","tags":["CDN and DNS"]}},"/iam/v1/api/v1/accept-invitation/{token}/":{"post":{"description":"Accepts an invitation token for a new pending user and sets their name and password.\nThis endpoint is used to complete the user registration process after receiving an invitation.\n","operationId":"AcceptInvitation","parameters":[{"description":"token","example":"","in":"path","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserAcceptInvitation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUser"}}},"description":"Invitation has been successfully accepted. The user account has been created and activated.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"A pending user with the given invitation token not found"}},"summary":"Accept Invitation","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/authn/":{"post":{"description":"Creates a new authentication token given a user email and password, and sets `TOKEN` cookie.\nIn case of Multi-Step Authentication, it requests a challenge instead of directly creating a token.\n","operationId":"CreateAuthTokenWithCred","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamLoginRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamChallenge"}}},"description":"Multi-Step Authentication is required. A challenge has been generated\nand must be answered to complete the authentication process.\n"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserTokenWithCredCreate"}}},"description":"Authentication was successful and a token has been created.\nThe token is returned in the response and also set as a cookie.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"User with the given email not found"}},"summary":"Create Authentication Token","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/authn/challenge/":{"post":{"description":"Completes the authentication process by providing the answer to a previously\nissued challenge. If successful, creates a new authentication token.\n","operationId":"CreateAuthTokenWithChallenge","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamChallengeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamChallenge"}}},"description":"Another challenge has been generated and must be answered to complete\nthe authentication process.\n"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserTokenWithCredCreate"}}},"description":"Challenge was successfully answered and authentication is complete.\nA token has been created and returned in the response.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Complete Challenge Authentication","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/detailed/workspace/{workspaceUUID}/group/":{"get":{"description":"Lists all groups in the specified workspace with detailed information,\nincluding members and roles.\n","operationId":"ListDetailedGroups","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamGroupDetail"},"type":"array"}}},"description":"Successfully retrieved the list of groups with detailed information.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Detailed Groups","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/detailed/workspace/{workspaceUUID}/group/{groupUUID}/":{"get":{"description":"Retrieves detailed information about a specific group in the workspace,\nincluding members and roles.\n","operationId":"GetDetailedGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamGroupDetail"}}},"description":"Successfully retrieved the detailed information for the specified group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Detailed Group","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/detailed/workspace/{workspaceUUID}/service-user/":{"get":{"description":"Lists all service users in the specified workspace with detailed information,\nincluding roles and permissions.\n","operationId":"ListDetailedServiceUsers","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUserDetailed"},"type":"array"}}},"description":"Successfully retrieved the list of service users with detailed information.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Detailed Service Users","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/detailed/workspace/{workspaceUUID}/service-user/{serviceUserUUID}/":{"get":{"description":"Retrieves comprehensive information about a specific service user in the workspace,\nincluding roles, permissions, and related resources.\n","operationId":"GetDetailedServiceUser","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserDetailed"}}},"description":"Successfully retrieved the detailed information for the specified service user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Detailed Service User","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/detailed/workspace/{workspaceUUID}/user/":{"get":{"description":"Lists all users in the specified workspace with detailed information,\nincluding roles, permissions, and related resources.\nOptionally filter users by email using the email query parameter.\n","operationId":"ListDetailedWorkspaceUsers","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Filter users by email address","in":"query","name":"email","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUserWorkspaceDetailedUser"},"type":"array"}}},"description":"Successfully retrieved the list of users with detailed information.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Detailed Workspace Users","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/detailed/workspace/{workspaceUUID}/user/{userUUID}/":{"get":{"description":"Retrieves comprehensive information about a specific user in the workspace,\nincluding roles, permissions, and related resources.\n","operationId":"GetDetailedWorkspaceUser","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserWorkspaceDetailedUser"}}},"description":"Successfully retrieved the detailed information for the specified user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Detailed Workspace User","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/healthz/":{"get":{"description":"check the health status of IAM service","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamHealthzResponse"}}},"description":"service is healthy"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamHealthzResponse"}}},"description":"service is not healthy"}},"summary":"Health-check endpoint","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/organizations/{organizationUUID}/third-parties/{thirdPartyUUID}/access-tokens":{"post":{"description":"Obtains an access token for a third-party service within an organization.\nThis endpoint facilitates integration with external services by managing authentication tokens.\n","operationId":"GetThirdPartyAccessToken","parameters":[{"description":"UUID of the third party","example":"","in":"path","name":"thirdPartyUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the organization","example":"","in":"path","name":"organizationUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamThirdPartyTokenRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamThirdPartyTokenResponse"}}},"description":"Successfully retrieved the third-party access token.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Third-Party Access Token","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/change-password/{token}/":{"post":{"description":"Changes the password of the user with the given token retrieved from the password-reset email.\nThis endpoint is used to complete the password reset process.\n","operationId":"ChangePassword","parameters":[{"description":"token","example":"","in":"path","name":"token","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamChangePasswordRequest"}}},"required":true},"responses":{"200":{"description":"Password has been successfully changed. The user can now log in with the new password.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"User not found or invalid/expired token"}},"summary":"Change Password","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/reset-password/":{"post":{"description":"Initiates the password reset process for a user with the given email address.\nA password reset link will be sent to the user's email if the account exists.\n","operationId":"ResetPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamPasswordResetRequest"}}},"required":true},"responses":{"200":{"description":"Password reset process has been initiated. If the email address is associated\nwith a valid account, a password reset link will be sent to that email.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Reset Password","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/{userUUID}/":{"get":{"description":"Retrieves detailed information about a specific user.\n","operationId":"GetUser","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUser"}}},"description":"Successfully retrieved the details of the specified user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get User","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/{userUUID}/bulk-can/workspace/{workspaceUUID}":{"post":{"description":"Checks if the specified user has access to perform the requested actions on the given services and paths within the workspace.\nThis endpoint allows checking multiple permissions in a single request, reducing the number of API calls needed for permission verification.\n","operationId":"bulkCanUser","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUserBulkCanRequestItem"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUserBulkCanResponseItem"},"type":"array"}}},"description":"Returns the results of the permission check for each requested service, path, and action combination.\nEach item in the response includes the original request details along with an \"allowed\" boolean indicating whether the permission is granted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Bulk can user","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/{userUUID}/otp/":{"delete":{"description":"Disables One-Time Password (OTP) authentication for the specified user.\n","operationId":"DisableUserOtp","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"OTP has been successfully disabled for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Disable User OTP","tags":["IAM (Identity \u0026 Access Management)"]},"get":{"description":"Checks whether One-Time Password (OTP) is enabled for the specified user.\n","operationId":"GetUserOtpStatus","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamOtpEnabled"}}},"description":"Successfully retrieved the OTP status for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get User OTP Status","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Enables One-Time Password (OTP) authentication for the specified user.\n","operationId":"EnableUserOtp","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserOTP"}}},"required":true},"responses":{"200":{"description":"OTP has been successfully enabled for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Enable User OTP","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/{userUUID}/public-key/":{"get":{"description":"Lists all public keys associated with the specified user.\n","operationId":"ListUserPublicKeys","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUserPublicKey"},"type":"array"}}},"description":"Successfully retrieved the list of public keys for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List User Public Keys","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new public key for the specified user.\n","operationId":"CreateUserPublicKey","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRequestCreateUserPublicKey"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserPublicKey"}}},"description":"Public key has been successfully created for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Duplicate key or title - the key already exists or the title is already in use"}},"summary":"Create User Public Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/{userUUID}/public-key/policy/":{"get":{"description":"Retrieves the public key security policy applied to the specified user,\nincluding whether a FIDO key is forced and which public key types are required.\n","operationId":"GetUserPublicKeyPolicy","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamPublicKeyPolicy"}}},"description":"Successfully retrieved the public key security policy for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"User with the given UUID not found"}},"summary":"Get User Public Key Policy","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/{userUUID}/public-key/{resourceId}/":{"delete":{"description":"Deletes a specific public key associated with the specified user.\n","operationId":"DeleteUserPublicKey","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Public key has been successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete User Public Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/{userUUID}/user-token/":{"get":{"description":"Lists all authentication tokens associated with the specified user.\n","operationId":"ListUserTokens","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUserToken"},"type":"array"}}},"description":"Successfully retrieved the list of tokens for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List User Tokens","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new authentication token for the specified user.\n","operationId":"CreateUserToken","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamReuqestUserTokenCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserToken"}}},"description":"Authentication token has been successfully created for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create User Token","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/{userUUID}/user-token/{resourceUUID}/":{"delete":{"description":"Deletes a specific authentication token associated with the specified user.\nThis operation cannot be undone and will immediately invalidate the token.\n","operationId":"DeleteUserToken","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"Resource UUID","example":"","in":"path","name":"resourceUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Authentication token has been successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete User Token","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/user/{userUUID}/workspace/":{"get":{"description":"Lists all workspaces that the specified user has access to.\n","operationId":"ListUserWorkspaces","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"Organization English Name","in":"query","name":"org_name","schema":{"type":"string"}},{"description":"Workspace Name","in":"query","name":"name","schema":{"type":"string"}},{"description":"worksapce uuid","in":"query","name":"workspace_uuid","schema":{"type":"string"}},{"description":"Include master workspaces, default is False","in":"query","name":"include_master","schema":{"type":"string"}},{"description":"Include suspended workspaces, default is False","in":"query","name":"include_suspended","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUserWorkspace"},"type":"array"}}},"description":"Successfully retrieved the list of workspaces for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List User Workspaces","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/backup-key/":{"get":{"description":"Lists all backup SSH keys associated with the specified workspace.\n","operationId":"ListBackupKeys","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamBackupKey"},"type":"array"}}},"description":"Successfully retrieved the list of backup keys for the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Backup Keys","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new backup SSH key for the specified workspace.\n","operationId":"CreateBackupKey","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRequestCreateBackupKey"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamBackupKey"}}},"description":"Backup key has been successfully created for the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Duplicate key or title - the key already exists or the title is already in use"}},"summary":"Create Backup Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/backup-key/{resourceUUID}/":{"delete":{"description":"Deletes a specific backup SSH key associated with the specified workspace.\n","operationId":"DeleteBackupKey","parameters":[{"description":"Resource UUID","example":"","in":"path","name":"resourceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Backup key has been successfully deleted from the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Backup Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/":{"get":{"description":"Lists all groups in the specified workspace.\n","operationId":"ListGroups","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamGroup"},"type":"array"}}},"description":"Successfully retrieved the list of groups in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Groups","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new group in the specified workspace.\n","operationId":"CreateGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRequestCreateGroup"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamGroup"}}},"description":"Group has been successfully created in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create Group","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/{groupUUID}/":{"delete":{"description":"Deletes the specified group from the workspace.\nThis operation cannot be undone.\n","operationId":"DeleteGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Group has been successfully deleted from the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Group","tags":["IAM (Identity \u0026 Access Management)"]},"get":{"description":"Retrieves detailed information about a specific group in the specified workspace.\n","operationId":"GetGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamGroup"}}},"description":"Successfully retrieved the details of the specified group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Group","tags":["IAM (Identity \u0026 Access Management)"]},"put":{"description":"Updates the specified group in the workspace with new information.\nThis replaces all group properties with the provided values.\n","operationId":"UpdateGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRequestCreateGroup"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamGroup"}}},"description":"Group has been successfully updated with the provided information.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update Group","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/{groupUUID}/bulk-add-roles/":{"post":{"description":"Assigns multiple roles to the specified group in the workspace in a single operation.\nIf multiple items are provided, role bindings will be created for each unique set of (role, item).\nIf no items list is provided, a single role binding with null value for its items will be created.\n","operationId":"BulkAddRolesToGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamBulkAddRolesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamRoleBinding"},"type":"array"}}},"description":"Roles have been successfully assigned to the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Bulk Add Roles to Group","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/{groupUUID}/bulk-add-service-users/":{"post":{"description":"Adds multiple service users to the specified group in the workspace in a single operation.\n","operationId":"BulkAddServiceUsersToGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamBulkAddServiceUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUserGroup"},"type":"array"}}},"description":"Service users have been successfully added to the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Bulk Add Service Users to Group","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/{groupUUID}/bulk-add-users/":{"post":{"description":"Adds multiple users to the specified group in the workspace in a single operation.\n","operationId":"BulkAddUsersToGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamBulkAddUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUserGroup"},"type":"array"}}},"description":"Users have been successfully added to the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Bulk Add Users to Group","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/{groupUUID}/role/":{"get":{"description":"Lists all roles assigned to the specified group in the workspace.\nThis endpoint provides information about the permissions and access levels\ngranted to the group.\n","operationId":"ListGroupRoles","parameters":[{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamRole"},"type":"array"}}},"description":"Successfully retrieved the list of roles assigned to the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Group Roles","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/{groupUUID}/service-user/":{"get":{"description":"Lists all service users that are members of the specified group in the workspace.\n","operationId":"ListGroupServiceUsers","parameters":[{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUser"},"type":"array"}}},"description":"Successfully retrieved the list of service users that are members of the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Group Service Users","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/{groupUUID}/service-user/{serviceUserUUID}/":{"delete":{"description":"Removes a specific service user from the specified group in the workspace.\n","operationId":"RemoveServiceUserFromGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Service user has been successfully removed from the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Remove Service User from Group","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Adds a specific service user to the specified group in the workspace.\n","operationId":"AddServiceUserToGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUser"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserGroupResponse"}}},"description":"Service user has been successfully added to the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Add Service User to Group","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/{groupUUID}/user/":{"get":{"description":"Lists all users that are members of the specified group in the workspace.\n","operationId":"ListGroupUsers","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUser"},"type":"array"}}},"description":"Successfully retrieved the list of users that are members of the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Group Users","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/group/{groupUUID}/user/{userUUID}/":{"delete":{"description":"Removes a specific user from the specified group in the workspace.\n","operationId":"RemoveUserFromGroup","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"User has been successfully removed from the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Remove User from Group","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Adds a specific user to the specified group in the workspace.\n","operationId":"AddUserToGroup","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamCreateUser"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserGroup"}}},"description":"User has been successfully added to the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Add User to Group","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/invite/":{"post":{"description":"Invites users with the given email addresses to the specified workspace.\nInvitation emails will be sent to addresses that do not have an account.\nEmails corresponding to users already in the workspace will be ignored.\n","operationId":"InviteUsersToWorkspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamInviteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserInvitation"}}},"description":"Users have been successfully invited to the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Invite Users to Workspace","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/kise/key/service-user/":{"get":{"description":"Lists all KISE keys associated with service users in the specified workspace.\n","operationId":"ListServiceUserKiseKeys","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUserKiseKey"},"type":"array"}}},"description":"Successfully retrieved the list of KISE keys for service users in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Workspace Service User KISE Keys","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/":{"get":{"description":"Lists all roles available in the specified workspace.\nOptionally filter roles by service name using the service query parameter.\n","operationId":"ListRoles","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Filter roles based on given service name. If not provided, returns roles for all services.","in":"query","name":"service","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamRole"},"type":"array"}}},"description":"Successfully retrieved the list of roles for the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Workspace Roles","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new role in the specified workspace.\n","operationId":"CreateRole","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamCreateRole"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamMinimalRoleWithTime"}}},"description":"Role has been successfully created in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create Workspace Role","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/":{"delete":{"description":"Deletes a specific role from the workspace.\nThis operation cannot be undone.\n","operationId":"DeleteRole","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Role has been successfully deleted from the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Workspace Role","tags":["IAM (Identity \u0026 Access Management)"]},"get":{"description":"Retrieves detailed information about a specific role in the workspace.\n","operationId":"GetRole","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRole"}}},"description":"Successfully retrieved the details of the specified role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Workspace Role","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/bulk-add-rules/":{"post":{"description":"Assigns multiple rules to the specified role in the workspace in a single operation.\n","operationId":"BulkAddRulesToRole","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamBulkAddRulesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamRoleRule"},"type":"array"}}},"description":"Rules have been successfully assigned to the role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Bulk Add Rules to Role","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/bulk-add-service-users/":{"post":{"description":"Assigns multiple service users to the specified role in the workspace in a single operation.\nIf multiple items are provided, role bindings will be created for each unique set of (service_user, item).\n","operationId":"BulkAddServiceUsersToRole","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamBulkAddServiceUsersToRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUserRoleBindingMinimal"},"type":"array"}}},"description":"Service users have been successfully assigned to the role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Bulk Add Service Users to Role","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/bulk-add-users/":{"post":{"description":"Assigns multiple users to the specified role in the workspace in a single operation.\nIf multiple items are provided, role bindings will be created for each unique set of (user, item).\n","operationId":"BulkAddUsersToRole","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamBulkAddUsersToRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUserRoleBindingMinimal"},"type":"array"}}},"description":"Users have been successfully assigned to the role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Bulk Add Users to Role","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/group/{groupUUID}/":{"delete":{"description":"Removes a specific role from the specified group in the workspace.\nThis deletes the role binding between the group and the role.\n","operationId":"RemoveRoleFromGroup","parameters":[{"description":"UUID of the group","example":"","in":"path","name":"groupUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Role has been successfully removed from the group.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Remove Role from Group","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/rule/":{"get":{"description":"Lists all rules associated with the specified role in the workspace.\n","operationId":"ListRoleRules","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamRule"},"type":"array"}}},"description":"Successfully retrieved the list of rules for the role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Role Rules","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/rule/{ruleUUID}/":{"delete":{"description":"Deletes a specific rule from the specified role in the workspace.\n","operationId":"RemoveRuleFromRole","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the rule","example":"","in":"path","name":"ruleUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Rule has been successfully deleted from the role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Role Rule","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new rule for the specified role in the workspace.\n","operationId":"AddRuleToRole","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the rule","example":"","in":"path","name":"ruleUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRequestRuleCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRule"}}},"description":"Rule has been successfully created for the role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create Role Rule","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/service-user/":{"get":{"description":"Lists all service users that have been assigned the specified role in the workspace.\n","operationId":"ListRolesServiceUsers","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUserWithRoleItems"},"type":"array"}}},"description":"Successfully retrieved the list of service users with the specified role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Roles Service Users","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/service-user/{serviceUserUUID}/":{"delete":{"description":"Removes the specified role from a service user in the workspace.\n","operationId":"RemoveRoleFromServiceUser","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Role has been successfully removed from the service user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Remove Role from Service User","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Adds a service user to the specified role in the workspace.\n","operationId":"AssignRoleToServiceUser","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRoleBindingItems"}}},"required":true},"responses":{"200":{"description":"Service user has been successfully added to the role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Add Service User to Role","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/user/":{"get":{"description":"Lists all users that have been assigned the specified role in the workspace.\n","operationId":"ListRoleUsers","parameters":[{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUserWithRoleItems"},"type":"array"}}},"description":"Successfully retrieved the list of users with the specified role.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Role users","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/role/{roleUUID}/user/{userUUID}/":{"delete":{"description":"Removes the specified role from a user in the workspace.\n","operationId":"RemoveRoleFromUser","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the role","example":"","in":"path","name":"roleUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Role has been successfully removed from the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Remove Role from User","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/rule/":{"get":{"description":"Lists all rules defined in the specified workspace.\n","operationId":"ListRules","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamRule"},"type":"array"}}},"description":"Successfully retrieved the list of rules for the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Workspace Rules","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new rule in the specified workspace.\n","operationId":"CreateRule","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRequestRuleCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRule"}}},"description":"Rule has been successfully created in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Duplicate rule name in the same workspace is not allowed"}},"summary":"Create Workspace Rule","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/rule/{ruleUUID}/":{"delete":{"description":"Deletes a specific rule from the workspace.\nThis operation cannot be undone.\n","operationId":"DeleteRule","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the rule","example":"","in":"path","name":"ruleUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Rule has been successfully deleted from the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Workspace Rule","tags":["IAM (Identity \u0026 Access Management)"]},"get":{"description":"Retrieves detailed information about a specific rule in the workspace.\n","operationId":"GetRule","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the rule","example":"","in":"path","name":"ruleUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRule"}}},"description":"Successfully retrieved the details of the specified rule.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get Workspace Rule","tags":["IAM (Identity \u0026 Access Management)"]},"put":{"description":"Updates a specific rule in the workspace.\n","operationId":"UpdateRule","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the rule","example":"","in":"path","name":"ruleUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRequestRuleCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamRule"}}},"description":"Rule has been successfully updated.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update Workspace Rule","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/rule/{ruleUUID}/role/":{"get":{"description":"Lists all roles that include the specified rule in the workspace.\n","operationId":"ListRuleRoles","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the rule","example":"","in":"path","name":"ruleUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamRole"},"type":"array"}}},"description":"Successfully retrieved the list of roles that include the specified rule.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Rule Roles","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/":{"get":{"description":"Lists all service users in the specified workspace.\n","operationId":"ListServiceUsers","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUser"},"type":"array"}}},"description":"Successfully retrieved the list of service users for the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Service Users","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new service user in the specified workspace.\n","operationId":"CreateServiceUser","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUser"}}},"description":"Service user has been successfully created in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create Service User","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/me/kise/key/":{"post":{"description":"Creates a new KISE key for the specified service user in the workspace.\n","operationId":"CreateCurrentServiceUserKiseKey","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserKiseKey"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserKiseKey"}}},"description":"KISE key has been successfully created for the service user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create Service User KISE Key For Current Service User Requesting","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/me/kise/key/{resourceUUID}/":{"delete":{"description":"Deletes a specific KISE key associated with the specified service user in the workspace.\nThis operation cannot be undone.\n","operationId":"DeleteCurrentServiceUserKiseKey","parameters":[{"description":"Resource UUID","example":"","in":"path","name":"resourceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"KISE key has been successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Service User KISE Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/{serviceUserUUID}/":{"delete":{"description":"Deletes a specific service user from the workspace.\nThis operation cannot be undone.\n","operationId":"DeleteServiceUser","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Service user has been successfully deleted from the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Service User","tags":["IAM (Identity \u0026 Access Management)"]},"put":{"description":"Updates a specific service user in the workspace.\n","operationId":"UpdateServiceUser","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUser"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUser"}}},"description":"Service user has been successfully updated.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Update Service User","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/{serviceUserUUID}/kise/key/":{"post":{"description":"Creates a new KISE key for the specified service user in the workspace.\n","operationId":"CreateServiceUserKiseKey","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserKiseKey"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserKiseKey"}}},"description":"KISE key has been successfully created for the service user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create Service User KISE Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/{serviceUserUUID}/kise/key/{resourceUUID}/":{"delete":{"description":"Deletes a specific KISE key associated with the specified service user in the workspace.\nThis operation cannot be undone.\n","operationId":"DeleteServiceUserKiseKey","parameters":[{"description":"Resource UUID","example":"","in":"path","name":"resourceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"KISE key has been successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Service User KISE Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/{serviceUserUUID}/service-user-public-key/":{"get":{"description":"Lists all public keys associated with the specified service user.\n","operationId":"ListServiceUserPublicKeys","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUserPublicKey"},"type":"array"}}},"description":"Successfully retrieved the list of public keys for the service user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Service User Public Keys","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new public key for the specified service user.\n","operationId":"CreateServiceUserPublicKey","parameters":[{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserPublicKeyCreate"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserPublicKey"}}},"description":"Public key has been successfully created for the service user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create Service User Public Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/{serviceUserUUID}/service-user-public-key/{resourceUUID}/":{"delete":{"description":"Deletes a specific public key associated with the specified service user.\n","operationId":"DeleteServiceUserPublicKey","parameters":[{"description":"Resource UUID","example":"","in":"path","name":"resourceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Public key has been successfully deleted from the service user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Service User Public Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/{serviceUserUUID}/token/":{"get":{"description":"Lists all authentication tokens associated with the specified service user.\n","operationId":"ListServiceUserTokens","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamServiceUserToken"},"type":"array"}}},"description":"Successfully retrieved the list of tokens for the service user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Service User Tokens","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new authentication token for the specified service user.\n","operationId":"CreateServiceUserToken","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserTokenWithSecret"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamServiceUserTokenWithSecret"}}},"description":"Authentication token has been successfully created for the service user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create Service User Token","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service-user/{serviceUserUUID}/token/{resourceUUID}/":{"delete":{"description":"Deletes a specific authentication token associated with the specified service user.\nThis operation cannot be undone and will immediately invalidate the token.\n","operationId":"DeleteServiceUserToken","parameters":[{"description":"Resource UUID","example":"","in":"path","name":"resourceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Authentication token has been successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete Service User Token","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/service/":{"get":{"description":"Lists all services available in the specified workspace.\n","operationId":"ListServices","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamService"},"type":"array"}}},"description":"Successfully retrieved the list of services for the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Services","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/third-parties/{thirdPartyUUID}/service-users/{serviceUserUUID}/bulk-refresh-tokens":{"post":{"description":"Refreshes multiple authentication tokens for a service user with a third-party service.\nThis is useful for maintaining continuous access to third-party APIs and services.\n","operationId":"BulkRefreshThirdPartyTokens","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the service-user","example":"","in":"path","name":"serviceUserUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the third party","example":"","in":"path","name":"thirdPartyUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamRefreshTokenReq"},"type":"array"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamRefreshTokenResp"},"type":"array"}}},"description":"Successfully refreshed the authentication tokens.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Bulk Refresh Third-Party Tokens","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/user/":{"get":{"description":"Lists all users in the specified workspace.\nOptionally filter users by email using the email query parameter.\n","operationId":"ListWorkspaceUsers","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Filter users by email address","in":"query","name":"email","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUser"},"type":"array"}}},"description":"Successfully retrieved the list of users for the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List Workspace Users","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/user/{userUUID}/":{"delete":{"description":"Removes the specified user from the workspace.\nThis operation cannot be undone.\n","operationId":"RemoveUserFromWorkspace","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"User has been successfully removed from the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Remove User from Workspace","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/user/{userUUID}/allow/":{"put":{"description":"Allows a previously suspended user to access the workspace again.\n","operationId":"AllowUser","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamCreateUser"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUser"}}},"description":"User has been successfully allowed access to the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Allow User","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/user/{userUUID}/kise/key/":{"get":{"description":"Lists all KISE (Key Infrastructure for Secure Environments) keys\nassociated with the specified user in the workspace.\n","operationId":"ListUserKiseKeys","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/iamUserKiseKey"},"type":"array"}}},"description":"Successfully retrieved the list of KISE keys for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"List User KISE Keys","tags":["IAM (Identity \u0026 Access Management)"]},"post":{"description":"Creates a new KISE key for the specified user in the workspace.\n","operationId":"CreateUserKiseKey","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamCreateUserKiseKey"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUserKiseKey"}}},"description":"KISE key has been successfully created for the user.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Create User KISE Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/user/{userUUID}/kise/key/{resourceUUID}/":{"delete":{"description":"Deletes a specific KISE key associated with the specified user in the workspace.\nThis operation cannot be undone.\n","operationId":"DeleteUserKiseKey","parameters":[{"description":"Resource UUID","example":"","in":"path","name":"resourceUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"KISE key has been successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Delete User KISE Key","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/api/v1/workspace/{workspaceUUID}/user/{userUUID}/suspend/":{"put":{"description":"Suspends a user's access to the workspace.\nThe user will not be able to access the workspace until they are allowed again.\n","operationId":"SuspendUser","parameters":[{"description":"UUID of the user","example":"","in":"path","name":"userUUID","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamCreateUser"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamUser"}}},"description":"User has been successfully suspended from the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Suspend User","tags":["IAM (Identity \u0026 Access Management)"]}},"/iam/v1/openid/token/":{"post":{"description":"Obtains an OpenID Connect token for authentication.\nThis endpoint implements the OAuth 2.0 token endpoint as defined in the OpenID Connect specification.\n","operationId":"GetOpenIdToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamOpenIdTokenRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamOpenIdTokenResponse"}}},"description":"Successfully retrieved the OpenID token.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Bad request - invalid configuration provided"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Authentication credentials were invalid, absent or insufficient."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iamError"}}},"description":"Forbidden - insufficient permissions"}},"summary":"Get OpenID Token","tags":["IAM (Identity \u0026 Access Management)"]}},"/postgres/v2/thr1/workspaces/{workspaceUUID}/csus":{"post":{"description":"Submits thirdparty access properties customer csu for postgresql clusters","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]}},"/postgres/v2/thr1/workspaces/{workspaceUUID}/postgresqlclusters":{"get":{"description":"Retrieve a list of all of your PostgreSQL Clusters v2.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]},"post":{"description":"Create a new PostgreSQL Cluster v2.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]}},"/postgres/v2/thr1/workspaces/{workspaceUUID}/postgresqlclusters/{resourceId}":{"delete":{"description":"Delete a PostgreSQL Cluster v2.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]},"get":{"description":"Retrieve a PostgreSQL Cluster v2.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]},"patch":{"description":"Partial Update a PostgreSQL Cluster v2.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]}},"/postgres/v2/thr3/workspaces/{workspaceUUID}/csus":{"post":{"description":"Submits thirdparty access properties customer csu for postgresql clusters","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]}},"/postgres/v2/thr3/workspaces/{workspaceUUID}/postgresqlclusters":{"get":{"description":"Retrieve a list of all of your PostgreSQL Clusters v2.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]},"post":{"description":"Create a new PostgreSQL Cluster v2.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]}},"/postgres/v2/thr3/workspaces/{workspaceUUID}/postgresqlclusters/{resourceId}":{"delete":{"description":"Delete a PostgreSQL Cluster v2.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]},"get":{"description":"Retrieve a PostgreSQL Cluster v2.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]},"patch":{"description":"Partial Update a PostgreSQL Cluster v2.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["PostgreSQL v2"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/machines":{"get":{"description":"Retrieve a list of all your machines.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/machines/{resourceId}":{"get":{"description":"Retrieve details of the specified machine by machine name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Machine","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"To remove specific machines from a node pool, first, use this API to apply a JSON merge patch. The only effective change required in the patch is setting the cluster.x-k8s.io/delete-machine annotation under metadata.annotations.\n\nOnce these annotations are applied, use the Scale Node Pool API to update the machine count. For example, if the node pool currently has five machines and you want to remove two, set the number of replicas to 5 - 2 = 3.          \n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Set delete-machine annotation","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/sotoonaddons":{"get":{"description":"Retrieve a list of all Cluster's Addons.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a cluster Addon.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/sotoonaddons/{resourceId}":{"delete":{"description":"Delete the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Addon","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Get details of the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Addon","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replace the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Replace Addon","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/sotoonclusters":{"get":{"description":"Retrieves a paginated list of all Kubernetes clusters in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonClusterList"}}},"description":"Successfully retrieved the list of Kubernetes clusters. The response includes details \nabout each cluster such as its configuration, status, metadata, name, creation time, \nspecs, and current status.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List Clusters","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes cluster in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster was successfully created and is being provisioned. The request must include \ncluster specifications like version and networking details. The response contains the \ncomplete cluster details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - cluster with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/sotoonclusters/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes cluster (by cluster name) from the workspace.\nThis action will terminate all cluster resources and cannot be undone.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The cluster and all its associated resources were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete Cluster","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes cluster by cluster name","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"Successfully retrieved the details of the specified Kubernetes cluster in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get Cluster","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Updates an existing Kubernetes cluster's configuration","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully updated. This can include modifications \nto metadata or other mutable properties. The response contains the complete updated \ncluster details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update Cluster","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes cluster.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully replaced. The response contains\nthe complete updated cluster details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/sotoonnodepools":{"get":{"description":"Retrieves a list of all Kubernetes NodePools in the specified workspace. \nNodePools are scalable groups of worker nodes with intelligent deletion policies.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepoolList"}}},"description":"Successfully retrieved the list of NodePools. The response includes\nconfiguration and status information for each nodepool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List NodePools","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes NodePool in the specified workspace with the provided configuration.\nThe request must include nodepool specifications like replicas and instance type.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool was successfully created and is being provisioned. \nThe response contains the complete nodepool details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - nodepool with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/sotoonnodepools/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes NodePool (by nodepool name) from the workspace.\nThis action will terminate all worker nodes and cannot be undone.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The nodepool and all its worker nodes were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete NodePool","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes NodePool by nodepool name in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"Successfully retrieved the details of the specified NodePool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get NodePool","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Dynamically scales the number of worker nodes in the nodepool","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerNodepoolPatchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool scaling operation was initiated successfully. Scaling uses intelligent \ndeletion policies with exponential decay algorithm prioritizing oldest and unhealthy \nmachines for removal. Rolling update strategy with MaxSurge=1 and MaxUnavailable=0 \nensures zero downtime. Monitor status fields to track progress.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Scale Nodepool","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Updates an existing Kubernetes NodePool's configuration by nodepool name.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully updated.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update NodePool","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes NodePool by nodepool name.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully replaced.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/usersecrets":{"get":{"description":"Retrieve a list of all your secrets, including kubeconfig and other types of secrets.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a secrets, including any type of token.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-free/workspaces/{workspaceUUID}/usersecrets/{resourceId}":{"get":{"description":"Get details of the specified Secret by secret name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Secret","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/machines":{"get":{"description":"Retrieve a list of all your machines.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/machines/{resourceId}":{"get":{"description":"Retrieve details of the specified machine by machine name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Machine","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"To remove specific machines from a node pool, first, use this API to apply a JSON merge patch. The only effective change required in the patch is setting the cluster.x-k8s.io/delete-machine annotation under metadata.annotations.\n\nOnce these annotations are applied, use the Scale Node Pool API to update the machine count. For example, if the node pool currently has five machines and you want to remove two, set the number of replicas to 5 - 2 = 3.          \n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Set delete-machine annotation","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/sotoonaddons":{"get":{"description":"Retrieve a list of all Cluster's Addons.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a cluster Addon.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/sotoonaddons/{resourceId}":{"delete":{"description":"Delete the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Addon","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Get details of the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Addon","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replace the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Replace Addon","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/sotoonclusters":{"get":{"description":"Retrieves a paginated list of all Kubernetes clusters in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonClusterList"}}},"description":"Successfully retrieved the list of Kubernetes clusters. The response includes details \nabout each cluster such as its configuration, status, metadata, name, creation time, \nspecs, and current status.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List Clusters","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes cluster in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster was successfully created and is being provisioned. The request must include \ncluster specifications like version and networking details. The response contains the \ncomplete cluster details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - cluster with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/sotoonclusters/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes cluster (by cluster name) from the workspace.\nThis action will terminate all cluster resources and cannot be undone.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The cluster and all its associated resources were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete Cluster","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes cluster by cluster name","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"Successfully retrieved the details of the specified Kubernetes cluster in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get Cluster","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Updates an existing Kubernetes cluster's configuration","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully updated. This can include modifications \nto metadata or other mutable properties. The response contains the complete updated \ncluster details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update Cluster","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes cluster.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully replaced. The response contains\nthe complete updated cluster details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/sotoonnodepools":{"get":{"description":"Retrieves a list of all Kubernetes NodePools in the specified workspace. \nNodePools are scalable groups of worker nodes with intelligent deletion policies.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepoolList"}}},"description":"Successfully retrieved the list of NodePools. The response includes\nconfiguration and status information for each nodepool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List NodePools","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes NodePool in the specified workspace with the provided configuration.\nThe request must include nodepool specifications like replicas and instance type.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool was successfully created and is being provisioned. \nThe response contains the complete nodepool details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - nodepool with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/sotoonnodepools/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes NodePool (by nodepool name) from the workspace.\nThis action will terminate all worker nodes and cannot be undone.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The nodepool and all its worker nodes were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete NodePool","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes NodePool by nodepool name in the specified workspace.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"Successfully retrieved the details of the specified NodePool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get NodePool","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Dynamically scales the number of worker nodes in the nodepool","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerNodepoolPatchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool scaling operation was initiated successfully. Scaling uses intelligent \ndeletion policies with exponential decay algorithm prioritizing oldest and unhealthy \nmachines for removal. Rolling update strategy with MaxSurge=1 and MaxUnavailable=0 \nensures zero downtime. Monitor status fields to track progress.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Scale Nodepool","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Updates an existing Kubernetes NodePool's configuration by nodepool name.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully updated.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update NodePool","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes NodePool by nodepool name.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully replaced.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/usersecrets":{"get":{"description":"Retrieve a list of all your secrets, including kubeconfig and other types of secrets.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a secrets, including any type of token.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-premium/workspaces/{workspaceUUID}/usersecrets/{resourceId}":{"get":{"description":"Get details of the specified Secret by secret name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Secret","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/machines":{"get":{"description":"Retrieve a list of all your machines.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/machines/{resourceId}":{"get":{"description":"Retrieve details of the specified machine by machine name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Machine","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"To remove specific machines from a node pool, first, use this API to apply a JSON merge patch. The only effective change required in the patch is setting the cluster.x-k8s.io/delete-machine annotation under metadata.annotations.\n\nOnce these annotations are applied, use the Scale Node Pool API to update the machine count. For example, if the node pool currently has five machines and you want to remove two, set the number of replicas to 5 - 2 = 3.          \n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Set delete-machine annotation","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/sotoonaddons":{"get":{"description":"Retrieve a list of all Cluster's Addons.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a cluster Addon.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/sotoonaddons/{resourceId}":{"delete":{"description":"Delete the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Addon","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Get details of the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Addon","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replace the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Replace Addon","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/sotoonclusters":{"get":{"description":"Retrieves a paginated list of all Kubernetes clusters in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonClusterList"}}},"description":"Successfully retrieved the list of Kubernetes clusters. The response includes details \nabout each cluster such as its configuration, status, metadata, name, creation time, \nspecs, and current status.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List Clusters","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes cluster in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster was successfully created and is being provisioned. The request must include \ncluster specifications like version and networking details. The response contains the \ncomplete cluster details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - cluster with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/sotoonclusters/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes cluster (by cluster name) from the workspace.\nThis action will terminate all cluster resources and cannot be undone.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The cluster and all its associated resources were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete Cluster","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes cluster by cluster name","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"Successfully retrieved the details of the specified Kubernetes cluster in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get Cluster","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Updates an existing Kubernetes cluster's configuration","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully updated. This can include modifications \nto metadata or other mutable properties. The response contains the complete updated \ncluster details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update Cluster","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes cluster.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully replaced. The response contains\nthe complete updated cluster details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/sotoonnodepools":{"get":{"description":"Retrieves a list of all Kubernetes NodePools in the specified workspace. \nNodePools are scalable groups of worker nodes with intelligent deletion policies.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepoolList"}}},"description":"Successfully retrieved the list of NodePools. The response includes\nconfiguration and status information for each nodepool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List NodePools","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes NodePool in the specified workspace with the provided configuration.\nThe request must include nodepool specifications like replicas and instance type.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool was successfully created and is being provisioned. \nThe response contains the complete nodepool details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - nodepool with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/sotoonnodepools/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes NodePool (by nodepool name) from the workspace.\nThis action will terminate all worker nodes and cannot be undone.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The nodepool and all its worker nodes were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete NodePool","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes NodePool by nodepool name in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"Successfully retrieved the details of the specified NodePool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get NodePool","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Dynamically scales the number of worker nodes in the nodepool","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerNodepoolPatchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool scaling operation was initiated successfully. Scaling uses intelligent \ndeletion policies with exponential decay algorithm prioritizing oldest and unhealthy \nmachines for removal. Rolling update strategy with MaxSurge=1 and MaxUnavailable=0 \nensures zero downtime. Monitor status fields to track progress.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Scale Nodepool","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Updates an existing Kubernetes NodePool's configuration by nodepool name.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully updated.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update NodePool","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes NodePool by nodepool name.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully replaced.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/usersecrets":{"get":{"description":"Retrieve a list of all your secrets, including kubeconfig and other types of secrets.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a secrets, including any type of token.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr1-standard/workspaces/{workspaceUUID}/usersecrets/{resourceId}":{"get":{"description":"Get details of the specified Secret by secret name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Secret","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/machines":{"get":{"description":"Retrieve a list of all your machines.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/machines/{resourceId}":{"get":{"description":"Retrieve details of the specified machine by machine name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Machine","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"To remove specific machines from a node pool, first, use this API to apply a JSON merge patch. The only effective change required in the patch is setting the cluster.x-k8s.io/delete-machine annotation under metadata.annotations.\n\nOnce these annotations are applied, use the Scale Node Pool API to update the machine count. For example, if the node pool currently has five machines and you want to remove two, set the number of replicas to 5 - 2 = 3.          \n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Set delete-machine annotation","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/sotoonaddons":{"get":{"description":"Retrieve a list of all Cluster's Addons.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a cluster Addon.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/sotoonaddons/{resourceId}":{"delete":{"description":"Delete the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Addon","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Get details of the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Addon","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replace the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Replace Addon","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/sotoonclusters":{"get":{"description":"Retrieves a paginated list of all Kubernetes clusters in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonClusterList"}}},"description":"Successfully retrieved the list of Kubernetes clusters. The response includes details \nabout each cluster such as its configuration, status, metadata, name, creation time, \nspecs, and current status.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List Clusters","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes cluster in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster was successfully created and is being provisioned. The request must include \ncluster specifications like version and networking details. The response contains the \ncomplete cluster details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - cluster with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/sotoonclusters/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes cluster (by cluster name) from the workspace.\nThis action will terminate all cluster resources and cannot be undone.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The cluster and all its associated resources were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete Cluster","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes cluster by cluster name","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"Successfully retrieved the details of the specified Kubernetes cluster in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get Cluster","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Updates an existing Kubernetes cluster's configuration","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully updated. This can include modifications \nto metadata or other mutable properties. The response contains the complete updated \ncluster details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update Cluster","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes cluster.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully replaced. The response contains\nthe complete updated cluster details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/sotoonnodepools":{"get":{"description":"Retrieves a list of all Kubernetes NodePools in the specified workspace. \nNodePools are scalable groups of worker nodes with intelligent deletion policies.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepoolList"}}},"description":"Successfully retrieved the list of NodePools. The response includes\nconfiguration and status information for each nodepool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List NodePools","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes NodePool in the specified workspace with the provided configuration.\nThe request must include nodepool specifications like replicas and instance type.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool was successfully created and is being provisioned. \nThe response contains the complete nodepool details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - nodepool with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/sotoonnodepools/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes NodePool (by nodepool name) from the workspace.\nThis action will terminate all worker nodes and cannot be undone.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The nodepool and all its worker nodes were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete NodePool","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes NodePool by nodepool name in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"Successfully retrieved the details of the specified NodePool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get NodePool","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Dynamically scales the number of worker nodes in the nodepool","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerNodepoolPatchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool scaling operation was initiated successfully. Scaling uses intelligent \ndeletion policies with exponential decay algorithm prioritizing oldest and unhealthy \nmachines for removal. Rolling update strategy with MaxSurge=1 and MaxUnavailable=0 \nensures zero downtime. Monitor status fields to track progress.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Scale Nodepool","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Updates an existing Kubernetes NodePool's configuration by nodepool name.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully updated.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update NodePool","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes NodePool by nodepool name.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully replaced.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/usersecrets":{"get":{"description":"Retrieve a list of all your secrets, including kubeconfig and other types of secrets.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a secrets, including any type of token.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-premium/workspaces/{workspaceUUID}/usersecrets/{resourceId}":{"get":{"description":"Get details of the specified Secret by secret name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Secret","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/machines":{"get":{"description":"Retrieve a list of all your machines.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/machines/{resourceId}":{"get":{"description":"Retrieve details of the specified machine by machine name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Machine","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"To remove specific machines from a node pool, first, use this API to apply a JSON merge patch. The only effective change required in the patch is setting the cluster.x-k8s.io/delete-machine annotation under metadata.annotations.\n\nOnce these annotations are applied, use the Scale Node Pool API to update the machine count. For example, if the node pool currently has five machines and you want to remove two, set the number of replicas to 5 - 2 = 3.          \n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Set delete-machine annotation","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/sotoonaddons":{"get":{"description":"Retrieve a list of all Cluster's Addons.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a cluster Addon.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/sotoonaddons/{resourceId}":{"delete":{"description":"Delete the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Delete Addon","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Get details of the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Addon","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Update the specified cluster Addon by addon name.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Update Addon","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replace the specified cluster Addon by addon name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Replace Addon","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/sotoonclusters":{"get":{"description":"Retrieves a paginated list of all Kubernetes clusters in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonClusterList"}}},"description":"Successfully retrieved the list of Kubernetes clusters. The response includes details \nabout each cluster such as its configuration, status, metadata, name, creation time, \nspecs, and current status.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List Clusters","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes cluster in the specified workspace","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster was successfully created and is being provisioned. The request must include \ncluster specifications like version and networking details. The response contains the \ncomplete cluster details including the assigned unique identifier.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - cluster with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/sotoonclusters/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes cluster (by cluster name) from the workspace.\nThis action will terminate all cluster resources and cannot be undone.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The cluster and all its associated resources were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete Cluster","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes cluster by cluster name","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"Successfully retrieved the details of the specified Kubernetes cluster in the workspace.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get Cluster","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Updates an existing Kubernetes cluster's configuration","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully updated. This can include modifications \nto metadata or other mutable properties. The response contains the complete updated \ncluster details reflecting the changes made.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update Cluster","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes cluster.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonCluster"}}},"description":"The cluster configuration was successfully replaced. The response contains\nthe complete updated cluster details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace Cluster","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/sotoonnodepools":{"get":{"description":"Retrieves a list of all Kubernetes NodePools in the specified workspace. \nNodePools are scalable groups of worker nodes with intelligent deletion policies.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepoolList"}}},"description":"Successfully retrieved the list of NodePools. The response includes\nconfiguration and status information for each nodepool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"List NodePools","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Creates a new Kubernetes NodePool in the specified workspace with the provided configuration.\nThe request must include nodepool specifications like replicas and instance type.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool was successfully created and is being provisioned. \nThe response contains the complete nodepool details.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Conflict - nodepool with the same name already exists"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Create NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/sotoonnodepools/{resourceId}":{"delete":{"description":"Permanently removes the specified Kubernetes NodePool (by nodepool name) from the workspace.\nThis action will terminate all worker nodes and cannot be undone.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"The nodepool and all its worker nodes were successfully deleted.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Delete NodePool","tags":["Sotoon Kubernetes Engine"]},"get":{"description":"Retrieves detailed information about a specific Kubernetes NodePool by nodepool name in the specified workspace.\n","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"Successfully retrieved the details of the specified NodePool.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Get NodePool","tags":["Sotoon Kubernetes Engine"]},"patch":{"description":"Dynamically scales the number of worker nodes in the nodepool","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerNodepoolPatchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool scaling operation was initiated successfully. Scaling uses intelligent \ndeletion policies with exponential decay algorithm prioritizing oldest and unhealthy \nmachines for removal. Rolling update strategy with MaxSurge=1 and MaxUnavailable=0 \nensures zero downtime. Monitor status fields to track progress.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Scale Nodepool","tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Updates an existing Kubernetes NodePool's configuration by nodepool name.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully updated.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Update NodePool","tags":["Sotoon Kubernetes Engine"]},"put":{"description":"Replaces the entire configuration of an existing Kubernetes NodePool by nodepool name.\n","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerSotoonNodepool"}}},"description":"The nodepool configuration was successfully replaced.\n"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Bad request - invalid configuration"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unauthorized - invalid or expired authentication token"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Forbidden - insufficient permissions for workspace operations"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Not found - workspace or resource does not exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/containerStatus"}}},"description":"Unprocessable entity - resource constraints or quota exceeded"}},"summary":"Replace NodePool","tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/usersecrets":{"get":{"description":"Retrieve a list of all your secrets, including kubeconfig and other types of secrets.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]},"post":{"description":"Create or update a secrets, including any type of token.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Sotoon Kubernetes Engine"]}},"/ske/v2alpha1/thr3-standard/workspaces/{workspaceUUID}/usersecrets/{resourceId}":{"get":{"description":"Get details of the specified Secret by secret name.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"summary":"Get Secret","tags":["Sotoon Kubernetes Engine"]}},"/valkey/v1/thr1/workspaces/{workspaceUUID}/csus":{"post":{"description":"Submits thirdparty access properties customer csu for valkey clusters","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]}},"/valkey/v1/thr1/workspaces/{workspaceUUID}/valkeyclusters":{"get":{"description":"Retrieve a list of all of your Valkey Clusters.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]},"post":{"description":"Create a new Valkey Cluster.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]}},"/valkey/v1/thr1/workspaces/{workspaceUUID}/valkeyclusters/{resourceId}":{"delete":{"description":"Delete a Valkey Cluster.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]},"get":{"description":"Retrieve a Valkey Cluster.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]},"patch":{"description":"Partial Update a Valkey Cluster.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]}},"/valkey/v1/thr3/workspaces/{workspaceUUID}/csus":{"post":{"description":"Submits thirdparty access properties customer csu for valkey clusters","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]}},"/valkey/v1/thr3/workspaces/{workspaceUUID}/valkeyclusters":{"get":{"description":"Retrieve a list of all of your Valkey Clusters.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]},"post":{"description":"Create a new Valkey Cluster.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]}},"/valkey/v1/thr3/workspaces/{workspaceUUID}/valkeyclusters/{resourceId}":{"delete":{"description":"Delete a Valkey Cluster.","parameters":[{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}},{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]},"get":{"description":"Retrieve a Valkey Cluster.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]},"patch":{"description":"Partial Update a Valkey Cluster.","parameters":[{"description":"UUID of the workspace","example":"00000000-0000-0000-0000-000000000000","in":"path","name":"workspaceUUID","required":true,"schema":{"type":"string"}},{"description":"Resource ID","example":"","in":"path","name":"resourceId","required":true,"schema":{"type":"string"}}],"responses":{},"tags":["Valkey"]}}},"security":[{"Bearer Token":[]}],"tags":[{"name":"IAM (Identity \u0026 Access Management)"},{"description":"This API is used to manage CDN and DNS resources. You can use it to create, update, delete, and get CDN, DNS, and other related resources.\n","name":"CDN and DNS"},{"description":"This API is used to manage CDN and DNS resources. You can use it to create, update, delete, and get CDN, DNS, and other related resources.\n","name":"CDN and DNS (v2.1)"},{"description":"The Compute Service API is structured around several core resource types, each with its own schema definition and capabilities. These resources are designed to represent and manipulate distinct aspects of your cloud infrastructure:\n\n-   **Instances**: Virtual machines that constitute the fundamental building blocks of your applications. Instances can be customized in terms of CPU, memory, storage and network configuration.\n-   **Images**: Define the base operating system.\n-   **Instance Types**: Offer predefined configurations for instances, including CPU, memory, and other specifications, supporting optimization for varying workload requirements. They also define OS disk configurations in cases where the instance type specifies local disk.\n-   **Links**: Network interfaces that connect instances to subnets, enabling communication within and outside of your cloud network. It also includes private IP of network interface.\n-   **External IPs**: Public IP addresses that enable NAT functionality for network devices (Links or Loadbalancers), allowing requests to be translated to the destination network device. They can be used to assign public IPs to your network devices, facilitating external accessibility.\n\n### Data Model and Schema\nThe API's data model is meticulously structured to ensure consistent and reliable data handling across all interactions. It involves several key components that define how resources are identified, configured, and managed within the cloud infrastructure:\n\n-   **Object Metadata**: Standard fields such as `UID`, `Name`, `Labels`, and `Annotations` are utilized to uniquely identify resources, enable effective categorization, and facilitate metadata enrichment with additional information. The `Workspace` field links each resource to its associated workspace.\n    \n-   **Spec Fields**: The `spec` section of an object defines the desired state and configuration characteristics for that resource. It includes elements that specify the resource's properties and operational parameters.\n-   **Status Fields**: The `status` section captures the current observed state of a resource, reflecting its operational status and conditions.\n\n### Practical Example: Creating a Compute Instance\n\nThe process of deploying a new compute instance involves multiple steps to ensure proper network configuration and resource allocation. Below is a step-by-step guide to create an external IP, a network link, and finally an instance, using our API. Please note that we assume the workspace UUID is `a5f04639-37da-4162-afaf-e721f05ec8af`. In your implementation, replace this UUID with the one specific to your own workspace.\n\n#### Step 1: Create an External IP\n\nFirst, allocate an external IP to enable internet connectivity for your instance.\n\n```bash\ncurl --location 'https://api.sotoon.ir/compute/v2/thr1/workspaces/a5f04639-37da-4162-afaf-e721f05ec8af/external-ips' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer ••••••' \\\n--data '{\n    \"apiVersion\": \"compute/v2\",\n    \"kind\": \"ExternalIP\",\n    \"metadata\": {\n        \"name\": \"test-external-ip\",\n        \"workspace\": \"a5f04639-37da-4162-afaf-e721f05ec8af\"\n    },\n    \"spec\": {\n        \"reserved\": true\n    }\n}'\n```\n\n**Explanation**: This command reserves a new external IP identified by `test-external-ip` for the specified workspace. The IP can then be linked to other network resources.\n\n#### Step 2: Create a Network Link\n\nNext, create a network interface that will connect your instance to the subnet and associate it with the external IP created in the previous step. This link will enable both internal network communication and external internet access.\n\n```bash\ncurl --location 'https://api.sotoon.ir/compute/v2/thr1/workspaces/a5f04639-37da-4162-afaf-e721f05ec8af/links' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer ••••••' \\\n--data '{\n    \"apiVersion\": \"compute/v2\",\n    \"kind\": \"Link\",\n    \"metadata\": {\n        \"name\": \"test-link\",\n        \"workspace\": \"a5f04639-37da-4162-afaf-e721f05ec8af\"\n    },\n    \"spec\": {\n        \"externalIPRef\": {\n            \"name\": \"test-external-ip\"\n        },\n        \"subnetName\": \"default\",\n        \"vpcName\": \"default\"\n    }\n}'\n```\n\n**Explanation**: This command creates a new link named `test-link` in the workspace. It connects to the `default` subnet within the virtual private cloud (VPC) and uses the previously created `test-external-ip`. For internet connectivity, your instance can either connect through a link to a subnet with internet access or use an external IP. The external IP allows internet users to reach your instance by performing Network Address Translation (NAT), which routes traffic between the public internet and your link, enabling two-way communication with external services.\n\n#### Step 3: Create an Instance\n\nFinally, create a compute instance utilizing the above-created network link to ensure it is properly networked and ready for operations.\n\n```bash\ncurl --location 'https://api.sotoon.ir/compute/v2/thr1/workspaces/a5f04639-37da-4162-afaf-e721f05ec8af/instances' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer ••••••' \\\n--data '{\n    \"apiVersion\": \"compute/v2\",\n    \"kind\": \"Instance\",\n    \"metadata\": {\n        \"name\": \"test-instance\",\n        \"workspace\": \"a5f04639-37da-4162-afaf-e721f05ec8af\"\n    },\n    \"spec\": {\n        \"iamEnabled\": true,\n        \"imageSource\": {\n            \"image\": \"ubuntu-22.04\"\n        },\n        \"interfaces\": [\n            {\n                \"link\": \"test-link\",\n                \"name\": \"ens3\"\n            }\n        ],\n        \"poweredOn\": true,\n        \"type\": \"c1d30-1\"\n    }\n}'\n```\n\n**Explanation**: Here, the `test-instance` is being created within the specified workspace. It is powered on with a configuration that includes the `test-link` network interface, image `ubuntu-22.04`, and specified instance type `c1d30-1`.\n\nThese examples illustrate the interdependent nature of resources within the API, emphasizing the need to sequentially build network and compute configurations to successfully deploy instances. Explore the documentation further for details on managing these resources effectively.\n","name":"Compute"},{"name":"Sotoon Kubernetes Engine"},{"name":"PostgreSQL v2"},{"name":"Valkey"}]}