Create an organization annotations group

Create an organization annotations group

POST /organization/{organizationId}/annotationsGroups

Create an organization annotations group

cURL

curl --request POST \
  --url https://api.qovery.com/organization/{organizationId}/annotationsGroups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "annotations": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "scopes": []
}
'

import requests

url = "https://api.qovery.com/organization/{organizationId}/annotationsGroups"

payload = {
    "name": "<string>",
    "annotations": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "scopes": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    annotations: [{key: '<string>', value: '<string>'}],
    scopes: []
  })
};

fetch('https://api.qovery.com/organization/{organizationId}/annotationsGroups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/organization/{organizationId}/annotationsGroups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'annotations' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'scopes' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/organization/{organizationId}/annotationsGroups"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"annotations\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"scopes\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.qovery.com/organization/{organizationId}/annotationsGroups")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"annotations\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"scopes\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/organization/{organizationId}/annotationsGroups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"annotations\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"scopes\": []\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "annotations": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "scopes": [],
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

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 ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

organizationId · string<uuid> · required

Organization ID

Body

application/json

name · string · required

name of the annotations group

annotations · object[] · required

Show child attributes

scopes · enum<string>[] · required

Annotations Group Scope

Available options: DEPLOYMENTS, STATEFUL_SETS, SERVICES, INGRESS, GATEWAY_API_ROUTES, HPA, PODS, SECRETS, JOBS, CRON_JOBS

Response

201

application/json

Organization annotations group created

id · string<uuid> · required · read-only

created_at · string<date-time> · required · read-only

name · string · required

annotations · object[] · required

Show child attributes

scopes · enum<string>[] · required

Annotations Group Scope

Available options: DEPLOYMENTS, STATEFUL_SETS, SERVICES, INGRESS, GATEWAY_API_ROUTES, HPA, PODS, SECRETS, JOBS, CRON_JOBS

updated_at · string<date-time> · read-only