Build

Builds are packages of Functions and Assets that you bundle together for deployment. Builds contain Function Version SIDs, Asset Version SIDs, and Dependencies.

Dependencies are defined as JSON strings, for example:

1'[{"name": "randomcolor","version":"0.5.4" },
2 {"name": "util","version":"0.10.3" },
3 {"name": "xmldom","version":"0.1.27" },
4 {"name": "got","version":"6.7.1" },
5 {"name": "fs","version":"0.0.1-security" },
6 {"name": "lodash","version":"4.17.11" },
7 {"name": "date-fns","version":"1.30.1" }]'

Builds take time to package, deploy, and be verified. After creating a Build, it is best to poll every second to check the Build's status. When a Build is verified, it is ready to be used in a Deployment.

List of Build statuses

Build status	Meaning
`Building`	Build request is being processed by the packager.
`Completed`	We have run a health check on the uploaded package and verified it.
`Failed`	Packaging has failed at any of the above steps.

Build Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<ZB>

Optional

Not PII

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

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

accountSidSID<AC>

Optional

Not PII

The SID of the Account that created the Build resource.

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

serviceSidSID<ZS>

Optional

Not PII

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

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

statusenum<string>

Optional

Not PII

The status of the Build. Can be: building, completed, or failed.

Possible values:

buildingcompletedfailed

assetVersionsarray

Optional

Not PII

The list of Asset Version resource SIDs that are included in the Build.

functionVersionsarray

Optional

Not PII

The list of Function Version resource SIDs that are included in the Build.

dependenciesarray

Optional

Not PII

A list of objects that describe the Dependencies included in the Build. Each object contains the name and version of the dependency.

runtimeenum<string>

Optional

Not PII

The Runtime version that will be used to run the Build resource when it is deployed.

Possible values:

node8node10node12node14node16node18node20node22

dateCreatedstring<date-time>

Optional

Not PII

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

dateUpdatedstring<date-time>

Optional

Not PII

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

urlstring<uri>

Optional

Not PII

The absolute URL of the Build resource.

linksobject<uri-map>

Optional

Not PII

Create a Build resource

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

Path parameters

Property nameTypeRequiredPIIDescription

serviceSidstring

required

Not PII

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

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

assetVersionsarray[SID<ZN>]

Optional

Not PII

The list of Asset Version resource SIDs to include in the Build.

functionVersionsarray[SID<ZN>]

Optional

Not PII

The list of the Function Version resource SIDs to include in the Build.

dependenciesstring

Optional

Not PII

A list of objects that describe the Dependencies included in the Build. Each object contains the name and version of the dependency.

runtimestring

Optional

Not PII

The Runtime version that will be used to run the Build resource when it is deployed.

(information)

Info

You must specify all Function or Asset Versions when creating a Build. Builds only use the provided Versions, and do not reference the Versions used by previous Builds.

(warning)

Warning

In order to create a Build successfully, your request must include at least one Function Version, Asset Version, or a combination of both.

If no Function or Asset Versions are indicated, you'll receive Error 20001:

At least one Function Version or Asset Version is required for Build

