On this page

REST API: Key Resource v1

Use the Key resource to create and manage Standard and Restricted API keys.

API keys represent the required credentials that you'll use to authenticate to Twilio's REST API and to create and revoke Access Tokens.

(information)

Info

If your API key requires access to the /Accounts or /Accounts/{SID}/Keys endpoints, then you'll need to use a Main key. You can create Main keys only in the Twilio Console.

Types of keys

The API key types are: Main, Standard, and Restricted (public beta, Key resource v1 only). The following table describes each type.

Key type	Access permissions	Create in Console	Create with REST API
Main	Full access to all Twilio API resources. Equivalent to using your Account SID and Auth Token for API requests.	Yes	No
Standard	Access to all Twilio API resources, except for API key and Account resources.	Yes	Yes
Restricted	Customized, fine-grained access to specific Twilio API resources. Learn more about Restricted API keys.	Yes	Yes (v1 only)

Key Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<SK>

Optional

Not PII

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

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

friendly_namestring

Optional

Not PII

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.

Create an API key

POST https://iam.twilio.com/v1/Keys

(warning)

Warning

To create Standard API keys with the API, you must use one of the following credentials: your Account SID and Auth Token, a Main API key, or a Restricted API key with the permission for /twilio/iam/api-keys/create.

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Payments resource.

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

FriendlyNamestring

Optional

PII MTL: 30 days

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

KeyTypeenum<string>

Optional

Not PII

The `KeyType` form parameter is used to specify the type of key you want to create.

Default Behavior: If `KeyType` is not specified, the API will generate a standard key.

Restricted Key: If `KeyType` is set to `restricted`, the API will create a new restricted key. In this case, a policy object is required to define the permissions.

Possible values:

restricted

Policyobject

Optional

Not PII

The `Policy` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the Twilio documentation.

Create a Standard 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 createNewKey() {
11  const newApiKey = await client.iam.v1.newApiKey.create({
12    accountSid: "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
13    friendlyName: "Mario's API key",
14  });
15
16  console.log(newApiKey.sid);
17}
18
19createNewKey();

Output

1{
2  "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "friendly_name": "Mario's API key",
4  "date_created": "Mon, 13 Jun 2016 22:50:08 +0000",
5  "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000",
6  "secret": "foobar",
7  "policy": null
8}

The response contains a sid property and a secret property. Store the secret in a secure location, because you won't be able to retrieve it again. Twilio uses the Key resource's sid and the secret as the credentials when making API requests.

Create a Restricted 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 createNewKey() {
11  const newApiKey = await client.iam.v1.newApiKey.create({
12    accountSid: "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
13    friendlyName: "Mario's API key",
14    keyType: "restricted",
15    policy: {
16      allow: ["/twilio/messaging/messages/read"],
17    },
18  });
19
20  console.log(newApiKey.sid);
21}
22
23createNewKey();

Output

1{
2  "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "friendly_name": "Mario's API key",
4  "date_created": "Mon, 13 Jun 2016 22:50:08 +0000",
5  "date_updated": "Mon, 13 Jun 2016 22:50:08 +0000",
6  "secret": "foobar",
7  "policy": {
8    "allow": [
9      "/twilio/messaging/messages/read"
10    ]
11  }
12}

Fetch a Key resource

GET https://iam.twilio.com/v1/Keys/{Sid}

Returns a representation of the API key.

(warning)

Warning

For security reasons, Twilio returns the secret field only when the API key is first created and never includes the secret field when you fetch the resource. Your application should store the API key's SID and secret in a secure location to authenticate to the API.

Path parameters

Property nameTypeRequiredPIIDescription

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 a Standard 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 apiKey = await client.iam.v1
12    .apiKey("SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1")
13    .fetch();
14
15  console.log(apiKey.sid);
16}
17
18fetchKey();

Output

1{
2  "sid": "SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1",
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  "policy": null
7}

Fetch a Restricted 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 apiKey = await client.iam.v1
12    .apiKey("SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX2")
13    .fetch();
14
15  console.log(apiKey.sid);
16}
17
18fetchKey();

Output

1{
2  "sid": "SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX2",
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  "policy": {
7    "allow": [
8      "/twilio/messaging/messages/read"
9    ]
10  }
11}

List Key resources

GET https://iam.twilio.com/v1/Keys

Returns a list of API keys associated with a given Account, sorted by DateUpdated.

The list includes all API keys and paging information.

Query parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Payments resource.

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

PageSizeinteger

Optional

Not PII

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

Minimum: 1Maximum: 1000

Pageinteger

Optional

Not PII

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

Minimum: 0

PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

List Key resources

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 listGetKeys() {
11  const getApiKeys = await client.iam.v1.getApiKeys.list({
12    accountSid: "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
13    limit: 20,
14  });
15
16  getApiKeys.forEach((g) => console.log(g.sid));
17}
18
19listGetKeys();

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      "sid": "SKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
11      "friendly_name": "bar",
12      "date_created": "Mon, 13 Jun 2016 20:50:08 +0000",
13      "date_updated": "Mon, 13 Jun 2016 20:50:08 +0000"
14    }
15  ],
16  "meta": {
17    "page": 0,
18    "page_size": 50,
19    "first_page_url": "https://iam.twilio.com/v1/Keys?AccountSid=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
20    "previous_page_url": null,
21    "url": "https://iam.twilio.com/v1/Keys?AccountSid=ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
22    "next_page_url": null,
23    "key": "keys"
24  }
25}

Update a Key resource

POST https://iam.twilio.com/v1/Keys/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

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

FriendlyNamestring

Optional

PII MTL: 30 days

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

Policyobject

Optional

Not PII

Attempts to update the fields of an API Key resource.

If successful, Twilio returns the updated resource representation. The response is identical to that of the fetch a Key resource endpoint.

Update a Standard 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 apiKey = await client.iam.v1
12    .apiKey("SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .update({ friendlyName: "friendly_name" });
14
15  console.log(apiKey.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  "policy": null
7}

(information)

Update a Restricted key

The update request completely overwrites the existing policy associated with the original API key. You must include all the required permissions in the Policy object of an update request. To remove a specific permission while retaining others, include only the permissions that should be kept.

Update a Restricted 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 apiKey = await client.iam.v1
12    .apiKey("SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .update({
14      friendlyName: "friendly_name",
15      policy: {
16        allow: [
17          "/twilio/messaging/messages/read",
18          "/twilio/messaging/messages/update",
19        ],
20      },
21    });
22
23  console.log(apiKey.sid);
24}
25
26updateKey();

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  "policy": {
7    "allow": [
8      "/twilio/messaging/messages/read",
9      "/twilio/messaging/messages/update"
10    ]
11  }
12}

Delete a Key resource

DELETE https://iam.twilio.com/v1/Keys/{Sid}

Deletes an API key. Deleting an API key revokes the authorization to authenticate to the REST API and invalidates all Access Tokens generated using the API key's secret.

If the deletion is successful, Twilio returns an HTTP 204 response with no body.

Path parameters

Property nameTypeRequiredPIIDescription

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.iam.v1.apiKey("SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX").remove();
12}
13
14deleteKey();