Create an API key

Create a new API key within the authenticated organization.

POST /org/api_keys

Create an API key

cURL

curl --request POST \
  --url https://api.onkernel.com/org/api_keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "staging",
  "days_to_expire": 30,
  "project_id": "proj_abc123"
}
'

import requests

url = "https://api.onkernel.com/org/api_keys"

payload = {
    "name": "staging",
    "days_to_expire": 30,
    "project_id": "proj_abc123"
}
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: 'staging', days_to_expire: 30, project_id: 'proj_abc123'})
};

fetch('https://api.onkernel.com/org/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://api.onkernel.com/org/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' => 'staging',
    'days_to_expire' => 30,
    'project_id' => 'proj_abc123'
  ]),
  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.onkernel.com/org/api_keys"

	payload := strings.NewReader("{\n  \"name\": \"staging\",\n  \"days_to_expire\": 30,\n  \"project_id\": \"proj_abc123\"\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.onkernel.com/org/api_keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"staging\",\n  \"days_to_expire\": 30,\n  \"project_id\": \"proj_abc123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/org/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\": \"staging\",\n  \"days_to_expire\": 30,\n  \"project_id\": \"proj_abc123\"\n}"

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

201

{
  "id": "ckv9w8q2f000001l5r3j7k9m4",
  "name": "production",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "user-abc123",
    "email": "[e-mail]",
    "name": "Jane Doe"
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "project_id": "proj_abc123",
  "project_name": "Production",
  "masked_key": "sk_1234...abcd",
  "key": "sk_1234abcd"
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name · string · required

API key name (1-255 characters)

Required string length: 1 - 255

Example:

"staging"

days_to_expire · integer | null

Number of days until expiry, up to 3650. Use null for never.

Required range: 1 <= x <= 3650

Example:

30

project_id · string | null

Unique project identifier

Example:

"proj_abc123"

Response

201

application/json

API key created successfully

API key returned immediately after creation. Includes the plaintext key once.

id · string · required

Unique API key identifier

Example:

"ckv9w8q2f000001l5r3j7k9m4"

name · string · required

API key name

Example:

"production"

created_at · string<date-time> · required

When the API key was created

created_by · object · required

Show child attributes

expires_at · string<date-time> | null · required

When the API key expires

project_id · string | null · required

Project identifier for project-scoped API keys. Null means org-wide.

Example:

"proj_abc123"

project_name · string | null · required

Project name for project-scoped API keys. Null means the key is org-wide or the project name is unavailable.

Example:

"Production"

masked_key · string · required

Masked version of the API key

Example:

"sk_1234...abcd"

key · string · required

Plaintext API key. Only returned once when the key is created.

Example:

"sk_1234abcd"