Search by

quantcdn / quant-php-client

steveworley

Unified API for QuantCDN Admin and QuantCloud Platform services

Package info

github.com/quantcdn/quant-php-client

Homepage

pkg:composer/quantcdn/quant-php-client

Statistics

Installs: 5

Dependents: 0

Suggesters: 0

Stars: 1

Open Issues: 2


README

Unified API for QuantCDN Admin and QuantCloud Platform services

Rate limits

  • Per token. Each API token has a limit per organisation: by default 240 requests per minute. The limit counts after the token is validated, so tokens that share an IP address (for example Quant Cloud apps and CI runners) do not share a limit. An organisation can have a different limit (set per organisation or by subscription plan); contact Quant support to change it.
  • Unauthenticated requests. Requests that end without a valid token (no token, an invalid or expired token, public routes) have a coarse limit per client IP address: by default 600 requests per minute. A request with a valid token never counts against it and is never refused by it. A request with a valid token that is refused before the per-token limit runs (for example an organisation the token cannot use) still counts against the token.
  • KV per project. Some KV operations also have a limit per project, shared by every token: kv-admin 10 requests per minute (index create, delete and resume; upgrade; export create and resume; ledger declare, raise and drop), kv-erase 30 (ledger subject preview and shred), kv-verify 6 (ledger verify).
  • Responses. Over a limit the answer is 429 with a Retry-After header (seconds). KV routes answer the V2KvError body with code RATE_LIMITED and retryable true; other routes answer {"message": "Too Many Attempts."}. Rate-limited routes send RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset (IETF draft; Reset is seconds until the window resets) and X-RateLimit-Limit and X-RateLimit-Remaining on the responses of requests that reach a limiter, and X-RateLimit-Reset (Unix time) on a 429. A request refused before a limiter runs (for example a 401, 403 or 404 from an earlier check) can come back without these headers. When two limits apply, the headers describe the one with fewer requests left. Wait Retry-After seconds, then send the request again.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/quantcdn/quant-php-client.git"
    }
  ],
  "require": {
    "quantcdn/quant-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/quant-client/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\AIApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organisation = 'organisation_example'; // string
$month = 'month_example'; // string | YYYY-MM, defaults to current month
$group_by = 'model'; // string
$include = 'include_example'; // string | Set to 'daily' to append a 30-day series
$user_id = 'user_id_example'; // string | Scope the daily series to a user
$token_id = 'token_id_example'; // string | Scope the daily series to a token

try {
    $apiInstance->getAIUsageStats($organisation, $month, $group_by, $include, $user_id, $token_id);
} catch (Exception $e) {
    echo 'Exception when calling AIApi->getAIUsageStats: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://dashboard.quantcdn.io

Class Method HTTP request Description
AIApi getAIUsageStats GET /api/v3/organizations/{organisation}/ai/usage Organisation AI usage breakdown (subscription page parity)
AIAgentsApi chatWithAIAgent POST /api/v3/organizations/{organisation}/ai/agents/{agentId}/chat Chat with AI Agent
AIAgentsApi createAIAgent POST /api/v3/organizations/{organisation}/ai/agents Create AI Agent
AIAgentsApi deleteAIAgent DELETE /api/v3/organizations/{organisation}/ai/agents/{agentId} Delete Agent
AIAgentsApi deleteAgentOverlay DELETE /api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay Delete Agent Overlay
AIAgentsApi getAIAgent GET /api/v3/organizations/{organisation}/ai/agents/{agentId} Get Agent Details
AIAgentsApi getAgentOverlay GET /api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay Get Agent Overlay
AIAgentsApi listAIAgents GET /api/v3/organizations/{organisation}/ai/agents List AI Agents
AIAgentsApi updateAIAgent PUT /api/v3/organizations/{organisation}/ai/agents/{agentId} Update Agent
AIAgentsApi upsertAgentOverlay PUT /api/v3/organizations/{organisation}/ai/agents/{agentId}/overlay Upsert Agent Overlay
AICustomToolsApi createCustomTool POST /api/v3/organizations/{organisation}/ai/custom-tools Register Custom Edge Function Tool
AICustomToolsApi deleteCustomTool DELETE /api/v3/organizations/{organisation}/ai/custom-tools/{toolName} Delete Custom Tool
AICustomToolsApi getCustomTool GET /api/v3/organizations/{organisation}/ai/custom-tools/{toolName} Get Custom Tool
AICustomToolsApi listCustomTools GET /api/v3/organizations/{organisation}/ai/custom-tools List Custom Tools
AIFileStorageApi deleteFile DELETE /api/v3/organizations/{organisation}/ai/files/{fileId} Delete File
AIFileStorageApi getFile GET /api/v3/organizations/{organisation}/ai/files/{fileId} Get File
AIFileStorageApi listFiles GET /api/v3/organizations/{organisation}/ai/files List Files
AIFileStorageApi uploadFile POST /api/v3/organizations/{organisation}/ai/files Upload File to object storage
AIFilterPoliciesApi createFilterPolicy POST /api/v3/organizations/{organisation}/ai/filter-policies Create an AI filter policy for an organisation
AIFilterPoliciesApi deleteFilterPolicy DELETE /api/v3/organizations/{organisation}/ai/filter-policies/{policyId} Delete a specific AI filter policy
AIFilterPoliciesApi disableFilterPolicy PUT /api/v3/organizations/{organisation}/ai/filter-policies/{policyId}/disable Disable a specific AI filter policy
AIFilterPoliciesApi enableFilterPolicy PUT /api/v3/organizations/{organisation}/ai/filter-policies/{policyId}/enable Enable a specific AI filter policy
AIFilterPoliciesApi getFilterPolicy GET /api/v3/organizations/{organisation}/ai/filter-policies/{policyId} Get a specific AI filter policy
AIFilterPoliciesApi listFilterPolicies GET /api/v3/organizations/{organisation}/ai/filter-policies List AI filter policies for an organisation
AIFilterPoliciesApi updateFilterPolicy PUT /api/v3/organizations/{organisation}/ai/filter-policies/{policyId} Update a specific AI filter policy
AIGovernanceApi getGovernanceConfig GET /api/v3/organizations/{organisation}/ai/governance Get AI governance configuration for an organisation
AIGovernanceApi getGovernanceSpend GET /api/v3/organizations/{organisation}/ai/governance/spend Get AI spend summary for an organisation
AIGovernanceApi updateGovernanceConfig PUT /api/v3/organizations/{organisation}/ai/governance Update AI governance configuration for an organisation
AIInferenceApi chatInference POST /api/v3/organizations/{organisation}/ai/chat Chat inference via API Gateway (buffered responses) with multimodal support
AIInferenceApi chatInferenceStream 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 getDurableExecutionStatus GET /api/v3/organizations/{organisation}/ai/chat/executions/{identifier} Get Durable Execution Status
AIInferenceApi submitToolCallback POST /api/v3/organizations/{organisation}/ai/chat/callback Submit Client Tool Results (Callback)
AIModelsApi getAIModel GET /api/v3/organizations/{organisation}/ai/models/{modelId} Get AI Model Details
AIModelsApi listAIModels GET /api/v3/organizations/{organisation}/ai/models List available AI models for an organization
AIOrchestrationsApi cancelOrchestration POST /api/v3/organizations/{organisation}/ai/orchestrations/{orchestrationId}/cancel Cancel Durable Orchestration
AIOrchestrationsApi createOrchestration POST /api/v3/organizations/{organisation}/ai/orchestrations Create Durable Orchestration
AIOrchestrationsApi deleteOrchestration DELETE /api/v3/organizations/{organisation}/ai/orchestrations/{orchestrationId} Delete Durable Orchestration
AIOrchestrationsApi getOrchestration GET /api/v3/organizations/{organisation}/ai/orchestrations/{orchestrationId} Get Durable Orchestration
AIOrchestrationsApi listOrchestrationBatches GET /api/v3/organizations/{organisation}/ai/orchestrations/{orchestrationId}/batches List Orchestration Batches
AIOrchestrationsApi listOrchestrations GET /api/v3/organizations/{organisation}/ai/orchestrations List Durable Orchestrations
AIOrchestrationsApi pauseOrchestration POST /api/v3/organizations/{organisation}/ai/orchestrations/{orchestrationId}/pause Pause Durable Orchestration
AIOrchestrationsApi resumeOrchestration POST /api/v3/organizations/{organisation}/ai/orchestrations/{orchestrationId}/resume Resume Durable Orchestration
AIOrchestrationsApi startOrchestration POST /api/v3/organizations/{organisation}/ai/orchestrations/{orchestrationId}/start Start Durable Orchestration
AISearchApi aiSearchChat POST /api/v3/organisations/{organisation}/projects/{project}/ai-search/chat RAG chat with AI Search content
AISearchApi aiSearchDeletePages DELETE /api/v3/organisations/{organisation}/projects/{project}/ai-search/pages Delete pages by URLs or patterns
AISearchApi aiSearchDisable POST /api/v3/organisations/{organisation}/projects/{project}/ai-search/disable Disable AI Search for a project
AISearchApi aiSearchEnable POST /api/v3/organisations/{organisation}/projects/{project}/ai-search/enable Enable AI Search for a project
AISearchApi aiSearchGetCrawl GET /api/v3/organisations/{organisation}/projects/{project}/ai-search/crawls/{jobId} Get AI Search ingest job status
AISearchApi aiSearchGetCrawlPages GET /api/v3/organisations/{organisation}/projects/{project}/ai-search/crawls/{jobId}/pages Get per-page ingest results for a crawl job
AISearchApi aiSearchGetSettings GET /api/v3/organisations/{organisation}/projects/{project}/ai-search/settings Get AI Search public access and rate limit settings
AISearchApi aiSearchIngestPages POST /api/v3/organisations/{organisation}/projects/{project}/ai-search/pages Ingest pages into the AI Search index
AISearchApi aiSearchListCrawls GET /api/v3/organisations/{organisation}/projects/{project}/ai-search/crawls List AI Search ingest jobs
AISearchApi aiSearchListPages GET /api/v3/organisations/{organisation}/projects/{project}/ai-search/pages List indexed pages with cursor pagination
AISearchApi aiSearchPurgeIndex DELETE /api/v3/organisations/{organisation}/projects/{project}/ai-search/index Purge the entire AI Search index
AISearchApi aiSearchSearch POST /api/v3/organisations/{organisation}/projects/{project}/ai-search/search Semantic search across the AI Search index
AISearchApi aiSearchStatus GET /api/v3/organisations/{organisation}/projects/{project}/ai-search Get AI Search status for a project
AISearchApi aiSearchTopQueries GET /api/v3/organisations/{organisation}/projects/{project}/ai-search/top-queries Get the most popular AI Search queries
AISearchApi aiSearchTriggerCrawl POST /api/v3/organisations/{organisation}/projects/{project}/ai-search/crawls Trigger a crawler run that ingests into AI Search
AISearchApi aiSearchUpdateSettings PUT /api/v3/organisations/{organisation}/projects/{project}/ai-search/settings Update AI Search public access and rate limit settings
AISearchApi aiSearchUsage GET /api/v3/organisations/{organisation}/projects/{project}/ai-search/usage Get usage statistics for the AI Search site
AISessionsApi createAISession POST /api/v3/organizations/{organisation}/ai/sessions Create a new chat session with multi-tenant isolation
AISessionsApi deleteAISession DELETE /api/v3/organizations/{organisation}/ai/sessions/{sessionId} Delete a chat session
AISessionsApi extendAISession PUT /api/v3/organizations/{organisation}/ai/sessions/{sessionId}/extend Extend Session Expiration
AISessionsApi getAISession GET /api/v3/organizations/{organisation}/ai/sessions/{sessionId} Get a specific chat session
AISessionsApi listAISessions GET /api/v3/organizations/{organisation}/ai/sessions List chat sessions with multi-tenant filtering
AISessionsApi updateAISession PUT /api/v3/organizations/{organisation}/ai/sessions/{sessionId} Update Session
AISkillsApi createSkill POST /api/v3/organizations/{organisation}/ai/skills Create Inline Skill
AISkillsApi deleteSkill DELETE /api/v3/organizations/{organisation}/ai/skills/{skillId} Delete Skill
AISkillsApi deleteSkillCollection DELETE /api/v3/organizations/{organisation}/ai/skills/collections/{namespace} Delete Skill Collection
AISkillsApi getSkill GET /api/v3/organizations/{organisation}/ai/skills/{skillId} Get Skill Details
AISkillsApi importSkill POST /api/v3/organizations/{organisation}/ai/skills/import Import Skill from External Source
AISkillsApi importSkillCollection POST /api/v3/organizations/{organisation}/ai/skills/import-collection Import Skill Collection from GitHub
AISkillsApi listSkillCollections GET /api/v3/organizations/{organisation}/ai/skills/collections List Skill Collections
AISkillsApi listSkills GET /api/v3/organizations/{organisation}/ai/skills List Organization's Skills
AISkillsApi syncSkill POST /api/v3/organizations/{organisation}/ai/skills/{skillId}/sync Sync Skill from Source
AISkillsApi syncSkillCollection POST /api/v3/organizations/{organisation}/ai/skills/collections/{namespace}/sync Sync Skill Collection
AISkillsApi updateSkill PUT /api/v3/organizations/{organisation}/ai/skills/{skillId} Update Skill
AISlackBotsApi createSlackBot POST /api/v3/organizations/{organisation}/ai/slack-bots Create Slack Bot
AISlackBotsApi deleteSlackBot DELETE /api/v3/organizations/{organisation}/ai/slack-bots/{botId} Delete Slack Bot
AISlackBotsApi getSlackBot GET /api/v3/organizations/{organisation}/ai/slack-bots/{botId} Get Slack Bot
AISlackBotsApi getSlackBotThread GET /api/v3/organizations/{organisation}/ai/slack-bots/{botId}/threads/{channel}/{threadTs} Read a thread
AISlackBotsApi listSlackBotChannelMessages GET /api/v3/organizations/{organisation}/ai/slack-bots/{botId}/channels/{channel}/messages Read recent channel messages
AISlackBotsApi listSlackBots GET /api/v3/organizations/{organisation}/ai/slack-bots List Slack Bots
AISlackBotsApi listSlackBotsApiEnabled GET /api/v3/organizations/{organisation}/ai/slack-bots/api-enabled List API-enabled Slack bots
AISlackBotsApi postSlackBotMessage POST /api/v3/organizations/{organisation}/ai/slack-bots/{botId}/messages Post a message as the bot
AISlackBotsApi searchSlackWorkspaceChannels GET /api/v3/organizations/{organisation}/ai/slack-bots/{botId}/workspace/channels Search Slack Workspace Channels
AISlackBotsApi searchSlackWorkspaceUsers GET /api/v3/organizations/{organisation}/ai/slack-bots/{botId}/workspace/users Search Slack Workspace Users
AISlackBotsApi updateSlackBot PUT /api/v3/organizations/{organisation}/ai/slack-bots/{botId} Update Slack Bot
AITaskManagementApi createTask POST /api/v3/organizations/{organisation}/ai/tasks Create a new task
AITaskManagementApi deleteTask DELETE /api/v3/organizations/{organisation}/ai/tasks/{taskId} Delete a task
AITaskManagementApi getDependencyGraph GET /api/v3/organizations/{organisation}/ai/tasks/{taskListId}/dependency-graph Get dependency graph for a task list
AITaskManagementApi getTask GET /api/v3/organizations/{organisation}/ai/tasks/{taskId} Get task details
AITaskManagementApi listTasks GET /api/v3/organizations/{organisation}/ai/tasks List tasks with optional filtering
AITaskManagementApi updateTask PUT /api/v3/organizations/{organisation}/ai/tasks/{taskId} Update a task
AIToolApprovalApi decideToolProposal POST /api/v3/organizations/{organisation}/ai/tool-proposals/{proposalId}/decision Decide a tool approval proposal
AIToolApprovalApi getToolProposal GET /api/v3/organizations/{organisation}/ai/tool-proposals/{proposalId} Get a tool approval proposal
AIToolsApi getAIOrchestrationStatus GET /api/v3/organizations/{organisation}/ai/tools/orchestrations/{orchestrationId} Get Tool Orchestration Status (Async Tool Polling)
AIToolsApi getAIToolExecutionStatus GET /api/v3/organizations/{organisation}/ai/tools/executions/{executionId} Get async tool execution status and result
AIToolsApi listAIToolExecutions GET /api/v3/organizations/{organisation}/ai/tools/executions List tool executions for monitoring and debugging
AIToolsApi listAIToolNames GET /api/v3/organizations/{organisation}/ai/tools/names List tool names only (lightweight response)
AIToolsApi listAITools GET /api/v3/organizations/{organisation}/ai/tools List available built-in tools for function calling
AIToolsApi listMcpServers GET /api/v3/organizations/{organisation}/ai/mcp-servers List MCP servers with gateway URLs
AIUsageApi getMyUsage GET /api/v3/organizations/{organisation}/ai/usage/me Get AI usage summary for the authenticated user
AIVectorDatabaseApi createVectorCollection POST /api/v3/organizations/{organisation}/ai/vector-db/collections Create Vector Database Collection
AIVectorDatabaseApi deleteVectorCollection DELETE /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId} Delete Collection
AIVectorDatabaseApi deleteVectorDocuments DELETE /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/documents Delete Documents from Collection
AIVectorDatabaseApi getVectorCollection GET /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId} Get Collection Details
AIVectorDatabaseApi listVectorCollections GET /api/v3/organizations/{organisation}/ai/vector-db/collections List Vector Database Collections
AIVectorDatabaseApi listVectorDocuments GET /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/documents List Documents in Collection
AIVectorDatabaseApi queryVectorCollection POST /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/query Semantic Search Query
AIVectorDatabaseApi uploadVectorDocuments POST /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/documents Upload Documents to Collection
ApplicationsApi createApplication POST /api/v3/organizations/{organisation}/applications Create a new application
ApplicationsApi deleteApplication DELETE /api/v3/organizations/{organisation}/applications/{application} Delete an application
ApplicationsApi getApplication GET /api/v3/organizations/{organisation}/applications/{application} Get a single application
ApplicationsApi getEcrLoginCredentials GET /api/v3/organizations/{organisation}/applications/ecr-login Get container registry login credentials
ApplicationsApi listApplications GET /api/v3/organizations/{organisation}/applications Get all applications for an organisation
ApplicationsApi patchApplicationMetadata PATCH /api/v3/organizations/{organisation}/applications/{application}/metadata Merge-patch application metadata
ApplicationsApi putApplicationMetadata PUT /api/v3/organizations/{organisation}/applications/{application}/metadata Replace application metadata
BackupManagementApi createBackup POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type} Create a backup for an environment
BackupManagementApi deleteBackup DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}/{backupId} Delete a backup
BackupManagementApi downloadBackup GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}/{backupId}/download Generate a download URL for a backup
BackupManagementApi listBackups GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type} List backups for an environment
CDNMetricsApi getDailyMetrics GET /v2/organizations/{organization}/projects/{project}/metrics/daily Get daily metrics
CDNMetricsApi getHourlyMetrics GET /v2/organizations/{organization}/projects/{project}/metrics/hourly Get hourly metrics
CDNMetricsApi getMonthlyMetrics GET /v2/organizations/{organization}/projects/{project}/metrics/monthly Get monthly metrics
CommandsApi createCommand POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/commands Create a command for an environment
CommandsApi getCommand GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/commands/{command} Get a command
CommandsApi listCommands GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/commands Get all commands for an environment
ComposeApi getEnvironmentCompose GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose Get the compose file for an environment
ComposeApi patchEnvironmentCompose PATCH /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose Partially Update Environment Compose Definition
ComposeApi validateCompose POST /api/v3/organizations/{organisation}/compose/validate Validate a compose file
ContainersApi listContainers GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers Get the containers in an environment
ContainersApi updateContainer PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers/{container} Update a container in an environment
CrawlerSchedulesApi crawlerSchedulesAdd POST /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules Add a new schedule
CrawlerSchedulesApi crawlerSchedulesDelete DELETE /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule} Delete a schedule
CrawlerSchedulesApi crawlerSchedulesEdit PATCH /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule} Edit a schedule
CrawlerSchedulesApi crawlerSchedulesList GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules List schedules for a crawler
CrawlerSchedulesApi crawlerSchedulesShow GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule} Show a specific schedule
CrawlersApi crawlersCreate POST /api/v2/organizations/{organization}/projects/{project}/crawlers Create a new crawler
CrawlersApi crawlersDelete DELETE /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler} Delete a crawler
CrawlersApi crawlersGetRunById GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/runs/{run_id} Get a run by ID
CrawlersApi crawlersGetRuns GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/runs Get all runs for a crawler
CrawlersApi crawlersList GET /api/v2/organizations/{organization}/projects/{project}/crawlers List crawlers for the project
CrawlersApi crawlersRead GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler} Get details of a single crawler
CrawlersApi crawlersRun POST /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/run Run a crawler
CrawlersApi crawlersUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler} Update a crawler
CronApi createCronJob POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron Create a new cron job
CronApi deleteCronJob DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron} Delete a cron job
CronApi getCronJob GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron} Get a cron job
CronApi getCronRun GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron}/runs/{run} Get a cron run
CronApi listCronJobRuns GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron}/runs Get all runs for a cron job
CronApi listCronJobs GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron Get all cron jobs for an environment
CronApi updateCronJob PATCH /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron} Update a cron job
DomainsApi dNSCreateRecord POST /api/v2/organizations/{organization}/dns/zones/{zoneId}/records Create an A record
DomainsApi dNSListRecords GET /api/v2/organizations/{organization}/dns/zones/{zoneId}/records List DNS records
DomainsApi dNSListZones GET /api/v2/organizations/{organization}/dns/zones List organization DNS zones
DomainsApi dNSShowZone GET /api/v2/organizations/{organization}/dns/zones/{zoneId} Get a DNS zone
DomainsApi domainsCreate POST /api/v2/organizations/{organization}/projects/{project}/domains Add a new domain
DomainsApi domainsDelete DELETE /api/v2/organizations/{organization}/projects/{project}/domains/{domain} Delete a domain
DomainsApi domainsList GET /api/v2/organizations/{organization}/projects/{project}/domains List all domains for a project
DomainsApi domainsRead GET /api/v2/organizations/{organization}/projects/{project}/domains/{domain} Get details of a single domain
DomainsApi domainsRenew POST /api/v2/organizations/{organization}/projects/{project}/domains/{domain}/renew Renew the SSL certificate for a domain
EnvironmentsApi createEnvironment POST /api/v3/organizations/{organisation}/applications/{application}/environments Create a new environment
EnvironmentsApi deleteEnvironment DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment} Delete an environment
EnvironmentsApi getEnvironment GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment} Get a single environment
EnvironmentsApi getEnvironmentLogs GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/logs Get the logs for an environment
EnvironmentsApi getEnvironmentMetrics GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/metrics Get the metrics for an environment
EnvironmentsApi getEnvironmentSlowQueries GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/slow-queries Get MySQL slow queries for an environment
EnvironmentsApi listEnvironments GET /api/v3/organizations/{organisation}/applications/{application}/environments Get all environments for an application
EnvironmentsApi listSyncOperations GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/sync/{type} List the sync operations for an environment
EnvironmentsApi syncToEnvironment POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/sync/{type} Perform a sync operation from a source environment to the current environment
EnvironmentsApi updateEnvironment PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment} Update Environment Compose Definition
EnvironmentsApi updateEnvironmentState PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/state Update the state of an environment
HeadersApi headersCreate POST /api/v2/organizations/{organization}/projects/{project}/custom-headers Create or update custom headers
HeadersApi headersDelete DELETE /api/v2/organizations/{organization}/projects/{project}/custom-headers Delete custom headers
HeadersApi headersList GET /api/v2/organizations/{organization}/projects/{project}/custom-headers List custom headers for a project
IdleSleepApi getIdleSleep GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/idle-sleep Get Idle Sleep Setting
IdleSleepApi setIdleSleep PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/idle-sleep Set Idle Sleep Setting
KVApi kVArchivesList GET /api/v2/organizations/{organization}/kv/archives List retained ledger archives
KVApi kVArchivesPurge POST /api/v2/organizations/{organization}/kv/archives/{store_name}/purge Dry run or start a purge of a retained archive
KVApi kVArchivesPurgeManifest GET /api/v2/organizations/{organization}/kv/archives/{store_name}/purges/{purge_id}/manifest Get the manifest of a purge
KVApi kVArchivesPurgeReceipt GET /api/v2/organizations/{organization}/kv/archives/{store_name}/purges/{purge_id}/receipt Get the signed receipt of a purge
KVApi kVArchivesPurgeShow GET /api/v2/organizations/{organization}/kv/archives/{store_name}/purges/{purge_id} Show one purge of an archive
KVApi kVArchivesShow GET /api/v2/organizations/{organization}/kv/archives/{store_name} Show the archive of a deleted store
KVApi kVCreate POST /api/v2/organizations/{organization}/projects/{project}/kv Add a kv store
KVApi kVDelete DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id} Delete a kv store
KVApi kVEntriesDelete DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}/entry Delete a key, optionally only at a version
KVApi kVEntriesPut PUT /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}/entry Set a key, optionally only if absent or only at a version
KVApi kVEntriesShow GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}/entry Get a key with its version and metadata
KVApi kVExportCreate POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/export Start an export of the whole store to gzip JSON Lines files
KVApi kVExportResume POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/export/resume Queue a stalled export step again
KVApi kVExportShow GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/export Get the latest export and, when done, its download links
KVApi kVIndexesCount GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/indexes/{index_name}/count Count the keys that hold a value of a count index
KVApi kVIndexesCreate POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/indexes Declare an index
KVApi kVIndexesDelete DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/indexes/{index_name} Drop an index
KVApi kVIndexesList GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/indexes List the declared indexes of a store
KVApi kVIndexesLookup GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/indexes/{index_name}/lookup Get the key that holds a value of a unique index
KVApi kVIndexesResume POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/indexes/{index_name}/resume Queue a stalled index job step again
KVApi kVIndexesShow GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/indexes/{index_name} Get one index with its state and job
KVApi kVItemsBatchGet POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/batch-get Get up to 100 keys in one request
KVApi kVItemsCreate POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items Add an item to a kv store
KVApi kVItemsDelete DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key} Delete an item from a kv store
KVApi kVItemsIncrement POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}/increment Atomically add to a numeric value
KVApi kVItemsList GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items List items in a kv store
KVApi kVItemsPatch PATCH /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key} Update an item in a kv store (PATCH alias of PUT)
KVApi kVItemsPurge DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items Delete items in bulk by prefix and/or age
KVApi kVItemsShow GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key} Get an item from a kv store
KVApi kVItemsTransact POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/transact Run 1 to 25 operations as one transaction
KVApi kVItemsUpdate PUT /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key} Update an item in a kv store
KVApi kVKeysList GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/keys List keys with a cursor: by collection, prefix, filter, index or ledger time window
KVApi kVLedgersAppend POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/append Append an entry to a ledger
KVApi kVLedgersArchive GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/archive Get download links for the ledger archive, digests and anchor files
KVApi kVLedgersCreate POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers Declare a ledger
KVApi kVLedgersDelete DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name} Drop a ledger
KVApi kVLedgersList GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers List the ledgers of a store
KVApi kVLedgersProof GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/proof Get the inclusion proof of one ledger entry
KVApi kVLedgersPublicKey GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/public-key Get the public key that verifies ledger signatures
KVApi kVLedgersShow GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name} Get a ledger definition with its retention end and last verify
KVApi kVLedgersShred POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/shred Shred a data subject (cannot be undone)
KVApi kVLedgersShredsEntries GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/shreds/{shred_id}/entries List the shred entries of an erasure record
KVApi kVLedgersShredsList GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/shreds List the erasure records of a ledger
KVApi kVLedgersShredsReceipt GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/shreds/{shred_id}/receipt Get the signed receipt of a shred
KVApi kVLedgersStatus GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/status Get the chains, archive lag, digest, anchor and verify state of a ledger
KVApi kVLedgersSubjectEntries POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/subject-entries List the ledger entries of one data subject
KVApi kVLedgersSubjectPreview POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/subject-preview Preview a shred of a data subject
KVApi kVLedgersUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name} Raise a ledger
KVApi kVLedgersVerificationsReport GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/verifications/{verification_id}/report Get the signed report of one verification run
KVApi kVLedgersVerify POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/ledgers/{ledger_name}/verify Verify a ledger against its archive and signed digests
KVApi kVLinkToProject POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/link Link a KV store to another project
KVApi kVList GET /api/v2/organizations/{organization}/projects/{project}/kv List key-value stores
KVApi kVShow GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id} Get a kv store
KVApi kVUnlinkFromProject DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/link Unlink a KV store from this project
KVApi kVUpgradeCreate POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/upgrade Start, roll back, finalize or resume a format 1 to format 2 upgrade
KVApi kVUpgradeShow GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/upgrade Get the store format and the latest upgrade
KVApi kVUsageShow GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/usage Get 30-day usage and a cost estimate
OpenAICompatibilityApi oaiChatCompletions POST /oai/v1/chat/completions Create a chat completion (OpenAI-compatible)
OpenAICompatibilityApi oaiEmbeddings POST /oai/v1/embeddings Create embeddings (OpenAI-compatible)
OpenAICompatibilityApi oaiGetModel GET /oai/v1/models/{model} Retrieve a model (OpenAI-compatible)
OpenAICompatibilityApi oaiListModels GET /oai/v1/models List available models (OpenAI-compatible)
OrganizationsApi organizationsList GET /api/v2/organizations Retrieve all organizations
OrganizationsApi organizationsRead GET /api/v2/organizations/{organization} Get details of a single organization
ProjectsApi getProjectLogs GET /api/v2/organizations/{organization}/projects/{project}/logs Get CDN access logs for a project
ProjectsApi projectsCreate POST /api/v2/organizations/{organization}/projects Create a new project
ProjectsApi projectsDelete DELETE /api/v2/organizations/{organization}/projects/{project} Delete a project
ProjectsApi projectsList GET /api/v2/organizations/{organization}/projects Retrieve all projects for an organization
ProjectsApi projectsRead GET /api/v2/organizations/{organization}/projects/{project} Get details of a single project
ProjectsApi projectsUpdate PATCH /api/v2/organizations/{organization}/projects/{project} Update a project
PurgeApi purgeCreate POST /api/v2/organizations/{organization}/projects/{project}/purge Purge cache via URL or cache keys
ResourcesApi attachOrgResource POST /api/v3/organizations/{organisation}/resources/{resource}/attachments Attach a resource to an application environment
ResourcesApi createOrgResource POST /api/v3/organizations/{organisation}/resources Create a shared resource
ResourcesApi deleteOrgResource DELETE /api/v3/organizations/{organisation}/resources/{resource} Delete a shared resource
ResourcesApi detachOrgResource DELETE /api/v3/organizations/{organisation}/resources/{resource}/attachments/{application}/{environment} Detach a resource from an application environment
ResourcesApi getOrgResource GET /api/v3/organizations/{organisation}/resources/{resource} Get a shared resource and its attachments
ResourcesApi getOrgResourceCredentials GET /api/v3/organizations/{organisation}/resources/{resource}/credentials Get a cache's administrative credential
ResourcesApi listOrgResources GET /api/v3/organizations/{organisation}/resources List an organisation's shared resources
ResourcesApi purgeOrgResource POST /api/v3/organizations/{organisation}/resources/{resource}/purge Purge keys from a cache
RestoreManagementApi getRestoreStatus GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/restores/{restoreId} Get the status of a restore operation
RestoreManagementApi restoreDatabase POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{backupId}/restore-database Restore a database backup to a target environment
RestoreManagementApi restoreFilesystem POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{backupId}/restore-filesystem Restore a filesystem backup to a target environment
RulesApi rulesAuthCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/auth Create an authentication rule
RulesApi rulesAuthDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule} Delete an authentication rule
RulesApi rulesAuthFunctionCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/auth-function Create an auth function rule
RulesApi rulesAuthFunctionDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/auth-function/{rule} Delete an auth function rule
RulesApi rulesAuthFunctionList GET /api/v2/organizations/{organization}/projects/{project}/rules/auth-function List auth function rules
RulesApi rulesAuthFunctionRead GET /api/v2/organizations/{organization}/projects/{project}/rules/auth-function/{rule} Get details of an auth function rule
RulesApi rulesAuthFunctionUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/auth-function/{rule} Update an auth function rule
RulesApi rulesAuthList GET /api/v2/organizations/{organization}/projects/{project}/rules/auth List authentication rules
RulesApi rulesAuthRead GET /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule} Get details of an authentication rule
RulesApi rulesAuthUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule} Update an authentication rule
RulesApi rulesBotChallengeCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge Create a bot challenge rule
RulesApi rulesBotChallengeDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule} Delete a bot challenge rule
RulesApi rulesBotChallengeList GET /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge List bot challenge rules
RulesApi rulesBotChallengeRead GET /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule} Get details of a bot challenge rule
RulesApi rulesBotChallengeUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule} Update a bot challenge rule
RulesApi rulesContentFilterCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/content-filter Create a content filter rule
RulesApi rulesContentFilterDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule} Delete a content filter rule
RulesApi rulesContentFilterList GET /api/v2/organizations/{organization}/projects/{project}/rules/content-filter List content filter rules
RulesApi rulesContentFilterRead GET /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule} Get details of a content filter rule
RulesApi rulesContentFilterUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule} Update a content filter rule
RulesApi rulesCustomResponseCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/custom-response Create a custom response rule
RulesApi rulesCustomResponseDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule} Delete a custom response rule
RulesApi rulesCustomResponseList GET /api/v2/organizations/{organization}/projects/{project}/rules/custom-response List custom response rules
RulesApi rulesCustomResponseRead GET /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule} Get details of a custom response rule
RulesApi rulesCustomResponseUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule} Update a custom response rule
RulesApi rulesErrorPageCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/error-page Create a custom error page rule
RulesApi rulesErrorPageDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/error-page/{rule} Delete a custom error page rule
RulesApi rulesErrorPageList GET /api/v2/organizations/{organization}/projects/{project}/rules/error-page List custom error page rules
RulesApi rulesErrorPageRead GET /api/v2/organizations/{organization}/projects/{project}/rules/error-page/{rule} Get details of a custom error page rule
RulesApi rulesErrorPageUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/error-page/{rule} Update a custom error page rule
RulesApi rulesFunctionCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/function Create an edge function rule
RulesApi rulesFunctionDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule} Delete an edge function rule
RulesApi rulesFunctionList GET /api/v2/organizations/{organization}/projects/{project}/rules/function List edge function rules
RulesApi rulesFunctionRead GET /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule} Get details of an edge function rule
RulesApi rulesFunctionUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule} Update an edge function rule
RulesApi rulesHeadersCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/headers Create a header rule
RulesApi rulesHeadersDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule} Delete a header rule
RulesApi rulesHeadersList GET /api/v2/organizations/{organization}/projects/{project}/rules/headers List header rules
RulesApi rulesHeadersRead GET /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule} Get details of a header rule
RulesApi rulesHeadersUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule} Update a header rule
RulesApi rulesProxyCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/proxy Create a proxy rule
RulesApi rulesProxyDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule} Delete a proxy rule
RulesApi rulesProxyList GET /api/v2/organizations/{organization}/projects/{project}/rules/proxy List proxy rules
RulesApi rulesProxyRead GET /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule} Get details of a proxy rule
RulesApi rulesProxyUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule} Update a proxy rule
RulesApi rulesRedirectCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/redirect Create a redirect rule
RulesApi rulesRedirectDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule} Delete a redirect rule
RulesApi rulesRedirectList GET /api/v2/organizations/{organization}/projects/{project}/rules/redirect List redirect rules
RulesApi rulesRedirectRead GET /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule} Get details of a redirect rule
RulesApi rulesRedirectUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule} Update a redirect rule
RulesApi rulesServeStaticCreate POST /api/v2/organizations/{organization}/projects/{project}/rules/serve-static Create a serve static rule
RulesApi rulesServeStaticDelete DELETE /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule} Delete a serve static rule
RulesApi rulesServeStaticList GET /api/v2/organizations/{organization}/projects/{project}/rules/serve-static List serve static rules
RulesApi rulesServeStaticRead GET /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule} Get details of a serve static rule
RulesApi rulesServeStaticUpdate PATCH /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule} Update a serve static rule
SSHAccessApi getSshAccessCredentials GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/ssh-access Get SSH access credentials for an environment
ScalingPolicyApi deleteScalingPolicy DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/scaling-policies Delete Scaling Policy
ScalingPolicyApi listScalingPolicies GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/scaling-policies List Scaling Policies
ScalingPolicyApi upsertScalingPolicy PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/scaling-policies Upsert Scaling Policy
SubscriptionApi getSubscriptionCloudUsage GET /api/v3/organizations/{organisation}/subscription/cloud-usage Cloud-app cost breakdown for the subscription page
TokensApi tokensCreate POST /api/v2/organizations/{organization}/tokens Create a new API token scoped to this organization
TokensApi tokensDelete DELETE /api/v2/organizations/{organization}/tokens/{token_id} Revoke an API token
TokensApi tokensList GET /api/v2/organizations/{organization}/tokens List API tokens scoped to this organization
VariablesApi bulkSetEnvironmentVariables PUT /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables Bulk set/replace environment variables
VariablesApi deleteEnvironmentVariable DELETE /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables/{api_variable} Delete a variable
VariablesApi listEnvironmentVariables GET /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables Get all variables for an environment
VariablesApi updateEnvironmentVariable PUT /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables/{api_variable} Update a variable
VolumesApi createVolume POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes Create a new volume
VolumesApi deleteVolume DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes/{volume} Delete a volume
VolumesApi getVolume GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes/{volume} Get a volume
VolumesApi listVolumes GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes Get all volumes for an environment

Models

Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 4.29.0
    • Package version: 4.29.0
    • Generator version: 7.13.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen