SupportDashboard
Getting StartedAPI ReferenceRoadmapBlog
Getting StartedAPI ReferenceRoadmapBlog
    • Resources
    • Authentication
    • Pagination
    • Rate limiting
  • API Keys
    • GETList api keys
    • GETGet api key
    • POSTCreate api key
    • PUTUpdate api key
    • DELDelete api key
  • Environments
    • POSTCreate environment
    • PUTUpdate environment
    • DELDelete environment
  • Plans
    • The Plan object
    • GETList plans
    • GETGet plan
    • POSTCreate plan
    • PUTUpdate plan
    • DELDelete plan
    • PUTUpdate audience
    • DELDelete audience
  • Companies
    • The Company object
    • GETList companies
    • POSTUpsert company
    • GETLookup company
    • DELDelete company
    • POSTDelete company by keys
    • GETList company memberships
    • POSTGet or create company membership
    • DELDelete company membership
    • POSTUpsert company trait
  • Users
    • The User object
    • GETList users
    • GETLookup user
    • POSTUpsert user
    • DELDelete user
    • POSTDelete user by keys
    • POSTUpsert user trait
  • Events
    • The Event object
    • GETList events
    • POSTCreate event
    • POSTCreate event batch
    • GETGet event
  • Features
    • The Feature object
    • GETList features
    • GETGet feature
    • POSTCreate feature
    • PUTUpdate feature
    • DELDelete feature
  • Flags
    • The Flag object
    • GETList flags
    • GETGet flag
    • POSTCreate flag
    • PUTUpdate flag
    • DELDelete flag
    • PUTUpdate flag rules
    • POSTCheck flag
    • POSTCheck flags
  • Entitlements
    • GETList company overrides
    • GETGet company override
    • POSTCreate company override
    • PUTUpdate company override
    • DELDelete company override
    • GETList plan entitlements
    • GETGet plan entitlement
    • POSTCreate plan entitlement
    • PUTUpdate plan entitlement
    • DELDelete plan entitlement
  • Feature Usage
    • GETList feature usage
    • GETGet feature usage by company
LogoLogo
SupportDashboard
API Keys

PUT
https://api.schematichq.com/api-keys/:api_key_id
PUT
/api-keys/:api_key_id
1import { SchematicClient } from "@schematichq/schematic-typescript-node";
2
3const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4await client.accounts.updateApiKey("api_key_id");
Try it
1{
2 "data": {
3 "created_at": "2024-01-15T09:30:00Z",
4 "id": "string",
5 "name": "string",
6 "scopes": [
7 "string"
8 ],
9 "updated_at": "2024-01-15T09:30:00Z",
10 "description": "string",
11 "environment_id": "string",
12 "last_used_at": "2024-01-15T09:30:00Z"
13 },
14 "params": {}
15}
Was this page helpful?
Previous

Delete api key

Next
Built with
Update api key

Authentication

X-Schematic-Api-Keystring
API Key authentication via header

Path parameters

api_key_idstringRequired
api_key_id

Request

This endpoint expects an object.
descriptionstring or nullOptional
namestring or nullOptional

Response

OK
dataobject
paramsobject
Input parameters

Errors

api_key_id