Skip to content Skip to navigation Skip to topbar

On this page

Asset

Assets are static files that you can host at a particular domain in an Environment.

The steps to create Assets are as follows:

Create an Asset (this resource)
Create an Asset Version

We will need the Asset Version SID to include this Asset in a Build.

Asset Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<ZH>Optional

Not PII

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

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

account_sidSID<AC>Optional

Not PII

The SID of the Account that created the Asset resource.

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

service_sidSID<ZS>Optional

Not PII

The SID of the Service that the Asset resource is associated with.

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

friendly_namestringOptional

PII MTL: 7 days

The string that you assigned to describe the Asset resource. It can be a maximum of 255 characters.

date_createdstring<date-time>Optional

Not PII

The date and time in GMT when the Asset resource was created specified in ISO 8601 format.

date_updatedstring<date-time>Optional

Not PII

The date and time in GMT when the Asset resource was last updated specified in ISO 8601 format.

urlstring<uri>Optional

Not PII

The absolute URL of the Asset resource.

linksobject<uri-map>Optional

Not PII

The URLs of the Asset resource's nested resources.

Create an Asset resource

POST https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to create the Asset resource under.

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

FriendlyNamestringrequired

PII MTL: 7 days

A descriptive string that you create to describe the Asset resource. It can be a maximum of 255 characters.

Create an Asset

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 createAsset() {
11  const asset = await client.serverless.v1
12    .services("ServiceSid")
13    .assets.create({ friendlyName: "FriendlyName" });
14
15  console.log(asset.sid);
16}
17
18createAsset();

Output

1{
2  "sid": "ZH00000000000000000000000000000000",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "friendly_name": "FriendlyName",
6  "date_created": "2018-11-10T20:00:00Z",
7  "date_updated": "2018-11-10T20:00:00Z",
8  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000",
9  "links": {
10    "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions"
11  }
12}

Fetch an Asset resource

GET https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to fetch the Asset resource from.

SidSID<ZH>required

Not PII

The SID that identifies the Asset resource to fetch.

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

Fetch an Asset

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 fetchAsset() {
11  const asset = await client.serverless.v1
12    .services("ServiceSid")
13    .assets("ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .fetch();
15
16  console.log(asset.sid);
17}
18
19fetchAsset();

Output

1{
2  "sid": "ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "friendly_name": "test-asset",
6  "date_created": "2018-11-10T20:00:00Z",
7  "date_updated": "2018-11-10T20:00:00Z",
8  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000",
9  "links": {
10    "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions"
11  }
12}

Read multiple Asset resources

GET https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to read the Asset resources from.

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.

List multiple Assets

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 listAsset() {
11  const assets = await client.serverless.v1
12    .services("ServiceSid")
13    .assets.list({ limit: 20 });
14
15  assets.forEach((a) => console.log(a.sid));
16}
17
18listAsset();

Output

1{
2  "assets": [],
3  "meta": {
4    "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0",
5    "key": "assets",
6    "next_page_url": null,
7    "page": 0,
8    "page_size": 50,
9    "previous_page_url": null,
10    "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0"
11  }
12}

Update an Asset resource

POST https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to update the Asset resource from.

SidSID<ZH>required

Not PII

The SID that identifies the Asset resource to update.

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

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

FriendlyNamestringrequired

PII MTL: 7 days

A descriptive string that you create to describe the Asset resource. It can be a maximum of 255 characters.

Update an Asset

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 updateAsset() {
11  const asset = await client.serverless.v1
12    .services("ServiceSid")
13    .assets("ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .update({ friendlyName: "FriendlyName" });
15
16  console.log(asset.sid);
17}
18
19updateAsset();

Output

1{
2  "sid": "ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "friendly_name": "FriendlyName",
6  "date_created": "2018-11-10T20:00:00Z",
7  "date_updated": "2018-11-10T20:00:00Z",
8  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000",
9  "links": {
10    "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions"
11  }
12}

Delete an Asset resource

DELETE https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to delete the Asset resource from.

SidSID<ZH>required

Not PII

The SID that identifies the Asset resource to delete.

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

Delete an Asset

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 deleteAsset() {
11  await client.serverless.v1
12    .services("ServiceSid")
13    .assets("ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .remove();
15}
16
17deleteAsset();