Delete a key - Telnyx

DELETE

storage

kvs

{id}

keys

{key}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

await client.storage.kvs.keys.delete('id', 'key');

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

KV namespace ID

key

string

required

Key name. Allowed characters: a-z A-Z 0-9 - _ / = .; maximum 256 characters; names starting with _ are reserved for system use. May contain /; URL-encode it so the whole string is treated as one key (for example user/1 -> user%2F1).

Maximum string length: 256

Pattern: ^[-/_=.a-zA-Z0-9]+$

Response

Key deleted (returned even if the key did not exist)

Set a key's value

Pricing

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

await client.storage.kvs.keys.delete('id', 'key');

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}