Create a Build

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 createBuild() {
11  const build = await client.serverless.v1
12    .services("ServiceSid")
13    .builds.create({
14      assetVersions: ["ZNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],
15      functionVersions: ["ZNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],
16    });
17
18  console.log(build.sid);
19}
20
21createBuild();

Response

1{
2  "sid": "ZB00000000000000000000000000000000",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "asset_versions": [
6    {
7      "sid": "ZN00000000000000000000000000000000",
8      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9      "service_sid": "ZS00000000000000000000000000000000",
10      "asset_sid": "ZH00000000000000000000000000000000",
11      "date_created": "2018-11-10T20:00:00Z",
12      "path": "/asset-path",
13      "visibility": "PUBLIC"
14    }
15  ],
16  "function_versions": [
17    {
18      "sid": "ZN00000000000000000000000000000001",
19      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
20      "service_sid": "ZS00000000000000000000000000000000",
21      "function_sid": "ZH00000000000000000000000000000001",
22      "date_created": "2018-11-10T20:00:00Z",
23      "path": "/function-path",
24      "visibility": "PUBLIC"
25    }
26  ],
27  "dependencies": [
28    {
29      "name": "twilio",
30      "version": "3.29.2"
31    },
32    {
33      "name": "@twilio/runtime-handler",
34      "version": "1.0.1"
35    }
36  ],
37  "runtime": "node22",
38  "status": "building",
39  "date_created": "2018-11-10T20:00:00Z",
40  "date_updated": "2018-11-10T20:00:00Z",
41  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000",
42  "links": {
43    "build_status": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status"
44  }
45}

Create a Build and specify Dependencies

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 createBuild() {
11  const build = await client.serverless.v1
12    .services("ServiceSid")
13    .builds.create({
14      dependencies: JSON.stringify([
15        { name: "twilio", version: "3.71.2" },
16        { name: "@twilio/runtime-handler", version: "1.2.1" },
17      ]),
18      functionVersions: ["ZNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],
19    });
20
21  console.log(build.dependencies);
22}
23
24createBuild();

Response

1{
2  "sid": "ZB00000000000000000000000000000000",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "asset_versions": [
6    {
7      "sid": "ZN00000000000000000000000000000000",
8      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9      "service_sid": "ZS00000000000000000000000000000000",
10      "asset_sid": "ZH00000000000000000000000000000000",
11      "date_created": "2018-11-10T20:00:00Z",
12      "path": "/asset-path",
13      "visibility": "PUBLIC"
14    }
15  ],
16  "function_versions": [
17    {
18      "sid": "ZN00000000000000000000000000000001",
19      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
20      "service_sid": "ZS00000000000000000000000000000000",
21      "function_sid": "ZH00000000000000000000000000000001",
22      "date_created": "2018-11-10T20:00:00Z",
23      "path": "/function-path",
24      "visibility": "PUBLIC"
25    }
26  ],
27  "dependencies": [
28    {
29      "name": "twilio",
30      "version": "3.29.2"
31    },
32    {
33      "name": "@twilio/runtime-handler",
34      "version": "1.0.1"
35    }
36  ],
37  "runtime": "node22",
38  "status": "building",
39  "date_created": "2018-11-10T20:00:00Z",
40  "date_updated": "2018-11-10T20:00:00Z",
41  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000",
42  "links": {
43    "build_status": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status"
44  }
45}

Create a build with a specific Node.js runtime

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 createBuild() {
11  const build = await client.serverless.v1
12    .services("ServiceSid")
13    .builds.create({
14      functionVersions: ["ZNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],
15      runtime: "node14",
16    });
17
18  console.log(build.sid);
19}
20
21createBuild();

Response

1{
2  "sid": "ZB00000000000000000000000000000000",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "asset_versions": [
6    {
7      "sid": "ZN00000000000000000000000000000000",
8      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9      "service_sid": "ZS00000000000000000000000000000000",
10      "asset_sid": "ZH00000000000000000000000000000000",
11      "date_created": "2018-11-10T20:00:00Z",
12      "path": "/asset-path",
13      "visibility": "PUBLIC"
14    }
15  ],
16  "function_versions": [
17    {
18      "sid": "ZN00000000000000000000000000000001",
19      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
20      "service_sid": "ZS00000000000000000000000000000000",
21      "function_sid": "ZH00000000000000000000000000000001",
22      "date_created": "2018-11-10T20:00:00Z",
23      "path": "/function-path",
24      "visibility": "PUBLIC"
25    }
26  ],
27  "dependencies": [
28    {
29      "name": "twilio",
30      "version": "3.29.2"
31    },
32    {
33      "name": "@twilio/runtime-handler",
34      "version": "1.0.1"
35    }
36  ],
37  "runtime": "node14",
38  "status": "building",
39  "date_created": "2018-11-10T20:00:00Z",
40  "date_updated": "2018-11-10T20:00:00Z",
41  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000",
42  "links": {
43    "build_status": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status"
44  }
45}

Fetch a Build resource

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

Path parameters

Property nameTypeRequiredPIIDescription

serviceSidstring

required

Not PII

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

sidSID<ZB>

required

Not PII

The SID of the Build resource to fetch.

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

Fetch a Build

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

Response

1{
2  "sid": "ZBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "asset_versions": [
6    {
7      "sid": "ZN00000000000000000000000000000000",
8      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9      "service_sid": "ZS00000000000000000000000000000000",
10      "asset_sid": "ZH00000000000000000000000000000000",
11      "date_created": "2018-11-10T20:00:00Z",
12      "path": "/asset-path",
13      "visibility": "PUBLIC"
14    }
15  ],
16  "function_versions": [
17    {
18      "sid": "ZN00000000000000000000000000000001",
19      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
20      "service_sid": "ZS00000000000000000000000000000000",
21      "function_sid": "ZH00000000000000000000000000000001",
22      "date_created": "2018-11-10T20:00:00Z",
23      "path": "/function-path",
24      "visibility": "PUBLIC"
25    }
26  ],
27  "dependencies": [
28    {
29      "name": "twilio",
30      "version": "3.29.2"
31    },
32    {
33      "name": "@twilio/runtime-handler",
34      "version": "1.0.1"
35    }
36  ],
37  "runtime": "node22",
38  "status": "building",
39  "date_created": "2018-11-10T20:00:00Z",
40  "date_updated": "2018-11-10T20:00:00Z",
41  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000",
42  "links": {
43    "build_status": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status"
44  }
45}

Read multiple Build resources

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

Path parameters

Property nameTypeRequiredPIIDescription

serviceSidstring

required

Not PII

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

Query parameters

Property nameTypeRequiredPIIDescription

pageSizeinteger<int64>

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 multiple Builds

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

Response

1{
2  "builds": [],
3  "meta": {
4    "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0",
5    "key": "builds",
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/Builds?PageSize=50&Page=0"
11  }
12}

Delete a Build resource

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

Path parameters

Property nameTypeRequiredPIIDescription

serviceSidstring

required

Not PII

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

sidSID<ZB>

required

Not PII

The SID of the Build resource to delete.

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

Delete a Build

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