/apikeys/{id}

PATCH /apikeys/{id}

Update an API key

Updates an API key with the specified ID. Only account administrators can update API keys, and API keys cannot update other API keys.

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

id path string

The ID of the API key to update

Optional Parameters

Click here to view an exhaustive list of all available parameters

x-account-id header string

The account ID for the request

{
  "description": "string",
  "flatPermissionsList": [
    "string"
  ]
}

{
  "description": "string",
  "expiresAt": "string",
  "flatPermissionsList": [
    "string"
  ]
}

Try it out

Output:

Responses

Description

API key updated successfully

{
  "success": false
}

Description

ApiKey not found

{
  "error": "API key not found"
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/ApiKeyInput

#/components/parameters/xAccountIdHeader

OpenAPI
TypeScript

in: header
name: x-account-id
schema:
  type: string
description: The account ID for the request
required: false

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/ApiKeyInput

OpenAPI
TypeScript

type: object
required:
  - description
  - flatPermissionsList
properties:
  description:
    type: string
    description: Description of the API key
  expiresAt:
    type: string
    format: date-time
    nullable: true
    description: ISO date-time string when the API key expires, or null/empty for no
      expiration
  flatPermissionsList:
    type: array
    example:
      - readApplications
      - writeApplications
    items:
      type: string
    description: List of permission IDs to assign to the API key

>
export interface ApiKeyInput {
  /** Description of the API key */
  description: string;
  /** ISO date-time string when the API key expires, or null/empty for no expiration */
  expiresAt?: Date;
  /** List of permission IDs to assign to the API key */
  flatPermissionsList: string[];
}

Route Source Code

Check out the source code for this route entrypoint here: /apikeys/[id]/route.ts

Or the swagger.yaml spec this documentation was generated from: /apikeys/swagger.yaml