# info.description
## Overview

The OnetSolutions API provides programmatic access to manage your cloud infrastructure, domains, and web hosting services.

## Authentication

All API requests require authentication using one of the following methods:

- **JWT Token**: Obtain a token via login endpoints and include it in the `Authorization: Bearer <token>` header
- **API Key**: Generate an API key from your account settings and use it as `Authorization: Bearer sk-onetsolutions-...`

## Rate Limiting

API requests are rate-limited to ensure fair usage:
- **Standard**: 1000 requests per minute
- **Burst**: 100 requests per second

## Pagination

List endpoints return paginated results. Use `page` and `page_size` query parameters.

## Error Handling

The API uses standard HTTP status codes:
- `200` Success
- `201` Created
- `400` Bad Request
- `401` Unauthorized
- `403` Forbidden
- `404` Not Found
- `429` Too Many Requests

# paths./v1/auth/me.get.description
Retrieve detailed information about the currently authenticated user, including profile data, organization memberships, and token expiration time. This endpoint is commonly used to validate authentication state and fetch user context.

# paths./v1/auth/me.get.responses.200.description
Current user information and token expiration

# paths./v1/auth/me.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/compute/images/public.get.description
Retrieve a list of all publicly available operating system images. Public images include various Linux distributions, Windows Server editions, and pre-configured application stacks maintained by the platform.

# paths./v1/compute/images/public.get.summary
[Images] List public operating system images

# paths./v1/compute/images/public.get.parameters[].description
A page number within the paginated result set.

# paths./v1/compute/images/public.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/compute/locations.get.description
Retrieve a list of all available datacenter locations where compute instances can be deployed. Each location includes geographic information, available features, and current capacity status.

# paths./v1/compute/locations.get.summary
[Locations] List available datacenter locations

# paths./v1/compute/locations.get.parameters[].description
A page number within the paginated result set.

# paths./v1/compute/locations.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/compute/locations/{id}.get.description
Retrieve detailed information about a specific datacenter location, including geographic coordinates, available instance sizes, network connectivity options, and compliance certifications.

# paths./v1/compute/locations/{id}.get.summary
[Locations] Get datacenter location details

# paths./v1/compute/locations/{id}.get.parameters[].description
Unique identifier of the datacenter location.

# paths./v1/compute/locations/{id}.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/compute/sizes.get.description
Retrieve a list of all available instance sizes (machine types). Each size defines a combination of CPU cores, memory, and storage with associated pricing information. Use this to select appropriate resources for your workload.

# paths./v1/compute/sizes.get.parameters[].description
A page number within the paginated result set.

# paths./v1/compute/sizes.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/compute/sizes/{id}.get.description
Retrieve detailed specifications of a specific instance size, including CPU cores, memory allocation, included storage, network bandwidth, and pricing tiers for different billing periods.

# paths./v1/compute/sizes/{id}.get.responses.200.description
Instance size details retrieved successfully

# paths./v1/compute/sizes/{id}.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/compute/software-packages.get.description
Retrieve a list of all software packages available for installation on compute instances. The catalog includes applications, runtime environments, databases, and development tools.

# paths./v1/compute/software-packages.get.summary
[Software] List available software packages

# paths./v1/compute/software-packages.get.parameters[].description
A page number within the paginated result set.

# paths./v1/compute/software-packages.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/compute/software-packages/{id}.get.description
Retrieve detailed information about a specific software package, including version, description, system requirements, and installation parameters.

# paths./v1/compute/software-packages/{id}.get.parameters[].description
Unique identifier of the software package.

# paths./v1/compute/software-packages/{id}.get.responses.200.description
Software package details retrieved successfully

# paths./v1/compute/software-packages/{id}.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/domains/availability/check.get.description
Check if a domain is available for registration and get suggestions if not.

# paths./v1/domains/availability/check.get.parameters[].description
Domain name to check (e.g., example.com)

# paths./v1/domains/availability/check.get.responses.200.description
Domain availability check completed successfully

# paths./v1/domains/availability/suggestions.get.description
Get available domain suggestions with different TLDs for a given SLD.

# paths./v1/domains/availability/suggestions.get.parameters[].description
Maximum number of suggestions to return (default: 5, max: 20)

# paths./v1/domains/availability/suggestions.get.parameters[].description
Second-level domain (e.g., 'example' for example.com)

# paths./v1/domains/tlds.get.description
Retrieve a paginated list of all supported top-level domains (TLDs) with their pricing information. Each TLD includes registration, renewal, and transfer prices along with any special requirements or restrictions. Use this endpoint to discover available TLDs and their associated costs before initiating domain registration.

# paths./v1/domains/tlds.get.parameters[].description
Filter by category: 'generic', 'country', or 'new'. Example: ?category=generic

# paths./v1/domains/tlds.get.parameters[].description
A page number within the paginated result set.

# paths./v1/domains/tlds.get.parameters[].description
Search in TLD name and display name. Example: ?search=com

# paths./v1/domains/tlds.get.parameters[].description
Filter by exact TLD extension (case-insensitive). Example: ?tld=com

# paths./v1/domains/tlds.get.parameters[].description
Filter by TLD containing this string. Example: ?tld_contains=co

# paths./v1/domains/tlds.get.responses.200.description
Successfully retrieved the list of available TLDs with pricing

# paths./v1/domains/tlds.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/domains/tlds/check/{domain_name}.get.description
Check whether a specific domain name is available for registration. The response includes the availability status, registration price if available, and any premium pricing that may apply. For unavailable domains, additional information about the current registration status may be provided when available from the registry.

# paths./v1/domains/tlds/check/{domain_name}.get.parameters[].description
The fully qualified domain name to check (e.g., example.com, mysite.org)

# paths./v1/domains/tlds/check/{domain_name}.get.responses.200.description
Domain availability check completed successfully

# paths./v1/domains/tlds/check/{domain_name}.get.responses.400.description
Invalid domain name format or unsupported TLD

# paths./v1/domains/tlds/check/{domain_name}.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/domains/tlds/check/{domain_name}.get.responses.429.description
Rate limit exceeded. Too many availability checks in a short period

# paths./v1/domains/tlds/check/{domain_name}.get.responses.500.description
Failed to check availability with the registry

# paths./v1/hosting/plan-groups.get.description
Returns a list of all active web hosting plan groups.

# paths./v1/hosting/plan-groups.get.summary
[Hosting Plans] List web hosting plan groups

# paths./v1/hosting/plan-groups/{slug}.get.description
Returns details of a specific web hosting plan group including its plans.

# paths./v1/hosting/plan-groups/{slug}.get.summary
[Hosting Plans] Retrieve a web hosting plan group

# paths./v1/hosting/plans.get.description
Retrieve a list of all available web hosting plans with pricing.

# paths./v1/hosting/plans.get.summary
[Hosting Plans] List available web hosting plans

# paths./v1/hosting/plans.get.parameters[].description
A page number within the paginated result set.

# paths./v1/hosting/plans.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/hosting/plans/{id}.get.description
Retrieve detailed information about a specific web hosting plan including all pricing options.

# paths./v1/hosting/plans/{id}.get.summary
[Hosting Plans] Get web hosting plan details

# paths./v1/hosting/plans/{id}.get.parameters[].description
A UUID string identifying this Web Hosting Plan.

# paths./v1/hosting/plans/{id}.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations.get.description
Retrieve a list of all organizations that the authenticated user has access to. Results include organizations where the user is a member with any role level. The list is ordered by organization name.

# paths./v1/organizations.get.responses.200.description
List of organizations the user has access to

# paths./v1/organizations.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{id}.get.description
Retrieve detailed information about a specific organization by its unique identifier. Returns organization metadata including name, plan details, quotas, and configuration.

# paths./v1/organizations/{id}.get.parameters[].description
A UUID string identifying this organization.

# paths./v1/organizations/{id}.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{id}.get.responses.403.description
User does not have access to this organization

# paths./v1/organizations/{organization_id}/projects.get.description
Retrieve a list of all projects within an organization that the authenticated user has access to. Results are filtered based on the user's role and project memberships.

# paths./v1/organizations/{organization_id}/projects.get.parameters[].description
A UUID string identifying the organization.

# paths./v1/organizations/{organization_id}/projects.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects.get.responses.403.description
Insufficient permissions to view projects in this organization

# paths./v1/organizations/{organization_id}/projects/{id}.get.description
Retrieve detailed information about a specific project by its unique identifier. Returns project metadata including name, quotas, usage statistics, and configuration.

# paths./v1/organizations/{organization_id}/projects/{id}.get.parameters[].description
A UUID string identifying the organization.

