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 Annotations Group API

The Organization Annotations Group API from Qovery — 3 operation(s) for organization annotations group.

Qovery Organization Annotations Group 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 Annotations Group. 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 6 operations across 3 paths, and defines 9 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.

6 operations 3 paths 9 schemas 1 DELETE3 GET1 POST1 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 Annotations Group 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 6

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

Organization Annotations Group 6
GET
/organization/{organizationId}/annotationsGroups
List organization annotations group
listOrganizationAnnotationsGroup 1 param → 200401403404
POST
/organization/{organizationId}/annotationsGroups
Create an organization annotations group
createOrganizationAnnotationsGroup 1 param body → 201400401403
GET
/organization/{organizationId}/annotationsGroups/{annotationsGroupId}
Get organization annotations group
getOrganizationAnnotationsGroup 2 params → 200401403404
PUT
/organization/{organizationId}/annotationsGroups/{annotationsGroupId}
Edit organization annotations group
editOrganizationAnnotationsGroup 2 params body → 200401403404
DELETE
/organization/{organizationId}/annotationsGroups/{annotationsGroupId}
Delete organization annotations group
deleteOrganizationAnnotationsGroup 2 params → 204401403404
GET
/organization/{organizationId}/annotationsGroups/{annotationsGroupId}/associatedItems
Get organization annotations group associated items
getOrganizationAnnotationsGroupAssociatedItems 2 params → 200401403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are OrganizationAnnotationsGroupCreateRequest (3 properties), Base (3 properties), Annotation (2 properties), OrganizationAnnotationsGroupAssociatedItemsResponseList (1 property). Each schema is shown below with its type and property counts.

OrganizationAnnotationsGroupEnrichedResponse
Annotation
object
2 properties 2 required
AnnotationsGroupAssociatedItemType
string
Annotations Group Associated Item Type
OrganizationAnnotationsGroupResponse
OrganizationAnnotationsGroupScopeEnum
string
Annotations Group Scope
OrganizationAnnotationsGroupAssociatedItemsResponseList
object
1 property
Base
object
3 properties 2 required
OrganizationAnnotationsGroupEnrichedResponseList
array
OrganizationAnnotationsGroupCreateRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-organization-annotations-group-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