Create API key

curl --request POST \
  --url https://{tenant}.cubecloud.dev/api/v1/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "allowedEndpoints": [
    "<string>"
  ],
  "deploymentIds": [
    123
  ],
  "ttlHours": 2
}
'

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/api-keys"

payload = {
    "name": "<string>",
    "allowedEndpoints": ["<string>"],
    "deploymentIds": [123],
    "ttlHours": 2
}
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>',
    allowedEndpoints: ['<string>'],
    deploymentIds: [123],
    ttlHours: 2
  })
};

fetch('https://{tenant}.cubecloud.dev/api/v1/api-keys', 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://{tenant}.cubecloud.dev/api/v1/api-keys",
  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>',
    'allowedEndpoints' => [
        '<string>'
    ],
    'deploymentIds' => [
        123
    ],
    'ttlHours' => 2
  ]),
  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://{tenant}.cubecloud.dev/api/v1/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"allowedEndpoints\": [\n    \"<string>\"\n  ],\n  \"deploymentIds\": [\n    123\n  ],\n  \"ttlHours\": 2\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://{tenant}.cubecloud.dev/api/v1/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"allowedEndpoints\": [\n    \"<string>\"\n  ],\n  \"deploymentIds\": [\n    123\n  ],\n  \"ttlHours\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/api-keys")

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  \"allowedEndpoints\": [\n    \"<string>\"\n  ],\n  \"deploymentIds\": [\n    123\n  ],\n  \"ttlHours\": 2\n}"

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

{
  "createdAt": "2023-12-25",
  "id": 123,
  "name": "<string>",
  "token": "<string>",
  "updatedAt": "2023-12-25",
  "userId": 123,
  "allowedEndpoints": [
    "<string>"
  ],
  "deploymentIds": [
    123
  ],
  "expiresAt": "2023-12-25",
  "lastUsedAt": "2023-12-25",
  "suffix": "<string>"
}

POST

api

api-keys

Create API key

curl --request POST \
  --url https://{tenant}.cubecloud.dev/api/v1/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "allowedEndpoints": [
    "<string>"
  ],
  "deploymentIds": [
    123
  ],
  "ttlHours": 2
}
'

import requests

url = "https://{tenant}.cubecloud.dev/api/v1/api-keys"

payload = {
    "name": "<string>",
    "allowedEndpoints": ["<string>"],
    "deploymentIds": [123],
    "ttlHours": 2
}
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>',
    allowedEndpoints: ['<string>'],
    deploymentIds: [123],
    ttlHours: 2
  })
};

fetch('https://{tenant}.cubecloud.dev/api/v1/api-keys', 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://{tenant}.cubecloud.dev/api/v1/api-keys",
  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>',
    'allowedEndpoints' => [
        '<string>'
    ],
    'deploymentIds' => [
        123
    ],
    'ttlHours' => 2
  ]),
  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://{tenant}.cubecloud.dev/api/v1/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"allowedEndpoints\": [\n    \"<string>\"\n  ],\n  \"deploymentIds\": [\n    123\n  ],\n  \"ttlHours\": 2\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://{tenant}.cubecloud.dev/api/v1/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"allowedEndpoints\": [\n    \"<string>\"\n  ],\n  \"deploymentIds\": [\n    123\n  ],\n  \"ttlHours\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.cubecloud.dev/api/v1/api-keys")

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  \"allowedEndpoints\": [\n    \"<string>\"\n  ],\n  \"deploymentIds\": [\n    123\n  ],\n  \"ttlHours\": 2\n}"

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

{
  "createdAt": "2023-12-25",
  "id": 123,
  "name": "<string>",
  "token": "<string>",
  "updatedAt": "2023-12-25",
  "userId": 123,
  "allowedEndpoints": [
    "<string>"
  ],
  "deploymentIds": [
    123
  ],
  "expiresAt": "2023-12-25",
  "lastUsedAt": "2023-12-25",
  "suffix": "<string>"
}

Authorizations

Authorization

string

header

required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Body

application/json

CreateApiKeyInput

name

string

required

allowedEndpoints

string[] | null

deploymentIds

integer[] | null

ttlHours

integer | null

Required range: x >= 1

Response

200 - application/json

createdAt

required

integer

required

name

string

required

token

string

required

updatedAt

required

userId

integer

required

allowedEndpoints

string[] | null

deploymentIds

integer[] | null

expiresAt

lastUsedAt

suffix

string | null

Getting Started

Core Data Endpoints

AI Endpoints

Platform Endpoints

Create API key

Authorizations

Body

Response