# paths./v1/organizations/{organization_id}/projects/{id}.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{id}.get.responses.403.description
Insufficient permissions to view this project

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a paginated list of all images available to the organization. This includes both public platform images and private images created from instance snapshots within the organization.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access images

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific image, including operating system details, disk size, creation date, and availability status.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this image

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.description
Update the metadata of a private image, including name and description. Only private images owned by the organization can be modified. Public platform images cannot be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.403.description
Insufficient permissions or cannot modify public images

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Partially update the metadata of a private image. Only provided fields will be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[Images] Partially update image metadata

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions or cannot modify public images

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.description
Permanently delete a private image from the organization. Only private images owned by the organization can be deleted. Images currently in use by running instances cannot be deleted. Public platform images cannot be deleted.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.403.description
Insufficient permissions or cannot delete public images

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.409.description
Image is in use by one or more instances

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a paginated list of all compute instances within the specified project. Results include instance metadata, current status, and resource allocation details.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.200.description
List of instances retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this project

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Provision a new virtual machine instance with the specified configuration. The instance will be created in the specified project and datacenter location. Instance creation is an asynchronous operation; monitor the task status for completion.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Instances] Create a new compute instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.400.description
Invalid request parameters or configuration

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions or quota exceeded

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific compute instance, including hardware configuration, network settings, current status, and associated resources.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Instances] Get compute instance details

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.description
Update modifiable properties of a compute instance such as name, description, and tags. Hardware configuration changes require the resize endpoint.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.summary
[Instances] Replace compute instance metadata

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.403.description
Insufficient permissions to modify this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Partially update modifiable properties of a compute instance. Only provided fields will be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[Instances] Partially update compute instance metadata

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.description
Permanently delete a compute instance and all associated data. This action is irreversible. The instance will be stopped if running, and all attached volumes will be detached. Billing for the instance will cease upon deletion.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.403.description
Insufficient permissions to delete this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.409.description
Instance cannot be deleted in its current state

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Activate an addon (such as snapshot or backup service) for an existing compute instance. This creates a WHMCS order for the addon and processes payment using available credit or saved payment method. Returns order details including invoice and payment status.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Instances] Activate an addon for a compute instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.200.description
Addon activation order created successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.400.description
Invalid request or addon configuration error

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to modify this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Trigger an on-demand collection of QEMU guest-agent information (OS, hostname, filesystems, network interfaces) for the instance. Runs asynchronously on the worker; poll the instance detail endpoint to read the updated agent_info.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Request cancellation of a compute instance subscription. The instance will continue to operate until the end of the current billing period, after which it will be permanently deleted. This action can be revoked before the billing period ends. An optional reason can be provided for the cancellation.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to cancel this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Instance already has a pending cancellation

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve the current active or pending console session for a compute instance. Returns session details including status and connection URL if available.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.200.description
Active console session retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access instance console

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Create a new VNC console session for direct graphical access to the compute instance. The session provides browser-based access to the instance console, useful for troubleshooting boot issues or accessing instances without network connectivity.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to access instance console

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Console access unavailable in current instance state

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Get the current status and URL of a console session.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.description
Terminate an active or pending console session. This will cancel the underlying Prefect flow and mark the session as expired. Use this endpoint to cleanly close a console session when access is no longer needed.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the console session.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.403.description
Insufficient permissions to close this console session

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve the list of instance sizes the current instance is eligible to upgrade to, based on the configured upgrade paths in the billing system. Returns an empty list when the current size is not mapped to a billing product.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Instances] List eligible upgrade sizes for a compute instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Attach an available GPU to the instance. The instance is stopped and restarted as part of the operation. Billing starts on attachment and is charged per started hour. The operation is asynchronous; monitor the returned task for completion.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve the current GPU attachments (sessions) for this instance, including the active attachment with its model, billed hours and timing.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[GPU] List GPU attachments for an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve the GPUs that are physically present and available on the hypervisor node hosting this instance. Only GPUs with status 'available' are returned.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[GPU] List GPUs available on the instance node

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Detach a GPU from the instance and finalize billing for the session. The instance is stopped and restarted as part of the operation. The operation is asynchronous; monitor the returned task for completion.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve the finished GPU attachment sessions (detached or failed) for this instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[GPU] List past GPU sessions for an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.200.description
GPU session history retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Update the hostname of a compute instance. The new hostname will be applied to both the instance metadata and the guest operating system configuration. A reboot may be required for the change to take effect within the guest OS.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[Instances] Change compute instance hostname

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a paginated list of all billing invoices associated with a specific compute instance. Each invoice includes billing period, usage details, and payment status.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Instances] List billing invoices for an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to view instance invoices

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve real-time performance metrics for a compute instance including CPU utilization, memory usage, network throughput, and disk I/O. Metrics are collected from the monitoring system and represent the current state of the instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Instances] Get current instance performance metrics

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to view instance metrics

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve historical performance metrics for a compute instance over a specified time period. Returns time-series data for CPU utilization, memory usage, network throughput, and disk I/O. Data is available for the past 1 to 30 days with automatic aggregation based on the time range.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Instances] Get historical instance performance metrics

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to view instance metrics

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Gracefully reboot a running compute instance. The guest operating system will receive a reboot signal and restart cleanly. Use the reset endpoint for an immediate hard reboot.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to reboot this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Reinstall the operating system on a compute instance. This operation will erase all data on the primary disk and install a fresh OS from the specified image. The instance must be stopped before reinstallation. This action is irreversible.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Instances] Reinstall operating system on a compute instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.400.description
Invalid image or reinstallation configuration

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to reinstall this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Instance must be stopped before reinstallation

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Perform a hard reset on a compute instance, equivalent to a physical power cycle. This immediately cuts power and restarts the instance without graceful shutdown. Use only when the instance is unresponsive to graceful shutdown commands.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Instances] Hard reset a compute instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to reset this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Instance cannot be reset in its current state

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Change the hardware configuration of a compute instance by selecting a different size. The instance must be stopped before resizing. After resizing, the instance will have new CPU, memory, and potentially disk allocations based on the selected size.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions or quota exceeded

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Instance must be stopped before resizing

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Revoke a pending cancellation request for a compute instance. The instance will continue to operate and be billed normally. This action is only available before the scheduled cancellation date at the end of the billing period.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Instances] Revoke instance cancellation request

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to modify this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Send an ACPI shutdown signal to the compute instance, allowing the guest OS to perform a clean shutdown. This is equivalent to pressing the power button on a physical machine.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Instances] Gracefully shutdown a compute instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to shutdown this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Power on a stopped compute instance. The instance will boot from its current disk state. This is an asynchronous operation; the instance status will transition from 'stopped' to 'running'.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions or instance is suspended

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Gracefully shut down a running compute instance. The guest operating system will receive a shutdown signal and have time to terminate processes cleanly. Use the reset endpoint for an immediate power-off.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to stop this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Reactivate a compute instance that was suspended due to payment issues. This operation requires sufficient account balance or an active payment method with available credit. Upon successful reactivation, the instance will be started automatically.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Instances] Reactivate a suspended compute instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
A UUID string identifying this Instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.402.description
Payment required - insufficient balance or no valid payment method

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to unsuspend this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a paginated list of all backups created for a compute instance. Backups are full copies of the instance disk stored in a separate location for disaster recovery purposes.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Backups] List all backups for an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access backups

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Create a full backup of a compute instance's disk. Backups are stored in a geographically separate location and can be used for disaster recovery. Backup creation is asynchronous and may take several minutes depending on disk size.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions or backup quota exceeded

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific backup, including size, creation date, status, retention policy, and storage location.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this backup

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.description
Update the metadata of a backup, including name, description, and retention policy. The backup data itself cannot be modified.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.403.description
Insufficient permissions to modify this backup

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Partially update the metadata of a backup. Only the provided fields will be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[Backups] Partially update backup metadata

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this backup

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Generate a temporary pre-signed URL for downloading a backup file. The URL is valid for a limited time and provides direct access to the backup data. Use this for offline storage or migration to another platform.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to download this backup

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Restore a compute instance to the state captured in a backup. This operation will replace the current disk contents with the backup data. The instance must be stopped before restoration. This action is irreversible and all current data will be lost.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Backups] Restore an instance from a backup

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to restore this backup

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Instance must be stopped before restoration

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a paginated list of all firewall rules configured for a specific compute instance. Rules control inbound and outbound network traffic to the instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Firewall] List all firewall rules for an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access firewall rules

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Create a new firewall rule for a compute instance. Rules can allow or deny traffic based on protocol, port, and source/destination IP addresses. The rule will not take effect until firewall rules are applied to the instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.400.description
Invalid rule configuration or parameters

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to create firewall rules

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific firewall rule, including protocol, ports, IP ranges, and current status.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.200.description
Firewall rule details retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to view this firewall rule

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.description
Modify an existing firewall rule configuration. Changes will not take effect until firewall rules are applied to the instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.400.description
Invalid rule configuration or parameters

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.403.description
Insufficient permissions to modify this firewall rule

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Partially modify an existing firewall rule configuration. Only provided fields will be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[Firewall] Partially update a firewall rule

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.400.description
Invalid rule configuration or parameters

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this firewall rule

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.description
Remove a firewall rule from the instance configuration. The deletion will not take effect until firewall rules are applied to the instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.403.description
Insufficient permissions to delete this firewall rule

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Apply all configured firewall rules to the compute instance. This is an asynchronous operation that updates the instance's network security configuration. Rules that were added, modified, or deleted will take effect after this operation completes.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Firewall] Apply firewall rules to an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to apply firewall rules

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Another firewall operation is in progress

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Apply a predefined firewall template to the instance, replacing existing rules. Templates provide common security configurations for different use cases (e.g., web server, database server). This operation applies the rules immediately.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Firewall] Apply a predefined firewall template

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to apply firewall templates

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Another firewall operation is in progress

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Disable all firewall rules for the instance without deleting them. This effectively opens all traffic to the instance. Use the apply endpoint to push changes. Warning: Disabling firewall rules may expose the instance to security risks.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.200.description
All firewall rules disabled successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to modify firewall rules

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Enable all configured firewall rules for the instance. This activates any previously disabled rules. Use the apply endpoint to push changes to the instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to modify firewall rules

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a list of predefined firewall templates that can be applied to instances. Templates include common configurations for web servers, database servers, and other typical use cases.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Firewall] List available firewall templates

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to view firewall templates

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a list of all IP addresses assigned to a compute instance, including both public (floating) and private IP addresses.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[IP Addresses] List all IP addresses for an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to view IP addresses

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific IP address, including address type, version (IPv4/IPv6), gateway, and reverse DNS configuration.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.200.description
IP address details retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to view this IP address

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Update the configuration of an IP address, including reverse DNS (PTR) record. Changes to reverse DNS may take time to propagate across DNS servers.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[IP Addresses] Update IP address configuration

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.400.description
Invalid update parameters or reverse DNS format

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this IP address

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a paginated list of all snapshots created from a compute instance. Snapshots capture the complete disk state at a point in time and can be used to restore the instance or create new instances.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Snapshots] List all snapshots for an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access snapshots

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Create a point-in-time snapshot of a compute instance's disk. The snapshot captures the complete disk state and can be used to restore the instance or create new instances. Snapshot creation is asynchronous; monitor the task status for completion.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions or quota exceeded

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Another snapshot operation is in progress

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific snapshot, including size, creation date, status, and associated instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this snapshot

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.description
Update the metadata of a snapshot, including name and description. The snapshot data itself cannot be modified.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.403.description
Insufficient permissions to modify this snapshot

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Partially update the metadata of a snapshot. Only the provided fields will be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[Snapshots] Partially update snapshot metadata

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this snapshot

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.description
Permanently delete a snapshot and free the associated storage space. This action is irreversible. Snapshots that are being used as the source for an ongoing operation cannot be deleted.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.403.description
Insufficient permissions to delete this snapshot

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.409.description
Snapshot is in use and cannot be deleted

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Restore a compute instance to the state captured in a snapshot. This operation will replace the current disk contents with the snapshot data. The instance must be stopped before restoration. This action is irreversible and all current data will be lost.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Snapshots] Restore an instance from a snapshot

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to restore this snapshot

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Instance must be stopped before restoration

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a list of all software packages installed on a compute instance, including version information and installation status.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Software] List installed software on an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.200.description
Installed software list retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Create a record of installed software on a compute instance. Use the install endpoint to actually install software on the instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Software] Create installed software record

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.201.description
Installed software record created successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific software installation on an instance, including version, installation date, configuration, and current status.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[Software] Get installed software details

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the installed software.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this software

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.404.description
Installed software or instance not found

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.description
Update the configuration of installed software on an instance. Configuration changes may require a service restart to take effect.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the installed software.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.403.description
Insufficient permissions to modify this software

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.404.description
Installed software or instance not found

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Partially update the configuration of installed software. Only provided fields will be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[Software] Partially update installed software configuration

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the installed software.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this software

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.404.description
Installed software or instance not found

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.description
Remove the installed software record from the system. This removes the tracking record but does not uninstall the software from the instance. Use the uninstall endpoint to remove the software from the instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.summary
[Software] Delete installed software record

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the installed software.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.204.description
Installed software record deleted successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.403.description
Insufficient permissions to delete this record

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.404.description
Installed software or instance not found

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve installation logs for this software package

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance Installed Software.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Stream installation logs in real-time via Server-Sent Events

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance Installed Software.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Install a software package on a compute instance. The installation is performed asynchronously; monitor the task status for completion. The instance must be running and accessible via the network for installation to succeed.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Software] Install software on an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the compute instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.400.description
Invalid installation parameters or software incompatible

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to install software

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Software is already installed or another installation is in progress

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
List all tasks for a specific instance via nested resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve details of a specific task via nested resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance Task.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Returns aggregated data for the project dashboard including instance counts by status, resource totals, and task statistics.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a paginated list of all SSH public keys registered in the project. SSH keys are used for secure authentication when connecting to compute instances.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access SSH keys

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Register a new SSH public key in the project. The key can then be added to compute instances during creation or later to enable secure SSH access. Only the public key portion should be provided.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to create SSH keys

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
SSH key with this fingerprint already exists

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific SSH key, including name, fingerprint, key type, and creation date.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this SSH key

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.description
Update the metadata of an SSH key, such as its name. The public key itself cannot be modified; delete and recreate the key instead.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.403.description
Insufficient permissions to modify this SSH key

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Partially update the metadata of an SSH key. Only provided fields will be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[SSH Keys] Partially update SSH key metadata

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this SSH key

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.description
Remove an SSH key from the project. Deleting a key does not remove it from instances where it has already been deployed. New instances will no longer be able to use this key.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.403.description
Insufficient permissions to delete this SSH key

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
List all instance tasks for all instances in a project.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this Instance Task.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a paginated list of all storage volumes within the project. Volumes are persistent block storage devices that can be attached to instances.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access volumes

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Create a new persistent block storage volume in the specified project. Volumes can be attached to compute instances to provide additional storage. Volume creation is asynchronous; monitor the task status for completion.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions or storage quota exceeded

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific storage volume, including size, status, attachment state, and associated instance if attached.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the storage volume.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this volume

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.description
Update the metadata of a storage volume, including name and description. To change the volume size, use the resize endpoint.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.summary
[Volumes] Replace storage volume metadata

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the storage volume.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.403.description
Insufficient permissions to modify this volume

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Partially update the metadata of a storage volume. Only the provided fields will be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[Volumes] Partially update storage volume metadata

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the storage volume.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this volume

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.description
Permanently delete a storage volume and all data stored on it. The volume must be detached from any instances before deletion. This action is irreversible.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the storage volume.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.403.description
Insufficient permissions to delete this volume

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.409.description
Volume is attached to an instance and cannot be deleted

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Attach a storage volume to a compute instance. The volume will be available as a block device within the instance. A volume can only be attached to one instance at a time. Hot-attach is supported for running instances.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Volumes] Attach a volume to an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the storage volume.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to attach this volume

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
Volume is already attached to an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Detach a storage volume from its currently attached compute instance. Ensure all data is synced and the volume is unmounted within the guest OS before detaching to prevent data loss.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[Volumes] Detach a volume from an instance

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the storage volume.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions to detach this volume

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Increase the size of a storage volume. Volumes can only be expanded, not shrunk. After resizing, you may need to extend the filesystem within the guest OS to use the additional space. Hot-resize is supported for attached volumes.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the storage volume.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions or storage quota exceeded

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve a paginated list of all Virtual Private Clouds (VPCs) in the project. VPCs provide isolated network environments for compute instances with configurable IP address ranges and network policies.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.description
Create a new Virtual Private Cloud (VPC) with the specified network configuration. VPCs provide isolated network environments where instances can communicate securely using private IP addresses.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.summary
[VPCs] Create a new Virtual Private Cloud

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.403.description
Insufficient permissions or VPC quota exceeded

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.post.responses.409.description
VPC with overlapping CIDR range already exists

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.description
Retrieve detailed information about a specific VPC, including CIDR range, connected instances, and network configuration.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.summary
[VPCs] Get Virtual Private Cloud details

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the Virtual Private Cloud.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.responses.403.description
Insufficient permissions to access this VPC

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.description
Update the configuration of a Virtual Private Cloud. Note that the CIDR range cannot be modified after creation.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the Virtual Private Cloud.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.put.responses.403.description
Insufficient permissions to modify this VPC

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.description
Partially update the configuration of a Virtual Private Cloud. Only provided fields will be updated.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.summary
[VPCs] Partially update Virtual Private Cloud

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the Virtual Private Cloud.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.patch.responses.403.description
Insufficient permissions to modify this VPC

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.description
Delete a Virtual Private Cloud and release its network resources. All instances must be removed from the VPC before it can be deleted.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the Virtual Private Cloud.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the organization that owns the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.parameters[].description
Unique identifier of the project containing the resource.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.delete.responses.403.description
Insufficient permissions to delete this VPC

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/comput.get.parameters[].description
A UUID string identifying this VPC IP Allocation.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.description
Retrieve a paginated list of all DNS zones within the specified project. Each zone includes its name, status, record count, and configuration details. DNS zones provide authoritative DNS hosting for your domains and allow you to manage DNS records.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.200.description
Successfully retrieved the list of DNS zones

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.403.description
You do not have permission to access this project's DNS zones

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.description
Create a new DNS zone for hosting domain DNS records. The zone will be provisioned in Cloudflare and configured with default SOA and NS records. Once created, you can add additional DNS records and optionally attach the zone to a domain for integrated management. Zone names must be valid domain names and unique within the project.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.400.description
Invalid zone name or configuration. The zone name may be malformed or already exists

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.403.description
You do not have permission to create DNS zones in this project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.409.description
A DNS zone with this name already exists in the project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.500.description
Failed to provision DNS zone in Cloudflare

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.description
Retrieve comprehensive details for a specific DNS zone including all associated DNS records, zone status, nameserver assignments, and configuration. Use this endpoint to view the complete DNS configuration for a zone.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.parameters[].description
The unique identifier (UUID) of the DNS zone to retrieve

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.200.description
DNS zone details with all records retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.403.description
You do not have permission to access this DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.404.description
DNS zone not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.description
Permanently delete a DNS zone and all associated DNS records. This action is irreversible and will also remove the zone from Cloudflare. If the zone is attached to a domain, the association will be removed. Ensure you have exported any records you wish to preserve before deletion.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.parameters[].description
The unique identifier (UUID) of the DNS zone to delete

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.responses.204.description
DNS zone and all records deleted successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.responses.403.description
You do not have permission to delete this DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.responses.404.description
DNS zone not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.responses.500.description
Failed to delete DNS zone from Cloudflare

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.description
Export all DNS records from a zone in standard BIND zone file format. This export can be used for backup purposes or to import the zone into another DNS provider. The export includes all record types and their current configuration.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.summary
[DNS Zones] Export DNS zone in BIND format

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.parameters[].description
The unique identifier (UUID) of the DNS zone to export

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.200.description
DNS zone exported successfully in BIND format

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.403.description
You do not have permission to export this DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.404.description
DNS zone not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.description
Import DNS records into a zone from standard BIND zone file format. Existing records are preserved unless they conflict with imported records. The import process validates all records before applying changes. Invalid records will be rejected with detailed error messages indicating the issue.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.summary
[DNS Zones] Import DNS records from BIND format

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.parameters[].description
The unique identifier (UUID) of the DNS zone to import into

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.200.description
DNS records imported successfully. Returns the list of created records

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.400.description
Invalid BIND format or records failed validation. Check the error details for specific issues

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.403.description
You do not have permission to import records into this DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.404.description
DNS zone not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.description
Retrieve a paginated list of all DNS records within a specific zone. Records can be filtered by type to show only specific record types. Each record includes its name, type, content, TTL, and proxy status (for applicable record types).

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.summary
[DNS Records] List DNS records for a zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.parameters[].description
The unique identifier (UUID) of the DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.parameters[].description
Filter records by type (e.g., A, AAAA, CNAME, MX, TXT, NS, SRV, CAA)

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.200.description
Successfully retrieved the list of DNS records

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.403.description
You do not have permission to access this DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.404.description
DNS zone not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.description
Create a new DNS record within a zone. Supported record types include A, AAAA, CNAME, MX, TXT, NS, SRV, CAA, and more. The record is immediately propagated to Cloudflare's global network. Certain record types have specific format requirements for their content field (e.g., MX requires priority, SRV requires priority/weight/port).

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.parameters[].description
The unique identifier (UUID) of the DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.400.description
Invalid record data. Check that the record type, name, and content are valid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.403.description
You do not have permission to create records in this DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.404.description
DNS zone not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.post.responses.409.description
A conflicting record already exists (e.g., duplicate CNAME)

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.description
Retrieve details for a specific DNS record including its name, type, content, TTL, proxy status, and any type-specific metadata. Use this endpoint to get the current configuration of an individual DNS record.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.summary
[DNS Records] Retrieve DNS record details

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.parameters[].description
The unique identifier (UUID) of the DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.parameters[].description
The unique identifier (UUID) of the DNS record to retrieve

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.200.description
DNS record details retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.403.description
You do not have permission to access this DNS record

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.description
Update an existing DNS record's configuration. You can modify the name, content, TTL, and proxy status (for applicable types). The record type cannot be changed; delete and recreate the record if you need to change its type. Changes are immediately propagated to Cloudflare's global network.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.parameters[].description
The unique identifier (UUID) of the DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.parameters[].description
The unique identifier (UUID) of the DNS record to update

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.responses.400.description
Invalid record data. Check that all fields are valid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.responses.403.description
You do not have permission to update this DNS record

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.responses.409.description
Update would create a conflicting record

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.description
Permanently delete a DNS record from the zone. The record is immediately removed from Cloudflare's global network. This action is irreversible. Exercise caution when deleting critical records such as NS or SOA records as this may affect zone functionality.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.parameters[].description
The unique identifier (UUID) of the DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.parameters[].description
The unique identifier (UUID) of the DNS record to delete

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.delete.responses.403.description
You do not have permission to delete this DNS record

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.description
Retrieve the current settings for a DNS zone including SSL mode, cache level, security level, and performance options. Settings are synchronized with the DNS provider and reflect the current configuration.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.parameters[].description
The unique identifier (UUID) of the DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.parameters[].description
If true, synchronize settings from the DNS provider before returning

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.200.description
DNS zone settings retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.400.description
DNS zone is not provisioned on the provider

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.403.description
You do not have permission to access this DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.get.responses.404.description
DNS zone not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.description
Update the configuration settings for a DNS zone. Changes are applied to both the local database and synchronized with the DNS provider. Available settings include SSL/TLS mode, HTTPS enforcement, cache levels, security settings, and performance optimizations.

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.parameters[].description
The unique identifier (UUID) of the DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.responses.400.description
Invalid settings values or DNS zone not provisioned

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.responses.403.description
You do not have permission to update this DNS zone

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.responses.404.description
DNS zone not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/dns-zo.put.responses.500.description
Failed to update settings on the DNS provider

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.description
Retrieve a paginated list of all domains registered within the specified project. Each domain includes its current status, expiration date, and configuration details. Use this endpoint to monitor your domain portfolio and track registration statuses.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.200.description
Successfully retrieved the list of domains

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.403.description
You do not have permission to access this project's domains

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.description
Retrieve comprehensive details for a specific domain including its registration status, expiration date, nameservers, WHOIS privacy settings, transfer lock status, and associated DNS zone information. Use this endpoint to get the current state of a domain.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.parameters[].description
Comma-separated list of related resources to expand. Available: 'tld' (includes full TLD info with pricing). Example: ?expand=tld

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.parameters[].description
The unique identifier (UUID) of the domain to retrieve

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.403.description
You do not have permission to access this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.description
Enable or disable automatic renewal for a domain. When enabled, the domain will be automatically renewed before its expiration date, provided sufficient account balance is available. Automatic renewal helps prevent accidental domain expiration and potential loss of the domain name. Renewal notifications will be sent regardless of this setting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.403.description
You do not have permission to modify this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.description
Update the WHOIS contact information for a domain including registrant, administrative, technical, and billing contacts. Contact changes are submitted to the registry and may require verification depending on the TLD. Some registries may initiate a transfer verification process when changing registrant information.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.202.description
Contact update task created and queued for processing

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.400.description
Invalid contact information or contact does not exist

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.403.description
You do not have permission to update contacts for this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.description
Associate a DNS zone with a domain. This links the domain to an existing DNS zone for unified management. When attached, the domain's nameservers can be automatically configured to point to the zone's authoritative servers. The DNS zone must already exist and belong to the same project.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.200.description
DNS zone attached to domain successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.400.description
Invalid DNS zone or zone name does not match domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.403.description
You do not have permission to modify this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.description
Activate DNS management for a domain by creating a DNS zone on the DNS provider. This operation provisions the zone and returns the nameservers that must be configured at the domain registrar for DNS delegation. If the zone already exists, it refreshes the zone status and returns the current nameservers.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.200.description
DNS zone activated successfully with nameservers to configure

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.403.description
You do not have permission to activate DNS for this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.500.description
Failed to provision DNS zone on the provider

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.description
Apply the DNS zone nameservers to the domain at the registrar level. This updates the domain's nameserver delegation to point to the activated DNS zone. The operation is asynchronous and creates a task to update nameservers at the registrar. The DNS zone must be activated before applying nameservers.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.summary
[Domains] Apply DNS nameservers to domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.202.description
Nameserver update task created and queued for processing

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.400.description
DNS zone is not activated or has no nameservers

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.403.description
You do not have permission to update this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.description
Check the activation status of the domain's DNS zone. This queries the DNS provider to verify if the zone has been properly activated and nameservers are correctly delegated. Returns the current verification status.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.summary
[Domains] Verify DNS zone activation status

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.400.description
DNS zone is not configured for this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.403.description
You do not have permission to access this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.description
Retrieve the EPP (Extensible Provisioning Protocol) authorization code for a domain. This code is required to transfer the domain to another registrar. The EPP code is typically valid for a limited time (usually 5-30 days depending on the registry). The domain must be unlocked before the transfer can be initiated at the new registrar.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.400.description
Domain has no registrar ID or registrar connector not configured

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.403.description
You do not have permission to retrieve the EPP code for this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.description
Associate a domain with a web hosting service. This links the domain to the hosting account and optionally configures DNS records to point to the hosting server. When configure_dns is true, A and CNAME records are automatically created for the root domain and www subdomain pointing to the hosting server IP.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.summary
[Domains] Associate domain with web hosting

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.200.description
Domain successfully associated with hosting

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.400.description
Invalid hosting ID or DNS configuration failed

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.403.description
You do not have permission to modify this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.description
Remove the association between a domain and its web hosting service. This does not delete any DNS records that were previously created; those must be managed separately through the DNS zone endpoints if cleanup is required.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.summary
[Domains] Disassociate domain from web hosting

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.200.description
Domain successfully disassociated from hosting

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.403.description
You do not have permission to modify this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.description
Enable the transfer lock (registrar lock) on a domain to prevent unauthorized transfers to another registrar. This is a security measure recommended for all domains. When locked, the domain cannot be transferred until explicitly unlocked. The lock status is propagated to the registry immediately.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.parameters[].description
The unique identifier (UUID) of the domain to lock

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.202.description
Domain lock task created and queued for processing

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.403.description
You do not have permission to lock this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.description
Update the authoritative nameservers for a domain. Changes are propagated to the registry and may take up to 48 hours to fully propagate across the global DNS system. Provide between 2 and 13 nameserver hostnames. The nameservers must be valid and responding to DNS queries for the update to succeed.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.parameters[].description
The unique identifier (UUID) of the domain to update

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.202.description
Nameserver update task created and queued for processing

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.400.description
Invalid nameserver configuration or nameservers not responding

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.403.description
You do not have permission to update this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.put.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.description
Enable or disable WHOIS privacy protection for a domain. When enabled, the registrant's personal information (name, address, phone, email) is replaced with proxy contact details in public WHOIS queries. This helps protect against spam and unwanted contact. Note that some TLDs may not support WHOIS privacy or may have specific requirements.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.summary
[Domains] Toggle WHOIS privacy protection

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.202.description
WHOIS privacy toggle task created and queued for processing

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.400.description
WHOIS privacy is not supported for this TLD

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.403.description
You do not have permission to modify WHOIS privacy for this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.description
Retrieve a list of all tasks for a specific domain. Tasks include operations like nameserver updates, contact changes, lock/unlock requests, DNS zone activations, etc. Use this endpoint to monitor the status of pending operations and view task history.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.parameters[].description
Filter tasks by status (pending, running, completed, failed, cancelled)

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.403.description
You do not have permission to access this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.description
Retrieve detailed information about a specific task for a domain. Includes task type, current status, parameters, result, error message (if failed), and timing information.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.parameters[].description
The unique identifier (UUID) of the domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.parameters[].description
The unique identifier (UUID) of the task

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.get.responses.403.description
You do not have permission to access this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.description
Disable the transfer lock on a domain to allow transfers to another registrar. This must be done before initiating an outbound transfer. For security purposes, it is recommended to re-enable the lock after the transfer is complete or if you decide not to proceed with the transfer.

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.parameters[].description
The unique identifier (UUID) of the domain to unlock

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.202.description
Domain unlock task created and queued for processing

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.403.description
You do not have permission to unlock this domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.404.description
Domain not found or does not belong to the specified project

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.description
Create an order for a domain. Supports three order types:
- **register**: Register a new domain (checks availability first)
- **transfer**: Transfer an existing domain from another registrar (EPP code required)
- **external**: Use an external domain you already own (no WHMCS order, DNS only)

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.400.description
Invalid order data or order processing failed

