Create Api Key

POST/v1/api-key/create

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Request Body (JSON)

Request Body

Property	Type	Required
`name`	`string`	No
`userId`	`string`	No
`orgId`	`string`	No
`type`	`"API_KEY_TYPE_UNSPECIFIED" \| "API_KEY_TYPE_USER" \| "API_KEY_TYPE_ORG"`	No

Responses

200 Create new Everstack API key

Property	Type	Description
`apiKey`	`object`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/api-key/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","userId":"string","orgId":"string","type":"API_KEY_TYPE_UNSPECIFIED"}'

const response = await fetch("http://localhost:8089/v1/api-key/create", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "string",
  "userId": "string",
  "orgId": "string",
  "type": "API_KEY_TYPE_UNSPECIFIED"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/api-key/create",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "name": "string",
  "userId": "string",
  "orgId": "string",
  "type": "API_KEY_TYPE_UNSPECIFIED"
},
)
data = response.json()

Response

{
  "apiKey": {
    "id": "string",
    "name": "string",
    "hash": "string",
    "userId": "string",
    "orgId": "string",
    "type": "API_KEY_TYPE_UNSPECIFIED",
    "sensitiveId": "string",
    "lastUsedAt": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}