Developers

Create API Key

Creates a new API key for an application.

The key value is returned exactly once, in this response. Later reads expose the key’s metadata (name, expiry, status) but never the secret again. Store it in your secret manager the moment you receive it; if it is lost, the only remedy is to create a new key.

Rotation. Set an expiry even for long-lived keys, and rotate before it lands: create the new key, deploy it, then let the old one expire. A rotation then never needs a window where no valid key exists.

POST

apps

{app_id}

api-keys

Create API Key

curl --request POST \
  --url https://public-api.gateway.connexease.com/api/v1/apps/{app_id}/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "prod-backend",
  "expiresAt": "2027-08-20T13:27:30.368Z"
}
'

import requests

url = "https://public-api.gateway.connexease.com/api/v1/apps/{app_id}/api-keys"

payload = {
    "name": "prod-backend",
    "expiresAt": "2027-08-20T13:27:30.368Z"
}
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: 'prod-backend', expiresAt: '2027-08-20T13:27:30.368Z'})
};

fetch('https://public-api.gateway.connexease.com/api/v1/apps/{app_id}/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://public-api.gateway.connexease.com/api/v1/apps/{app_id}/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' => 'prod-backend',
    'expiresAt' => '2027-08-20T13:27:30.368Z'
  ]),
  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://public-api.gateway.connexease.com/api/v1/apps/{app_id}/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"prod-backend\",\n  \"expiresAt\": \"2027-08-20T13:27:30.368Z\"\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://public-api.gateway.connexease.com/api/v1/apps/{app_id}/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"prod-backend\",\n  \"expiresAt\": \"2027-08-20T13:27:30.368Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.gateway.connexease.com/api/v1/apps/{app_id}/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\": \"prod-backend\",\n  \"expiresAt\": \"2027-08-20T13:27:30.368Z\"\n}"

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

{
  "data": {
    "id": "47fee6cf-9634-47b2-882f-4e9b90e57158",
    "appId": "app_7poyXj8GXuv76e",
    "name": "prod-backend",
    "key": "<secret_key>",
    "isActive": true,
    "expiresAt": "2027-08-20T13:27:30.368000Z",
    "createdAt": "2026-08-20T13:33:15.985914Z"
  },
  "isSuccess": true
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

Authorizations

Authorization

string

header

required

Secret key in Bearer sk_... format. Server-to-server only — never embed it in a browser or mobile client. The organization is resolved from the key, so organization_id is never passed explicitly.

Path Parameters

app_id

string

required

Application ID. Must belong to the organization resolved from your secret key, otherwise the request returns 404 with APPLICATION_004.

Example:

"app_7poyXj8GXuv76e"

Body

application/json

name

string

required

A label for the key. Use something that identifies where it is deployed (prod-backend, ci-pipeline) — it is how you will recognise the key later, since the value itself is not visible.

expiresAt

string<date-time>

ISO-8601 timestamp at which the key stops working. Must be in the future.

Response

The created key, including its one-time value.

data

object

Show child attributes

isSuccess

enum<boolean>

Available options:

true

Create API Key

curl --request POST \
  --url https://public-api.gateway.connexease.com/api/v1/apps/{app_id}/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "prod-backend",
  "expiresAt": "2027-08-20T13:27:30.368Z"
}
'

import requests

url = "https://public-api.gateway.connexease.com/api/v1/apps/{app_id}/api-keys"

payload = {
    "name": "prod-backend",
    "expiresAt": "2027-08-20T13:27:30.368Z"
}
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: 'prod-backend', expiresAt: '2027-08-20T13:27:30.368Z'})
};

fetch('https://public-api.gateway.connexease.com/api/v1/apps/{app_id}/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://public-api.gateway.connexease.com/api/v1/apps/{app_id}/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' => 'prod-backend',
    'expiresAt' => '2027-08-20T13:27:30.368Z'
  ]),
  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://public-api.gateway.connexease.com/api/v1/apps/{app_id}/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"prod-backend\",\n  \"expiresAt\": \"2027-08-20T13:27:30.368Z\"\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://public-api.gateway.connexease.com/api/v1/apps/{app_id}/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"prod-backend\",\n  \"expiresAt\": \"2027-08-20T13:27:30.368Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.gateway.connexease.com/api/v1/apps/{app_id}/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\": \"prod-backend\",\n  \"expiresAt\": \"2027-08-20T13:27:30.368Z\"\n}"

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

{
  "data": {
    "id": "47fee6cf-9634-47b2-882f-4e9b90e57158",
    "appId": "app_7poyXj8GXuv76e",
    "name": "prod-backend",
    "key": "<secret_key>",
    "isActive": true,
    "expiresAt": "2027-08-20T13:27:30.368000Z",
    "createdAt": "2026-08-20T13:33:15.985914Z"
  },
  "isSuccess": true
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

{
  "isSuccess": false,
  "errors": {
    "code": "META_075",
    "group": "VALIDATION",
    "description": "Template with 0000000000 not found in Meta.",
    "params": {},
    "fields": {}
  }
}

Getting Started

Sandbox Public API

Analytics

Application

Template

Media

Developers

Reference

Create API Key

Authorizations

Path Parameters

Body

Response