# paths./v1/organizations/{organization_id}/projects/{project_id}/domain.post.responses.409.description
Domain is not available for registration. Includes suggestions for alternative domains

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a paginated list of web hosting accounts within the specified project.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.200.description
List of web hosting accounts retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.403.description
Insufficient permissions to access this project

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve detailed information about a specific web hosting account, including plan details, resource usage, and billing information.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.200.description
Web hosting details retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.403.description
Insufficient permissions to access this hosting

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of all addon domains for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.description
Delete an addon domain from this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Create a new addon domain for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid input or failed to create addon domain

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Submit a cancellation request for a web hosting account.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.summary
[Web Hosting] Request web hosting cancellation

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Create a WHMCS upgrade order to change the web hosting account to a different plan. Returns the resulting order and invoice details so the customer can complete payment.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid plan selection or upgrade could not be created

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.403.description
Insufficient permissions or hosting is not active

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Generate a single sign-on URL for direct access to the cPanel control panel.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of all cron jobs for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid input or failed to create cron job

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid input or failed to delete cron job

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Set privileges for a user on a database.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of all MySQL users for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Create a new MySQL user for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of all MySQL databases for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.description
Delete a MySQL database from this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Create a new MySQL database for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid input or failed to create database

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Get disk usage information for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Get all DNS records for this hosting's domain zone.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.description
Remove a DNS record from this hosting's domain zone.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Add a new DNS record to this hosting's domain zone.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.put.description
Modify an existing DNS record in this hosting's domain zone.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.put.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Get PHP version configuration for each domain/subdomain on this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.200.description
Domains PHP versions listed successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve the list of web hosting plans the account is eligible to change to.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.summary
[Web Hosting] List eligible upgrade plans

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.200.description
List of eligible plans retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.403.description
Insufficient permissions to access this hosting

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of all email accounts for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.description
Delete an email account from this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Change the password for an email account.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Set the disk quota for an email account.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Create a new email account for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
List files in a directory for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.400.description
Server API credentials not configured or invalid path

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of all FTP accounts for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.description
Delete an FTP account from this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Create a new FTP account for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid input or failed to create FTP account

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Change the PHP version for a specific domain or the main domain.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Get all PHP versions available on this hosting server.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of all redirects for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid input or failed to create redirect

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Get CloudLinux LVE resource usage (CPU, memory, entry processes, I/O) for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Revoke a pending cancellation request for a web hosting account.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.summary
[Web Hosting] Revoke web hosting cancellation

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of SSL certificates associated with this web hosting account. Includes certificate status, expiration dates, and validation check results.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.parameters[].description
Filter certificates expiring within 30 days

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.parameters[].description
Filter by certificate status (valid, expired, pending, failed)

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.200.description
List of SSL certificates retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.403.description
Insufficient permissions to access this hosting

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of all subdomains for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.delete.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Create a new subdomain for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid input or failed to create subdomain

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Generate a single sign-on URL for direct access to the webmail interface (Roundcube). Optionally specify an email address to login directly to that specific email account.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.summary
[Emails] Get Webmail (Roundcube) auto-login URL

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.parameters[].description
Optional email address to login directly to a specific email account (e.g., user@domain.com). If not provided, logs into the main cPanel webmail interface.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.400.description
Failed to generate SSO link or invalid email

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Generate a single sign-on URL for direct access to the WHM control panel. Only available for reseller hosting accounts.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.400.description
Failed to generate SSO link or account is not a reseller

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Retrieve a list of all WordPress sites managed by Softaculous for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Create a Softaculous backup of a WordPress instance (files and database).

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Clone a WordPress instance to another domain or directory (e.g. staging).

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid input or failed to clone WordPress

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Delete a WordPress instance managed by Softaculous.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.description
Generate a one-time wp-admin login URL for a WordPress instance.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.summary
[WordPress] Get WordPress admin SSO link

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Update a WordPress instance to the latest available version.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Install a new WordPress site via Softaculous for this hosting.

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.400.description
Invalid input or failed to install WordPress

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/projects/{project_id}/hostin.post.description
Create an order for web hosting. Supports four domain source types:
- **register**: Register a new domain with the hosting
- **transfer**: Transfer an existing domain from another registrar (EPP code required)
- **existing**: Use a domain already in your organization
- **external**: Use an external domain you own (DNS pointing only)

# paths./v1/organizations/{organization_id}/projects/{project_id}/monito.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/monito.put.parameters[].description
A UUID string identifying this dashboard.

# paths./v1/organizations/{organization_id}/projects/{project_id}/notifi.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/projects/{project_id}/notifi.get.responses.200.description
List of notifications retrieved successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/notifi.get.description
Retrieve details of a specific notification

# paths./v1/organizations/{organization_id}/projects/{project_id}/notifi.get.parameters[].description
A UUID string identifying this Project Notification.

# paths./v1/organizations/{organization_id}/projects/{project_id}/notifi.post.description
Mark one or more notifications as read. If no IDs provided, marks all unread notifications as read.

# paths./v1/organizations/{organization_id}/projects/{project_id}/notifi.post.summary
[Notifications] Mark notifications as read

# paths./v1/organizations/{organization_id}/projects/{project_id}/notifi.post.responses.200.description
Notifications marked as read successfully

# paths./v1/organizations/{organization_id}/projects/{project_id}/notifi.get.description
Returns the count of unread notifications for this project

# paths./v1/organizations/{organization_id}/projects/{project_id}/notifi.get.summary
[Notifications] Get unread notification count

# paths./v1/organizations/{organization_id}/projects/usage.get.description
Retrieve usage statistics for all projects accessible to the authenticated user. Includes information such as analysis count, member count, and quota utilization.

