{ "swagger": "2.0", "info": { "title": "Hikube API", "description": "Manage the resources of the Hikube platform.\n\n## Errors\n\nAn error response carries an HTTP status for the class of the error and a JSON body (`ErrorResponse`) whose `code` identifies the precise error:\n\n```json\n{\"requestId\": \"4bf92f3577b34da6a3ce929d0e0e4736\", \"code\": 20101, \"message\": \"invalid name: must be at least 3 characters\", \"details\": []}\n```\n\nA code reads as a service prefix followed by three digits: `001`–`099` are platform errors (not found, already exists, unavailable…), `100`–`199` invalid input, `200`–`299` business rules. Handle errors on `code`: the wording of `message` may change.\n\n### Common\n\n| Code | Error |\n|------|-------|\n| 10001 | Authentication failed: invalid bearer token |\n| 10002 | Permission denied: missing or invalid credentials, or credentials that do not allow this operation |\n| 10003 | Event stream ticket expired |\n| 10004 | The api-key could not be checked (temporary); retry, the key is not known to be invalid |\n| 10005 | Refused by a platform admission policy; the message names the field, `details` the policy and its reason |\n| 10006 | Invalid update_mask: a path names no updatable field, or one key of a collection |\n\n### Instance\n\n| Code | Error |\n|------|-------|\n| 20001 | Instance not found |\n| 20002 | Instance already exists |\n| 20003 | Permission denied on the instance |\n| 20004 | Instance modified concurrently; retry |\n| 20005 | Instance platform unavailable |\n| 20006 | Instance provisioning failed |\n| 20007 | A dependency of the instance is not ready |\n| 20008 | The disks of the instance could not be read |\n| 20009 | A disk of the instance could not be created or updated |\n| 20100 | Invalid project_id |\n| 20101 | Invalid instance name |\n| 20102 | Invalid instance_type |\n| 20103 | Unknown instance_type |\n| 20104 | Invalid image, or image missing while the first disk has none |\n| 20105 | Unknown cloud image |\n| 20106 | disks is required |\n| 20107 | Invalid disk name |\n| 20108 | Invalid disk size |\n| 20109 | Duplicate disk name |\n| 20110 | Invalid SSH key |\n| 20111 | Invalid port number (above 65535) |\n| 20112 | Unknown GPU type |\n| 20113 | VPC not found in the project |\n| 20114 | The instance type has too little RAM for a GPU (4 GiB minimum) |\n| 20115 | User data cannot be set on a Windows instance: the platform generates it |\n| 20200 | Disk already attached to another instance |\n| 20201 | Instance already running |\n| 20202 | Instance already stopped |\n| 20203 | Instance cannot be restarted in its current state |\n| 20204 | GPU type not available |\n| 20205 | Not enough GPUs available to start the instance |\n| 20206 | No public IPv4 address available |\n| 20207 | No single node can host all the requested GPUs |\n| 20208 | The system disk of an instance cannot be replaced, detached or moved |\n\n### Disk\n\n| Code | Error |\n|------|-------|\n| 30001 | Disk not found |\n| 30002 | Disk already exists |\n| 30003 | Permission denied on the disk |\n| 30005 | Disk platform unavailable |\n| 30006 | Disk provisioning failed |\n| 30007 | Disk attached to an instance |\n| 30100 | Invalid project_id |\n| 30101 | Invalid disk name |\n| 30102 | Invalid disk size |\n| 30103 | Unknown cloud image |\n| 30104 | Invalid custom image URL |\n| 30105 | Invalid custom image OS |\n| 30200 | Disk cannot be shrunk |\n| 30201 | Disk detached but still used by a running instance until it restarts |\n\n### Project\n\n| Code | Error |\n|------|-------|\n| 40001 | Project not found |\n| 40002 | Project already exists |\n| 40003 | Permission denied on the project |\n| 40005 | Project platform unavailable |\n| 40006 | Project provisioning failed |\n| 40100 | Invalid organization_id |\n| 40101 | Invalid project name |\n| 40102 | Invalid hostname |\n| 40103 | Invalid CPU quota |\n| 40104 | Invalid memory quota |\n| 40105 | Invalid storage quota |\n| 40200 | etcd cannot be disabled while Kubernetes clusters exist |\n| 40201 | A quota cannot be lowered below current usage |\n| 40202 | A quota cannot exceed what the organization has left |\n\n### Bucket\n\n| Code | Error |\n|------|-------|\n| 50001 | Bucket not found |\n| 50002 | Bucket already exists |\n| 50003 | Permission denied on the bucket |\n| 50005 | Bucket platform unavailable |\n| 50010 | Bucket user not found |\n| 50011 | Bucket user already exists |\n| 50100 | Invalid project_id |\n| 50101 | Invalid bucket name |\n| 50102 | Invalid bucket username |\n\n### IAM\n\n| Code | Error |\n|------|-------|\n| 60001 | User not found |\n| 60002 | User already exists |\n| 60003 | Permission denied, including an api-key scope above the caller's own |\n| 60005 | IAM platform unavailable |\n| 60006 | Api-key not found |\n| 60007 | Api-key store failure; retrying is safe |\n| 60008 | Api-keys are not enabled |\n| 60009 | Api-key limit of the project reached |\n| 60100 | Invalid organization_id |\n| 60101 | Invalid username |\n| 60102 | Invalid email |\n| 60103 | Invalid first name |\n| 60104 | Invalid last name |\n| 60105 | Invalid project_id |\n| 60106 | Invalid api-key scope |\n| 60107 | Invalid api-key id |\n| 60108 | Invalid api-key name |\n| 60109 | Invalid api-key validity |\n\n### Organization\n\n| Code | Error |\n|------|-------|\n| 60001 | Organization not found |\n| 60100 | Invalid organization_id |\n\n### Kubernetes\n\n| Code | Error |\n|------|-------|\n| 70001 | Cluster not found |\n| 70002 | Cluster already exists |\n| 70003 | Permission denied on the cluster |\n| 70005 | Kubernetes platform unavailable |\n| 70006 | Cluster provisioning failed |\n| 70100 | Invalid project_id |\n| 70101 | Invalid cluster name |\n| 70102 | Invalid version |\n| 70103 | Unsupported Kubernetes version |\n| 70104 | Invalid control plane replicas |\n| 70105 | Node groups are required |\n| 70106 | Invalid node group name |\n| 70107 | Unknown node group instance_type |\n| 70108 | Invalid node group replicas |\n| 70109 | max_replicas lower than min_replicas |\n| 70110 | Unknown GPU type |\n| 70111 | Unknown control plane preset |\n| 70112 | Invalid hostname |\n| 70113 | Invalid node group storage size |\n| 70200 | GPU type not available |\n| 70201 | No public IPv4 address available |\n| 70202 | No single node can host the GPUs of a node group |\n| 70203 | An addon is enabled without the addon it requires |\n| 70204 | GPUs cannot be added to or all removed from an existing node group |\n| 70205 | Project datastore being provisioned: retry later |\n| 70206 | Version downgrade refused |\n| 70207 | Project etcd disabled by GitOps: do not retry |\n| 70208 | Project etcd failed to deploy: do not retry |\n\n### Postgres\n\n| Code | Error |\n|------|-------|\n| 80001 | Cluster not found |\n| 80002 | Cluster already exists |\n| 80003 | Permission denied on the cluster |\n| 80005 | Postgres platform unavailable |\n| 80006 | Cluster provisioning failed |\n| 80100 | Invalid project_id |\n| 80101 | Invalid cluster name |\n| 80102 | Invalid or unsupported version |\n| 80103 | Invalid replicas |\n| 80104 | Invalid storage size |\n| 80105 | Invalid database name |\n| 80106 | Invalid max_connections |\n| 80107 | Invalid quorum configuration |\n| 80108 | Unknown preset |\n| 80109 | Unknown extension |\n| 80150 | Invalid username |\n| 80151 | Unknown user role |\n| 80152 | Unknown database role |\n| 80200 | Password generation failed |\n| 80201 | The cluster mode cannot be changed after creation |\n| 80202 | No public IPv4 address available |\n| 80203 | Version downgrade refused |\n| 80204 | Storage cannot be shrunk |\n| 80205 | Cluster has nothing to restart yet (still provisioning): retry once it is provisioned |\n\n### Account\n\n| Code | Error |\n|------|-------|\n| 90001 | Account not found |\n| 90005 | Account service unavailable |\n\n### MariaDB\n\n| Code | Error |\n|------|-------|\n| 110001 | Cluster not found |\n| 110002 | Cluster already exists |\n| 110003 | Permission denied on the cluster |\n| 110005 | MariaDB platform unavailable |\n| 110006 | Cluster provisioning failed |\n| 110100 | Invalid project_id |\n| 110101 | Invalid cluster name |\n| 110102 | Invalid or unsupported version |\n| 110103 | Invalid replicas |\n| 110104 | Invalid storage size |\n| 110105 | Invalid database name |\n| 110106 | Invalid max_user_connections |\n| 110107 | Unknown preset |\n| 110150 | Invalid username |\n| 110151 | Unknown database role |\n| 110200 | Password generation failed |\n| 110201 | The cluster mode cannot be changed after creation |\n| 110202 | No public IPv4 address available |\n| 110203 | Version downgrade refused |\n| 110204 | Storage cannot be shrunk |\n| 110205 | Cluster has nothing to restart yet (still provisioning): retry once it is provisioned |\n\n### Redis\n\n| Code | Error |\n|------|-------|\n| 120001 | Cluster not found |\n| 120002 | Cluster already exists |\n| 120003 | Permission denied on the cluster |\n| 120005 | Redis platform unavailable |\n| 120006 | Cluster provisioning failed |\n| 120100 | Invalid project_id |\n| 120101 | Invalid cluster name |\n| 120102 | Invalid or unsupported version |\n| 120103 | Invalid replicas |\n| 120104 | Invalid storage size |\n| 120105 | Unknown preset |\n| 120200 | Password generation failed |\n| 120201 | The cluster mode cannot be changed after creation |\n| 120202 | No public IPv4 address available |\n| 120203 | Version downgrade refused |\n| 120204 | Storage cannot be shrunk |\n| 120205 | Cluster has nothing to restart yet (still provisioning): retry once it is provisioned |\n| 120206 | Password rotation refused: authentication is disabled on the cluster |\n| 120207 | Password rotation refused: authentication was just enabled and is still being set up, retry in a few seconds |\n\n### RabbitMQ\n\n| Code | Error |\n|------|-------|\n| 140001 | Cluster not found |\n| 140002 | Cluster already exists |\n| 140003 | Permission denied on the cluster |\n| 140005 | RabbitMQ platform unavailable |\n| 140006 | Cluster provisioning failed |\n| 140100 | Invalid project_id |\n| 140101 | Invalid cluster name |\n| 140102 | Invalid replicas |\n| 140103 | Invalid storage size |\n| 140104 | Invalid or unsupported version |\n| 140105 | Unknown preset |\n| 140150 | Invalid username |\n| 140160 | Invalid vhost name |\n| 140161 | Unknown vhost role |\n| 140200 | Password generation failed |\n| 140201 | The cluster mode cannot be changed after creation |\n| 140202 | No public IPv4 address available |\n| 140203 | Version downgrade refused |\n| 140204 | Storage cannot be shrunk |\n| 140205 | Cluster has nothing to restart yet (still provisioning): retry once it is provisioned |\n\n### MongoDB\n\n| Code | Error |\n|------|-------|\n| 150001 | Cluster not found |\n| 150002 | Cluster already exists |\n| 150003 | Permission denied on the cluster |\n| 150005 | MongoDB platform unavailable |\n| 150006 | Cluster provisioning failed |\n| 150100 | Invalid project_id |\n| 150101 | Invalid cluster name |\n| 150102 | Invalid or unsupported version |\n| 150103 | Invalid replicas |\n| 150104 | Invalid storage size |\n| 150105 | Invalid database name |\n| 150106 | Invalid sharding configuration |\n| 150107 | Unknown preset |\n| 150150 | Invalid username |\n| 150151 | Unknown database role |\n| 150200 | Password generation failed |\n| 150201 | The cluster mode cannot be changed after creation |\n| 150202 | No public IPv4 address available |\n| 150203 | Version downgrade refused |\n| 150204 | Storage cannot be shrunk |\n| 150205 | Cluster has nothing to restart yet (still provisioning): retry once it is provisioned |\n\n### Network\n\n| Code | Error |\n|------|-------|\n| 160001 | VPC not found |\n| 160002 | VPC already exists |\n| 160003 | VPC used by instances; detach them first |\n| 160005 | Network platform unavailable |\n| 160010 | Subnet not found |\n| 160011 | Subnet already exists |\n| 160012 | Subnet used by instances; detach them first |\n| 160100 | Invalid project_id |\n| 160101 | Invalid VPC name |\n| 160150 | Invalid subnet name |\n| 160151 | Invalid CIDR |\n| 160152 | CIDR overlaps another subnet or a reserved range |\n| 160153 | CIDR is not a private range |\n| 160154 | CIDR is not IPv4 |\n\n### Billing\n\n| Code | Error |\n|------|-------|\n| 170100 | Unknown currency |\n\n### Backup\n\n| Code | Error |\n|------|-------|\n| 180001 | Destination not found |\n| 180002 | Plan not found |\n| 180003 | Backup run not found |\n| 180004 | Backup not found |\n| 180005 | Restore not found |\n| 180006 | Destination already exists |\n| 180007 | Plan already exists |\n| 180008 | Conflict: a name taken in the same second, or a concurrent change |\n| 180009 | Platform unavailable |\n| 180010 | Provisioning failed |\n| 180011 | Bucket not found in the project |\n| 180012 | Bucket user not found on the bucket |\n| 180013 | Application not found |\n| 180014 | Teardown incomplete: delete the destination again |\n| 180015 | Cancellation incomplete: cancel again to finish |\n| 180100 | project_id missing |\n| 180101 | Invalid destination name |\n| 180102 | Invalid plan name |\n| 180103 | Retention out of range |\n| 180105 | Schedule cannot be parsed, is an interval, or names a time zone |\n| 180106 | Schedule fires more than once an hour |\n| 180107 | Kind with no backup driver |\n| 180108 | Malformed recovery time, or combined with a restore point |\n| 180109 | Destructive confirmation missing |\n| 180110 | Invalid storage source |\n| 180111 | Application required |\n| 180112 | Value outside the accepted set |\n| 180113 | Name required |\n| 180200 | Destination not ready |\n| 180201 | Destination in use |\n| 180203 | Kind not supported by the destination |\n| 180204 | Backup not restorable, with the reason |\n| 180205 | A restore is already in progress for the application |\n| 180206 | Target kind does not match the backup |\n| 180207 | Point in time, or latest, on a kind other than Postgres |\n| 180208 | Separate target unsupported for the VM kinds |\n| 180209 | Destination being deleted |\n| 180210 | Backup being read by a restore |\n| 180211 | Source application gone: name a target |\n| 180212 | Postgres already written to another destination |\n| 180213 | No original disks to keep |\n| 180214 | Recovery time outside the window |\n| 180215 | Log archiving down |\n| 180216 | Run cannot be cancelled |\n| 180217 | Backup locked by its write-once bucket |\n| 180218 | Retention shorter than the bucket's lock |\n| 180219 | No transaction after the recovery time |\n| 180220 | Backup state cannot be verified now |\n| 180221 | The restore would leave the backup's history |\n| 180222 | The VM, or one of its disks, was created again since the backup |\n| 180223 | Restore cannot be cancelled |\n| 180224 | Postgres backup and target of different major versions |\n| 180225 | A disk cannot be restored over itself |\n| 180226 | Postgres still coming up from its last restore |\n| 180227 | Nothing to cancel yet: cancel again in a few seconds |", "version": "v0.1.0", "contact": { "name": "Hikube - HIDORA", "url": "https://hikube.cloud", "email": "contact@hidora.io" } }, "host": "api.demo.hikube.cloud", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/backup/v1alpha1/projects/{projectId}/destinations": { "get": { "summary": "List Backup Destinations", "operationId": "BackupService_ListDestinations", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListDestinationsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] }, "post": { "summary": "Create Backup Destination", "operationId": "BackupService_CreateDestination", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreateDestinationResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BackupServiceCreateDestinationBody" } } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/destinations/{name}": { "get": { "summary": "Get Backup Destination", "operationId": "BackupService_GetDestination", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetDestinationResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] }, "delete": { "summary": "Delete Backup Destination", "operationId": "BackupService_DeleteDestination", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteDestinationResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] }, "patch": { "summary": "Update Backup Destination", "operationId": "BackupService_UpdateDestination", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UpdateDestinationResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BackupServiceUpdateDestinationBody" } } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/plans": { "get": { "summary": "List Backup Plans", "operationId": "BackupService_ListPlans", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListPlansResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "applicationName", "in": "query", "required": false, "type": "string" }, { "name": "applicationKind", "description": "Only the plans of applications of this kind. Empty for any kind.", "in": "query", "required": false, "type": "string", "enum": [ "", "postgres", "mariadb", "instance", "disk" ] } ], "tags": [ "Backup" ] }, "post": { "summary": "Create Backup Plan", "operationId": "BackupService_CreatePlan", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreatePlanResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BackupServiceCreatePlanBody" } } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/plans/{name}": { "get": { "summary": "Get Backup Plan", "operationId": "BackupService_GetPlan", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetPlanResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] }, "delete": { "summary": "Delete Backup Plan", "operationId": "BackupService_DeletePlan", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeletePlanResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] }, "patch": { "summary": "Update Backup Plan", "operationId": "BackupService_UpdatePlan", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UpdatePlanResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BackupServiceUpdatePlanBody" } } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/jobs": { "get": { "summary": "List Backup Runs", "operationId": "BackupService_ListJobs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListJobsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "applicationName", "in": "query", "required": false, "type": "string" }, { "name": "plan", "in": "query", "required": false, "type": "string" } ], "tags": [ "Backup" ] }, "post": { "summary": "Start Backup Run", "operationId": "BackupService_CreateJob", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreateJobResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BackupServiceCreateJobBody" } } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/jobs/{name}": { "get": { "summary": "Get Backup Run", "operationId": "BackupService_GetJob", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetJobResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/jobs/{name}/cancel": { "put": { "summary": "Cancel Backup Run", "description": "Stops an unfinished backup run where the storage driver can stop, ending it failed with the message \"Backup cancelled.\". Works for a run not started yet, a Postgres backup still waiting to start, a VM instance or disk run (its data transfers are cancelled) and a MariaDB run. Refused with FailedPrecondition for a Postgres backup already running, a VM run that has not started moving data yet (retry in a few seconds), and a finished run. Deleting a run is not offered: the driver would carry on and leave an archive nothing refers to.", "operationId": "BackupService_CancelJob", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CancelJobResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/backups": { "get": { "summary": "List Backups", "operationId": "BackupService_ListBackups", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListBackupsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "applicationName", "description": "Matches an archive taken from this application, and an archive that merely\ncontains it — see Backup.covers. Asking what protects a disk of a VM\ntherefore returns the VM's archive.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/backups/{name}": { "get": { "summary": "Get Backup", "operationId": "BackupService_GetBackup", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetBackupResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] }, "delete": { "summary": "Delete Backup", "operationId": "BackupService_DeleteBackup", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteBackupResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "confirmDestructive", "description": "Required for VM instance and VM disk backups, whose stored archive is destroyed with the record. Not required for Postgres and MariaDB.", "in": "query", "required": false, "type": "boolean" } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/restores": { "get": { "summary": "List Restores", "operationId": "BackupService_ListRestores", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListRestoresResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "applicationName", "in": "query", "required": false, "type": "string" } ], "tags": [ "Backup" ] }, "post": { "summary": "Create Restore", "operationId": "BackupService_CreateRestore", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreateRestoreResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BackupServiceCreateRestoreBody" } } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/restores/{name}": { "get": { "summary": "Get Restore", "operationId": "BackupService_GetRestore", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetRestoreResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] }, "delete": { "summary": "Delete Restore", "description": "Removes the record of a finished restore. Refused with FailedPrecondition while the restore is pending or running: the driver would carry on without a record, and the application would be released to a second restore. On a finished restore only the record goes; the application and the backup are unchanged. A VM restore that does not finish is stopped with CancelRestore.", "operationId": "BackupService_DeleteRestore", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteRestoreResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] } }, "/backup/v1alpha1/projects/{projectId}/restores/{name}/cancel": { "put": { "summary": "Cancel Restore", "description": "Stops an unfinished VM instance or disk restore, ending it failed with a message saying what it leaves behind. Its data transfers are cancelled, and a restore not started yet is removed. Refused with FailedPrecondition for Postgres and MariaDB, whose restores fail on their own after thirty minutes, for a VM restore that has not started moving data yet (retry in a few seconds), and for a restore that is finished or finishing. Nothing is reverted: the VM may be left stopped with its disks set aside, and restoring again brings it back.", "operationId": "BackupService_CancelRestore", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CancelRestoreResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Backup" ] } }, "/billing/v1alpha1/prices/instance": { "get": { "summary": "List instance (VM) prices", "operationId": "BillingService_ListInstancePrices", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListPricesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "currency", "description": "ISO 4217 currency code, required: CHF or EUR", "in": "query", "required": false, "type": "string" } ], "tags": [ "Billing" ] } }, "/billing/v1alpha1/prices/database": { "get": { "summary": "List database prices", "operationId": "BillingService_ListDatabasePrices", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListPricesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "currency", "description": "ISO 4217 currency code, required: CHF or EUR", "in": "query", "required": false, "type": "string" } ], "tags": [ "Billing" ] } }, "/billing/v1alpha1/prices/kubernetes": { "get": { "summary": "List Kubernetes (managed control plane) prices", "operationId": "BillingService_ListKubernetesPrices", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListPricesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "currency", "description": "ISO 4217 currency code, required: CHF or EUR", "in": "query", "required": false, "type": "string" } ], "tags": [ "Billing" ] } }, "/billing/v1alpha1/prices/licenses": { "get": { "summary": "List OS licence prices", "operationId": "BillingService_ListLicensesPrices", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListPricesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "currency", "description": "ISO 4217 currency code, required: CHF or EUR", "in": "query", "required": false, "type": "string" } ], "tags": [ "Billing" ] } }, "/billing/v1alpha1/prices/gpu": { "get": { "summary": "List GPU prices", "operationId": "BillingService_ListGpuPrices", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListPricesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "currency", "description": "ISO 4217 currency code, required: CHF or EUR", "in": "query", "required": false, "type": "string" } ], "tags": [ "Billing" ] } }, "/billing/v1alpha1/prices/network": { "get": { "summary": "List network prices", "operationId": "BillingService_ListNetworkPrices", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListPricesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "currency", "description": "ISO 4217 currency code, required: CHF or EUR", "in": "query", "required": false, "type": "string" } ], "tags": [ "Billing" ] } }, "/billing/v1alpha1/prices/block-storage": { "get": { "summary": "List block storage prices (per GiB)", "operationId": "BillingService_ListBlockStoragePrices", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListPricesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "currency", "description": "ISO 4217 currency code, required: CHF or EUR", "in": "query", "required": false, "type": "string" } ], "tags": [ "Billing" ] } }, "/billing/v1alpha1/prices/object-storage": { "get": { "summary": "List object storage prices (per GiB)", "operationId": "BillingService_ListObjectStoragePrices", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListPricesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "currency", "description": "ISO 4217 currency code, required: CHF or EUR", "in": "query", "required": false, "type": "string" } ], "tags": [ "Billing" ] } }, "/bucket/v1alpha1/projects/{projectId}/buckets": { "get": { "summary": "List Buckets", "operationId": "BucketService_ListBuckets", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubebucketv1ListResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Object Storage" ] }, "post": { "summary": "Create Bucket", "operationId": "BucketService_CreateBucket", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubebucketv1CreateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BucketServiceCreateBucketBody" } } ], "tags": [ "Object Storage" ] } }, "/bucket/v1alpha1/projects/{projectId}/buckets/{name}": { "get": { "summary": "Get Bucket", "operationId": "BucketService_GetBucket", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubebucketv1GetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Object Storage" ] }, "delete": { "summary": "Delete Bucket", "operationId": "BucketService_DeleteBucket", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubebucketv1DeleteResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Object Storage" ] } }, "/bucket/v1alpha1/projects/{projectId}/buckets/{bucketName}/users": { "get": { "summary": "List Bucket Users", "operationId": "BucketService_ListUsers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubebucketv1ListUsersResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "bucketName", "in": "path", "required": true, "type": "string" } ], "tags": [ "Object Storage" ] }, "post": { "summary": "Create Bucket User", "operationId": "BucketService_CreateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubebucketv1CreateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "bucketName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1BucketServiceCreateUserBody" } } ], "tags": [ "Object Storage" ] } }, "/bucket/v1alpha1/projects/{projectId}/buckets/{bucketName}/users/{username}": { "get": { "summary": "Get Bucket User", "operationId": "BucketService_GetUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubebucketv1GetUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "bucketName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "Object Storage" ] }, "delete": { "summary": "Delete Bucket User", "operationId": "BucketService_DeleteUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubebucketv1DeleteUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "bucketName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "Object Storage" ] }, "patch": { "summary": "Update Bucket User", "operationId": "BucketService_UpdateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubebucketv1UpdateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "bucketName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1BucketServiceUpdateUserBody" } } ], "tags": [ "Object Storage" ] } }, "/bucket/v1alpha1/projects/{projectId}/buckets/{bucketName}/users/{username}/rotate-credentials": { "post": { "summary": "Rotate Bucket User Credentials", "operationId": "BucketService_RotateUserCredentials", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RotateUserCredentialsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "bucketName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "Object Storage" ] } }, "/disk/v1alpha1/projects/{projectId}/disks": { "get": { "summary": "List Disks", "operationId": "DiskService_ListDisks", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubediskv1ListResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Disk Storage" ] }, "post": { "summary": "Create Disk", "operationId": "DiskService_CreateDisk", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubediskv1CreateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DiskServiceCreateDiskBody" } } ], "tags": [ "Disk Storage" ] } }, "/disk/v1alpha1/projects/{projectId}/disks/{name}": { "get": { "summary": "Get Disk", "operationId": "DiskService_GetDisk", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubediskv1GetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Disk Storage" ] }, "delete": { "summary": "Delete Disk", "operationId": "DiskService_DeleteDisk", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubediskv1DeleteResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Disk Storage" ] }, "patch": { "summary": "Update Disk", "operationId": "DiskService_UpdateDisk", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubediskv1UpdateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DiskServiceUpdateDiskBody" } } ], "tags": [ "Disk Storage" ] } }, "/gpu/v1alpha1/gpus": { "get": { "summary": "List GPU types and availability", "operationId": "GpuService_ListGpus", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListGpusResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "GPU" ] } }, "/instance/v1alpha1/projects/{projectId}/instances": { "get": { "summary": "List Instances", "operationId": "InstanceService_ListInstances", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubeinstancev1ListResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Instance" ] }, "post": { "summary": "Create Instance", "operationId": "InstanceService_CreateInstance", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubeinstancev1CreateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InstanceServiceCreateInstanceBody" } } ], "tags": [ "Instance" ] } }, "/instance/v1alpha1/projects/{projectId}/instances/{name}": { "get": { "summary": "Get Instance", "operationId": "InstanceService_GetInstance", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubeinstancev1GetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Instance" ] }, "delete": { "summary": "Delete Instance", "operationId": "InstanceService_DeleteInstance", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubeinstancev1DeleteResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Instance" ] }, "patch": { "summary": "Update Instance", "operationId": "InstanceService_UpdateInstance", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubeinstancev1UpdateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InstanceServiceUpdateInstanceBody" } } ], "tags": [ "Instance" ] } }, "/instance/v1alpha1/projects/{projectId}/instances/{name}/start": { "put": { "summary": "Start Instance", "operationId": "InstanceService_StartInstance", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1StartResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Instance" ] } }, "/instance/v1alpha1/projects/{projectId}/instances/{name}/stop": { "put": { "summary": "Stop Instance", "operationId": "InstanceService_StopInstance", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1StopResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Instance" ] } }, "/instance/v1alpha1/projects/{projectId}/instances/{name}/restart": { "put": { "summary": "Restart Instance", "operationId": "InstanceService_RestartInstance", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RestartResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Instance" ] } }, "/instance/v1alpha1/projects/{projectId}/instances/{name}/reload-userdata": { "put": { "summary": "Reload UserData script", "operationId": "InstanceService_ReloadInstanceUserData", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ReloadUserDataResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Instance" ] } }, "/instance/v1alpha1/cloud-images": { "get": { "summary": "List Available Cloud Images", "operationId": "InstanceService_ListCloudImages", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListCloudImagesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "Instance" ] } }, "/instance/v1alpha1/instance-types": { "get": { "summary": "List Available Instance Types", "operationId": "InstanceService_ListInstanceTypes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListInstanceTypesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "Instance" ] } }, "/kubernetes/v1alpha1/projects/{projectId}/clusters": { "get": { "summary": "List clusters", "operationId": "KubernetesService_ListKubernetesClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubekubernetesv1ListResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Kubernetes" ] }, "post": { "summary": "Create cluster", "operationId": "KubernetesService_CreateKubernetesCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubekubernetesv1CreateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/KubernetesServiceCreateKubernetesClusterBody" } } ], "tags": [ "Kubernetes" ] } }, "/kubernetes/v1alpha1/projects/{projectId}/clusters/{name}": { "get": { "summary": "Get cluster", "operationId": "KubernetesService_GetKubernetesCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubekubernetesv1GetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Kubernetes" ] }, "delete": { "summary": "Delete cluster", "operationId": "KubernetesService_DeleteKubernetesCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubekubernetesv1DeleteResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Kubernetes" ] }, "patch": { "summary": "Update cluster", "operationId": "KubernetesService_UpdateKubernetesCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubekubernetesv1UpdateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/KubernetesServiceUpdateKubernetesClusterBody" } } ], "tags": [ "Kubernetes" ] } }, "/kubernetes/v1alpha1/projects/{projectId}/clusters/{name}/kubeconfig": { "get": { "summary": "Get kubeconfig", "operationId": "KubernetesService_GetKubernetesClusterKubeconfig", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetKubeconfigResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Kubernetes" ] } }, "/kubernetes/v1alpha1/versions": { "get": { "summary": "List available Kubernetes versions", "operationId": "KubernetesService_ListKubernetesVersions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListVersionsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "Kubernetes" ] } }, "/kubernetes/v1alpha1/presets": { "get": { "summary": "List resource presets allowed for the Kubernetes control plane", "operationId": "KubernetesService_ListKubernetesPresets", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubekubernetesv1ListPresetsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "Kubernetes" ] } }, "/mariadb/v1alpha1/projects/{projectId}/clusters": { "get": { "summary": "List clusters", "operationId": "MariaDBService_ListMariaDBClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1ListResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] }, "post": { "summary": "Create cluster", "operationId": "MariaDBService_CreateMariaDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1CreateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/MariaDBServiceCreateMariaDBClusterBody" } } ], "tags": [ "MariaDB" ] } }, "/mariadb/v1alpha1/projects/{projectId}/clusters/{name}": { "get": { "summary": "Get cluster", "operationId": "MariaDBService_GetMariaDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1GetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] }, "delete": { "summary": "Delete cluster", "operationId": "MariaDBService_DeleteMariaDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1DeleteResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] }, "patch": { "summary": "Update cluster", "operationId": "MariaDBService_UpdateMariaDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1UpdateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/MariaDBServiceUpdateMariaDBClusterBody" } } ], "tags": [ "MariaDB" ] } }, "/mariadb/v1alpha1/projects/{projectId}/clusters/{name}/restart": { "post": { "summary": "Restart cluster", "description": "Starts a restart of the cluster's MariaDB servers and returns without waiting. All servers restart at once: the cluster is briefly unreachable, its data is kept.", "operationId": "MariaDBService_RestartMariaDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RestartMariaDBClusterResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] } }, "/mariadb/v1alpha1/projects/{projectId}/clusters/{clusterName}/databases": { "get": { "summary": "List databases", "operationId": "MariaDBService_ListDatabases", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1ListDatabasesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] }, "post": { "summary": "Create database", "operationId": "MariaDBService_CreateDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1CreateDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1MariaDBServiceCreateDatabaseBody" } } ], "tags": [ "MariaDB" ] } }, "/mariadb/v1alpha1/projects/{projectId}/clusters/{clusterName}/databases/{databaseName}": { "get": { "summary": "Get database", "operationId": "MariaDBService_GetDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1GetDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] }, "delete": { "summary": "Delete database", "operationId": "MariaDBService_DeleteDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1DeleteDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] } }, "/mariadb/v1alpha1/projects/{projectId}/clusters/{clusterName}/users": { "get": { "summary": "List users", "operationId": "MariaDBService_ListUsers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1ListUsersResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] }, "post": { "summary": "Create user", "operationId": "MariaDBService_CreateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1CreateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1MariaDBServiceCreateUserBody" } } ], "tags": [ "MariaDB" ] } }, "/mariadb/v1alpha1/projects/{projectId}/clusters/{clusterName}/users/{username}": { "get": { "summary": "Get user", "operationId": "MariaDBService_GetUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1GetUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] }, "delete": { "summary": "Delete user", "operationId": "MariaDBService_DeleteUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1DeleteUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] }, "patch": { "summary": "Update user", "operationId": "MariaDBService_UpdateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1UpdateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1MariaDBServiceUpdateUserBody" } } ], "tags": [ "MariaDB" ] } }, "/mariadb/v1alpha1/projects/{projectId}/clusters/{clusterName}/users/{username}/rotate-password": { "post": { "summary": "Rotate user password", "operationId": "MariaDBService_RotateUserPassword", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1RotateUserPasswordResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "MariaDB" ] } }, "/mariadb/v1alpha1/presets": { "get": { "summary": "List resource presets allowed for mariadb", "operationId": "MariaDBService_ListMariaDBPresets", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemariadbv1ListPresetsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "MariaDB" ] } }, "/mongodb/v1alpha1/projects/{projectId}/clusters": { "get": { "summary": "List clusters", "operationId": "MongoDBService_ListMongoDBClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1ListResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] }, "post": { "summary": "Create cluster", "operationId": "MongoDBService_CreateMongoDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1CreateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/MongoDBServiceCreateMongoDBClusterBody" } } ], "tags": [ "MongoDB" ] } }, "/mongodb/v1alpha1/projects/{projectId}/clusters/{name}": { "get": { "summary": "Get cluster", "operationId": "MongoDBService_GetMongoDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1GetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] }, "delete": { "summary": "Delete cluster", "operationId": "MongoDBService_DeleteMongoDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1DeleteResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] }, "patch": { "summary": "Update cluster", "operationId": "MongoDBService_UpdateMongoDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1UpdateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/MongoDBServiceUpdateMongoDBClusterBody" } } ], "tags": [ "MongoDB" ] } }, "/mongodb/v1alpha1/projects/{projectId}/clusters/{name}/restart": { "post": { "summary": "Restart cluster", "description": "Starts a restart of the cluster's mongod members (replica set, config servers and shards) and returns without waiting. All members restart at once: the cluster is briefly unreachable, its data is kept. The mongos routers are not restarted.", "operationId": "MongoDBService_RestartMongoDBCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RestartMongoDBClusterResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] } }, "/mongodb/v1alpha1/projects/{projectId}/clusters/{clusterName}/databases": { "get": { "summary": "List databases", "operationId": "MongoDBService_ListDatabases", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1ListDatabasesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] }, "post": { "summary": "Create database", "operationId": "MongoDBService_CreateDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1CreateDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1MongoDBServiceCreateDatabaseBody" } } ], "tags": [ "MongoDB" ] } }, "/mongodb/v1alpha1/projects/{projectId}/clusters/{clusterName}/databases/{databaseName}": { "get": { "summary": "Get database", "operationId": "MongoDBService_GetDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1GetDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] }, "delete": { "summary": "Delete database", "operationId": "MongoDBService_DeleteDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1DeleteDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] } }, "/mongodb/v1alpha1/projects/{projectId}/clusters/{clusterName}/users": { "get": { "summary": "List users", "operationId": "MongoDBService_ListUsers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1ListUsersResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] }, "post": { "summary": "Create user", "operationId": "MongoDBService_CreateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1CreateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1MongoDBServiceCreateUserBody" } } ], "tags": [ "MongoDB" ] } }, "/mongodb/v1alpha1/projects/{projectId}/clusters/{clusterName}/users/{username}": { "get": { "summary": "Get user", "operationId": "MongoDBService_GetUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1GetUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] }, "delete": { "summary": "Delete user", "operationId": "MongoDBService_DeleteUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1DeleteUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] }, "patch": { "summary": "Update user", "operationId": "MongoDBService_UpdateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1UpdateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1MongoDBServiceUpdateUserBody" } } ], "tags": [ "MongoDB" ] } }, "/mongodb/v1alpha1/projects/{projectId}/clusters/{clusterName}/users/{username}/rotate-password": { "post": { "summary": "Rotate user password", "operationId": "MongoDBService_RotateUserPassword", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1RotateUserPasswordResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "MongoDB" ] } }, "/mongodb/v1alpha1/presets": { "get": { "summary": "List resource presets allowed for mongodb", "operationId": "MongoDBService_ListMongoDBPresets", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubemongodbv1ListPresetsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "MongoDB" ] } }, "/network/v1alpha1/projects/{projectId}/vpcs": { "get": { "summary": "List VPCs", "operationId": "NetworkService_ListVPCs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListVPCsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Network" ] }, "post": { "summary": "Create VPC", "operationId": "NetworkService_CreateVPC", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreateVPCResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NetworkServiceCreateVPCBody" } } ], "tags": [ "Network" ] } }, "/network/v1alpha1/projects/{projectId}/vpcs/{name}": { "get": { "summary": "Get VPC", "operationId": "NetworkService_GetVPC", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetVPCResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Network" ] }, "delete": { "summary": "Delete VPC", "operationId": "NetworkService_DeleteVPC", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteVPCResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Network" ] } }, "/network/v1alpha1/projects/{projectId}/vpcs/{vpcName}/subnets": { "get": { "summary": "List Subnets", "operationId": "NetworkService_ListSubnets", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListSubnetsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "vpcName", "in": "path", "required": true, "type": "string" } ], "tags": [ "Network" ] }, "post": { "summary": "Create Subnet", "operationId": "NetworkService_CreateSubnet", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreateSubnetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "vpcName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NetworkServiceCreateSubnetBody" } } ], "tags": [ "Network" ] } }, "/network/v1alpha1/projects/{projectId}/vpcs/{vpcName}/subnets/{subnetName}": { "get": { "summary": "Get Subnet", "operationId": "NetworkService_GetSubnet", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetSubnetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "vpcName", "in": "path", "required": true, "type": "string" }, { "name": "subnetName", "in": "path", "required": true, "type": "string" } ], "tags": [ "Network" ] }, "delete": { "summary": "Delete Subnet", "operationId": "NetworkService_DeleteSubnet", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteSubnetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "vpcName", "in": "path", "required": true, "type": "string" }, { "name": "subnetName", "in": "path", "required": true, "type": "string" } ], "tags": [ "Network" ] } }, "/postgres/v1alpha1/projects/{projectId}/clusters": { "get": { "summary": "List clusters", "operationId": "PostgresService_ListPostgresClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1ListResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] }, "post": { "summary": "Create cluster", "operationId": "PostgresService_CreatePostgresCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1CreateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PostgresServiceCreatePostgresClusterBody" } } ], "tags": [ "Postgres" ] } }, "/postgres/v1alpha1/projects/{projectId}/clusters/{name}": { "get": { "summary": "Get cluster", "operationId": "PostgresService_GetPostgresCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1GetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] }, "delete": { "summary": "Delete cluster", "operationId": "PostgresService_DeletePostgresCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1DeleteResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] }, "patch": { "summary": "Update cluster", "operationId": "PostgresService_UpdatePostgresCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1UpdateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PostgresServiceUpdatePostgresClusterBody" } } ], "tags": [ "Postgres" ] } }, "/postgres/v1alpha1/projects/{projectId}/clusters/{name}/restart": { "post": { "summary": "Restart cluster", "description": "Starts a rolling restart of the cluster's PostgreSQL instances and returns without waiting. Replicas restart first, then the primary in place: reads stay served by the replicas, writes are refused while the primary restarts. The data is kept.", "operationId": "PostgresService_RestartPostgresCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RestartPostgresClusterResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] } }, "/postgres/v1alpha1/projects/{projectId}/clusters/{clusterName}/databases": { "get": { "summary": "List databases", "operationId": "PostgresService_ListDatabases", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1ListDatabasesResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] }, "post": { "summary": "Create database", "operationId": "PostgresService_CreateDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1CreateDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1PostgresServiceCreateDatabaseBody" } } ], "tags": [ "Postgres" ] } }, "/postgres/v1alpha1/projects/{projectId}/clusters/{clusterName}/databases/{databaseName}": { "get": { "summary": "Get database", "operationId": "PostgresService_GetDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1GetDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] }, "delete": { "summary": "Delete database", "operationId": "PostgresService_DeleteDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1DeleteDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] }, "patch": { "summary": "Update database", "operationId": "PostgresService_UpdateDatabase", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UpdateDatabaseResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PostgresServiceUpdateDatabaseBody" } } ], "tags": [ "Postgres" ] } }, "/postgres/v1alpha1/extensions": { "get": { "summary": "List available PostgreSQL extensions", "operationId": "PostgresService_ListExtensions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListExtensionsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "Postgres" ] } }, "/postgres/v1alpha1/presets": { "get": { "summary": "List resource presets allowed for postgres", "operationId": "PostgresService_ListPostgresPresets", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1ListPresetsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "Postgres" ] } }, "/postgres/v1alpha1/projects/{projectId}/clusters/{clusterName}/users": { "get": { "summary": "List users", "operationId": "PostgresService_ListUsers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1ListUsersResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] }, "post": { "summary": "Create user", "operationId": "PostgresService_CreateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1CreateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1PostgresServiceCreateUserBody" } } ], "tags": [ "Postgres" ] } }, "/postgres/v1alpha1/projects/{projectId}/clusters/{clusterName}/users/{username}": { "get": { "summary": "Get user", "operationId": "PostgresService_GetUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1GetUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] }, "delete": { "summary": "Delete user", "operationId": "PostgresService_DeleteUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1DeleteUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] }, "patch": { "summary": "Update user", "operationId": "PostgresService_UpdateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1UpdateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1PostgresServiceUpdateUserBody" } } ], "tags": [ "Postgres" ] } }, "/postgres/v1alpha1/projects/{projectId}/clusters/{clusterName}/users/{username}/rotate-password": { "post": { "summary": "Rotate user password", "operationId": "PostgresService_RotateUserPassword", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikubepostgresv1RotateUserPasswordResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "Postgres" ] } }, "/rabbitmq/v1alpha1/projects/{projectId}/clusters": { "get": { "summary": "List clusters", "operationId": "RabbitMQService_ListRabbitMQClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1ListResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] }, "post": { "summary": "Create cluster", "operationId": "RabbitMQService_CreateRabbitMQCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1CreateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RabbitMQServiceCreateRabbitMQClusterBody" } } ], "tags": [ "RabbitMQ" ] } }, "/rabbitmq/v1alpha1/projects/{projectId}/clusters/{name}": { "get": { "summary": "Get cluster", "operationId": "RabbitMQService_GetRabbitMQCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1GetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] }, "delete": { "summary": "Delete cluster", "operationId": "RabbitMQService_DeleteRabbitMQCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1DeleteResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] }, "patch": { "summary": "Update cluster", "operationId": "RabbitMQService_UpdateRabbitMQCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1UpdateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RabbitMQServiceUpdateRabbitMQClusterBody" } } ], "tags": [ "RabbitMQ" ] } }, "/rabbitmq/v1alpha1/projects/{projectId}/clusters/{name}/restart": { "post": { "summary": "Restart cluster", "description": "Starts a restart of the cluster's RabbitMQ nodes and returns without waiting. All nodes restart at once: the cluster is briefly unreachable, its data is kept.", "operationId": "RabbitMQService_RestartRabbitMQCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RestartRabbitMQClusterResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] } }, "/rabbitmq/v1alpha1/projects/{projectId}/clusters/{clusterName}/users": { "get": { "summary": "List users", "operationId": "RabbitMQService_ListUsers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1ListUsersResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] }, "post": { "summary": "Create user", "operationId": "RabbitMQService_CreateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1CreateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1RabbitMQServiceCreateUserBody" } } ], "tags": [ "RabbitMQ" ] } }, "/rabbitmq/v1alpha1/projects/{projectId}/clusters/{clusterName}/users/{username}": { "get": { "summary": "Get user", "operationId": "RabbitMQService_GetUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1GetUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] }, "delete": { "summary": "Delete user", "operationId": "RabbitMQService_DeleteUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1DeleteUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] }, "patch": { "summary": "Update user", "operationId": "RabbitMQService_UpdateUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1UpdateUserResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1RabbitMQServiceUpdateUserBody" } } ], "tags": [ "RabbitMQ" ] } }, "/rabbitmq/v1alpha1/projects/{projectId}/clusters/{clusterName}/users/{username}/rotate-password": { "post": { "summary": "Rotate user password", "operationId": "RabbitMQService_RotateUserPassword", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1RotateUserPasswordResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "username", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] } }, "/rabbitmq/v1alpha1/projects/{projectId}/clusters/{clusterName}/vhosts": { "get": { "summary": "List vhosts", "operationId": "RabbitMQService_ListVhosts", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ListVhostsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] }, "post": { "summary": "Create vhost", "operationId": "RabbitMQService_CreateVhost", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1CreateVhostResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RabbitMQServiceCreateVhostBody" } } ], "tags": [ "RabbitMQ" ] } }, "/rabbitmq/v1alpha1/projects/{projectId}/clusters/{clusterName}/vhosts/{vhostName}": { "get": { "summary": "Get vhost", "operationId": "RabbitMQService_GetVhost", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1GetVhostResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "vhostName", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] }, "delete": { "summary": "Delete vhost", "operationId": "RabbitMQService_DeleteVhost", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DeleteVhostResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "clusterName", "in": "path", "required": true, "type": "string" }, { "name": "vhostName", "in": "path", "required": true, "type": "string" } ], "tags": [ "RabbitMQ" ] } }, "/rabbitmq/v1alpha1/presets": { "get": { "summary": "List resource presets allowed for rabbitmq", "operationId": "RabbitMQService_ListRabbitMQPresets", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberabbitmqv1ListPresetsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "RabbitMQ" ] } }, "/redis/v1alpha1/projects/{projectId}/clusters": { "get": { "summary": "List clusters", "operationId": "RedisService_ListRedisClusters", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberedisv1ListResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" } ], "tags": [ "Redis" ] }, "post": { "summary": "Create cluster", "operationId": "RedisService_CreateRedisCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberedisv1CreateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RedisServiceCreateRedisClusterBody" } } ], "tags": [ "Redis" ] } }, "/redis/v1alpha1/projects/{projectId}/clusters/{name}": { "get": { "summary": "Get cluster", "operationId": "RedisService_GetRedisCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberedisv1GetResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Redis" ] }, "delete": { "summary": "Delete cluster", "operationId": "RedisService_DeleteRedisCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberedisv1DeleteResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Redis" ] }, "patch": { "summary": "Update cluster", "operationId": "RedisService_UpdateRedisCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberedisv1UpdateResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RedisServiceUpdateRedisClusterBody" } } ], "tags": [ "Redis" ] } }, "/redis/v1alpha1/projects/{projectId}/clusters/{name}/restart": { "post": { "summary": "Restart cluster", "description": "Starts a restart of the cluster's Redis servers and sentinels and returns without waiting. All servers and sentinels restart at once: the cluster is briefly unreachable, its data is kept. Applies a pending authentication or password change (see restartRequired).", "operationId": "RedisService_RestartRedisCluster", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RestartRedisClusterResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Redis" ] } }, "/redis/v1alpha1/projects/{projectId}/clusters/{name}/rotate-password": { "post": { "summary": "Rotate cluster password", "description": "Replaces the cluster password and returns the new one. Authentication stays enabled throughout. The running servers keep accepting the previous password until the cluster is restarted (POST .../restart); restartRequired reports it until then. Refused when authentication is disabled, and, with a retryable error, right after authentication was enabled, while the cluster's password is still being set up.", "operationId": "RedisService_RotatePassword", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1RotatePasswordResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "tags": [ "Redis" ] } }, "/redis/v1alpha1/presets": { "get": { "summary": "List resource presets allowed for redis", "operationId": "RedisService_ListRedisPresets", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/hikuberedisv1ListPresetsResponse" } }, "400": { "description": "Bad Request - Invalid input, or the operation is not possible in the current state", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20101, "message": "invalid name: must be at least 3 characters", "details": [] } } }, "401": { "description": "Unauthorized - Invalid or expired credentials. When the ingress gateway rejects the bearer token, the body is the gateway's own and not an ErrorResponse; when the API rejects the request (code 10001), the body is an ErrorResponse.", "schema": { "$ref": "#/definitions/v1ErrorResponse" } }, "403": { "description": "Forbidden - Missing or invalid credentials, or insufficient permissions", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 10002, "message": "permission denied to access on resource", "details": [] } } }, "404": { "description": "Not Found - Resource does not exist", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20001, "message": "instance 'myvm' not found", "details": [] } } }, "409": { "description": "Conflict - Resource already exists, or was modified concurrently", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20002, "message": "instance 'myvm' already exists", "details": [] } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "message": "internal server error", "details": [] } } }, "503": { "description": "Service Unavailable - Platform is temporarily unavailable", "schema": { "$ref": "#/definitions/v1ErrorResponse" }, "examples": { "application/json": { "requestId": "4bf92f3577b34da6a3ce929d0e0e4736", "code": 20005, "message": "instance service unavailable", "details": [] } } } }, "tags": [ "Redis" ] } } }, "definitions": { "BackupServiceCreateDestinationBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Destination name, unique within the project", "maxLength": 40, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "bucketName": { "type": "string", "description": "Name of a bucket in this project, managed by the bucket service. Required, with bucket_user." }, "bucketUser": { "type": "string", "description": "Bucket user whose credentials the destination uses. Required, with bucket_name." }, "retentionDays": { "type": "integer", "format": "int64", "description": "How long archives are kept, in whole days. Enforcement is driver-side." } }, "description": "CreateDestinationRequest deliberately carries no endpoint, access-key or\nsecret-key field. Storage coordinates are derived from the referenced\nbucket, and the way to guarantee a caller cannot supply them is for the\nfields not to exist.\n\nThat invariant survives external storage rather than being traded away for\nit: a destination will name a credential created through its own operation,\nso the coordinates still never ride on this message.\n\nThe storage source is exactly one of the bucket pair or, later, a\ncredential. The fields are flat and the exclusivity is the validator's\n(validateStorageSource), as the contract conventions require of exclusive\ninputs: a oneof renders as unrelated optional properties in OpenAPI." }, "BackupServiceCreateJobBody": { "type": "object", "properties": { "application": { "$ref": "#/definitions/v1ApplicationRef" }, "destination": { "type": "string" } } }, "BackupServiceCreatePlanBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Plan name, unique within the project", "maxLength": 40, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "application": { "$ref": "#/definitions/v1ApplicationRef" }, "destination": { "type": "string" }, "cron": { "type": "string", "description": "Five-field cron expression, or @hourly, @daily, @weekly, @monthly, @yearly, interpreted in UTC. Must not fire more than once per hour. @every and CRON_TZ=/TZ= prefixes are refused." } } }, "BackupServiceCreateRestoreBody": { "type": "object", "properties": { "backup": { "type": "string" }, "target": { "$ref": "#/definitions/v1ApplicationRef", "description": "Omit to restore over the backup's own source application. Naming that same\napplication explicitly is the identical operation and is treated as such.\nOnly postgres and mariadb accept a different target." }, "confirmDestructive": { "type": "boolean", "description": "Required whenever the resolved target is the source application, or is an existing application that already holds data." }, "recoveryTime": { "type": "string", "format": "date-time", "description": "Postgres only. Must fall inside the backup's recovery_window: at or after\nearliest, before last_commit_at and before cross_timeline_after. Omit it to\nrestore the state restore_point names. Exclusive with restore_point latest." }, "originalDisks": { "type": "string", "enum": [ "", "discard", "keep" ], "description": "What becomes of the disks a VM instance restored over its source displaces. Either way they are replaced by the backup's copies. discard, the default, which empty means: what they held is deleted once the restore has succeeded, so a restore that says nothing does not start paying for a second copy; a restore that fails or is cancelled deletes nothing and keeps them as keep does, and its message says so. keep: what they held is kept as a disk of its own, named \u003cdisk\u003e-orig-\u003cid\u003e, attached to nothing, listed and billed like any other disk. keep is refused on any other restore." }, "restorePoint": { "type": "string", "enum": [ "", "backup", "latest" ], "description": "Postgres only, and only without recovery_time. backup, the default, which empty means: the state of the backup named. latest: the latest state its archived log reaches, along its history." } } }, "BackupServiceUpdateDestinationBody": { "type": "object", "properties": { "retentionDays": { "type": "integer", "format": "int64", "description": "New retention in days. MariaDB, VM instance and VM disk archives keep the retention they were written with; Postgres archives are governed by the destination's current retention." }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`retentionDays`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `retentionDays`." } } }, "BackupServiceUpdatePlanBody": { "type": "object", "properties": { "cron": { "type": "string", "description": "Same rules as CreatePlanRequest.cron." }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`cron`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `cron`." } }, "description": "Only the schedule is mutable. The application and the destination are fixed\nat creation." }, "BucketServiceCreateBucketBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Bucket name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "locking": { "type": "boolean", "description": "Enable S3 Object Lock (WORM). Cannot be changed after creation." }, "encrypted": { "type": "boolean", "description": "Enable encryption at rest (LUKS). Cannot be changed after creation." } } }, "DiskServiceCreateDiskBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Disk name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "size": { "type": "integer", "format": "int64", "description": "Define storage capacity in GiB", "maximum": 4096, "minimum": 20 }, "encrypted": { "type": "boolean", "description": "Enable disk encryption" }, "asyncReplication": { "type": "boolean", "description": "Use async replication (sync replication is the default)" }, "data": { "$ref": "#/definitions/v1Data" } } }, "DiskServiceUpdateDiskBody": { "type": "object", "properties": { "size": { "type": "integer", "format": "int64", "description": "Define storage capacity in GiB", "maximum": 4096, "minimum": 20 }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update (`size`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `size`." } } }, "InstanceServiceCreateInstanceBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Instance name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "instanceType": { "type": "string", "example": "u1.medium", "description": "Instance type\n\nAvailable types:\n- U1 series: u1.medium, u1.large, u1.xlarge, u1.2xlarge, u1.4xlarge, u1.8xlarge\n- S1 series: s1.small, s1.medium, s1.large, s1.xlarge, s1.3large, s1.2xlarge, s1.3xlarge, s1.4xlarge, s1.8xlarge\n- M1 series: m1.large, m1.xlarge, m1.2xlarge, m1.4xlarge, m1.8xlarge", "maxLength": 63, "minLength": 1 }, "image": { "type": "string", "example": "ubuntu-24.04", "description": "Cloud image of the system disk, named \u003cdistro\u003e-\u003cversion\u003e; GET /instance/v1alpha1/cloud-images lists the accepted values. Optional only when the first disk is an existing disk that already carries an image.", "maxLength": 128, "minLength": 1 }, "disks": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Disk" }, "description": "Declare your disks here\nThe system disk has to be in first position\n" }, "network": { "$ref": "#/definitions/v1Network" }, "gpus": { "type": "array", "items": { "type": "string" }, "description": "GPU types (see GPU service for available types)" }, "sshKeys": { "type": "array", "items": { "type": "string" }, "description": "SSH public keys to add to the instance, each as \"\u003calgorithm\u003e \u003cbase64 key\u003e [comment]\".\nThe following public key algorithms are available :\nssh-ed25519\nsk-ssh-ed25519@openssh.com\necdsa-sha2-nistp256\necdsa-sha2-nistp384\necdsa-sha2-nistp521\nsk-ecdsa-sha2-nistp256@openssh.com\nssh-rsa" }, "userData": { "type": "string", "default": "#cloud-config", "description": "Cloud-Init UserData script. Not available for Windows VMs: the initialization\nscript is managed automatically to set the administrator password.\nStart with #cloud-config. For custom (imported) Linux images, cloud-init\nmust be installed on the image." }, "automaticRestart": { "type": "boolean", "description": "When enabled, the VM automatically restarts \neven after a shutdown from the guest OS." } } }, "InstanceServiceUpdateInstanceBody": { "type": "object", "properties": { "instanceType": { "type": "string", "example": "u1.medium", "description": "Instance type (e.g., u1.medium, s1.large, m1.xlarge)", "maxLength": 63, "minLength": 1 }, "disks": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Disk" }, "description": "When sent, the complete list of disks of the instance after the update, system disk first.\n- A disk already in the project is attached; a non-zero size resizes it, 0 keeps its size.\n- A disk that does not exist yet is created (size required).\n- A disk attached now but missing from the list is detached, not deleted." }, "network": { "$ref": "#/definitions/v1Network" }, "gpus": { "type": "array", "items": { "type": "string" }, "description": "GPU types (see GPU service for available types)" }, "sshKeys": { "type": "array", "items": { "type": "string" }, "description": "SSH public keys to add to the instance, each as \"\u003calgorithm\u003e \u003cbase64 key\u003e [comment]\".\nThe following public key algorithms are available :\nssh-ed25519\nsk-ssh-ed25519@openssh.com\necdsa-sha2-nistp256\necdsa-sha2-nistp384\necdsa-sha2-nistp521\nsk-ecdsa-sha2-nistp256@openssh.com\nssh-rsa" }, "userData": { "type": "string", "default": "#cloud-config", "description": "Specify Cloud-Init UserData script\nStart with #cloud-config.\nOn update, an empty string removes the user data. On a Windows instance the user data is generated: an empty string is ignored, any other value is refused (20115)." }, "automaticRestart": { "type": "boolean", "description": "When enabled, the VM automatically restarts even after a shutdown from the guest OS." }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`gpus,network.vpcs`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `instanceType`, `disks`, `network.publicIpv4`, `network.firewall.enabled`, `network.firewall.allowedInboundPorts`, `network.vpcs`, `gpus`, `sshKeys`, `userData`, `automaticRestart`." } } }, "KubernetesServiceCreateKubernetesClusterBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Kubernetes cluster name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "version": { "type": "string", "example": "v1.31", "description": "Kubernetes version", "maxLength": 10, "minLength": 1 }, "host": { "type": "string", "description": "Hostname for accessing the cluster", "maxLength": 253, "minLength": 1 }, "controlPlane": { "$ref": "#/definitions/v1ControlPlane" }, "nodeGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/v1NodeGroup" }, "description": "Node groups, keyed by node group name. A node group name is 1 to 63 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit (no `_` nor `.`)." }, "config": { "$ref": "#/definitions/v1Configuration" }, "addons": { "$ref": "#/definitions/v1Addons" } } }, "KubernetesServiceUpdateKubernetesClusterBody": { "type": "object", "properties": { "version": { "type": "string", "example": "v1.31", "description": "Kubernetes version", "maxLength": 10, "minLength": 1 }, "host": { "type": "string", "description": "Hostname for accessing the cluster", "maxLength": 253, "minLength": 1 }, "controlPlane": { "$ref": "#/definitions/v1ControlPlane" }, "nodeGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/v1NodeGroup" }, "description": "Node groups, keyed by node group name. A node group name is 1 to 63 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit (no `_` nor `.`)." }, "config": { "$ref": "#/definitions/v1Configuration" }, "addons": { "$ref": "#/definitions/v1Addons" }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`version,addons.fluxcd.enabled`). When omitted, the fields present in the body are updated and every other field is left unchanged. nodeGroups is replaced as a whole; a free-form configuration sent {} is left unchanged, sent null it is removed. Updatable paths: `version`, `host`, `controlPlane.preset`, `controlPlane.replicas`, `nodeGroups`, `config.cni`, `config.dns`, `config.verticalPodAutoscaler`, `addons.certManager.enabled`, `addons.certManager.configOverride`, `addons.fluxcd.enabled`, `addons.fluxcd.configOverride`, `addons.gpuOperator.enabled`, `addons.gpuOperator.configOverride`, `addons.ingressNginx.enabled`, `addons.ingressNginx.configOverride`, `addons.monitoringAgents.enabled`, `addons.monitoringAgents.configOverride`, `addons.velero.enabled`, `addons.velero.configOverride`, `addons.gatewayApi.enabled`, `addons.hami.enabled`, `addons.hami.configOverride`, `addons.ouroboros.enabled`, `addons.ouroboros.configOverride`." } } }, "MariaDBServiceCreateMariaDBClusterBody": { "type": "object", "properties": { "name": { "type": "string", "description": "MariaDB cluster name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "version": { "type": "string", "example": "v11.8", "description": "MariaDB version (supported: v10.6, v10.11, v11.4, v11.8)" }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access via LoadBalancer" }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "preset": { "type": "string", "example": "s1.small", "description": "Size of the cluster. The sizes available for MariaDB, with their CPU and memory limits, are given by \"List resource presets allowed for mariadb\". A read may return a size that is no longer offered: it is kept as long as it is not changed." } } }, "MariaDBServiceUpdateMariaDBClusterBody": { "type": "object", "properties": { "version": { "type": "string", "example": "v11.8", "description": "MariaDB version (supported: v10.6, v10.11, v11.4, v11.8)" }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access via LoadBalancer" }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`external,size`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `version`, `replicas`, `external`, `size`." } } }, "MongoDBServiceCreateMongoDBClusterBody": { "type": "object", "properties": { "name": { "type": "string", "description": "MongoDB cluster name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "version": { "type": "string", "example": "v8", "description": "MongoDB version (supported: v6, v7, v8)" }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access via LoadBalancer" }, "preset": { "type": "string", "example": "s1.small", "description": "Size of the cluster. The sizes available for MongoDB, with their CPU and memory limits, are given by \"List resource presets allowed for mongodb\". A read may return a size that is no longer offered: it is kept as long as it is not changed." }, "sharding": { "$ref": "#/definitions/v1Sharding", "description": "Sharding configuration. When enabled, deploys config servers, mongos routers, and shards." } } }, "MongoDBServiceUpdateMongoDBClusterBody": { "type": "object", "properties": { "version": { "type": "string", "example": "v8", "description": "MongoDB version (supported: v6, v7, v8)" }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access via LoadBalancer" }, "sharding": { "$ref": "#/definitions/v1Sharding", "description": "Sharding configuration. When enabled, deploys config servers, mongos routers, and shards." }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`external,sharding.config.mongos.replicas`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `version`, `replicas`, `size`, `external`, `sharding.enabled`, `sharding.config.configServers.replicas`, `sharding.config.configServers.size`, `sharding.config.mongos.replicas`, `sharding.config.shards`." } } }, "NetworkServiceCreateSubnetBody": { "type": "object", "properties": { "subnetName": { "type": "string", "description": "Subnet name, 1 to 63 characters: lowercase letters, digits and hyphens. Must be unique within the VPC.", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9-]+$" }, "cidr": { "type": "string", "example": "172.16.0.0/24", "description": "Subnet CIDR in IPv4 notation.\n\nConstraints:\n- Must be a valid CIDR (e.g. 172.16.0.0/24)\n- Must not overlap with other subnets in this VPC\n- Must not overlap with reserved ranges\n\nRecommended: subsets of 172.16.0.0/12" } } }, "NetworkServiceCreateVPCBody": { "type": "object", "properties": { "name": { "type": "string", "description": "VPC name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit. Must be unique within the project.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" } } }, "PostgresServiceCreatePostgresClusterBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Postgres cluster name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "version": { "type": "string", "example": "v16", "description": "PostgreSQL version (supported: v15, v16, v17, v18)" }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access via LoadBalancer" }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "preset": { "type": "string", "example": "s1.small", "description": "Size of the cluster. The sizes available for Postgres, with their CPU and memory limits, are given by \"List resource presets allowed for postgres\". A read may return a size that is no longer offered: it is kept as long as it is not changed." }, "config": { "$ref": "#/definitions/v1Config" }, "quorum": { "$ref": "#/definitions/v1QuorumConfig" } } }, "PostgresServiceUpdateDatabaseBody": { "type": "object", "properties": { "extensions": { "type": "array", "items": { "type": "string" }, "description": "List of PostgreSQL extensions to enable" }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`extensions`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `extensions`." } } }, "PostgresServiceUpdatePostgresClusterBody": { "type": "object", "properties": { "version": { "type": "string", "example": "v16", "description": "PostgreSQL version (supported: v15, v16, v17, v18)" }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access via LoadBalancer" }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "preset": { "type": "string", "example": "s1.small", "description": "Size of the cluster. The sizes available for Postgres, with their CPU and memory limits, are given by \"List resource presets allowed for postgres\". A read may return a size that is no longer offered: it is kept as long as it is not changed. Empty keeps the current size." }, "config": { "$ref": "#/definitions/v1Config" }, "quorum": { "$ref": "#/definitions/v1QuorumConfig" }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`external,quorum.minSyncReplicas`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `version`, `replicas`, `external`, `size`, `preset`, `config.maxConnections`, `quorum.maxSyncReplicas`, `quorum.minSyncReplicas`." } } }, "RabbitMQServiceCreateRabbitMQClusterBody": { "type": "object", "properties": { "name": { "type": "string", "description": "RabbitMQ cluster name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "version": { "type": "string", "example": "v4.2", "description": "RabbitMQ version (supported: v3.13, v4.0, v4.1, v4.2)" }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access via LoadBalancer" }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "preset": { "type": "string", "example": "s1.small", "description": "Size of the cluster. The sizes available for RabbitMQ, with their CPU and memory limits, are given by \"List resource presets allowed for rabbitmq\". A read may return a size that is no longer offered: it is kept as long as it is not changed." } } }, "RabbitMQServiceCreateVhostBody": { "type": "object", "properties": { "vhostName": { "type": "string", "description": "Vhost name, 1 to 255 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit (no `_` nor `.`).", "maxLength": 255, "minLength": 1, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" } } }, "RabbitMQServiceUpdateRabbitMQClusterBody": { "type": "object", "properties": { "version": { "type": "string", "example": "v4.2", "description": "RabbitMQ version" }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access" }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`external,size`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `version`, `replicas`, `external`, `size`." } } }, "RedisServiceCreateRedisClusterBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Redis cluster name, 3 to 16 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 16, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "version": { "type": "string", "example": "v7", "description": "Redis version (supported: v7, v8)" }, "preset": { "type": "string", "example": "s1.small", "description": "Size of the cluster. The sizes available for Redis, with their CPU and memory limits, are given by \"List resource presets allowed for redis\". A read may return a size that is no longer offered: it is kept as long as it is not changed." }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access via LoadBalancer" }, "authEnabled": { "type": "boolean", "description": "Enable Redis authentication. When enabled, a password is generated and returned on creation." } } }, "RedisServiceUpdateRedisClusterBody": { "type": "object", "properties": { "version": { "type": "string", "example": "v7", "description": "Redis version (supported: v7, v8)" }, "preset": { "type": "string", "example": "s1.small", "description": "Size of the cluster. The sizes available for Redis, with their CPU and memory limits, are given by \"List resource presets allowed for redis\". A read may return a size that is no longer offered: it is kept as long as it is not changed." }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas.\n1 = standalone mode (storage-level replication)\n2-8 = cluster mode (application-level replication)\nMode cannot be changed after creation.", "maximum": 8, "minimum": 1 }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB", "maximum": 4096, "minimum": 1 }, "external": { "type": "boolean", "description": "Enable external access via LoadBalancer" }, "authEnabled": { "type": "boolean", "description": "Enable Redis authentication. When enabled, a password is generated and returned on creation. Changed on an existing cluster, it takes effect on the running servers only after a restart (POST .../restart); restartRequired reports it until then." }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`external,authEnabled`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `version`, `preset`, `replicas`, `size`, `external`, `authEnabled`." } } }, "hikubebucketv1CreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "locking": { "type": "boolean" }, "encrypted": { "type": "boolean" }, "status": { "type": "string" } } }, "hikubebucketv1CreateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubebucketv1UserConfig" }, "bucketName": { "type": "string", "description": "S3 bucket name to connect to" }, "endpoint": { "type": "string", "description": "S3 endpoint URL" }, "secrets": { "$ref": "#/definitions/v1Secrets", "description": "Generated S3 credentials. Only returned once on creation, store securely." } } }, "hikubebucketv1DeleteResponse": { "type": "object" }, "hikubebucketv1DeleteUserResponse": { "type": "object" }, "hikubebucketv1GetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "locking": { "type": "boolean" }, "encrypted": { "type": "boolean" }, "bucketName": { "type": "string" }, "endpoint": { "type": "string" }, "status": { "type": "string" }, "retention": { "$ref": "#/definitions/v1BucketRetention", "description": "Object Lock (WORM) retention the bucket was provisioned with, fixed by the platform. Absent when locking is false, and also when locking is true but the retention cannot be read: absence never means \"no retention\" for a locked bucket." } } }, "hikubebucketv1GetUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubebucketv1UserConfig" } } }, "hikubebucketv1ListResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "buckets": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubebucketv1GetResponse" } } } }, "hikubebucketv1ListUsersResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "users": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubebucketv1GetUserResponse" } } } }, "hikubebucketv1UpdateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubebucketv1UserConfig" } } }, "hikubebucketv1UserConfig": { "type": "object", "properties": { "readonly": { "type": "boolean", "description": "Access level for this user.\n\n- false: read/write access (GetObject, PutObject, DeleteObject, ListBucket)\n- true: read-only access (GetObject, ListBucket only)" } } }, "hikubediskv1CreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "size": { "type": "integer", "format": "int64" }, "encrypted": { "type": "boolean" }, "asyncReplication": { "type": "boolean" }, "local": { "type": "boolean", "description": "True if the disk uses non-replicated local storage. Read-only; legacy disks may still report true." }, "data": { "$ref": "#/definitions/v1Data" }, "status": { "type": "string" }, "attachedTo": { "type": "string", "description": "Name of the instance this disk is attached to" } } }, "hikubediskv1DeleteResponse": { "type": "object", "title": "Empty - deletion successful" }, "hikubediskv1GetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "size": { "type": "integer", "format": "int64" }, "encrypted": { "type": "boolean" }, "asyncReplication": { "type": "boolean" }, "local": { "type": "boolean", "description": "True if the disk uses non-replicated local storage. Read-only; legacy disks may still report true." }, "data": { "$ref": "#/definitions/v1Data" }, "attachedTo": { "type": "string", "description": "Name of the instance this disk is attached to" }, "downloadProgress": { "type": "integer", "format": "int64", "description": "Download progress 0–100. Non-zero only while status is downloading or on completion (100)." }, "status": { "type": "string" } } }, "hikubediskv1ListResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "disks": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubediskv1GetResponse" } } } }, "hikubediskv1UpdateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "size": { "type": "integer", "format": "int64" }, "encrypted": { "type": "boolean" }, "asyncReplication": { "type": "boolean" }, "local": { "type": "boolean", "description": "True if the disk uses non-replicated local storage. Read-only; legacy disks may still report true." }, "data": { "$ref": "#/definitions/v1Data" }, "status": { "type": "string" }, "attachedTo": { "type": "string", "description": "Name of the instance this disk is attached to" } } }, "hikubeinstancev1CreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "instanceType": { "type": "string" }, "image": { "type": "string" }, "disks": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Disk" } }, "network": { "$ref": "#/definitions/v1NetworkResponse" }, "gpus": { "type": "array", "items": { "type": "string" } }, "sshKeys": { "type": "array", "items": { "type": "string" } }, "userData": { "type": "string", "description": "Cloud-Init UserData script. Always empty for Windows VMs." }, "running": { "type": "boolean" }, "automaticRestart": { "type": "boolean" }, "defaultUser": { "type": "string", "description": "Default username for the VM. Empty for custom (imported) images." }, "credentials": { "$ref": "#/definitions/v1Credentials", "description": "Windows credentials. Only present for official Windows images on Create." }, "status": { "type": "string" }, "reason": { "type": "string", "description": "Human-readable reason explaining the current status when the VM is not Ready (e.g. ResourceQuotaExceeded, ImagePullError)." } } }, "hikubeinstancev1DeleteResponse": { "type": "object", "title": "Empty - deletion successful" }, "hikubeinstancev1GetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "instanceType": { "type": "string" }, "image": { "type": "string" }, "disks": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Disk" } }, "network": { "$ref": "#/definitions/v1NetworkResponse" }, "gpus": { "type": "array", "items": { "type": "string" } }, "sshKeys": { "type": "array", "items": { "type": "string" } }, "userData": { "type": "string", "description": "Cloud-Init UserData script. Always empty for Windows VMs." }, "running": { "type": "boolean" }, "automaticRestart": { "type": "boolean" }, "defaultUser": { "type": "string", "description": "Default username for the VM. Empty for custom (imported) images." }, "status": { "type": "string" }, "reason": { "type": "string", "description": "Human-readable reason explaining the current status when the VM is not Ready (e.g. ResourceQuotaExceeded, ImagePullError)." }, "restartRequired": { "type": "boolean", "description": "true when a change has been stored that only takes effect once the VM restarts (e.g. a reloaded UserData); until then the VM keeps running its previous configuration. false when no restart is pending, including when the platform reports no restart state for this VM." } } }, "hikubeinstancev1ListResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "instances": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubeinstancev1GetResponse" } }, "partialErrors": { "type": "object", "additionalProperties": { "type": "string" }, "title": "partial_errors contains errors for instances where some data couldn't be retrieved\nKey is the instance name, value is the error message" } } }, "hikubeinstancev1UpdateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "instanceType": { "type": "string" }, "image": { "type": "string" }, "disks": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Disk" } }, "network": { "$ref": "#/definitions/v1NetworkResponse" }, "gpus": { "type": "array", "items": { "type": "string" } }, "sshKeys": { "type": "array", "items": { "type": "string" } }, "userData": { "type": "string", "description": "Cloud-Init UserData script. Always empty for Windows VMs." }, "running": { "type": "boolean" }, "automaticRestart": { "type": "boolean" }, "defaultUser": { "type": "string", "description": "Default username for the VM. Empty for custom (imported) images." }, "status": { "type": "string" }, "reason": { "type": "string", "description": "Human-readable reason explaining the current status when the VM is not Ready (e.g. ResourceQuotaExceeded, ImagePullError)." }, "restartRequired": { "type": "boolean", "description": "Same meaning as restartRequired on Get, read when this response is built. The platform evaluates the update asynchronously, so a restart this update requires is usually not reflected yet: read the instance again to know whether a restart is pending." } } }, "hikubekubernetesv1CreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "host": { "type": "string" }, "controlPlane": { "$ref": "#/definitions/v1ControlPlane" }, "nodeGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/v1NodeGroup" } }, "config": { "$ref": "#/definitions/v1Configuration" }, "addons": { "$ref": "#/definitions/v1Addons" }, "status": { "type": "string" } } }, "hikubekubernetesv1DeleteResponse": { "type": "object" }, "hikubekubernetesv1GetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "host": { "type": "string" }, "controlPlane": { "$ref": "#/definitions/v1ControlPlane" }, "nodeGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/v1NodeGroup" } }, "config": { "$ref": "#/definitions/v1Configuration" }, "addons": { "$ref": "#/definitions/v1Addons" }, "status": { "type": "string" } } }, "hikubekubernetesv1ListPresetsResponse": { "type": "object", "properties": { "presets": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Preset" }, "description": "Resource presets allowed for the Kubernetes control plane" } } }, "hikubekubernetesv1ListResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "clusters": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubekubernetesv1GetResponse" } } } }, "hikubekubernetesv1UpdateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "host": { "type": "string" }, "controlPlane": { "$ref": "#/definitions/v1ControlPlane" }, "nodeGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/v1NodeGroup" } }, "config": { "$ref": "#/definitions/v1Configuration" }, "addons": { "$ref": "#/definitions/v1Addons" }, "status": { "type": "string" } } }, "hikubemariadbv1CreateDatabaseResponse": { "type": "object", "properties": { "databaseName": { "type": "string" }, "roles": { "$ref": "#/definitions/hikubemariadbv1DatabaseRoles" } } }, "hikubemariadbv1CreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "preset": { "type": "string" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the primary, port 3306.\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikubemariadbv1CreateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubemariadbv1UserConfig" }, "password": { "type": "string", "description": "Generated password. Only returned once, store securely." } } }, "hikubemariadbv1DatabaseRoles": { "type": "object", "properties": { "admin": { "type": "array", "items": { "type": "string" }, "description": "List of users with admin role on this database" }, "readonly": { "type": "array", "items": { "type": "string" }, "description": "List of users with readonly role on this database" } } }, "hikubemariadbv1DeleteDatabaseResponse": { "type": "object" }, "hikubemariadbv1DeleteResponse": { "type": "object" }, "hikubemariadbv1DeleteUserResponse": { "type": "object" }, "hikubemariadbv1GetDatabaseResponse": { "type": "object", "properties": { "databaseName": { "type": "string" }, "roles": { "$ref": "#/definitions/hikubemariadbv1DatabaseRoles" } } }, "hikubemariadbv1GetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "preset": { "type": "string" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the primary, port 3306.\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikubemariadbv1GetUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubemariadbv1UserConfig" } } }, "hikubemariadbv1ListDatabasesResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "databases": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubemariadbv1GetDatabaseResponse" } } } }, "hikubemariadbv1ListPresetsResponse": { "type": "object", "properties": { "presets": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Preset" }, "description": "Resource presets allowed for mariadb clusters" } } }, "hikubemariadbv1ListResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "clusters": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubemariadbv1GetResponse" } } } }, "hikubemariadbv1ListUsersResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "users": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubemariadbv1GetUserResponse" } } } }, "hikubemariadbv1RotateUserPasswordResponse": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string", "description": "New generated password. Only returned once, store securely." } } }, "hikubemariadbv1UpdateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the primary, port 3306.\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." } } }, "hikubemariadbv1UpdateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubemariadbv1UserConfig" } } }, "hikubemariadbv1UserConfig": { "type": "object", "properties": { "maxUserConnections": { "type": "integer", "format": "int64", "description": "Maximum number of simultaneous connections for this user (0 = unlimited)", "maximum": 10000 }, "databases": { "type": "object", "example": { "orders": { "role": "admin" }, "audit": { "role": "readonly" } }, "additionalProperties": { "$ref": "#/definitions/hikubemariadbv1UserDatabaseRole" }, "description": "Role of the user on each database, keyed by database name." } } }, "hikubemariadbv1UserDatabaseRole": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "readonly", "" ], "description": "Role for this database.\n\nPossible values:\n- 'admin': full access (read/write/create/drop tables, sequences, functions)\n- 'readonly': read-only access (SELECT on tables, USAGE on sequences)\n- '' (empty): no role on this database" } } }, "hikubemongodbv1CreateDatabaseResponse": { "type": "object", "properties": { "databaseName": { "type": "string" }, "roles": { "$ref": "#/definitions/hikubemongodbv1DatabaseRoles" } } }, "hikubemongodbv1CreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "preset": { "type": "string" }, "sharding": { "$ref": "#/definitions/v1Sharding" }, "host": { "type": "string" }, "status": { "type": "string" }, "hosts": { "type": "array", "items": { "type": "string" }, "description": "External addresses (LoadBalancer IP or hostname, port 27017) a client connects to. Empty when external is false, or while no address is assigned yet.\nSharded cluster: the single mongos address, same value as host.\nReplica set: one address per member, in member order; members without an address yet are left out. The members currently advertise their in-cluster names to drivers, so connect to one member with directConnection=true; a driver given replicaSet cannot resolve the other members from outside the cluster." }, "replicaSet": { "type": "string", "enum": [ "", "rs0" ], "description": "Name of the replica set to pass as replicaSet in the connection string: always \"rs0\", the name the platform gives every replica set. Empty for a sharded cluster, whose clients connect through mongos." }, "internalHost": { "type": "string", "description": "In-cluster DNS name, port 27017: the mongos routers of a sharded cluster, or the members of replica set \"rs0\" (connect with replicaSet=rs0).\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikubemongodbv1CreateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubemongodbv1UserConfig" }, "password": { "type": "string", "description": "Generated password. Only returned once, store securely." } } }, "hikubemongodbv1DatabaseRoles": { "type": "object", "properties": { "admin": { "type": "array", "items": { "type": "string" }, "description": "List of users with admin role on this database" }, "readonly": { "type": "array", "items": { "type": "string" }, "description": "List of users with readonly role on this database" } } }, "hikubemongodbv1DeleteDatabaseResponse": { "type": "object" }, "hikubemongodbv1DeleteResponse": { "type": "object" }, "hikubemongodbv1DeleteUserResponse": { "type": "object" }, "hikubemongodbv1GetDatabaseResponse": { "type": "object", "properties": { "databaseName": { "type": "string" }, "roles": { "$ref": "#/definitions/hikubemongodbv1DatabaseRoles" } } }, "hikubemongodbv1GetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "preset": { "type": "string" }, "sharding": { "$ref": "#/definitions/v1Sharding" }, "host": { "type": "string" }, "status": { "type": "string" }, "hosts": { "type": "array", "items": { "type": "string" }, "description": "External addresses (LoadBalancer IP or hostname, port 27017) a client connects to. Empty when external is false, or while no address is assigned yet.\nSharded cluster: the single mongos address, same value as host.\nReplica set: one address per member, in member order; members without an address yet are left out. The members currently advertise their in-cluster names to drivers, so connect to one member with directConnection=true; a driver given replicaSet cannot resolve the other members from outside the cluster." }, "replicaSet": { "type": "string", "enum": [ "", "rs0" ], "description": "Name of the replica set to pass as replicaSet in the connection string: always \"rs0\", the name the platform gives every replica set. Empty for a sharded cluster, whose clients connect through mongos." }, "internalHost": { "type": "string", "description": "In-cluster DNS name, port 27017: the mongos routers of a sharded cluster, or the members of replica set \"rs0\" (connect with replicaSet=rs0).\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikubemongodbv1GetUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubemongodbv1UserConfig" } } }, "hikubemongodbv1ListDatabasesResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "databases": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubemongodbv1GetDatabaseResponse" } } } }, "hikubemongodbv1ListPresetsResponse": { "type": "object", "properties": { "presets": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Preset" }, "description": "Resource presets allowed for mongodb clusters" } } }, "hikubemongodbv1ListResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "clusters": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubemongodbv1GetResponse" } } } }, "hikubemongodbv1ListUsersResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "users": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubemongodbv1GetUserResponse" } } } }, "hikubemongodbv1RotateUserPasswordResponse": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string", "description": "New generated password. Only returned once, store securely." } } }, "hikubemongodbv1UpdateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "sharding": { "$ref": "#/definitions/v1Sharding" }, "host": { "type": "string" }, "status": { "type": "string" }, "hosts": { "type": "array", "items": { "type": "string" }, "description": "External addresses (LoadBalancer IP or hostname, port 27017) a client connects to. Empty when external is false, or while no address is assigned yet.\nSharded cluster: the single mongos address, same value as host.\nReplica set: one address per member, in member order; members without an address yet are left out. The members currently advertise their in-cluster names to drivers, so connect to one member with directConnection=true; a driver given replicaSet cannot resolve the other members from outside the cluster." }, "replicaSet": { "type": "string", "enum": [ "", "rs0" ], "description": "Name of the replica set to pass as replicaSet in the connection string: always \"rs0\", the name the platform gives every replica set. Empty for a sharded cluster, whose clients connect through mongos." }, "internalHost": { "type": "string", "description": "In-cluster DNS name, port 27017: the mongos routers of a sharded cluster, or the members of replica set \"rs0\" (connect with replicaSet=rs0).\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." } } }, "hikubemongodbv1UpdateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubemongodbv1UserConfig" } } }, "hikubemongodbv1UserConfig": { "type": "object", "properties": { "databases": { "type": "object", "example": { "orders": { "role": "admin" }, "audit": { "role": "readonly" } }, "additionalProperties": { "$ref": "#/definitions/hikubemongodbv1UserDatabaseRole" }, "description": "Required, at least one entry. Role of the user on each database, keyed by database name." } } }, "hikubemongodbv1UserDatabaseRole": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "readonly" ], "description": "Role for this database, required.\n\nPossible values:\n- 'admin': full access (read/write/create/drop collections)\n- 'readonly': read-only access" } } }, "hikubepostgresv1CreateDatabaseResponse": { "type": "object", "properties": { "databaseName": { "type": "string" }, "roles": { "$ref": "#/definitions/hikubepostgresv1DatabaseRoles" }, "extensions": { "type": "array", "items": { "type": "string" } } } }, "hikubepostgresv1CreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "preset": { "type": "string" }, "config": { "$ref": "#/definitions/v1Config" }, "quorum": { "$ref": "#/definitions/v1QuorumConfig" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the primary (read-write), port 5432.\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikubepostgresv1CreateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubepostgresv1UserConfig" }, "password": { "type": "string", "description": "Generated password. Only returned once, store securely." } } }, "hikubepostgresv1DatabaseRoles": { "type": "object", "properties": { "admin": { "type": "array", "items": { "type": "string" }, "description": "List of users with admin role on this database" }, "readonly": { "type": "array", "items": { "type": "string" }, "description": "List of users with readonly role on this database" } } }, "hikubepostgresv1DeleteDatabaseResponse": { "type": "object" }, "hikubepostgresv1DeleteResponse": { "type": "object" }, "hikubepostgresv1DeleteUserResponse": { "type": "object" }, "hikubepostgresv1GetDatabaseResponse": { "type": "object", "properties": { "databaseName": { "type": "string" }, "roles": { "$ref": "#/definitions/hikubepostgresv1DatabaseRoles" }, "extensions": { "type": "array", "items": { "type": "string" } } } }, "hikubepostgresv1GetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "preset": { "type": "string" }, "config": { "$ref": "#/definitions/v1Config" }, "quorum": { "$ref": "#/definitions/v1QuorumConfig" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the primary (read-write), port 5432.\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikubepostgresv1GetUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubepostgresv1UserConfig" } } }, "hikubepostgresv1ListDatabasesResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "databases": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubepostgresv1GetDatabaseResponse" } } } }, "hikubepostgresv1ListPresetsResponse": { "type": "object", "properties": { "presets": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Preset" }, "description": "Resource presets allowed for postgres clusters" } } }, "hikubepostgresv1ListResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "clusters": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubepostgresv1GetResponse" } } } }, "hikubepostgresv1ListUsersResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "users": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikubepostgresv1GetUserResponse" } } } }, "hikubepostgresv1RotateUserPasswordResponse": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string", "description": "New generated password. Only returned once, store securely." } } }, "hikubepostgresv1UpdateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "preset": { "type": "string" }, "config": { "$ref": "#/definitions/v1Config" }, "quorum": { "$ref": "#/definitions/v1QuorumConfig" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the primary (read-write), port 5432.\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikubepostgresv1UpdateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikubepostgresv1UserConfig" } } }, "hikubepostgresv1UserConfig": { "type": "object", "properties": { "privileges": { "$ref": "#/definitions/v1UserPrivileges", "description": "User privileges configuration" }, "databases": { "type": "object", "example": { "orders": { "role": "admin" }, "audit": { "role": "readonly" } }, "additionalProperties": { "$ref": "#/definitions/hikubepostgresv1UserDatabaseRole" }, "description": "Role of the user on each database, keyed by database name." } } }, "hikubepostgresv1UserDatabaseRole": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "readonly", "" ], "description": "Role for this database.\n\nPossible values:\n- 'admin': full access (read/write/create/drop tables, sequences, functions)\n- 'readonly': read-only access (SELECT on tables, USAGE on sequences/functions)\n- '' (empty): no role on this database" } } }, "hikuberabbitmqv1CreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "preset": { "type": "string" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the cluster, port 5672 (AMQP).\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikuberabbitmqv1CreateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikuberabbitmqv1UserConfig" }, "password": { "type": "string", "description": "Generated password. Only returned once, store securely." } } }, "hikuberabbitmqv1DeleteResponse": { "type": "object" }, "hikuberabbitmqv1DeleteUserResponse": { "type": "object" }, "hikuberabbitmqv1GetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "preset": { "type": "string" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the cluster, port 5672 (AMQP).\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikuberabbitmqv1GetUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikuberabbitmqv1UserConfig" } } }, "hikuberabbitmqv1ListPresetsResponse": { "type": "object", "properties": { "presets": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Preset" }, "description": "Resource presets allowed for rabbitmq clusters" } } }, "hikuberabbitmqv1ListResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "clusters": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikuberabbitmqv1GetResponse" } } } }, "hikuberabbitmqv1ListUsersResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "users": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikuberabbitmqv1GetUserResponse" } } } }, "hikuberabbitmqv1RotateUserPasswordResponse": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string", "description": "New generated password. Only returned once, store securely." } } }, "hikuberabbitmqv1UpdateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the cluster, port 5672 (AMQP).\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." } } }, "hikuberabbitmqv1UpdateUserResponse": { "type": "object", "properties": { "username": { "type": "string" }, "config": { "$ref": "#/definitions/hikuberabbitmqv1UserConfig" } } }, "hikuberabbitmqv1UserConfig": { "type": "object", "properties": { "vhosts": { "type": "object", "example": { "orders": { "role": "admin" }, "audit": { "role": "readonly" } }, "additionalProperties": { "$ref": "#/definitions/v1UserVhostRole" }, "description": "Role of the user on each vhost, keyed by vhost name." } } }, "hikuberedisv1CreateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "preset": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "authEnabled": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "host": { "type": "string" }, "status": { "type": "string" }, "password": { "type": "string", "description": "Initial authentication password (only returned on creation when auth_enabled is true)" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the current master, port 6379.\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" } } }, "hikuberedisv1DeleteResponse": { "type": "object" }, "hikuberedisv1GetResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "preset": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "authEnabled": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the current master, port 6379.\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" }, "restartRequired": { "type": "boolean", "description": "true when a stored change (authentication enabled or disabled, password rotated) has been rendered but the running Redis servers still use their previous configuration: it takes effect after a restart (POST .../restart). false when no restart is pending, including while the cluster is still starting. Output only" } } }, "hikuberedisv1ListPresetsResponse": { "type": "object", "properties": { "presets": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Preset" }, "description": "Resource presets allowed for redis clusters" } } }, "hikuberedisv1ListResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "clusters": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/hikuberedisv1GetResponse" } } } }, "hikuberedisv1UpdateResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "preset": { "type": "string" }, "replicas": { "type": "integer", "format": "int64" }, "external": { "type": "boolean" }, "authEnabled": { "type": "boolean" }, "size": { "type": "integer", "format": "int64" }, "host": { "type": "string" }, "status": { "type": "string" }, "internalHost": { "type": "string", "description": "In-cluster DNS name of the current master, port 6379.\nAlways set, whether or not external is enabled. It resolves and is reachable from the workloads of the same project (instances, Kubernetes clusters); unlike host, it cannot be reached from other projects nor from outside the platform." }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the cluster runs with, resolved from its preset and any explicit resources override. Output only" }, "restartRequired": { "type": "boolean", "description": "true when a stored change (authentication enabled or disabled, password rotated) has been rendered but the running Redis servers still use their previous configuration: it takes effect after a restart (POST .../restart). false when no restart is pending, including while the cluster is still starting. Output only" } } }, "protobufNullValue": { "type": "string", "enum": [ "NULL_VALUE" ], "default": "NULL_VALUE", "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." }, "v1Addons": { "type": "object", "properties": { "certManager": { "$ref": "#/definitions/v1CertManagerAddon" }, "fluxcd": { "$ref": "#/definitions/v1FluxcdAddon" }, "gpuOperator": { "$ref": "#/definitions/v1GpuOperatorAddon" }, "ingressNginx": { "$ref": "#/definitions/v1IngressNginxAddon" }, "monitoringAgents": { "$ref": "#/definitions/v1MonitoringAgentsAddon" }, "velero": { "$ref": "#/definitions/v1VeleroAddon" }, "gatewayApi": { "$ref": "#/definitions/v1GatewayApiAddon" }, "hami": { "$ref": "#/definitions/v1HamiAddon" }, "ouroboros": { "$ref": "#/definitions/v1OuroborosAddon" } } }, "v1ApplicationRef": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "", "postgres", "mariadb", "instance", "disk" ], "description": "Kind of the application: postgres, mariadb, instance (VM instance) or disk (VM disk). Required in a request. Empty in a response only for an application of a kind with no backup driver, which can exist only if created outside this API." }, "name": { "type": "string" } }, "description": "ApplicationRef names an application inside the project." }, "v1Backup": { "type": "object", "properties": { "name": { "type": "string" }, "application": { "$ref": "#/definitions/v1ApplicationRef" }, "destination": { "type": "string" }, "plan": { "type": "string" }, "job": { "type": "string" }, "takenAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "unknown", "pending", "ready", "failed" ], "description": "State of the stored archive. Always set. pending while it is being written; only ready can be restored from, and restorable says whether it still can." }, "message": { "type": "string" }, "location": { "type": "string", "description": "Archive URI. Never carries credentials. Empty for the VM kinds: their\ndata sits in a repository every VM backup of the destination shares, and\nthe driver's URI names only its own object in the platform's namespace." }, "sizeBytes": { "type": "string", "format": "int64", "description": "Absent unless the size was measured. None of the four kinds reports a\nsize today. Absent rather than 0, because a zero that looks like a\nmeasurement is worse than no answer." }, "restorable": { "type": "boolean", "description": "Whether a restore from this backup would be admitted, as far as the API\ncan tell without reading the bucket: the backup is ready, a destination of\nthe name it was written to exists, is not being deleted, and was created\nbefore the backup was taken — a destination created after it is another\none under the same name, and may point at another bucket. For the VM\nkinds, the storage layer must also still hold the archive: it is removed,\ndata included, at the end of its retention, while this record stays.\n\nIt is not a check that the archive's objects are in the bucket. When\nfalse, not_restorable_cause says which situation it is." }, "covers": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1ApplicationRef" }, "description": "The other applications whose data this one archive also contains.\n\nBacking up a VM instance captures the disks it runs on — the driver adds\none selector per disk, so a two-disk VM's archive holds both. Those disks\nare applications in their own right, listed in the project's disks, and\nuntil now nothing said they were backed up at all: an archive was findable\nonly under the application named in `application`.\n\nThis lists them rather than repeating the archive under each one. There is\none archive, written once, charged once, and `application` stays the single\nanswer to \"what was this taken from\" — a copy per disk would read as three\nbackups of three things.\n\nIt never names `application` itself, and it is empty for the kinds whose\narchive holds one application's data and nothing else.\n\nListing by `application_name` matches on this too, which is the point: a\ntenant asking what protects a disk gets the VM's archive back.\n\nBeing listed here is not being separately restorable. Restoring writes back\neverything the archive covers, because the storage driver builds a\nrestore's scope from the backup rather than from the request — there is no\nfield on a restore that names a subset. A disk listed here is restored by\nrestoring the application in `application`, with its siblings." }, "recoveryWindow": { "$ref": "#/definitions/v1RecoveryWindow", "description": "Postgres only: the span a point-in-time restore from this backup can\nreach. Absent for every other kind, and for a Postgres backup whose base\nbackup end is not known. taken_at is when the base backup began, which is\nearlier than any instant it can be restored to — see RecoveryWindow." }, "notRestorableReason": { "type": "string", "description": "Why restorable is false, in words that complete \"this backup cannot be\nrestored because…\". Empty when restorable is true. message stays the\ndriver's account of the backup itself." }, "notRestorableCause": { "type": "string", "enum": [ "", "not_ready", "destination_removed", "destination_tearing_down", "destination_replaced", "destination_unverified", "stored_archive_gone" ], "description": "- not_ready: the backup is pending or failed.\n - destination_removed: no destination of that name exists. Only its\n record is known to be gone; whether the bucket still holds the data is\n not checked, and a destination recreated under that name does not\n bring the backup back (see destination_replaced).\n - destination_tearing_down: the destination's deletion has begun.\n - destination_replaced: a destination of that name exists but was\n created after the backup was taken, so it is not the one the backup\n was written to. This holds even when it points at the same bucket.\n - destination_unverified: the destinations could not be read; retry.\n - stored_archive_gone: VM kinds, the storage layer no longer holds the\n archive.\n\nThe source application having been deleted is not among them: the archive\nis intact, and whether a restore needs another target is CreateRestore's\nanswer for the request it is given.", "title": "Why restorable is false, as a closed set to branch on. Empty when\nrestorable is true. The situations call for different actions:" } }, "description": "Backup is the record of a stored archive." }, "v1BackupDestination": { "type": "object", "properties": { "name": { "type": "string" }, "bucketName": { "type": "string", "description": "Populated for bucket storage, empty for external. Branch on storage_kind\nrather than on emptiness." }, "bucketUser": { "type": "string" }, "endpoint": { "type": "string", "description": "Where the archives are written. Derived, never supplied by the caller." }, "retentionDays": { "type": "integer", "format": "int64" }, "supportedKinds": { "type": "array", "items": { "type": "string", "enum": [ "postgres", "mariadb", "instance", "disk" ] }, "description": "Application kinds this destination backs up, among postgres, mariadb, instance and disk. Every destination supports all four today." }, "status": { "type": "string", "enum": [ "unknown", "provisioning", "ready", "error" ], "description": "Whether the destination can take backups. Always set. Only ready accepts plans, runs and restores." }, "message": { "type": "string" }, "storageKind": { "type": "string", "enum": [ "bucket", "external" ], "description": "Where the destination writes. Always set, and always bucket today: a bucket in this project, managed by the bucket service. external, an S3-compatible store outside Hikube named through a credential, is not yet creatable." }, "credential": { "type": "string", "description": "Name of the credential an external destination writes through. Empty for\nbucket storage. The credential's keys are never echoed here, or anywhere." }, "objectLock": { "type": "boolean", "description": "- retention_days cannot be set below object_lock_days, since nothing\n can expire sooner and a shorter retention would only make records\n disappear while their data stays;\n - a backup written here cannot be deleted until object_lock_days after\n it was taken. Deleting just its record would leave the data stored,\n billed and impossible to restore.\n\nFixed when the destination is created, because a bucket's locking can\nnever change.", "title": "True when the bucket is write-once (S3 Object Lock). Every object written\nto it is locked for object_lock_days in compliance mode, which nobody can\nshorten. Consequences the API enforces:" }, "objectLockDays": { "type": "integer", "format": "int64", "description": "How long the bucket locks every object, in days — read from the bucket's\nstorage class, 365 for every write-once bucket today. Zero when\nobject_lock is false. It is this destination's minimum retention." }, "createdAt": { "type": "string", "format": "date-time" } }, "description": "BackupDestination is where backups are written and for how long they are\nkept. It is bound to a bucket the tenant owns in the same project; there is\nno platform-owned destination." }, "v1BackupJob": { "type": "object", "properties": { "name": { "type": "string" }, "application": { "$ref": "#/definitions/v1ApplicationRef" }, "destination": { "type": "string" }, "plan": { "type": "string", "description": "Empty for on-demand runs." }, "status": { "type": "string", "enum": [ "unknown", "pending", "running", "succeeded", "failed" ], "description": "Where the run is. Always set. pending until the platform starts it; unknown only for a state the platform reports that this API does not know." }, "message": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time" }, "backup": { "type": "string", "description": "Name of the Backup the run produced." }, "progress": { "$ref": "#/definitions/v1TransferProgress", "description": "Absent for the Postgres and MariaDB kinds, and once the run's transfer\nrecords have been collected. See TransferProgress." } }, "description": "BackupJob is one backup run, whether started on demand or by a plan." }, "v1BackupPlan": { "type": "object", "properties": { "name": { "type": "string" }, "application": { "$ref": "#/definitions/v1ApplicationRef" }, "destination": { "type": "string" }, "cron": { "type": "string", "description": "A five-field cron expression, or @hourly, @daily, @weekly, @monthly,\n@yearly, interpreted in UTC. See CreatePlanRequest.cron." }, "status": { "type": "string", "enum": [ "unknown", "ready", "error" ], "description": "Whether the plan can fire. Always set. error means its schedule, destination or application is unusable, and message says which." }, "message": { "type": "string" }, "lastRunAt": { "type": "string", "format": "date-time", "description": "When the plan's most recent run started. The platform does not record it\non the plan: it is read from the plan's runs. Absent until the first run\nstarts, and a run not started yet leaves the one before it." }, "nextRunAt": { "type": "string", "format": "date-time", "description": "Computed by the API from the plan's own schedule. Absent only when the\nschedule does not parse, which is also when the plan reports error." }, "createdAt": { "type": "string", "format": "date-time" } }, "description": "BackupPlan is a recurring backup of one application on a cron schedule." }, "v1BucketRetention": { "type": "object", "properties": { "days": { "type": "integer", "format": "int32", "description": "Default retention period, in days, applied to every object written to the bucket." }, "mode": { "type": "string", "enum": [ "compliance", "governance" ], "description": "S3 Object Lock retention mode. \"compliance\": no one can shorten the retention or delete a locked object before it expires. \"governance\": users with a special permission can." }, "retainOnDelete": { "type": "boolean", "description": "The storage behind the bucket is kept by the platform when the bucket is deleted." } } }, "v1BucketServiceCreateUserBody": { "type": "object", "properties": { "username": { "type": "string", "description": "Username, 1 to 63 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit (no `_` nor `.`).", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "config": { "$ref": "#/definitions/hikubebucketv1UserConfig", "description": "User configuration" } } }, "v1BucketServiceUpdateUserBody": { "type": "object", "properties": { "config": { "$ref": "#/definitions/hikubebucketv1UserConfig", "description": "User configuration" }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`config.readonly`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `config.readonly`." } } }, "v1CancelJobResponse": { "type": "object", "properties": { "job": { "$ref": "#/definitions/v1BackupJob" } } }, "v1CancelRestoreResponse": { "type": "object", "properties": { "restore": { "$ref": "#/definitions/v1RestoreJob" } } }, "v1CertManagerAddon": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "configOverride": { "type": "object", "description": "Helm values override (object)\nSee https://artifacthub.io/packages/helm/cert-manager/cert-manager for available options" } } }, "v1CheckGpuCoLocationResponse": { "type": "object", "properties": { "coLocatable": { "type": "boolean" }, "conflictingGpus": { "type": "array", "items": { "type": "string" }, "description": "Subset of `names` that cannot be hosted together on any single node.\nEmpty when co_locatable is true." } } }, "v1CloudImage": { "type": "object", "properties": { "name": { "type": "string", "description": "OS distribution name" }, "versions": { "type": "array", "items": { "type": "string" }, "description": "Available versions for this distribution" }, "minSizeGib": { "type": "integer", "format": "int64", "example": 28, "description": "Minimum disk size in GiB required to provision a disk with this image (image footprint + system overhead). 0 means no image-specific override; the global disk-size floor applies." } } }, "v1Config": { "type": "object", "properties": { "maxConnections": { "type": "integer", "format": "int64", "description": "Maximum number of concurrent connections", "maximum": 10000, "minimum": 1 } } }, "v1ConfigServersConfig": { "type": "object", "properties": { "replicas": { "type": "integer", "format": "int64", "description": "Number of config server replicas", "maximum": 7, "minimum": 1 }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB for config servers", "maximum": 4096, "minimum": 1 } } }, "v1Configuration": { "type": "object", "properties": { "cni": { "type": "object", "description": "Cilium CNI configuration override (object)\nSee https://docs.cilium.io/en/stable/helm-reference/ for available options" }, "dns": { "type": "object", "description": "CoreDNS configuration override (object)\nSee https://github.com/coredns/helm/tree/master/charts/coredns for available options" }, "verticalPodAutoscaler": { "type": "object", "description": "Vertical Pod Autoscaler configuration override (object)\nSee https://github.com/cowboysysop/charts/tree/master/charts/vertical-pod-autoscaler for available options" } } }, "v1ControlPlane": { "type": "object", "properties": { "preset": { "type": "string", "example": "s1.small", "description": "Size of the control plane. The sizes available, with their CPU and memory limits, are given by \"List resource presets allowed for the Kubernetes control plane\".\nRead: the size of the API server; components gives each component's own.\nWrite: a size different from the current one is written on the four components; an unchanged value leaves every component as it is. A read may return a size that is no longer offered: it is kept as long as it is not changed." }, "replicas": { "type": "integer", "format": "int64", "description": "Number of control plane replicas", "maximum": 5, "minimum": 1 }, "components": { "$ref": "#/definitions/v1ControlPlaneComponents", "description": "Preset and limits of each control plane component. Output only, ignored on input", "readOnly": true } } }, "v1ControlPlaneComponent": { "type": "object", "properties": { "preset": { "type": "string", "example": "s1.small", "description": "Size of the component" }, "resources": { "$ref": "#/definitions/v1Resources", "description": "CPU and memory limits the component runs with" } }, "description": "ControlPlaneComponent is the sizing of one control plane component as the\nplatform resource stores it." }, "v1ControlPlaneComponents": { "type": "object", "properties": { "apiServer": { "$ref": "#/definitions/v1ControlPlaneComponent" }, "controllerManager": { "$ref": "#/definitions/v1ControlPlaneComponent" }, "scheduler": { "$ref": "#/definitions/v1ControlPlaneComponent" }, "konnectivity": { "$ref": "#/definitions/v1ControlPlaneComponent" } } }, "v1CreateDestinationResponse": { "type": "object", "properties": { "destination": { "$ref": "#/definitions/v1BackupDestination" } } }, "v1CreateJobResponse": { "type": "object", "properties": { "job": { "$ref": "#/definitions/v1BackupJob" } } }, "v1CreatePlanResponse": { "type": "object", "properties": { "plan": { "$ref": "#/definitions/v1BackupPlan" } } }, "v1CreateRestoreResponse": { "type": "object", "properties": { "restore": { "$ref": "#/definitions/v1RestoreJob" } } }, "v1CreateSubnetResponse": { "type": "object", "properties": { "subnetName": { "type": "string" }, "cidr": { "type": "string" } } }, "v1CreateVPCResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" } } }, "v1CreateVhostResponse": { "type": "object", "properties": { "vhostName": { "type": "string" }, "roles": { "$ref": "#/definitions/v1VhostRoles" } } }, "v1Credentials": { "type": "object", "properties": { "password": { "type": "string", "description": "Generated password for the Windows administrator account. Only returned on Create." } }, "description": "Credentials holds the generated credentials for a Windows VM. Only populated on\nCreate for official Windows images (windows-server-2022, windows-server-2025).\nThe username is available in the default_user field of the response." }, "v1CustomImage": { "type": "object", "properties": { "url": { "type": "string", "description": "Image HTTP Url", "maxLength": 2048, "minLength": 1 }, "cdrom": { "type": "boolean", "description": "Enable this if your image is a ISO format file" }, "os": { "type": "string", "example": "linux", "description": "OS family of the image. Required when a Windows custom image is provided so the platform can pick the right storage class and instance profile. Accepted values: \"linux\" (default), \"windows\"." } } }, "v1Data": { "type": "object", "properties": { "image": { "$ref": "#/definitions/v1Image" } } }, "v1DeleteBackupResponse": { "type": "object", "properties": { "name": { "type": "string" }, "archiveDeleted": { "type": "boolean", "description": "True when removing the record also removes the stored archive, so a\nclient never has to infer the outcome from the application kind. The\nremoval is asked of the storage driver and completes after the response:\nthe archive's objects go shortly after, and deduplicated disk data is\nreleased when the platform next reclaims data no other backup shares.\nA backup in a write-once bucket is never deleted while its lock holds —\nthe request is refused — so this is never true of a locked archive." }, "message": { "type": "string" } } }, "v1DeleteDestinationResponse": { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string", "description": "States that stored archives are not deleted, and that removing the\ndestination removes what enforced retention on Postgres archives." } } }, "v1DeletePlanResponse": { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" } } }, "v1DeleteRestoreResponse": { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" } } }, "v1DeleteSubnetResponse": { "type": "object" }, "v1DeleteVPCResponse": { "type": "object" }, "v1DeleteVhostResponse": { "type": "object" }, "v1DetachResponse": { "type": "object" }, "v1Disk": { "type": "object", "properties": { "name": { "type": "string", "description": "Disk name. A disk of that name already in the project is attached as is; otherwise a new disk is created, whose name follows the disk name rule: 3 to 16 characters, lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit.", "maxLength": 32, "minLength": 3, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "size": { "type": "integer", "format": "int64", "description": "Define storage capacity in GiB", "maximum": 4096, "minimum": 20 }, "encrypted": { "type": "boolean", "description": "Enable disk encryption. Ignored when the disk already exists; only honored when a new disk is created via this request." }, "asyncReplication": { "type": "boolean", "description": "Use async replication (sync replication is the default). Ignored when the disk already exists; only honored when a new disk is created via this request." }, "local": { "type": "boolean", "description": "True if the disk uses non-replicated local storage. Read-only; legacy disks may still report true." } } }, "v1ErrorResponse": { "type": "object", "properties": { "requestId": { "type": "string", "example": "4bf92f3577b34da6a3ce929d0e0e4736", "description": "Identifier of the request. Quote it when contacting support." }, "code": { "type": "integer", "format": "int32", "example": 20101, "description": "Numeric code identifying the precise error, listed in the error code table of the API description. Absent when the error has no specific code." }, "message": { "type": "string", "example": "invalid name: must be at least 3 characters", "description": "Human-readable error message. Use code, not this text, to handle an error programmatically." }, "details": { "type": "array", "items": { "type": "object" }, "description": "Additional structured information about the error, usually empty." } }, "description": "Body of an error response." }, "v1Firewall": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable firewall functions to filter access ports\n" }, "allowedInboundPorts": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Specify list of ports to expose\n" } } }, "v1FluxcdAddon": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "configOverride": { "type": "object", "description": "Helm values override (object)\nSee https://raw.githubusercontent.com/cozystack/cozystack/refs/heads/main/packages/system/fluxcd/values.yaml for available options" } } }, "v1GatewayApiAddon": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Install Kubernetes Gateway API CRDs (experimental channel) from kubernetes-sigs/gateway-api.\nSee https://gateway-api.sigs.k8s.io for documentation and available resources." } } }, "v1GetBackupResponse": { "type": "object", "properties": { "backup": { "$ref": "#/definitions/v1Backup" } } }, "v1GetDestinationResponse": { "type": "object", "properties": { "destination": { "$ref": "#/definitions/v1BackupDestination" } } }, "v1GetJobResponse": { "type": "object", "properties": { "job": { "$ref": "#/definitions/v1BackupJob" } } }, "v1GetKubeconfigResponse": { "type": "object", "properties": { "kubeconfig": { "type": "string", "description": "Kubeconfig file content (YAML)" } } }, "v1GetPlanResponse": { "type": "object", "properties": { "plan": { "$ref": "#/definitions/v1BackupPlan" } } }, "v1GetRestoreResponse": { "type": "object", "properties": { "restore": { "$ref": "#/definitions/v1RestoreJob" } } }, "v1GetSubnetResponse": { "type": "object", "properties": { "subnetName": { "type": "string" }, "cidr": { "type": "string" } } }, "v1GetVPCResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" } } }, "v1GetVhostResponse": { "type": "object", "properties": { "vhostName": { "type": "string" }, "roles": { "$ref": "#/definitions/v1VhostRoles" } } }, "v1Gpu": { "type": "object", "properties": { "name": { "type": "string", "example": "l40s", "description": "GPU type name" }, "displayName": { "type": "string", "example": "NVIDIA L40S", "description": "Human-readable GPU name for display in UIs" }, "vram": { "type": "integer", "format": "int64", "description": "Video memory in GB" }, "available": { "type": "boolean", "description": "Whether this GPU type is available" } }, "title": "Public GPU representation" }, "v1GpuOperatorAddon": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "configOverride": { "type": "object", "description": "Helm values override (object)\nSee https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/getting-started.html for available options" } } }, "v1HamiAddon": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable HAMi GPU virtualization middleware (requires gpu_operator.enabled)" }, "configOverride": { "type": "object", "description": "Helm values override (object)\nSee https://project-hami.io/docs for available options" } } }, "v1Image": { "type": "object", "properties": { "name": { "type": "string", "example": "ubuntu-24.04", "description": "Cloud image, named \u003cdistro\u003e-\u003cversion\u003e; GET /instance/v1alpha1/cloud-images lists the accepted values.", "maxLength": 128, "minLength": 1 }, "custom": { "$ref": "#/definitions/v1CustomImage" } } }, "v1IngressNginxAddon": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "configOverride": { "type": "object", "description": "Helm values override (object)\nSee https://github.com/kubernetes/ingress-nginx/tree/main/charts/ingress-nginx for available options" } } }, "v1InstanceType": { "type": "object", "properties": { "name": { "type": "string" }, "vcpu": { "type": "integer", "format": "int64", "description": "Number of virtual CPUs" }, "ram": { "type": "integer", "format": "int64", "description": "RAM in GiB" } } }, "v1InternalGetPublicIPAvailabilityResponse": { "type": "object", "properties": { "available": { "type": "string", "format": "int64" } } }, "v1InternalGpu": { "type": "object", "properties": { "name": { "type": "string" }, "displayName": { "type": "string" }, "vram": { "type": "integer", "format": "int64" }, "availableCount": { "type": "string", "format": "int64" } }, "title": "Internal GPU representation with exact availability count" }, "v1InternalListGpusResponse": { "type": "object", "properties": { "gpus": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1InternalGpu" } } } }, "v1InternalListVMsByVPCResponse": { "type": "object", "properties": { "vmNames": { "type": "array", "items": { "type": "string" }, "description": "Names of the VMs attached to the requested VPC (and subnet, if specified)." } } }, "v1ListBackupsResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "backups": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Backup" } } } }, "v1ListCloudImagesResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "images": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1CloudImage" } } } }, "v1ListDestinationsResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "destinations": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1BackupDestination" } } } }, "v1ListExtensionsResponse": { "type": "object", "properties": { "extensions": { "type": "array", "items": { "type": "string" }, "description": "List of available PostgreSQL extensions" } } }, "v1ListGpusResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "gpus": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Gpu" } } } }, "v1ListInstanceTypesResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "instanceTypes": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1InstanceType" }, "description": "Available instance types.\n\nSeries:\n- u1: Balanced (1:4 vCPU/RAM ratio)\n- s1: Standard (1:2 vCPU/RAM ratio)\n- m1: Memory-optimized (1:8 vCPU/RAM ratio)" } } }, "v1ListJobsResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "jobs": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1BackupJob" } } } }, "v1ListPlansResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "plans": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1BackupPlan" } } } }, "v1ListPricesResponse": { "type": "object", "properties": { "currency": { "type": "string", "example": "CHF", "description": "ISO 4217 currency code" }, "totalCount": { "type": "integer", "format": "int64" }, "prices": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1Price" } } } }, "v1ListRestoresResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "restores": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1RestoreJob" } } } }, "v1ListSubnetsResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "subnets": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1GetSubnetResponse" } } } }, "v1ListVPCsResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "vpcs": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1GetVPCResponse" } } } }, "v1ListVersionsResponse": { "type": "object", "properties": { "versions": { "type": "array", "items": { "type": "string" }, "description": "List of supported Kubernetes versions" } } }, "v1ListVhostsResponse": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "vhosts": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1GetVhostResponse" } } } }, "v1MariaDBServiceCreateDatabaseBody": { "type": "object", "properties": { "databaseName": { "type": "string", "description": "Database name, 1 to 63 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit (no `_` nor `.`).", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" } } }, "v1MariaDBServiceCreateUserBody": { "type": "object", "properties": { "username": { "type": "string", "description": "Username, 1 to 63 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit (no `_` nor `.`).", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "config": { "$ref": "#/definitions/hikubemariadbv1UserConfig", "description": "User configuration" } } }, "v1MariaDBServiceUpdateUserBody": { "type": "object", "properties": { "config": { "$ref": "#/definitions/hikubemariadbv1UserConfig", "description": "User configuration" }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`config.maxUserConnections`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `config.maxUserConnections`, `config.databases`." } } }, "v1MongoDBServiceCreateDatabaseBody": { "type": "object", "properties": { "databaseName": { "type": "string", "description": "Database name, 1 to 63 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit (no `_` nor `.`).", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" } } }, "v1MongoDBServiceCreateUserBody": { "type": "object", "properties": { "username": { "type": "string", "description": "Username, 1 to 63 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit (no `_` nor `.`).", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "config": { "$ref": "#/definitions/hikubemongodbv1UserConfig", "description": "User configuration" } } }, "v1MongoDBServiceUpdateUserBody": { "type": "object", "properties": { "config": { "$ref": "#/definitions/hikubemongodbv1UserConfig", "description": "User configuration" }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update (`config.databases`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `config.databases`." } } }, "v1MongosConfig": { "type": "object", "properties": { "replicas": { "type": "integer", "format": "int64", "description": "Number of mongos replicas", "maximum": 8, "minimum": 1 } } }, "v1MonitoringAgentsAddon": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "configOverride": { "type": "object", "description": "Helm values override (object)\nSee https://raw.githubusercontent.com/cozystack/cozystack/refs/heads/main/packages/system/monitoring-agents/values.yaml for available options" } } }, "v1Network": { "type": "object", "properties": { "publicIpv4": { "type": "boolean", "description": "Enable external access to your VM\nwith a public IPv4" }, "firewall": { "$ref": "#/definitions/v1Firewall" }, "vpcs": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1VPCConnection" }, "description": "VPC connections" } } }, "v1NetworkResponse": { "type": "object", "properties": { "publicIpv4": { "type": "boolean" }, "ips": { "type": "array", "items": { "type": "string" }, "description": "Addresses of the instance other than internal_ip: those of its other interfaces (VPC connections, addresses the guest reports) and, when public_ipv4 is true, the public IPv4 (public_ip). Each address is listed once.\nThe addresses of the interfaces are read from the running instance (Get, List, the instance event stream): the responses of Create and Update list the public IPv4 only." }, "firewall": { "$ref": "#/definitions/v1Firewall" }, "vpcs": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1VPCConnection" } }, "internalIp": { "type": "string", "description": "Address of the instance on the network of its project, whether or not public_ipv4 is enabled. It is reachable from the workloads of the same project, subject to the firewall of the guest. To reach the instance from another project or from outside the platform, use public_ip.\nRead from the running instance: set on Get, List and the instance event stream, empty while the instance is not running and on the responses of Create and Update." }, "publicIp": { "type": "string", "description": "Address through which the instance is reached from outside the platform, when public_ipv4 is true: the one to use to connect to it from the Internet. Empty while public_ipv4 is false, and until the address is allocated. It is also listed in ips.\nDo not infer it from its range: depending on the address pool, it can be a private address." } } }, "v1NodeGroup": { "type": "object", "properties": { "instanceType": { "type": "string", "example": "u1.medium", "description": "Instance type for nodes in this group", "maxLength": 63, "minLength": 1 }, "storage": { "type": "integer", "format": "int64", "description": "System disk size in GiB, carrying the node OS image, kubelet state and the containerd image cache. Omit to use the platform default (20 GiB)", "maximum": 4096, "minimum": 1 }, "minReplicas": { "type": "integer", "format": "int64", "description": "Minimum number of nodes", "maximum": 128 }, "maxReplicas": { "type": "integer", "format": "int64", "description": "Maximum number of nodes", "maximum": 128, "minimum": 1 }, "gpus": { "type": "array", "items": { "type": "string" }, "description": "GPU types (see GPU service for available types)" }, "isExposed": { "type": "boolean", "description": "Whether this node group is exposed externally" } } }, "v1OuroborosAddon": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable the hairpin-NAT fix for ingress-nginx with PROXY-protocol (requires ingress_nginx.enabled)" }, "configOverride": { "type": "object", "description": "Helm values override (object)\nSee https://raw.githubusercontent.com/cozystack/cozystack/refs/heads/main/packages/extra/ouroboros/values.yaml for available options" } } }, "v1PostgresServiceCreateDatabaseBody": { "type": "object", "properties": { "databaseName": { "type": "string", "description": "Database name, 1 to 54 characters: lowercase letters, digits, `_` and `-`, starting with a letter or `_`, and not starting with `pg_`.", "maxLength": 54, "minLength": 1, "pattern": "^[a-z_][a-z0-9_-]*$" }, "extensions": { "type": "array", "items": { "type": "string" }, "description": "List of PostgreSQL extensions to enable" } } }, "v1PostgresServiceCreateUserBody": { "type": "object", "properties": { "username": { "type": "string", "description": "Username, 1 to 63 characters: lowercase letters, digits and underscores, starting with a letter or an underscore. postgres, streaming_replica and cnpg_pooler_pgbouncer are reserved.", "maxLength": 63, "minLength": 1, "pattern": "^[a-z_][a-z0-9_]*$" }, "config": { "$ref": "#/definitions/hikubepostgresv1UserConfig", "description": "User configuration: privileges and per-database role assignments" } } }, "v1PostgresServiceUpdateUserBody": { "type": "object", "properties": { "config": { "$ref": "#/definitions/hikubepostgresv1UserConfig", "description": "User configuration: privileges and per-database role assignments" }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`config.privileges.replication`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `config.privileges.replication`, `config.databases`." } } }, "v1Preset": { "type": "object", "properties": { "name": { "type": "string", "example": "s1.small", "description": "Size name" }, "cpu": { "type": "string", "example": "1", "description": "CPU limit in K8s quantity format" }, "memory": { "type": "string", "example": "2Gi", "description": "Memory limit in K8s quantity format" } }, "description": "Preset is a named resource size used by managed services (Kubernetes\ncontrol plane, Postgres, MariaDB, MongoDB, Redis, RabbitMQ). Names follow\nthe series of the VM instance types (u1, s1, m1), and a name means the same\nresources for a VM and a managed service. CPU and memory are the limits\nthe size sets, in K8s quantity format." }, "v1Price": { "type": "object", "properties": { "name": { "type": "string", "example": "HK-VM-U1.MEDIUM", "description": "Resource SKU" }, "priceMonthly": { "type": "number", "format": "double", "description": "Monthly price" }, "priceHourly": { "type": "number", "format": "double", "description": "Hourly price" } }, "description": "Price of a single billable resource. For block and object storage,\nthe price applies per GiB; for all other categories it applies per\nresource." }, "v1QuorumConfig": { "type": "object", "properties": { "maxSyncReplicas": { "type": "integer", "format": "int64", "description": "Maximum number of synchronous replicas (must be \u003e= min_sync_replicas)", "maximum": 10 }, "minSyncReplicas": { "type": "integer", "format": "int64", "description": "Minimum number of synchronous replicas", "maximum": 10 } } }, "v1RabbitMQServiceCreateUserBody": { "type": "object", "properties": { "username": { "type": "string", "description": "Username, 1 to 63 characters: lowercase letters, digits and hyphens, starting with a letter and ending with a letter or digit (no `_` nor `.`).", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([a-z0-9-]*[a-z0-9])?$" }, "config": { "$ref": "#/definitions/hikuberabbitmqv1UserConfig", "description": "User configuration" } } }, "v1RabbitMQServiceUpdateUserBody": { "type": "object", "properties": { "config": { "$ref": "#/definitions/hikuberabbitmqv1UserConfig", "description": "User configuration" }, "updateMask": { "type": "string", "description": "Optional. Comma-separated field paths to update, in lowerCamelCase (`config.vhosts`). When omitted, the fields present in the body are updated and every other field is left unchanged. Updatable paths: `config.vhosts`." } } }, "v1RecoveryWindow": { "type": "object", "properties": { "earliest": { "type": "string", "format": "date-time", "description": "The first instant from which a restore of this backup can be consistent,\nand the instant restore_point backup aims at. PostgreSQL cannot stop\nreplaying before the backup it replays onto was consistent, so this — not\ntaken_at, which is when the base backup began — is the earliest instant\nreachable. It is the end of the base backup as the archive records it, or,\nwhen a transaction written before the position the backup ended at is\nstamped later than that, that transaction's time: aimed earlier, the\nrestore would stop before it reached consistency." }, "latest": { "type": "string", "format": "date-time", "description": "The last instant the archived log is known to cover, computed when the\nbackup is read: now, less the cluster's archive_timeout, less a minute for\nthe upload. An estimate on the safe side — the last archived segment is not\npublished by the platform, the forced-switch interval is. Re-read rather\nthan keep it: it moves forward with time, and it is not carried by events.\n\nAbsent when the database's continuous archiving is not working: then no\ninstant after the base backup can be promised, and a restore should not\nname one.\n\nBeing inside the window is necessary, not sufficient. PostgreSQL stops at\nthe first transaction committed after the requested instant; on a\ndatabase that committed nothing since, it never finds one and the restore\nfails. To get the latest state of an idle database, restore without a\nrecovery time." }, "lastCommitAt": { "type": "string", "format": "date-time", "description": "The last transaction — commit or abort — in the archived log this backup\nreplays through, read from the bucket, so it stays right when the source\nis deleted or restored over. That log is the one PostgreSQL follows from\nthe backup's timeline: a transaction on another timeline of the same\nstream does not count. A restore stops just before the first\ntransaction later than the instant asked for, so every instant at or after\nthis one fails, and is refused: the state it describes is the latest one,\nwhich a restore without a recovery time gives.\n\nWith it known the reachable span is earliest up to, not including,\nlast_commit_at, and latest can be ignored. Absent with last_commit_known\nfalse when the log could not be read; absent with last_commit_known true\nwhen the replayed log holds no transaction at all. When it is earlier\nthan earliest, or absent with last_commit_known true, no instant is\nreachable and only restore_point backup or latest works." }, "lastCommitKnown": { "type": "boolean" }, "latestRestorable": { "type": "boolean", "description": "Whether restore_point latest replays this backup's history. False only\nwhen it is established that it does not: the stream's most recent backup\nlies on another timeline — a branch left by an earlier in-place restore\ninto the same stream — which is where the restore would start from.\nTrue when the stream's backup catalog could not be read: CreateRestore\nreads it again, and refuses then with 180221 if the branch is established,\nor 180220 if the catalog still cannot be read." }, "crossTimelineAfter": { "type": "string", "format": "date-time", "description": "The first instant from which a restore would start from a backup on\nanother timeline, rather than one on this backup's history: instants at\nor after it are refused (180221). Absent when none is established — no\nsuch backup exists, which is the case of every stream with a single\nhistory, or the catalog could not be read, in which case CreateRestore\nreads it again and refuses an instant it still cannot place (180220)." } }, "description": "RecoveryWindow is what a point-in-time restore can reach from one Postgres\nbackup. A restore asking for an instant outside it is refused up front,\nrather than accepted and left to time out thirty minutes later." }, "v1ReloadUserDataResponse": { "type": "object" }, "v1ResolveGpuResourcesResponse": { "type": "object", "properties": { "resolved": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Mapping from API GPU name to the fully qualified K8s resource name\n(\"nvidia.com/\u003cResourceName\u003e\"). One entry per unique input name." } } }, "v1Resources": { "type": "object", "properties": { "cpu": { "type": "string", "example": "2", "description": "CPU limit in K8s quantity format. Empty when source is unknown" }, "memory": { "type": "string", "example": "1Gi", "description": "Memory limit in K8s quantity format. Empty when source is unknown" }, "source": { "type": "string", "example": "preset", "enum": [ "preset", "override", "unknown" ], "description": "Where cpu and memory come from.\n\n- preset: the preset's limits\n- override: explicit resources set on the platform resource replace at least one of the preset's limits\n- unknown: the size is not known and nothing overrides it" } }, "description": "Resources is what a workload sized by a preset actually runs with. Output\nonly." }, "v1RestartMariaDBClusterResponse": { "type": "object" }, "v1RestartMongoDBClusterResponse": { "type": "object" }, "v1RestartPostgresClusterResponse": { "type": "object" }, "v1RestartRabbitMQClusterResponse": { "type": "object" }, "v1RestartRedisClusterResponse": { "type": "object" }, "v1RestartResponse": { "type": "object" }, "v1RestoreJob": { "type": "object", "properties": { "name": { "type": "string" }, "backup": { "type": "string" }, "target": { "$ref": "#/definitions/v1ApplicationRef", "description": "The application the restore writes into, as resolved at admission: for a\nrestore in place, the backup's own application, even when the request\nnamed no target and the backup has been deleted since." }, "inPlace": { "type": "boolean", "description": "True when the resolved target is the backup's own source application,\nwhether or not a target was named explicitly." }, "recoveryTime": { "type": "string", "format": "date-time", "description": "Postgres only." }, "status": { "type": "string", "enum": [ "unknown", "pending", "running", "succeeded", "failed" ], "description": "Where the restore is. Always set. pending until the platform starts it; unknown only for a state the platform reports that this API does not know." }, "message": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time" }, "progress": { "$ref": "#/definitions/v1TransferProgress", "description": "Absent for the Postgres and MariaDB kinds, and once the restore's transfer\nrecords have been collected. See TransferProgress." }, "originalDisks": { "type": "string", "enum": [ "", "discard", "keep" ], "description": "What was asked of the disks this restore displaced: discard or keep. The tenant's answer, not its outcome: a discard that did not succeed kept them, as its message says. Empty when the question did not arise — any restore but a VM instance or disk restored over its source — and for a restore created before the API offered the choice." }, "restorePoint": { "type": "string", "enum": [ "", "backup", "latest" ], "description": "What a Postgres restore without recovery_time was resolved to: backup, the backup's own state (recovery_time then carries the instant it resolved to, when it resolved to one), or latest. Empty when an instant was asked for, and for the other kinds." } }, "description": "RestoreJob brings an application back from one of its backups." }, "v1RotatePasswordResponse": { "type": "object", "properties": { "password": { "type": "string" } } }, "v1RotateUserCredentialsResponse": { "type": "object", "properties": { "username": { "type": "string" }, "secrets": { "$ref": "#/definitions/v1Secrets", "description": "New S3 credentials. Only returned once, store securely." } } }, "v1Secrets": { "type": "object", "properties": { "accessKeyId": { "type": "string", "description": "S3 access key ID. Only returned once on creation, store securely." }, "accessSecretKey": { "type": "string", "description": "S3 secret access key. Only returned once on creation, store securely." } } }, "v1ShardConfig": { "type": "object", "properties": { "name": { "type": "string", "description": "Shard name" }, "replicas": { "type": "integer", "format": "int64", "description": "Number of replicas for this shard", "maximum": 8, "minimum": 1 }, "size": { "type": "integer", "format": "int64", "description": "Storage capacity in GiB for this shard", "maximum": 4096, "minimum": 1 } } }, "v1Sharding": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable sharding" }, "config": { "$ref": "#/definitions/v1ShardingConfig", "description": "Sharding configuration (required when enabled is true)" } } }, "v1ShardingConfig": { "type": "object", "properties": { "configServers": { "$ref": "#/definitions/v1ConfigServersConfig", "description": "Config server configuration" }, "mongos": { "$ref": "#/definitions/v1MongosConfig", "description": "Mongos router configuration" }, "shards": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/v1ShardConfig" }, "description": "List of shard configurations" } } }, "v1StartResponse": { "type": "object" }, "v1StopResponse": { "type": "object" }, "v1TransferProgress": { "type": "object", "properties": { "bytesDone": { "type": "string", "format": "uint64" }, "bytesTotal": { "type": "string", "format": "uint64" }, "percent": { "type": "integer", "format": "int64", "description": "Derived from the two above so every client shows the same number rather\nthan each rounding its own way. 0 to 100." } }, "description": "TransferProgress reports how far a transfer has got.\n\nIt is present only for the VM kinds, whose transfer is measured; the\nPostgres and MariaDB kinds report nothing countable. The message is\ntherefore absent rather than zeroed for those kinds, so a client can tell\n\"no progress available for this kind\" from \"nothing transferred yet\".\n\nbytes_total is the volume read, not the space the archive occupies: the\narchives are deduplicated, so the stored size is not a per-backup quantity\nat all. Label it as data transferred, never as the size of the backup." }, "v1UpdateDatabaseResponse": { "type": "object", "properties": { "databaseName": { "type": "string" }, "roles": { "$ref": "#/definitions/hikubepostgresv1DatabaseRoles" }, "extensions": { "type": "array", "items": { "type": "string" } } } }, "v1UpdateDestinationResponse": { "type": "object", "properties": { "destination": { "$ref": "#/definitions/v1BackupDestination" } } }, "v1UpdatePlanResponse": { "type": "object", "properties": { "plan": { "$ref": "#/definitions/v1BackupPlan" } } }, "v1UserPrivileges": { "type": "object", "properties": { "replication": { "type": "boolean", "description": "Grant replication privileges.\n\nAllows the user to:\n- Connect in replication mode\n- Use streaming replication functions\n- Receive WAL for physical or logical replication\n\nRequired for backup tools and read replicas." } } }, "v1UserVhostRole": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "readonly", "" ], "description": "Role for this vhost.\n\nPossible values:\n- 'admin': full access (configure/write/read on all resources)\n- 'readonly': read-only access\n- '' (empty): no role on this vhost" } } }, "v1VPCConnection": { "type": "object", "properties": { "name": { "type": "string", "description": "VPC name" }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "Subnet names within this VPC to connect to.\nEach subnet adds secondary network interfaces to the VM." } } }, "v1VeleroAddon": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "configOverride": { "type": "object", "description": "Helm values override (object)\nSee https://github.com/vmware-tanzu/helm-charts/tree/main/charts/velero for available options" } } }, "v1VhostRoles": { "type": "object", "properties": { "admin": { "type": "array", "items": { "type": "string" }, "description": "List of users with admin role on this vhost" }, "readonly": { "type": "array", "items": { "type": "string" }, "description": "List of users with readonly role on this vhost" } } } }, "securityDefinitions": { "ApiKey": { "type": "apiKey", "description": "Project api-key (sk_hk_\u003ckeyId\u003e_\u003csecret\u003e) for machine clients. Callable operations are those of the public document.", "name": "X-Hikube-Api-Key", "in": "header" }, "OAuth2": { "type": "oauth2", "flow": "accessCode", "authorizationUrl": "https://keycloak.hikube.cloud/realms/cozy/protocol/openid-connect/auth", "tokenUrl": "https://keycloak.hikube.cloud/realms/cozy/protocol/openid-connect/token", "scopes": { "openid": "openid" } } }, "security": [ { "OAuth2": [ "openid" ] }, { "ApiKey": [] } ], "externalDocs": { "url": "https://docs.hikube.cloud" } }