Unified API for QuantCDN Admin and QuantCloud Platform services
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 4.8.0
- Package version: 1.0.0
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 3.9+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/quantcdn/quant-python-client.git(you may need to run pip with root permission: sudo pip install git+https://github.com/quantcdn/quant-python-client.git)
Then import the package:
import quantcdnInstall via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import quantcdnExecute pytest to run the tests.
Please follow the installation procedure and then run the following:
import quantcdn
from quantcdn.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
host = "https://dashboard.quantcdn.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = quantcdn.AIAgentsApi(api_client)
organisation = 'organisation_example' # str | The organisation ID
agent_id = 'agent_id_example' # str | The agent ID
chat_with_ai_agent_request = quantcdn.ChatWithAIAgentRequest() # ChatWithAIAgentRequest |
try:
# Chat with AI Agent
api_response = api_instance.chat_with_ai_agent(organisation, agent_id, chat_with_ai_agent_request)
print("The response of AIAgentsApi->chat_with_ai_agent:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AIAgentsApi->chat_with_ai_agent: %s\n" % e)All URIs are relative to https://dashboard.quantcdn.io
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AIAgentsApi | chat_with_ai_agent | POST /api/v3/organizations/{organisation}/ai/agents/{agentId}/chat | Chat with AI Agent |
| AIAgentsApi | create_ai_agent | POST /api/v3/organizations/{organisation}/ai/agents | Create AI Agent |
| AIAgentsApi | delete_ai_agent | DELETE /api/v3/organizations/{organisation}/ai/agents/{agentId} | Delete Agent |
| AIAgentsApi | get_ai_agent | GET /api/v3/organizations/{organisation}/ai/agents/{agentId} | Get Agent Details |
| AIAgentsApi | list_ai_agents | GET /api/v3/organizations/{organisation}/ai/agents | List AI Agents |
| AIAgentsApi | update_ai_agent | PUT /api/v3/organizations/{organisation}/ai/agents/{agentId} | Update Agent |
| AICustomToolsApi | create_custom_tool | POST /api/v3/organizations/{organisation}/ai/custom-tools | Register Custom Edge Function Tool |
| AICustomToolsApi | delete_custom_tool | DELETE /api/v3/organizations/{organisation}/ai/custom-tools/{toolName} | Delete Custom Tool |
| AICustomToolsApi | list_custom_tools | GET /api/v3/organizations/{organisation}/ai/custom-tools | List Custom Tools |
| AIInferenceApi | chat_inference | POST /api/v3/organizations/{organisation}/ai/chat | Chat inference via API Gateway (buffered responses) with multimodal support |
| AIInferenceApi | chat_inference_stream | POST /api/v3/organizations/{organisation}/ai/chat/stream | Chat inference via streaming endpoint (true HTTP streaming) with multimodal support |
| AIInferenceApi | embeddings | POST /api/v3/organizations/{organisation}/ai/embeddings | Generate text embeddings for semantic search and RAG applications |
| AIInferenceApi | image_generation | POST /api/v3/organizations/{organisation}/ai/image-generation | Generate images with Amazon Nova Canvas |
| AIModelsApi | get_ai_model | GET /api/v3/organizations/{organisation}/ai/models/{modelId} | Get AI Model Details |
| AIModelsApi | list_ai_models | GET /api/v3/organizations/{organisation}/ai/models | List available AI models for an organization |
| AIMonitoringApi | get_ai_usage_stats | GET /api/v3/organizations/{organisation}/ai/usage | Get AI usage statistics |
| AISessionsApi | create_ai_session | POST /api/v3/organizations/{organisation}/ai/sessions | Create a new chat session with multi-tenant isolation |
| AISessionsApi | delete_ai_session | DELETE /api/v3/organizations/{organisation}/ai/sessions/{sessionId} | Delete a chat session |
| AISessionsApi | extend_ai_session | PUT /api/v3/organizations/{organisation}/ai/sessions/{sessionId}/extend | Extend Session Expiration |
| AISessionsApi | get_ai_session | GET /api/v3/organizations/{organisation}/ai/sessions/{sessionId} | Get a specific chat session |
| AISessionsApi | list_ai_sessions | GET /api/v3/organizations/{organisation}/ai/sessions | List chat sessions with multi-tenant filtering |
| AISessionsApi | update_ai_session | PUT /api/v3/organizations/{organisation}/ai/sessions/{sessionId} | Update Session |
| AIToolsApi | get_ai_tool_execution_status | GET /api/v3/organizations/{organisation}/ai/tools/executions/{executionId} | Get async tool execution status and result |
| AIToolsApi | list_ai_tool_executions | GET /api/v3/organizations/{organisation}/ai/tools/executions | List tool executions for monitoring and debugging |
| AIToolsApi | list_ai_tool_names | GET /api/v3/organizations/{organisation}/ai/tools/names | List tool names only (lightweight response) |
| AIToolsApi | list_ai_tools | GET /api/v3/organizations/{organisation}/ai/tools | List available built-in tools for function calling |
| AIVectorDatabaseApi | create_vector_collection | POST /api/v3/organizations/{organisation}/ai/vector-db/collections | Create Vector Database Collection |
| AIVectorDatabaseApi | delete_vector_collection | DELETE /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId} | Delete Collection |
| AIVectorDatabaseApi | get_vector_collection | GET /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId} | Get Collection Details |
| AIVectorDatabaseApi | list_vector_collections | GET /api/v3/organizations/{organisation}/ai/vector-db/collections | List Vector Database Collections |
| AIVectorDatabaseApi | query_vector_collection | POST /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/query | Semantic Search Query |
| AIVectorDatabaseApi | upload_vector_documents | POST /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/documents | Upload Documents to Collection |
| ApplicationsApi | create_application | POST /api/v3/organizations/{organisation}/applications | Create a new application |
| ApplicationsApi | delete_application | DELETE /api/v3/organizations/{organisation}/applications/{application} | Delete an application |
| ApplicationsApi | get_application | GET /api/v3/organizations/{organisation}/applications/{application} | Get a single application |
| ApplicationsApi | get_ecr_login_credentials | GET /api/v3/organizations/{organisation}/applications/ecr-login | Get ECR login credentials |
| ApplicationsApi | list_applications | GET /api/v3/organizations/{organisation}/applications | Get all applications for an organisation |
| BackupManagementApi | create_backup | POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type} | Create a backup for an environment |
| BackupManagementApi | delete_backup | DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}/{backupId} | Delete a backup |
| BackupManagementApi | download_backup | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}/{backupId}/download | Generate a download URL for a backup |
| BackupManagementApi | list_backups | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type} | List backups for an environment |
| CommandsApi | create_command | POST /api/v3/organizations/{organisation}/environments/{environment}/commands | Create a command for an environment |
| CommandsApi | get_command | GET /api/v3/organizations/{organisation}/environments/{environment}/commands/{command} | Get a command |
| CommandsApi | list_commands | GET /api/v3/organizations/{organisation}/environments/{environment}/commands | Get all commands for an environment |
| ComposeApi | get_environment_compose | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose | Get the compose file for an environment |
| ComposeApi | patch_environment_compose | PATCH /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose | Partially Update Environment Compose Definition |
| ComposeApi | validate_compose | POST /api/v3/organizations/{organisation}/compose/validate | Validate a compose file |
| ContainersApi | list_containers | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers | Get the containers in an environment |
| ContainersApi | update_container | PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers/{container} | Update a container in an environment |
| CrawlerSchedulesApi | crawler_schedules_add | POST /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules | Add a new schedule |
| CrawlerSchedulesApi | crawler_schedules_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule} | Delete a schedule |
| CrawlerSchedulesApi | crawler_schedules_edit | PATCH /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule} | Edit a schedule |
| CrawlerSchedulesApi | crawler_schedules_list | GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules | List schedules for a crawler |
| CrawlerSchedulesApi | crawler_schedules_show | GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule} | Show a specific schedule |
| CrawlersApi | crawlers_create | POST /api/v2/organizations/{organization}/projects/{project}/crawlers | Create a new crawler |
| CrawlersApi | crawlers_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler} | Delete a crawler |
| CrawlersApi | crawlers_get_run_by_id | GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/runs/{run_id} | Get a run by ID |
| CrawlersApi | crawlers_get_runs | GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/runs | Get all runs for a crawler |
| CrawlersApi | crawlers_list | GET /api/v2/organizations/{organization}/projects/{project}/crawlers | List crawlers for the project |
| CrawlersApi | crawlers_read | GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler} | Get details of a single crawler |
| CrawlersApi | crawlers_run | POST /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/run | Run a crawler |
| CrawlersApi | crawlers_update | PATCH /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler} | Update a crawler |
| CronApi | create_cron_job | POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron | Create a new cron job |
| CronApi | delete_cron_job | DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron} | Delete a cron job |
| CronApi | get_cron_job | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron} | Get a cron job |
| CronApi | get_cron_run | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron}/runs/{run} | Get a cron run |
| CronApi | list_cron_job_runs | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron}/runs | Get all runs for a cron job |
| CronApi | list_cron_jobs | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron | Get all cron jobs for an environment |
| CronApi | update_cron_job | PATCH /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron} | Update a cron job |
| DomainsApi | domains_create | POST /api/v2/organizations/{organization}/projects/{project}/domains | Add a new domain |
| DomainsApi | domains_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/domains/{domain} | Delete a domain |
| DomainsApi | domains_list | GET /api/v2/organizations/{organization}/projects/{project}/domains | List all domains for a project |
| DomainsApi | domains_read | GET /api/v2/organizations/{organization}/projects/{project}/domains/{domain} | Get details of a single domain |
| DomainsApi | domains_renew | POST /api/v2/organizations/{organization}/projects/{project}/domains/{domain}/renew | Renew the SSL certificate for a domain |
| EnvironmentsApi | create_environment | POST /api/v3/organizations/{organisation}/applications/{application}/environments | Create a new environment |
| EnvironmentsApi | delete_environment | DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment} | Delete an environment |
| EnvironmentsApi | get_environment | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment} | Get a single environment |
| EnvironmentsApi | get_environment_logs | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/logs | Get the logs for an environment |
| EnvironmentsApi | get_environment_metrics | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/metrics | Get the metrics for an environment |
| EnvironmentsApi | list_environments | GET /api/v3/organizations/{organisation}/applications/{application}/environments | Get all environments for an application |
| EnvironmentsApi | list_sync_operations | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/sync/{type} | List the sync operations for an environment |
| EnvironmentsApi | sync_to_environment | POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/sync/{type} | Perform a sync operation from a source environment to the current environment |
| EnvironmentsApi | update_environment | PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment} | Update Environment Compose Definition |
| EnvironmentsApi | update_environment_state | PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/state | Update the state of an environment |
| HeadersApi | headers_create | POST /api/v2/organizations/{organization}/projects/{project}/custom-headers | Create or update custom headers |
| HeadersApi | headers_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/custom-headers | Delete custom headers |
| HeadersApi | headers_list | GET /api/v2/organizations/{organization}/projects/{project}/custom-headers | List custom headers for a project |
| KVApi | k_v_create | POST /api/v2/organizations/{organization}/projects/{project}/kv | Add a kv store |
| KVApi | k_v_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id} | Delete a kv store |
| KVApi | k_v_items_create | POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items | Add an item to a kv store |
| KVApi | k_v_items_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key} | Delete an item from a kv store |
| KVApi | k_v_items_list | GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items | List items in a kv store |
| KVApi | k_v_items_show | GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key} | Get an item from a kv store |
| KVApi | k_v_items_update | PUT /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key} | Update an item in a kv store |
| KVApi | k_v_list | GET /api/v2/organizations/{organization}/projects/{project}/kv | List key-value stores |
| KVApi | k_v_show | GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id} | Get a kv store |
| OrganizationsApi | organizations_list | GET /api/v2/organizations | Retrieve all organizations |
| OrganizationsApi | organizations_read | GET /api/v2/organizations/{organization} | Get details of a single organization |
| ProjectsApi | projects_create | POST /api/v2/organizations/{organization}/projects | Create a new project |
| ProjectsApi | projects_delete | DELETE /api/v2/organizations/{organization}/projects/{project} | Delete a project |
| ProjectsApi | projects_list | GET /api/v2/organizations/{organization}/projects | Retrieve all projects for an organization |
| ProjectsApi | projects_read | GET /api/v2/organizations/{organization}/projects/{project} | Get details of a single project |
| ProjectsApi | projects_update | PATCH /api/v2/organizations/{organization}/projects/{project} | Update a project |
| PurgeApi | purge_create | POST /api/v2/organizations/{organization}/projects/{project}/purge | Purge cache via URL or cache keys |
| RulesApi | rules_auth_create | POST /api/v2/organizations/{organization}/projects/{project}/rules/auth | Create an authentication rule |
| RulesApi | rules_auth_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule} | Delete an authentication rule |
| RulesApi | rules_auth_list | GET /api/v2/organizations/{organization}/projects/{project}/rules/auth | List authentication rules |
| RulesApi | rules_auth_read | GET /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule} | Get details of an authentication rule |
| RulesApi | rules_auth_update | PATCH /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule} | Update an authentication rule |
| RulesApi | rules_bot_challenge_create | POST /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge | Create a bot challenge rule |
| RulesApi | rules_bot_challenge_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule} | Delete a bot challenge rule |
| RulesApi | rules_bot_challenge_list | GET /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge | List bot challenge rules |
| RulesApi | rules_bot_challenge_read | GET /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule} | Get details of a bot challenge rule |
| RulesApi | rules_bot_challenge_update | PATCH /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule} | Update a bot challenge rule |
| RulesApi | rules_content_filter_create | POST /api/v2/organizations/{organization}/projects/{project}/rules/content-filter | Create a content filter rule |
| RulesApi | rules_content_filter_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule} | Delete a content filter rule |
| RulesApi | rules_content_filter_list | GET /api/v2/organizations/{organization}/projects/{project}/rules/content-filter | List content filter rules |
| RulesApi | rules_content_filter_read | GET /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule} | Get details of a content filter rule |
| RulesApi | rules_content_filter_update | PATCH /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule} | Update a content filter rule |
| RulesApi | rules_custom_response_create | POST /api/v2/organizations/{organization}/projects/{project}/rules/custom-response | Create a custom response rule |
| RulesApi | rules_custom_response_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule} | Delete a custom response rule |
| RulesApi | rules_custom_response_list | GET /api/v2/organizations/{organization}/projects/{project}/rules/custom-response | List custom response rules |
| RulesApi | rules_custom_response_read | GET /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule} | Get details of a custom response rule |
| RulesApi | rules_custom_response_update | PATCH /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule} | Update a custom response rule |
| RulesApi | rules_function_create | POST /api/v2/organizations/{organization}/projects/{project}/rules/function | Create an edge function rule |
| RulesApi | rules_function_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule} | Delete an edge function rule |
| RulesApi | rules_function_list | GET /api/v2/organizations/{organization}/projects/{project}/rules/function | List edge function rules |
| RulesApi | rules_function_read | GET /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule} | Get details of an edge function rule |
| RulesApi | rules_function_update | PATCH /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule} | Update an edge function rule |
| RulesApi | rules_headers_create | POST /api/v2/organizations/{organization}/projects/{project}/rules/headers | Create a header rule |
| RulesApi | rules_headers_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule} | Delete a header rule |
| RulesApi | rules_headers_list | GET /api/v2/organizations/{organization}/projects/{project}/rules/headers | List header rules |
| RulesApi | rules_headers_read | GET /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule} | Get details of a header rule |
| RulesApi | rules_headers_update | PATCH /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule} | Update a header rule |
| RulesApi | rules_proxy_create | POST /api/v2/organizations/{organization}/projects/{project}/rules/proxy | Create a proxy rule |
| RulesApi | rules_proxy_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule} | Delete a proxy rule |
| RulesApi | rules_proxy_list | GET /api/v2/organizations/{organization}/projects/{project}/rules/proxy | List proxy rules |
| RulesApi | rules_proxy_read | GET /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule} | Get details of a proxy rule |
| RulesApi | rules_proxy_update | PATCH /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule} | Update a proxy rule |
| RulesApi | rules_redirect_create | POST /api/v2/organizations/{organization}/projects/{project}/rules/redirect | Create a redirect rule |
| RulesApi | rules_redirect_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule} | Delete a redirect rule |
| RulesApi | rules_redirect_list | GET /api/v2/organizations/{organization}/projects/{project}/rules/redirect | List redirect rules |
| RulesApi | rules_redirect_read | GET /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule} | Get details of a redirect rule |
| RulesApi | rules_redirect_update | PATCH /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule} | Update a redirect rule |
| RulesApi | rules_serve_static_create | POST /api/v2/organizations/{organization}/projects/{project}/rules/serve-static | Create a serve static rule |
| RulesApi | rules_serve_static_delete | DELETE /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule} | Delete a serve static rule |
| RulesApi | rules_serve_static_list | GET /api/v2/organizations/{organization}/projects/{project}/rules/serve-static | List serve static rules |
| RulesApi | rules_serve_static_read | GET /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule} | Get details of a serve static rule |
| RulesApi | rules_serve_static_update | PATCH /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule} | Update a serve static rule |
| SSHAccessApi | get_ssh_access_credentials | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/ssh-access | Get SSH access credentials for an environment |
| ScalingPolicyApi | delete_scaling_policy | DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/scaling-policies/{policyName} | Delete the scaling policy for an environment |
| ScalingPolicyApi | get_scaling_policies | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/scaling-policies | Get the scaling policies for an environment |
| ScalingPolicyApi | update_scaling_policy | PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/scaling-policies | Update the scaling policy for an environment |
| VariablesApi | bulk_set_environment_variables | PUT /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables | Bulk set/replace environment variables |
| VariablesApi | delete_environment_variable | DELETE /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables/{api_variable} | Delete a variable |
| VariablesApi | list_environment_variables | GET /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables | Get all variables for an environment |
| VariablesApi | update_environment_variable | PUT /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables/{api_variable} | Update a variable |
| VolumesApi | create_volume | POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes | Create a new volume |
| VolumesApi | delete_volume | DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes/{volume} | Delete a volume |
| VolumesApi | get_volume | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes/{volume} | Get a volume |
| VolumesApi | list_volumes | GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes | Get all volumes for an environment |
- Application
- ApplicationDatabase
- ApplicationDeploymentInformationInner
- ApplicationEnvironmentsInner
- ApplicationFilesystem
- ApplicationImageReference
- BulkSetEnvironmentVariablesRequest
- BulkSetEnvironmentVariablesRequestEnvironmentInner
- ChatInference200Response
- ChatInference200ResponseResponse
- ChatInference200ResponseResponseToolUse
- ChatInference200ResponseResponseToolUseOneOf
- ChatInference200ResponseResponseToolUseOneOf1Inner
- ChatInference200ResponseResponseToolUseOneOfResult
- ChatInference200ResponseUsage
- ChatInferenceRequest
- ChatInferenceRequestMessagesInner
- ChatInferenceRequestMessagesInnerContent
- ChatInferenceRequestMessagesInnerContentOneOfInner
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf1
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf1Image
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf1ImageSource
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf2
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf2Video
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf2VideoSource
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf3
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf3Document
- ChatInferenceRequestMessagesInnerContentOneOfInnerOneOf3DocumentSource
- ChatInferenceRequestResponseFormat
- ChatInferenceRequestToolConfig
- ChatInferenceRequestToolConfigToolsInner
- ChatInferenceRequestToolConfigToolsInnerToolSpec
- ChatInferenceRequestToolConfigToolsInnerToolSpecInputSchema
- ChatInferenceStreamRequest
- ChatInferenceStreamRequestMessagesInner
- ChatInferenceStreamRequestMessagesInnerContent
- ChatWithAIAgent200Response
- ChatWithAIAgent200ResponseResponse
- ChatWithAIAgent200ResponseResponseUsage
- ChatWithAIAgentRequest
- Command
- Compose
- Container
- ContainerDependsOnInner
- ContainerEnvironmentInner
- ContainerHealthCheck
- ContainerImageReference
- ContainerMountPointsInner
- ContainerOriginProtectionConfig
- ContainerSecretsInner
- CrawlersRun200Response
- CrawlersRunRequest
- CreateAIAgent201Response
- CreateAIAgentRequest
- CreateAISession201Response
- CreateAISessionRequest
- CreateAISessionRequestInitialMessagesInner
- CreateApplication403Response
- CreateApplicationRequest
- CreateApplicationRequestDatabase
- CreateApplicationRequestEnvironmentInner
- CreateApplicationRequestFilesystem
- CreateBackup202Response
- CreateBackupRequest
- CreateCommandRequest
- CreateCronJobRequest
- CreateCustomTool201Response
- CreateCustomToolRequest
- CreateEnvironment403Response
- CreateEnvironmentRequest
- CreateEnvironmentRequestEnvironmentInner
- CreateVectorCollection201Response
- CreateVectorCollection201ResponseCollection
- CreateVectorCollectionRequest
- CreateVolumeRequest
- Cron
- CronRun
- DeleteAIAgent200Response
- DeleteAISession200Response
- DeleteBackup200Response
- DeleteCustomTool200Response
- DeleteVectorCollection200Response
- DownloadBackup200Response
- Embeddings200Response
- Embeddings200ResponseEmbeddings
- Embeddings200ResponseUsage
- EmbeddingsRequest
- EmbeddingsRequestInput
- Environment
- EnvironmentResponse
- EnvironmentSummary
- ExtendAISession200Response
- ExtendAISessionRequest
- GetAIAgent200Response
- GetAIAgent200ResponseAgent
- GetAIModel200Response
- GetAIModel200ResponseCapabilities
- GetAIModel200ResponsePricing
- GetAIModel404Response
- GetAISession200Response
- GetAIToolExecutionStatus200Response
- GetAIToolExecutionStatus200ResponseResult
- GetAIToolExecutionStatus404Response
- GetAIUsageStats200Response
- GetAIUsageStats200ResponseByModelValue
- GetEcrLoginCredentials200Response
- GetEnvironmentLogs200Response
- GetEnvironmentLogs200ResponseLogEventsInner
- GetSshAccessCredentials200Response
- GetSshAccessCredentials200ResponseCredentials
- GetVectorCollection200Response
- GetVectorCollection200ResponseCollection
- ImageGeneration200Response
- ImageGenerationRequest
- ImageGenerationRequestBackgroundRemovalParams
- ImageGenerationRequestColorGuidedGenerationParams
- ImageGenerationRequestImageGenerationConfig
- ImageGenerationRequestImageVariationParams
- ImageGenerationRequestInPaintingParams
- ImageGenerationRequestOutPaintingParams
- ImageGenerationRequestTextToImageParams
- KVItemsCreate200Response
- KVItemsDelete200Response
- KVItemsShow200Response
- KVItemsShow200ResponseValue
- ListAIAgents200Response
- ListAIAgents200ResponseAgentsInner
- ListAIModels200Response
- ListAIModels200ResponseModelsInner
- ListAIModels200ResponseModelsInnerCapabilities
- ListAISessions200ResponseInner
- ListAIToolExecutions200Response
- ListAIToolExecutions200ResponseExecutionsInner
- ListAIToolNames200Response
- ListAITools200Response
- ListAITools200ResponseToolsInner
- ListAITools200ResponseToolsInnerToolSpec
- ListAITools200ResponseToolsInnerToolSpecInputSchema
- ListBackups200Response
- ListBackups200ResponseBackupsInner
- ListBackups422Response
- ListCustomTools200Response
- ListCustomTools200ResponseToolsInner
- ListVectorCollections200Response
- ListVectorCollections200ResponseCollectionsInner
- OrganizationsList200ResponseInner
- PatchEnvironmentCompose202Response
- PatchEnvironmentCompose202ResponseSpotConfiguration
- PatchEnvironmentCompose400Response
- PatchEnvironmentComposeRequest
- PatchEnvironmentComposeRequestSpotConfiguration
- PurgeCreateRequest
- QueryVectorCollection200Response
- QueryVectorCollection200ResponseResultsInner
- QueryVectorCollection200ResponseResultsInnerMetadata
- QueryVectorCollectionRequest
- ScalingPolicy
- SpotConfiguration
- SyncOperation
- SyncToEnvironmentRequest
- UpdateAIAgent200Response
- UpdateAIAgentRequest
- UpdateAISession200Response
- UpdateAISessionRequest
- UpdateAISessionRequestNewMessagesInner
- UpdateCronJobRequest
- UpdateEnvironmentRequest
- UpdateEnvironmentStateRequest
- UpdateEnvironmentVariableRequest
- UploadVectorDocuments200Response
- UploadVectorDocumentsRequest
- UploadVectorDocumentsRequestDocumentsInner
- UploadVectorDocumentsRequestDocumentsInnerMetadata
- V1ContentItem
- V1ContentListResponse
- V1ContentRequest
- V1DeleteResponse
- V1Error
- V1FormSubmissionItem
- V1FormSubmissionListResponse
- V1GetMetricSeriesResponse
- V1GetMetricSeriesResponseData
- V1GetMetricsResponse
- V1GetMetricsResponseData
- V1GlobalMetaResponse
- V1GlobalMetaResponseGlobalMeta
- V1Info
- V1Meta
- V1MetricDayStats
- V1MetricMinuteStats
- V1MetricMonthStats
- V1PingResponse
- V1ProxyItem
- V1ProxyListResponse
- V1RedirectItem
- V1RedirectListResponse
- V1RedirectRequest
- V1RedirectResponse
- V1Revision
- V1RevisionsResponse
- V1SearchHit
- V1SearchItemsResponse
- V1SearchMutationResponse
- V1SearchRecord
- V1SearchResponse
- V1SeriesPointDay
- V1SeriesPointMonth
- V1Transition
- V1UploadResponse
- V1UrlMetaRequest
- V1UrlMetaResponse
- V1WafLogItem
- V1WafLogListResponse
- V2Crawler
- V2CrawlerAssets
- V2CrawlerAssetsNetworkIntercept
- V2CrawlerAssetsParser
- V2CrawlerRequest
- V2CrawlerRun
- V2CrawlerSchedule
- V2CrawlerScheduleRequest
- V2CrawlerSitemapInner
- V2CustomHeaderRequest
- V2Domain
- V2DomainDnsGoLiveRecordsInner
- V2DomainDnsValidationRecordsInner
- V2DomainRequest
- V2Error
- V2Organization
- V2OrganizationRequest
- V2Project
- V2ProjectRequest
- V2Rule
- V2RuleAuth
- V2RuleAuthAction
- V2RuleAuthRequest
- V2RuleBotChallenge
- V2RuleBotChallengeAction
- V2RuleBotChallengeRequest
- V2RuleContentFilter
- V2RuleContentFilterAction
- V2RuleContentFilterRequest
- V2RuleCustomResponse
- V2RuleCustomResponseAction
- V2RuleCustomResponseRequest
- V2RuleFunction
- V2RuleFunctionAction
- V2RuleFunctionRequest
- V2RuleHeader
- V2RuleHeaderAction
- V2RuleHeaderRequest
- V2RuleProxy
- V2RuleProxyAction
- V2RuleProxyActionNotifyConfig
- V2RuleProxyActionQuantCloudSelection
- V2RuleProxyRequest
- V2RuleRedirect
- V2RuleRedirectAction
- V2RuleRedirectRequest
- V2RuleRequest
- V2RuleServeStatic
- V2RuleServeStaticAction
- V2RuleServeStaticRequest
- V2SecretStore
- V2SecretStoreRequest
- V2Store
- V2StoreItem
- V2StoreItemRequest
- V2StoreItemUpdateRequest
- V2StoreItemsListResponse
- V2StoreRequest
- ValidateCompose200Response
- ValidateCompose422Response
- ValidateComposeRequest
- Variable
- Volume
- WafConfig
- WafConfigBlockLists
- WafConfigHttpbl
- WafConfigThresholdsInner
Authentication schemes defined for the API:
- Type: Bearer authentication (JWT)