# paths./v1/organizations/{organization_id}/projects/usage.get.summary
[Projects] Get usage statistics for all projects

# paths./v1/organizations/{organization_id}/projects/usage.get.responses.200.description
Usage statistics for all accessible projects

# paths./v1/organizations/{organization_id}/projects/usage.get.responses.401.description
Authentication credentials missing or invalid

# paths./v1/organizations/{organization_id}/services.get.description
Retrieve all professional-service engagements (DevOps, development, assistance) for the specified organization, synced from WHMCS. Returns a paginated list.

# paths./v1/organizations/{organization_id}/services.get.parameters[].description
A page number within the paginated result set.

# paths./v1/organizations/{organization_id}/services.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/services.get.responses.403.description
User does not have permission to view services for this organization

# paths./v1/organizations/{organization_id}/services/{id}.get.summary
[Services] Get service engagement details

# paths./v1/organizations/{organization_id}/services/{id}.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/organizations/{organization_id}/services/{id}/invoices.get.summary
[Services] List invoices for a service engagement

# paths./v1/organizations/{organization_id}/services/{id}/invoices.get.responses.401.description
Authentication credentials were not provided or are invalid

# paths./v1/projects/filter.post.description
Search for projects matching the specified name criteria. Returns a filtered list of projects the user has access to.

# paths./v1/projects/filter.post.responses.200.description
List of projects matching the search criteria

# paths./v1/projects/filter.post.responses.401.description
Authentication credentials missing or invalid

# components.schemas.AddCredit.properties.amount.description
Amount to add in EUR (minimum 10.00 EUR, maximum 1000.00 EUR)

# components.schemas.AddCredit.properties.payment_method.description
Payment method for top-up

* `stripe` - stripe
* `paypal` - paypal
* `bank_transfer` - bank_transfer

# components.schemas.AddHostingToCart.properties.domain_source.description
* `register` - register
* `transfer` - transfer
* `existing` - existing
* `external` - external

# components.schemas.AddHostingToCart.properties.billing_cycle.description
* `monthly` - monthly
* `quarterly` - quarterly
* `semi_annually` - semi_annually
* `annually` - annually
* `biennially` - biennially
* `triennially` - triennially

# components.schemas.AddVPSToCart.properties.billing_cycle.description
* `monthly` - monthly
* `quarterly` - quarterly
* `semi_annually` - semi_annually
* `annually` - annually
* `biennially` - biennially
* `triennially` - triennially

# components.schemas.Addon.properties.billing_type.description
* `recurring` - Recurring
* `one_time` - One Time

# components.schemas.AffiliateWithdrawalRequest.properties.amount.description
Amount to withdraw. If not specified, withdraws the full balance.

# components.schemas.Alert.properties.status.description
* `active` - Active
* `resolved` - Resolved
* `acknowledged` - Acknowledged

# components.schemas.AllowedEmailDomain.properties.domain.description
Email domain without @ (e.g., 'company.com')

# components.schemas.BalanceTransaction.properties.transaction_type.description
Type de transaction

* `topup` - Top-up (recharge)
* `payment` - Payment (déduction)
* `refund` - Refund (remboursement)
* `adjustment` - Manual Adjustment
* `promo` - Promo Code Credit

# components.schemas.BalanceTransaction.properties.amount.description
Montant en EUR (positif = ajout, négatif = retrait)

# components.schemas.BalanceTransactionNested.properties.transaction_type.description
Type de transaction

* `topup` - Top-up (recharge)
* `payment` - Payment (déduction)
* `refund` - Refund (remboursement)
* `adjustment` - Manual Adjustment
* `promo` - Promo Code Credit

# components.schemas.BalanceTransactionNested.properties.amount.description
Montant en EUR (positif = ajout, négatif = retrait)

# components.schemas.Cart.properties.status.description
* `active` - Active
* `converted` - Converted to Order
* `abandoned` - Abandoned
* `expired` - Expired

# components.schemas.CartItem.properties.product_type.description
* `instance` - Compute Instance
* `hosting` - Web Hosting
* `domain` - Domain Name
* `ssl` - SSL Certificate
* `addon` - Addon
* `other` - Other

# components.schemas.CartItem.properties.billing_cycle.description
* `hourly` - Hourly
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.Checkout.properties.payment_method.description
* `stripe` - stripe
* `balance` - balance

# components.schemas.CreateDNSRecordInput.properties.type.description
* `A` - A
* `AAAA` - AAAA
* `CNAME` - CNAME
* `MX` - MX
* `TXT` - TXT
* `SRV` - SRV
* `CAA` - CAA

# components.schemas.CreateOrganizationAPIKey.properties.role.description
* `organization_guest` - Organization Guest
* `organization_viewer` - Organization Viewer
* `organization_editor` - Organization Editor
* `organization_owner` - Organization Owner

# components.schemas.CreateOrganizationRoleResponse.properties.role.description
* `organization_guest` - Organization Guest
* `organization_viewer` - Organization Viewer
* `organization_editor` - Organization Editor
* `organization_owner` - Organization Owner

# components.schemas.CreateProjectAPIKey.properties.role.description
* `workspace_viewer` - Project Viewer
* `workspace_editor` - Project Editor

