Function Version
Function Versions are specific versions of JavaScript Node.js code that execute at a particular domain.
The steps to create Functions are as follows:
-
Create a
Function
-
Create a Function Version
(this resource) by making a
POST
request to
https://serverless-upload.twilio.com
You will need the Function Version SID that the create request returns to include this Function in a Build.
Resource properties
sid
type: SID<ZN>
The unique string that we created to identify the Function Version resource.
Pattern:
^ZN[0-9a-fA-F]{32}$
service_sid
type: SID<ZS>
The SID of the Service that the Function Version resource is associated with.
Pattern:
^ZS[0-9a-fA-F]{32}$
function_sid
type: SID<ZH>
The SID of the Function resource that is the parent of the Function Version resource.
Pattern:
^ZH[0-9a-fA-F]{32}$
path
type: string
The URL-friendly string by which the Function Version resource can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If a Function Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one.
visibility
type: enum<string>
The access control that determines how the Function Version resource can be accessed. Can be: public
, protected
, or private
.
Possible values:
public
private
protected
date_created
type: string<date-time>
url
type: string<uri>
The absolute URL of the Function Version resource.
links
type: object<uri-map>
A Function Version resource is created by making a POST
request to the following, dedicated URL:
https://serverless-upload.twilio.com/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions
The following example creates a Function Version resource using the language of your choice (or curl) and an external file, firstfunc.js
, which contains the function body.
_36const fs = require('fs');
_36// Before running this code, install "form-data" and "axios" using `npm install form-data axios`
_36const FormData = require('form-data');
_36const axios = require('axios');
_36// Provision API Keys at twilio.com/console/runtime/api-keys
_36// and set the environment variables. See http://twil.io/secure
_36const apiKey = process.env.TWILIO_API_KEY;
_36const apiSecret = process.env.TWILIO_API_SECRET;
_36const serviceSid = 'ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
_36const functionSid = 'ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
_36const serviceUrl = `https://serverless-upload.twilio.com/v1/Services/${serviceSid}`;
_36const uploadUrl = `${serviceUrl}/Functions/${functionSid}/Versions`;
_36const form = new FormData();
_36form.append('Path', '/thanos');
_36form.append('Visibility', 'public');
_36form.append('Content', fs.createReadStream('firstfunc.js'), {
_36 contentType: 'application/javascript',
_36// Create a new Function Version
_36 .post(uploadUrl, form, {
_36 headers: form.getHeaders(),
_36 .then((response) => {
_36 const newVersionSid = response.data.sid;
_36 console.log(newVersionSid);
Warning
Note that the Serverless upload endpoint is on a different subdomain from the rest of the Serverless API (serverless-upload.twilio.com
instead of serverless.twilio.com
), and is not supported by the Twilio Helper Libraries at this time.
The create
action accepts these parameters:
Parameter | Description |
---|
Content | The Function code to upload as a JavaScript file. |
FunctionSid | The SID of the Function resource to upload this code to. |
Path | The path to assign the Function. Must be URL Friendly, without fragments, and the characters ;,?:@+&$()' " are disallowed. |
ServiceSid | The SID of the Function's Service. |
Visibility | The visibility of the Function. Can be public , protected , or private . |
GET https://serverless.twilio.com/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}
URI parameters
ServiceSid
type: string
The SID of the Service to fetch the Function Version resource from.
FunctionSid
type: SID<ZH>
The SID of the function that is the parent of the Function Version resource to fetch.
Pattern:
^ZH[0-9a-fA-F]{32}$
Sid
type: SID<ZN>
The SID of the Function Version resource to fetch.
Pattern:
^ZN[0-9a-fA-F]{32}$
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.serverless.v1.services('ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .functions('ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .functionVersions('ZNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(function_version => console.log(function_version.sid));
_13 "sid": "ZNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13 "service_sid": "ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13 "function_sid": "ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_13 "path": "/test-path",
_13 "visibility": "public",
_13 "date_created": "2018-11-10T20:00:00Z",
_13 "url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000",
_13 "function_version_content": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content"
GET https://serverless.twilio.com/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions
URI parameters
ServiceSid
type: string
The SID of the Service to read the Function Version resources from.
FunctionSid
type: SID<ZH>
The SID of the function that is the parent of the Function Version resources to read.
Pattern:
^ZH[0-9a-fA-F]{32}$
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
_12// Download the helper library from https://www.twilio.com/docs/node/install
_12// Find your Account SID and Auth Token at twilio.com/console
_12// and set the environment variables. See http://twil.io/secure
_12const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12const authToken = process.env.TWILIO_AUTH_TOKEN;
_12const client = require('twilio')(accountSid, authToken);
_12client.serverless.v1.services('ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .functions('ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(functionVersions => functionVersions.forEach(f => console.log(f.sid)));
_12 "function_versions": [],
_12 "first_page_url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0",
_12 "key": "function_versions",
_12 "next_page_url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=1",
_12 "previous_page_url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0",
_12 "url": "https://serverless.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0"
Info
There is no API endpoint for deleting a Function Version, only Functions. Function Versions are automatically purged if they are not used by a Build for 30 days. See our retention policy to learn more.