On this page

REST API: Key Resource v2010

You access the Twilio API using API keys that represent the required credentials. These keys:

Authenticate to the REST API
Create and revoke Access Tokens

(information)

Info

The v2010 Key resource provides the ability to create and manage API Keys. However, it does not support the creation of Restricted API Keys. For creating and managing Restricted API Keys, please refer to the Key Resource v1. The Key Resource v1 is a new REST API that supports all the features of the v2010 Key resource, and additionally allows the creation of Restricted API Keys.

See this document for more information about your request to Twilio's REST API, or read our article on Access Tokens to learn more.

API Keys can be provisioned and revoked through the REST API or the Twilio Console. This provides a powerful and flexible primitive for managing access to the Twilio API. There are two types of API Keys: Standard and Main.

Standard API Keys give you access to all the functionality in Twilio's API, except for managing API Keys, Account Configuration, and Subaccounts.

Main API Keys have the same access as Standard Keys, and can also manage API Keys, Account Configuration, and Subaccounts. Main API Keys give you the same level of access as if you were using account API Credentials.

Since API Keys can be independently revoked, you have complete control of the lifecycle of your API credentials.

For example, you might issue separate API Keys to different developers or different subsystems within your application. If a key is compromised or no longer used, you can delete it to prevent unauthorized access!

(warning)

Warning

If your use case requires API Keys to access the /Accounts or /Keys endpoint, a Main Key needs to be used. This can be created in the Console.

Key Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<SK>Optional

Not PII

The unique string that that we created to identify the Key resource.

Pattern: ^SK[0-9a-fA-F]{32}$Min length: 34Max length: 34

friendly_namestringOptional

PII MTL: 30 days

The string that you assigned to describe the resource.

date_createdstring<date-time-rfc-2822>Optional

Not PII

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_updatedstring<date-time-rfc-2822>Optional

Not PII

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

Fetch a Key resource

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json

Returns a representation of the API Key, including the properties below.

(warning)

Warning

For security reasons, the Secret field is ONLY returned when the API Key is first created - never when fetching the resource. Your application should store the API Key's Sid and Secret in a secure location to authenticate to the API and generate Access Tokens in the future.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Key resource to fetch.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<SK>required

Not PII

The Twilio-provided string that uniquely identifies the Key resource to fetch.

Pattern: ^SK[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch an API Key

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchKey() {
11  const key = await client.keys("SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX").fetch();
12
13  console.log(key.sid);
14}
15
16fetchKey();

Output

1{
2  "sid": "SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "friendly_name": "foo",
4  "date_created": "Mon, 13 Jun 2016 22:50:08 +0000",
5  "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000"
6}

Fetch an API Key

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchKey() {
11  const key = await client.keys("SK2a0747eba6abf96b7e3c3ff0b4530f6e").fetch();
12
13  console.log(key.sid);
14}
15
16fetchKey();

Output

1{
2  "sid": "SK2a0747eba6abf96b7e3c3ff0b4530f6e",
3  "friendly_name": "foo",
4  "date_created": "Mon, 13 Jun 2016 22:50:08 +0000",
5  "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000"
6}

Read a Key resource

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Keys.json

Returns a list of API Keys in this account, sorted by DateUpdated.

The list includes all API Keys. It also includes paging information.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Key resources to read.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

Read a Key resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listKey() {
11  const keys = await client.keys.list({ limit: 20 });
12
13  keys.forEach((k) => console.log(k.sid));
14}
15
16listKey();

Output

1{
2  "keys": [
3    {
4      "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "friendly_name": "foo",
6      "date_created": "Mon, 13 Jun 2016 22:50:08 +0000",
7      "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000"
8    }
9  ],
10  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0",
11  "end": 0,
12  "previous_page_uri": null,
13  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Keys.json?PageSize=50&Page=0",
14  "page_size": 50,
15  "start": 0,
16  "next_page_uri": null,
17  "page": 0
18}

Update a Key resource

POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json

Attempts to update the fields of an API Key instance.

If successful, it returns the updated resource representation. The response will be identical to that of the HTTP GET (fetch).

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Key resources to update.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<SK>required

Not PII

The Twilio-provided string that uniquely identifies the Key resource to update.

Pattern: ^SK[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

FriendlyNamestringOptional

PII MTL: 30 days

A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Update a Key resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateKey() {
11  const key = await client
12    .keys("SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .update({ friendlyName: "friendly_name" });
14
15  console.log(key.sid);
16}
17
18updateKey();

Output

1{
2  "sid": "SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3  "friendly_name": "friendly_name",
4  "date_created": "Mon, 13 Jun 2016 22:50:08 +0000",
5  "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000"
6}

Delete a Key Resource

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json

Deletes an API Key. This revokes its authorization to authenticate to the REST API and invalidates all Access Tokens generated using its secret.

If the delete is successful, Twilio will return an HTTP 204 response with no body.

(warning)

Warning

You may only delete Keys by authenticating with the account's AccountSid and AuthToken or API Keys that have the main key flag set in the console.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Key resources to delete.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<SK>required

Not PII

The Twilio-provided string that uniquely identifies the Key resource to delete.

Pattern: ^SK[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete a Key resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteKey() {
11  await client.keys("SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX").remove();
12}
13
14deleteKey();