# components.schemas.CreateUserOrganizationRoleInput.properties.role.description
* `organization_guest` - Organization Guest
* `organization_viewer` - Organization Viewer
* `organization_editor` - Organization Editor
* `organization_owner` - Organization Owner

# components.schemas.CreateUserProjectRoleInput.properties.role.description
* `workspace_viewer` - Project Viewer
* `workspace_editor` - Project Editor

# components.schemas.CreateUserProjectRoleResponse.properties.role.description
* `workspace_viewer` - Project Viewer
* `workspace_editor` - Project Editor

# components.schemas.DNSZone.properties.mode.description
* `onetsolutions` - onetsolutions
* `client` - client

# components.schemas.DNSZoneCreate.properties.mode.description
* `onetsolutions` - onetsolutions
* `client` - client

# components.schemas.DNSZoneList.properties.mode.description
* `onetsolutions` - onetsolutions
* `client` - client

# components.schemas.DNSZoneSettings.properties.ssl_mode.description
* `off` - off
* `flexible` - flexible
* `full` - full
* `full_strict` - full strict

# components.schemas.DNSZoneSettings.properties.cache_level.description
* `bypass` - bypass
* `no_query_string` - no query string
* `ignore_query_string` - ignore query string
* `standard` - standard
* `aggressive` - aggressive

# components.schemas.DNSZoneSettings.properties.security_level.description
* `essentially_off` - essentially off
* `low` - low
* `medium` - medium
* `high` - high
* `under_attack` - under attack

# components.schemas.DNSZoneSettingsUpdate.properties.ssl_mode.description
* `off` - off
* `flexible` - flexible
* `full` - full
* `full_strict` - full strict

# components.schemas.DNSZoneSettingsUpdate.properties.cache_level.description
* `bypass` - bypass
* `no_query_string` - no query string
* `ignore_query_string` - ignore query string
* `standard` - standard
* `aggressive` - aggressive

# components.schemas.DNSZoneSettingsUpdate.properties.security_level.description
* `essentially_off` - essentially off
* `low` - low
* `medium` - medium
* `high` - high
* `under_attack` - under attack

# components.schemas.Domain.properties.status.description
* `pending` - pending
* `registering` - registering
* `active` - active
* `expired` - expired
* `expiring_soon` - expiring soon
* `suspended` - suspended
* `transferring_in` - transferring in
* `transferring_out` - transferring out
* `pending_delete` - pending delete
* `deleted` - deleted
* `failed` - failed

# components.schemas.DomainList.properties.status.description
* `pending` - pending
* `registering` - registering
* `active` - active
* `expired` - expired
* `expiring_soon` - expiring soon
* `suspended` - suspended
* `transferring_in` - transferring in
* `transferring_out` - transferring out
* `pending_delete` - pending delete
* `deleted` - deleted
* `failed` - failed

# components.schemas.DomainOrderRequest.properties.order_type.description
* `register` - Register new domain
* `transfer` - Transfer existing domain
* `external` - Use external domain

# components.schemas.DomainTask.properties.task_type.description
* `register` - register
* `transfer_in` - transfer in
* `transfer_out` - transfer out
* `renew` - renew
* `update_nameservers` - update nameservers
* `update_contacts` - update contacts
* `get_epp_code` - get epp code
* `enable_whois_privacy` - enable whois privacy
* `disable_whois_privacy` - disable whois privacy
* `lock_domain` - lock domain
* `unlock_domain` - unlock domain
* `create_dns_zone` - create dns zone
* `delete_dns_zone` - delete dns zone
* `create_dns_record` - create dns record
* `update_dns_record` - update dns record
* `delete_dns_record` - delete dns record
* `sync_dns_records` - sync dns records

# components.schemas.DomainTask.properties.status.description
* `pending` - pending
* `running` - running
* `completed` - completed
* `failed` - failed
* `cancelled` - cancelled

# components.schemas.EditDNSRecordInput.properties.type.description
* `A` - A
* `AAAA` - AAAA
* `CNAME` - CNAME
* `MX` - MX
* `TXT` - TXT
* `SRV` - SRV
* `CAA` - CAA

# components.schemas.EmailSignup.properties.organization_type.description
* `personal` - Personal
* `professional` - Professional

# components.schemas.EmailSignup.properties.vat_number.description
European VAT number for company auto-fill (e.g., FR12345678901)

# components.schemas.EmailSignupResponse.properties.needs_onboarding.description
Whether the user should be redirected to onboarding to complete profile

# components.schemas.FilterProjectRequest.properties.name.description
Project name or partial name to search for

# components.schemas.HostingOrderRequest.properties.domain_source.description
* `register` - Register new domain
* `transfer` - Transfer existing domain
* `existing` - Use existing domain in system
* `external` - Use external domain

# components.schemas.HostingOrderRequest.properties.billing_cycle.description
* `free` - Free
* `one_time` - One Time
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.IPAddress.properties.interface.description
Network interface index (0=net0, 1=net1, etc.)

# components.schemas.Instance.properties.status.description
Billing status

* `pending` - Pending
* `provisioning` - Provisioning
* `active` - Active
* `suspended` - Suspended
* `terminated` - Terminated
* `cancelled` - Cancelled
* `error` - Error

# components.schemas.Instance.properties.billing_cycle.description
* `free` - Free
* `one_time` - One Time
* `hourly` - Hourly
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.Instance.properties.cancellation_requested_at.description
When cancellation was requested, effective at billing_end_date

# components.schemas.Instance.properties.cancellation_reason.description
Reason provided for cancellation request

# components.schemas.Instance.properties.is_installed.description
Whether the instance OS/service has been installed

# components.schemas.InstanceAddonActivate.properties.billing_cycle.description
* `monthly` - monthly
* `quarterly` - quarterly
* `semi_annually` - semi_annually
* `annually` - annually
* `biennially` - biennially
* `triennially` - triennially

# components.schemas.InstanceAgentInfo.properties.agent_available.description
Guest agent a répondu lors de la dernière collecte

# components.schemas.InstanceAgentInfo.properties.filesystems.description
Systèmes de fichiers (mountpoint, usage)

# components.schemas.InstanceBackup.properties.status.description
* `pending` - Pending
* `running` - Running
* `completed` - Completed
* `failed` - Failed
* `deleting` - Deleting
* `deleted` - Deleted

# components.schemas.InstanceBackup.properties.backup_type.description
* `manual` - Manual
* `scheduled` - Scheduled

# components.schemas.InstanceCreate.properties.billing_cycle.description
* `hourly` - hourly
* `monthly` - monthly
* `quarterly` - quarterly
* `semi_annually` - semi_annually
* `annually` - annually
* `biennially` - biennially
* `triennially` - triennially

# components.schemas.InstanceFirewallRule.properties.direction.description
* `inbound` - Inbound
* `outbound` - Outbound

# components.schemas.InstanceFirewallRule.properties.action.description
* `accept` - Accept
* `drop` - Drop
* `reject` - Reject

# components.schemas.InstanceFirewallRule.properties.protocol.description
* `tcp` - TCP
* `udp` - UDP
* `icmp` - ICMP
* `all` - All

# components.schemas.InstanceFirewallRule.properties.source_cidr.description
Source IP en notation CIDR (ex: 0.0.0.0/0 pour tout)

# components.schemas.InstanceFirewallRule.properties.priority.description
Priorité (plus petit = plus prioritaire)

# components.schemas.InstanceFirewallRuleCreate.properties.direction.description
* `in` - in
* `out` - out
* `inbound` - inbound
* `outbound` - outbound

# components.schemas.InstanceFirewallRuleCreate.properties.action.description
* `accept` - accept
* `drop` - drop
* `reject` - reject

# components.schemas.InstanceFirewallRuleCreate.properties.protocol.description
* `tcp` - tcp
* `udp` - udp
* `icmp` - icmp
* `all` - all

# components.schemas.InstanceImage.properties.visibility.description
Public images are available to all, private to organization only

* `public` - Public
* `private` - Private

# components.schemas.InstanceInstalledSoftware.properties.status.description
* `pending` - Pending
* `installing` - Installing
* `installed` - Installed
* `failed` - Failed
* `uninstalling` - Uninstalling
* `uninstalled` - Uninstalled

# components.schemas.InstanceInstalledSoftware.properties.install_parameters.description
Paramètres utilisés lors de l'installation

# components.schemas.InstanceMonitor.properties.status.description
* `up` - Up
* `down` - Down
* `degraded` - Degraded
* `pending` - Pending

# components.schemas.InstanceMonitorCheck.properties.status.description
* `up` - Up
* `down` - Down
* `degraded` - Degraded
* `pending` - Pending

# components.schemas.InstanceMonitorIncident.properties.status.description
* `ongoing` - Ongoing
* `resolved` - Resolved

# components.schemas.InstanceSecurityScan.properties.severity.description
Niveau de sévérité

* `info` - Info
* `low` - Low
* `medium` - Medium
* `high` - High
* `critical` - Critical

# components.schemas.InstanceSizeAddon.properties.is_included.description
If true, addon is included in the base price

# components.schemas.InstanceSizeAddonPricing.properties.billing_cycle.description
* `hourly` - Hourly
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.InstanceSizePricing.properties.billing_cycle.description
* `hourly` - Hourly
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.InstanceSnapshot.properties.status.description
* `pending` - Pending
* `present` - Present
* `deleting` - Deleting
* `failed` - Failed
* `deleted` - Deleted

# components.schemas.InstanceStateSync.properties.vm_status.description
Statut réel dans Hypervisor (running, stopped, etc.)

# components.schemas.InstanceSummary.properties.status.description
Billing status

* `pending` - Pending
* `provisioning` - Provisioning
* `active` - Active
* `suspended` - Suspended
* `terminated` - Terminated
* `cancelled` - Cancelled
* `error` - Error

