Registry /
http-networking / qovery-typescript-axios
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
Configuration
✓ import { Configuration } from 'qovery-typescript-axios';
✗ const Configuration = require('qovery-typescript-axios').Configuration;
The `Configuration` class is used to set up the base path, authentication (e.g., bearer token), and other client-wide settings. It is typically instantiated once. CommonJS require syntax might not work correctly if the package is primarily ESM.
ApplicationsApi
✓ import { ApplicationsApi } from 'qovery-typescript-axios';
✗ import ApplicationsApi from 'qovery-typescript-axios'; // Incorrect default import
const ApplicationsApi = require('qovery-typescript-axios').ApplicationsApi;
Generated OpenAPI clients typically expose API services as named exports (e.g., `ApplicationsApi`, `OrganizationApi`). Direct default imports are usually incorrect.
Application
✓ import { Application } from 'qovery-typescript-axios';
Type definitions for API models (like `Application`, `Environment`, etc.) are also named exports, available for type-checking and autocompletion in TypeScript projects.
This quickstart demonstrates how to configure the Qovery client with an API token and fetch a list of applications. It shows the basic setup for authentication and making an API call, including error handling.
import { Configuration, ApplicationsApi } from 'qovery-typescript-axios';
const API_TOKEN = process.env.QOVERY_API_TOKEN ?? 'YOUR_QOVERY_API_TOKEN';
if (!API_TOKEN || API_TOKEN === 'YOUR_QOVERY_API_TOKEN') {
console.error('Please set the QOVERY_API_TOKEN environment variable or replace the placeholder.');
process.exit(1);
}
const configuration = new Configuration({
basePath: 'https://api.qovery.com',
accessToken: API_TOKEN,
});
const applicationsApi = new ApplicationsApi(configuration);
async function listMyApplications() {
try {
// Assuming a method like 'listApplication' exists and takes optional parameters.
// The actual method name and parameters depend on the Qovery OpenAPI spec.
const response = await applicationsApi.listApplication(
'organization_id_example',
'project_id_example',
'environment_id_example',
0, // offset
10 // limit
);
console.log('Successfully fetched applications:', response.data);
} catch (error) {
if (error.isAxiosError) {
console.error('API Error:', error.response?.data || error.message);
} else {
console.error('An unexpected error occurred:', error);
}
}
}
listMyApplications();
Debug
Known issues
breakingThe README provided (v1.0.4) is significantly older than the current package version (v1.1.864). Breaking changes are highly probable between these versions due to updates in the underlying Qovery API specification, which directly drives the client generation. Always consult the official Qovery API documentation and the client's changelog on GitHub for specific breaking changes relevant to your version.fixReview your API calls against the latest Qovery API documentation and update your client instantiation and method calls as necessary. Be prepared for changes in method signatures, response structures, or required parameters.
affects: >=1.1.0
gotchaAuthentication is crucial for most API interactions. This client uses a `Configuration` object to pass the `accessToken`. Failing to provide a valid token will result in unauthorized (401) or forbidden (403) errors.fixEnsure you initialize the `Configuration` object with a valid `accessToken` (e.g., a Bearer token) obtained from Qovery. Verify the token's validity and permissions for the requested operations.
affects: >=1.0.0
breakingA supply chain attack was reported for the underlying `axios` library, affecting versions `1.14.1` and `0.30.4`. While these specific versions of `axios` were removed from npm, it's critical to ensure your `package-lock.json` or `yarn.lock` does not contain these malicious versions if your project's `qovery-typescript-axios` dependency resolves to them.fixAudit your `package-lock.json` or `yarn.lock` files to confirm that your `axios` dependency is not `1.14.1` or `0.30.4`. Run `npm audit` or `yarn audit` regularly. If affected, remove `node_modules`, clear cache, and reinstall dependencies after updating `axios` to a safe version.
affects: N/A (dependency specific)
Errors
Common errors & fixes
TypeError: Cannot read properties of undefined (reading 'someMethod')
The API client (e.g., `applicationsApi`) was not correctly initialized with a `Configuration` object, or the API method called does not exist.
fixEnsure `new ApplicationsApi(configuration)` is called with a properly instantiated `Configuration` object. Double-check the method name against the API documentation.
AxiosError: Request failed with status code 401 Unauthorized
The API request was made without proper authentication, or the provided access token is invalid or expired.
fixVerify that your `Configuration` object's `accessToken` is correctly set with a valid Qovery API token. Ensure the token has the necessary scopes/permissions for the API endpoint being accessed. Renew the token if expired.
Module not found: Can't resolve 'qovery-typescript-axios'
The package is not installed or the import path is incorrect. This can also happen due to CommonJS/ESM module incompatibility in certain bundler configurations.
fixRun `npm install qovery-typescript-axios`. If using CommonJS, try `const { Symbol } = require('qovery-typescript-axios');` but prefer ESM imports where possible. Ensure your bundler is configured to handle both module types if mixing. Audit
Dependencies
axiosrequiredThis client library is generated to use Axios as its underlying HTTP client for making API requests.