Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Organization Enterprise Connection API

The Organization Enterprise Connection API from Qovery — 2 operation(s) for organization enterprise connection.

Qovery Organization Enterprise Connection API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organization Enterprise Connection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 3 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 1.0.4.

Requests are made against a single base URL, https://api.qovery.com.

3 operations 2 paths 2 schemas 2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.4
Base URL
https://api.qovery.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qovery Organization Enterprise Connection API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' cu…
  • ApiKeyAuth — Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -…

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Organization Enterprise Connection 3
GET
/organization/{organizationId}/enterpriseconnection
List enterprise connections
listOrganizationEnterpriseConnections 1 param → 200401403404
GET
/organization/{organizationId}/enterpriseconnection/{connectionName}
Get enterprise connection
getOrganizationEnterpriseConnection 2 params → 200401403404
PUT
/organization/{organizationId}/enterpriseconnection/{connectionName}
Update enterprise connection
updateOrganizationEnterpriseConnection 2 params body → 200401403404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are EnterpriseConnectionDto (4 properties), EnterpriseConnectionResponseList (1 property). Each schema is shown below with its type and property counts.

EnterpriseConnectionResponseList
object
1 property
EnterpriseConnectionDto
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-organization-enterprise-connection-api-openapi.yml Raw ↑

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Receivers API
Qovery Alert Rules API
Qovery Application Actions API
Qovery Application Configuration API
Qovery Application Custom Domain API
Qovery Application Deployment History API
Qovery Application Deployment Restriction API
Qovery Application Environment Variable API
Qovery Application Logs API
Qovery Application Main Calls API
Qovery Application Secret API