# components.schemas.InstanceTask.properties.task_type.description
* `create_vps` - Create Instance
* `start_vps` - Start Instance
* `stop_vps` - Stop Instance
* `reboot_vps` - Reboot Instance
* `shutdown_vps` - Shutdown Instance
* `reset_vps` - Reset Instance
* `resize_vps` - Resize Instance
* `change_hostname` - Change Hostname
* `reinstall_os` - Reinstall OS
* `assign_ip` - Assign IP
* `remove_ip` - Remove IP
* `update_reverse_dns` - Update Reverse DNS
* `update_vpc` - Update VPC
* `apply_firewall` - Apply Firewall Rules
* `create_snapshot` - Create Snapshot
* `delete_snapshot` - Delete Snapshot
* `restore_snapshot` - Restore Snapshot
* `create_backup` - Create Backup
* `delete_backup` - Delete Backup
* `restore_backup` - Restore Backup
* `create_image_from_snapshot` - Create Image from Snapshot
* `delete_image` - Delete Image
* `create_volume` - Create Volume
* `attach_volume` - Attach Volume
* `detach_volume` - Detach Volume
* `resize_volume` - Resize Volume
* `delete_volume` - Delete Volume
* `attach_gpu` - Attach GPU
* `detach_gpu` - Detach GPU
* `install_software` - Install Software
* `uninstall_software` - Uninstall Software
* `get_vnc_url` - Get console access
* `sync_vps_state` - Sync Instance State
* `apply_config` - Apply Proxmox Configuration

# components.schemas.InstanceTask.properties.status.description
* `pending` - Pending
* `running` - Running
* `completed` - Completed
* `failed` - Failed
* `cancelled` - Cancelled

# components.schemas.InstanceVolume.properties.status.description
* `pending` - Pending
* `creating` - Creating
* `available` - Available
* `attached` - Attached
* `detached` - Detached
* `deleting` - Deleting
* `deleted` - Deleted
* `error` - Error

# components.schemas.InstanceVolume.properties.disk_type.description
Disk type (ssd, nvme)

* `ssd` - SSD
* `nvme` - NVMe
* `unknown` - Unknown

# components.schemas.Invoice.properties.status.description
* `draft` - Draft
* `pending` - Pending Payment
* `paid` - Paid
* `partially_paid` - Partially Paid
* `overdue` - Overdue
* `cancelled` - Cancelled
* `refunded` - Refunded

# components.schemas.InvoiceItem.properties.description.description
Item description with line breaks preserved

# components.schemas.InvoiceNested.properties.status.description
* `draft` - Draft
* `pending` - Pending Payment
* `paid` - Paid
* `partially_paid` - Partially Paid
* `overdue` - Overdue
* `cancelled` - Cancelled
* `refunded` - Refunded

# components.schemas.ListAPIKey.properties.role.description
* `organization_guest` - Organization Guest
* `organization_viewer` - Organization Viewer
* `organization_editor` - Organization Editor
* `organization_owner` - Organization Owner
* `workspace_viewer` - Project Viewer
* `workspace_editor` - Project Editor

# components.schemas.ListUserOrganizationRole.properties.role.description
* `organization_guest` - Organization Guest
* `organization_viewer` - Organization Viewer
* `organization_editor` - Organization Editor
* `organization_owner` - Organization Owner

# components.schemas.ListUserProjectRole.properties.role.description
* `workspace_viewer` - Project Viewer
* `workspace_editor` - Project Editor

# components.schemas.MarkNotificationsRead.properties.notification_ids.description
List of notification IDs to mark as read. If empty, marks all unread notifications as read.

# components.schemas.MetricDataPoint.properties.metric_type.description
* `cpu_usage` - CPU Usage (%)
* `memory_usage` - Memory Usage (%)
* `disk_usage` - Disk Usage (%)
* `disk_read_bytes` - Disk Read (bytes)
* `disk_write_bytes` - Disk Write (bytes)
* `network_in_bytes` - Network In (bytes)
* `network_out_bytes` - Network Out (bytes)
* `uptime` - Uptime (seconds)
* `load_average_1m` - Load Average (1 min)
* `load_average_5m` - Load Average (5 min)
* `load_average_15m` - Load Average (15 min)
* `cpu_count` - vCPU count
* `swap_usage` - Swap Usage (%)
* `swap_bytes` - Swap (bytes)
* `pressure_cpu_some` - CPU Pressure - Some (%)
* `pressure_cpu_full` - CPU Pressure - Full (%)
* `pressure_io_some` - I/O Pressure - Some (%)
* `pressure_io_full` - I/O Pressure - Full (%)
* `pressure_memory_some` - Memory Pressure - Some (%)
* `pressure_memory_full` - Memory Pressure - Full (%)

# components.schemas.Order.properties.status.description
* `pending` - Pending
* `active` - Active
* `fraud` - Fraud
* `cancelled` - Cancelled

# components.schemas.OrderItem.properties.product_type.description
* `instance` - Compute Instance
* `hosting` - Web Hosting
* `domain` - Domain Name
* `ssl` - SSL Certificate
* `addon` - Addon
* `other` - Other

# components.schemas.OrderItem.properties.billing_cycle.description
* `hourly` - Hourly
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.OrderNested.properties.status.description
* `pending` - Pending
* `active` - Active
* `fraud` - Fraud
* `cancelled` - Cancelled

# components.schemas.Organization.properties.organization_type.description
* `personal` - Personal
* `professional` - Professional

# components.schemas.Organization.properties.support_plan.description
* `basic` - Basic
* `advanced` - Advanced
* `business` - Business

# components.schemas.OrganizationAuthSettings.properties.enabled_providers.items.description
* `google` - google
* `microsoft` - microsoft
* `twitter` - twitter
* `onetsolutions` - onetsolutions

# components.schemas.OrganizationAuthSettings.properties.default_provider.description
Default auth provider type

* `google` - google
* `microsoft` - microsoft
* `twitter` - twitter
* `onetsolutions` - onetsolutions

# components.schemas.OrganizationBilling.properties.default_payment_method.description
* `stripe` - Stripe
* `paypal` - PayPal
* `utrust` - Utrust

# components.schemas.OrganizationCreate.properties.support_plan.description
* `basic` - Basic
* `advanced` - Advanced
* `business` - Business

# components.schemas.OrganizationPermissions.properties.role.description
User's role within the organization

* `organization_guest` - organization_guest
* `organization_viewer` - organization_viewer
* `organization_editor` - organization_editor
* `organization_owner` - organization_owner

# components.schemas.OrganizationPermissions.properties.permissions.description
List of permission codes granted to the user

# components.schemas.OrganizationUpdate.properties.organization_type.description
* `personal` - Personal
* `professional` - Professional

# components.schemas.OrganizationUpdate.properties.support_plan.description
* `basic` - Basic
* `advanced` - Advanced
* `business` - Business

# components.schemas.PatchedInstance.properties.status.description
Billing status

* `pending` - Pending
* `provisioning` - Provisioning
* `active` - Active
* `suspended` - Suspended
* `terminated` - Terminated
* `cancelled` - Cancelled
* `error` - Error

# components.schemas.PatchedInstance.properties.billing_cycle.description
* `free` - Free
* `one_time` - One Time
* `hourly` - Hourly
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.PatchedInstance.properties.cancellation_requested_at.description
When cancellation was requested, effective at billing_end_date

# components.schemas.PatchedInstance.properties.cancellation_reason.description
Reason provided for cancellation request

# components.schemas.PatchedInstance.properties.is_installed.description
Whether the instance OS/service has been installed

# components.schemas.PatchedInstanceBackup.properties.status.description
* `pending` - Pending
* `running` - Running
* `completed` - Completed
* `failed` - Failed
* `deleting` - Deleting
* `deleted` - Deleted

# components.schemas.PatchedInstanceBackup.properties.backup_type.description
* `manual` - Manual
* `scheduled` - Scheduled

# components.schemas.PatchedInstanceFirewallRule.properties.direction.description
* `inbound` - Inbound
* `outbound` - Outbound

# components.schemas.PatchedInstanceFirewallRule.properties.action.description
* `accept` - Accept
* `drop` - Drop
* `reject` - Reject

# components.schemas.PatchedInstanceFirewallRule.properties.protocol.description
* `tcp` - TCP
* `udp` - UDP
* `icmp` - ICMP
* `all` - All

# components.schemas.PatchedInstanceFirewallRule.properties.source_cidr.description
Source IP en notation CIDR (ex: 0.0.0.0/0 pour tout)

# components.schemas.PatchedInstanceFirewallRule.properties.priority.description
Priorité (plus petit = plus prioritaire)

# components.schemas.PatchedInstanceImage.properties.visibility.description
Public images are available to all, private to organization only

* `public` - Public
* `private` - Private

# components.schemas.PatchedInstanceInstalledSoftware.properties.status.description
* `pending` - Pending
* `installing` - Installing
* `installed` - Installed
* `failed` - Failed
* `uninstalling` - Uninstalling
* `uninstalled` - Uninstalled

# components.schemas.PatchedInstanceInstalledSoftware.properties.install_parameters.description
Paramètres utilisés lors de l'installation

# components.schemas.PatchedInstanceSecurityScan.properties.severity.description
Niveau de sévérité

* `info` - Info
* `low` - Low
* `medium` - Medium
* `high` - High
* `critical` - Critical

# components.schemas.PatchedInstanceSnapshot.properties.status.description
* `pending` - Pending
* `present` - Present
* `deleting` - Deleting
* `failed` - Failed
* `deleted` - Deleted

# components.schemas.PatchedInstanceVolume.properties.status.description
* `pending` - Pending
* `creating` - Creating
* `available` - Available
* `attached` - Attached
* `detached` - Detached
* `deleting` - Deleting
* `deleted` - Deleted
* `error` - Error

# components.schemas.PatchedInstanceVolume.properties.disk_type.description
Disk type (ssd, nvme)

* `ssd` - SSD
* `nvme` - NVMe
* `unknown` - Unknown

# components.schemas.PatchedOrganizationBilling.properties.default_payment_method.description
* `stripe` - Stripe
* `paypal` - PayPal
* `utrust` - Utrust

# components.schemas.PatchedOrganizationUpdate.properties.organization_type.description
* `personal` - Personal
* `professional` - Professional

# components.schemas.PatchedOrganizationUpdate.properties.support_plan.description
* `basic` - Basic
* `advanced` - Advanced
* `business` - Business

# components.schemas.PatchedProjectUpdate.properties.logo.description
Binary content of the logo encoded in base64 with appropriate header ex: data:image/png;base64,XXXXXX

# components.schemas.PatchedUpdateCartItem.properties.billing_cycle.description
* `monthly` - monthly
* `quarterly` - quarterly
* `semi_annually` - semi_annually
* `annually` - annually
* `biennially` - biennially
* `triennially` - triennially

# components.schemas.PatchedUpdateUserOrganizationRole.properties.role.description
* `organization_guest` - Organization Guest
* `organization_viewer` - Organization Viewer
* `organization_editor` - Organization Editor
* `organization_owner` - Organization Owner

# components.schemas.PatchedUpdateUserProjectRole.properties.role.description
* `workspace_viewer` - Project Viewer
* `workspace_editor` - Project Editor

# components.schemas.PayInvoice.properties.gateway_id.description
PaymentGateway UUID - required for most payment modes

# components.schemas.PayInvoice.properties.mode.description
Payment mode: redirect (gateway redirect), embedded (embedded form), saved_card (use saved payment method), manual (bank transfer), smart_buttons (PayPal popup), saved_paypal (saved PayPal account). If not provided, uses gateway's default mode.

* `redirect` - redirect
* `embedded` - embedded
* `saved_card` - saved_card
* `manual` - manual
* `smart_buttons` - smart_buttons
* `saved_paypal` - saved_paypal

# components.schemas.PayInvoice.properties.payment_method_id.description
SavedPaymentMethod ID - required for mode=saved_card or saved_paypal

# components.schemas.PayInvoice.properties.success_url.description
Redirect URL after successful payment (for redirect mode)

# components.schemas.PayInvoice.properties.cancel_url.description
Redirect URL after cancelled payment (for redirect mode)

# components.schemas.PayInvoice.properties.return_url.description
Return URL after embedded checkout (for embedded mode)

# components.schemas.PayInvoice.properties.use_balance.description
Apply available credit to the invoice before payment

# components.schemas.Payment.properties.status.description
* `pending` - Pending
* `processing` - Processing
* `completed` - Completed
* `failed` - Failed
* `refunded` - Refunded

# components.schemas.PaymentNested.properties.status.description
* `pending` - Pending
* `processing` - Processing
* `completed` - Completed
* `failed` - Failed
* `refunded` - Refunded

# components.schemas.ProjectCreate.properties.logo.description
Binary content of the logo encoded in base64 with appropriate header ex: data:image/png;base64,XXXXXX

# components.schemas.ProjectNotification.properties.notification_type.description
* `task_started` - Task Started
* `task_completed` - Task Completed
* `task_failed` - Task Failed
* `instance_status_changed` - Instance Status Changed
* `backup_completed` - Backup Completed
* `snapshot_created` - Snapshot Created
* `alert_triggered` - Alert Triggered

# components.schemas.ProjectPermissions.properties.role.description
User's role within the project

* `workspace_viewer` - workspace_viewer
* `workspace_editor` - workspace_editor

# components.schemas.ProjectPermissions.properties.permissions.description
List of permission codes granted for the project

# components.schemas.SSLCertificate.properties.status.description
* `valid` - Valid
* `expired` - Expired
* `pending` - Pending
* `failed` - Failed

# components.schemas.ServiceEngagement.description
Serializer for professional-services engagements synced from WHMCS.

# components.schemas.ServiceEngagement.properties.status.description
* `pending` - Pending
* `active` - Active
* `suspended` - Suspended
* `terminated` - Terminated
* `cancelled` - Cancelled
* `completed` - Completed

# components.schemas.ServiceEngagement.properties.billing_cycle.description
* `hourly` - Hourly
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.ServiceEngagement.properties.link.description
Custom field link (e.g. gift detail URL)

# components.schemas.SoftwareInstallLog.properties.level.description
* `debug` - Debug
* `info` - Info
* `warning` - Warning
* `error` - Error

# components.schemas.SoftwarePackage.properties.role_name.description
Ansible Galaxy role name (ex: geerlingguy.docker)

# components.schemas.SoftwarePackage.properties.category.description
Catégorie (ex: Container, Web Server, Database)

# components.schemas.SoftwarePackage.properties.parameters_schema.description
JSON Schema des paramètres configurables du role

# components.schemas.SoftwarePackage.properties.supported_os.description
List of supported OS (from Ansible Galaxy meta)

# components.schemas.SupportTicketCreate.properties.priority.description
* `low` - Low
* `medium` - Medium
* `high` - High
* `urgent` - Urgent

# components.schemas.SupportTicketCreate.properties.service_type.description
* `instance` - VPS Instance
* `domain` - Domain
* `web_hosting` - Web Hosting
* `general` - General

# components.schemas.SupportTicketDetail.properties.status.description
* `open` - Open
* `answered` - Answered
* `customer_reply` - Customer Reply
* `on_hold` - On Hold
* `in_progress` - In Progress
* `closed` - Closed

# components.schemas.SupportTicketDetail.properties.priority.description
* `low` - Low
* `medium` - Medium
* `high` - High
* `urgent` - Urgent

# components.schemas.SupportTicketDetail.properties.service_type.description
* `instance` - VPS Instance
* `domain` - Domain
* `web_hosting` - Web Hosting
* `general` - General

# components.schemas.SupportTicketList.properties.status.description
* `open` - Open
* `answered` - Answered
* `customer_reply` - Customer Reply
* `on_hold` - On Hold
* `in_progress` - In Progress
* `closed` - Closed

# components.schemas.SupportTicketList.properties.priority.description
* `low` - Low
* `medium` - Medium
* `high` - High
* `urgent` - Urgent

# components.schemas.SupportTicketList.properties.service_type.description
* `instance` - VPS Instance
* `domain` - Domain
* `web_hosting` - Web Hosting
* `general` - General

# components.schemas.SupportTicketReply.properties.reply_type.description
* `client` - Client Reply
* `admin` - Admin Reply
* `note` - Internal Note

# components.schemas.TLD.properties.category.description
* `generic` - generic
* `country` - country
* `new` - new
* `premium` - premium

# components.schemas.TopupResponse.description
Serializer for top-up response with invoice details

# components.schemas.UserAuthMethodsResponse.properties.has_password.description
Whether the user can login with email/password

# components.schemas.UserAuthMethodsResponse.properties.linked_providers.description
List of OAuth providers linked to this account

# components.schemas.UserAuthMethodsResponse.properties.mfa_methods.description
List of enabled MFA methods (totp, email)

# components.schemas.VPCIPAllocation.properties.status.description
* `reserved` - Reserved
* `allocated` - Allocated
* `released` - Released

# components.schemas.VPCIPAllocation.properties.allocation_type.description
* `gateway` - Gateway
* `instance` - Instance

# components.schemas.VPCIPAllocation.properties.interface_index.description
Network interface index (1=net1, 2=net2, etc.)

# components.schemas.VolumeSummary.properties.status.description
* `pending` - Pending
* `creating` - Creating
* `available` - Available
* `attached` - Attached
* `detached` - Detached
* `deleting` - Deleting
* `deleted` - Deleted
* `error` - Error

# components.schemas.WebHosting.properties.status.description
* `pending` - Pending
* `active` - Active
* `suspended` - Suspended
* `terminated` - Terminated
* `cancelled` - Cancelled
* `failed` - Failed

# components.schemas.WebHosting.properties.billing_cycle.description
* `free` - Free
* `one_time` - One Time
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.WebHosting.properties.suspension_reason.description
Reason for suspension

* `insufficient_balance` - Insufficient Balance
* `payment_failed` - Payment Failed
* `card_expired` - Card Expired
* `manual` - Manual Suspension

# components.schemas.WebHostingList.properties.status.description
* `pending` - Pending
* `active` - Active
* `suspended` - Suspended
* `terminated` - Terminated
* `cancelled` - Cancelled
* `failed` - Failed

# components.schemas.WebHostingList.properties.billing_cycle.description
* `free` - Free
* `one_time` - One Time
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.WebHostingPlan.properties.hosting_type.description
* `hostingaccount` - Standard Hosting
* `reselleraccount` - Reseller Hosting

# components.schemas.WebHostingPlan.properties.bandwidth_mb.description
Bandwidth in MB per month, 0 for unlimited

# components.schemas.WebHostingPlanList.properties.hosting_type.description
* `hostingaccount` - Standard Hosting
* `reselleraccount` - Reseller Hosting

# components.schemas.WebHostingPlanList.properties.bandwidth_mb.description
Bandwidth in MB per month, 0 for unlimited

# components.schemas.WebHostingPlanPricing.properties.billing_cycle.description
* `monthly` - Monthly
* `quarterly` - Quarterly
* `semi_annually` - Semi-Annually
* `annually` - Annually
* `biennially` - Biennially
* `triennially` - Triennially

# components.schemas.WebsitePreview.properties.ssl_status.description
* `valid` - Valid
* `expired` - Expired
* `invalid` - Invalid
* `none` - No SSL
* `unknown` - Unknown

# components.schemas.WebsitePreviewList.properties.ssl_status.description
* `valid` - Valid
* `expired` - Expired
* `invalid` - Invalid
* `none` - No SSL
* `unknown` - Unknown

# components.securitySchemes.BearerAuth.description
Use `Authorization: Bearer <token>` header. Token can be a JWT token or an API key (format: `sk-onetsolutions-...`).

# tags[].description
Login, passwordless authentication, MFA, OAuth providers, and token management.

# tags[].description
Organization management, members, roles, modules, audit logs, and notification settings.

# tags[].description
Project management, team members, and project-scoped resources.

# tags[].description
Cloud instances, volumes, snapshots, backups, VPCs, firewalls, SSH keys, uptime monitors, and instance tasks.

# tags[].description
Domain availability, registration, transfers, DNS zones, DNS records, and TLD information.

# tags[].description
cPanel-based web hosting, emails, databases, subdomains, FTP accounts, addon domains, and SSL certificates.