Skip to contentSkip to navigationSkip to topbar
Rate 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:

  1. Create an Asset (this resource)
  2. Create an Asset Version

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


Asset Properties

asset-properties page anchor
Resource properties
sidtype: SID<ZH>

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


service_sidtype: SID<ZS>

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


friendly_nametype: string
PII MTL: 7 days

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


date_createdtype: string<DATE TIME>

The date and time in GMT when the Asset resource was created specified in ISO 8601(link takes you to an external page) format.


date_updatedtype: string<DATE TIME>

The date and time in GMT when the Asset resource was last updated specified in ISO 8601(link takes you to an external page) format.


urltype: string<URI>

The absolute URL of the Asset resource.


linkstype: object<URI MAP>

The URLs of the Asset resource's nested resources.


Create an Asset resource

create-an-asset-resource page anchor
POST https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets

Parameters

create-parameters page anchor
URI parameters
ServiceSidtype: string
Path Parameter

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


Request body parameters
FriendlyNametype: stringRequired

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

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.serverless.v1.services('ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.assets
_11
.create({friendlyName: 'friendly_name'})
_11
.then(asset => console.log(asset.sid));

Output

_12
{
_12
"sid": "ZH00000000000000000000000000000000",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"service_sid": "ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"friendly_name": "asset-friendly",
_12
"date_created": "2018-11-10T20:00:00Z",
_12
"date_updated": "2018-11-10T20:00:00Z",
_12
"url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets/ZH00000000000000000000000000000000",
_12
"links": {
_12
"asset_versions": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets/ZH00000000000000000000000000000000/Versions"
_12
}
_12
}


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

URI parameters
ServiceSidtype: string
Path Parameter

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


Sidtype: SID<ZH>
Path Parameter

The SID that identifies the Asset resource to fetch.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.serverless.v1.services('ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.assets('ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.fetch()
_11
.then(asset => console.log(asset.friendlyName));

Output

_12
{
_12
"sid": "ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"service_sid": "ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"friendly_name": "test-asset",
_12
"date_created": "2018-11-10T20:00:00Z",
_12
"date_updated": "2018-11-10T20:00:00Z",
_12
"url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets/ZH00000000000000000000000000000000",
_12
"links": {
_12
"asset_versions": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets/ZH00000000000000000000000000000000/Versions"
_12
}
_12
}


Read multiple Asset resources

read-multiple-asset-resources page anchor
GET https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets

URI parameters
ServiceSidtype: string
Path Parameter

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


PageSizetype: integer
Query Parameter

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


Pagetype: integer
Query Parameter

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


PageTokentype: string
Query Parameter

The page token. This is provided by the API.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.serverless.v1.services('ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.assets
_11
.list({limit: 20})
_11
.then(assets => assets.forEach(a => console.log(a.sid)));

Output

_12
{
_12
"assets": [],
_12
"meta": {
_12
"first_page_url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets?PageSize=50&Page=0",
_12
"key": "assets",
_12
"next_page_url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets?PageSize=50&Page=1",
_12
"page": 0,
_12
"page_size": 50,
_12
"previous_page_url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets?PageSize=50&Page=0",
_12
"url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets?PageSize=50&Page=0"
_12
}
_12
}


Update an Asset resource

update-an-asset-resource page anchor
POST https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets/{Sid}

URI parameters
ServiceSidtype: string
Path Parameter

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


Sidtype: SID<ZH>
Path Parameter

The SID that identifies the Asset resource to update.


Request body parameters
FriendlyNametype: stringRequired

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

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_11
// Download the helper library from https://www.twilio.com/docs/node/install
_11
// Find your Account SID and Auth Token at twilio.com/console
_11
// and set the environment variables. See http://twil.io/secure
_11
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_11
const authToken = process.env.TWILIO_AUTH_TOKEN;
_11
const client = require('twilio')(accountSid, authToken);
_11
_11
client.serverless.v1.services('ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.assets('ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_11
.update({friendlyName: 'friendly_name'})
_11
.then(asset => console.log(asset.friendlyName));

Output

_12
{
_12
"sid": "ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"service_sid": "ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"friendly_name": "asset-friendly-update",
_12
"date_created": "2018-11-10T20:00:00Z",
_12
"date_updated": "2018-11-10T20:00:00Z",
_12
"url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets/ZH00000000000000000000000000000000",
_12
"links": {
_12
"asset_versions": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets/ZH00000000000000000000000000000000/Versions"
_12
}
_12
}


Delete an Asset resource

delete-an-asset-resource page anchor
DELETE https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets/{Sid}

URI parameters
ServiceSidtype: string
Path Parameter

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


Sidtype: SID<ZH>
Path Parameter

The SID that identifies the Asset resource to delete.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.serverless.v1.services('ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.assets('ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.remove();


Rate this Page: