Update Api Key

POST/v1/api-key/update

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)

id (query)

name (query)

userId (query)

orgId (query)

type (query)

Request Body (JSON)

Parameters

Name	In	Type	Required
`id`	query	`string`	No
`name`	query	`string`	No
`userId`	query	`string`	No
`orgId`	query	`string`	No
`type`	query	`"API_KEY_TYPE_UNSPECIFIED" \| "API_KEY_TYPE_USER" \| "API_KEY_TYPE_ORG"`	No

Responses

200 Update 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/update" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/v1/api-key/update", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/api-key/update",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
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"
    }
  ]
}