On this page

Service

Services are containers for your environments. You may only need one Service with many environments. When you begin working on a new application, you will likely want to create a new Service.

(warning)

Warning

The unique name of your service forms the first part of your Serverless domain and cannot be updated.

Service Properties

Property nameTypePIIDescription

sidSID<ZS>

Not PII

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

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

account_sidSID<AC>

Not PII

The SID of the Account that created the Service resource.

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

friendly_namestring

PII MTL: 7 days

The string that you assigned to describe the Service resource.

unique_namestring

PII MTL: 7 days

A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource's sid in the URL to address the Service resource.

include_credentialsboolean

Not PII

Whether to inject Account credentials into a function invocation context.

ui_editableboolean

Not PII

Whether the Service resource's properties and subresources can be edited via the UI.

domain_basestring

Not PII

The base domain name for this Service, which is a combination of the unique name and a randomly generated string.

date_createdstring<date-time>

Not PII

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

date_updatedstring<date-time>

Not PII

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

urlstring<uri>

Not PII

The absolute URL of the Service resource.

linksobject<uri-map>

Not PII

The URLs of the Service's nested resources.

Create a Service resource

POST https://serverless.twilio.com/v1/Services

Request body parameters

Property nameTypeRequiredPIIDescription

UniqueNamestringrequired

PII MTL: 7 days

A user-defined string that uniquely identifies the Service resource. It can be used as an alternative to the sid in the URL path to address the Service resource. This value must be 50 characters or less in length and be unique.

FriendlyNamestringrequired

PII MTL: 7 days

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

IncludeCredentialsbooleanOptional

Not PII

Whether to inject Account credentials into a function invocation context. The default value is true.

UiEditablebooleanOptional

Not PII

Whether the Service's properties and subresources can be edited via the UI. The default value is false.

Create Service

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_20// Download the helper library from https://www.twilio.com/docs/node/install
_20const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_20
_20// Find your Account SID and Auth Token at twilio.com/console
_20// and set the environment variables. See http://twil.io/secure
_20const accountSid = process.env.TWILIO_ACCOUNT_SID;
_20const authToken = process.env.TWILIO_AUTH_TOKEN;
_20const client = twilio(accountSid, authToken);
_20
_20async function createService() {
_20  const service = await client.serverless.v1.services.create({
_20    friendlyName: "My New App",
_20    includeCredentials: true,
_20    uniqueName: "my-new-app",
_20  });
_20
_20  console.log(service.sid);
_20}
_20
_20createService();

Output


_18{
_18  "sid": "ZS00000000000000000000000000000000",
_18  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_18  "friendly_name": "My New App",
_18  "unique_name": "my-new-app",
_18  "include_credentials": true,
_18  "ui_editable": false,
_18  "domain_base": "service-unique-1234",
_18  "date_created": "2018-11-10T20:00:00Z",
_18  "date_updated": "2018-11-10T20:00:00Z",
_18  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000",
_18  "links": {
_18    "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments",
_18    "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions",
_18    "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets",
_18    "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds"
_18  }
_18}

Fetch a Service resource

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

Path parameters

Property nameTypeRequiredPIIDescription

Sidstringrequired

Not PII

The sid or unique_name of the Service resource to fetch.

Fetch a Service

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function fetchService() {
_16  const service = await client.serverless.v1.services("Sid").fetch();
_16
_16  console.log(service.sid);
_16}
_16
_16fetchService();

Output


_18{
_18  "sid": "Sid",
_18  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_18  "friendly_name": "test-service",
_18  "unique_name": "test-service-1",
_18  "include_credentials": true,
_18  "ui_editable": false,
_18  "domain_base": "test-service-1-1234",
_18  "date_created": "2018-11-10T20:00:00Z",
_18  "date_updated": "2018-11-10T20:00:00Z",
_18  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000",
_18  "links": {
_18    "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments",
_18    "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions",
_18    "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets",
_18    "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds"
_18  }
_18}

Read multiple Service resources

GET https://serverless.twilio.com/v1/Services

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 Services

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_16// Download the helper library from https://www.twilio.com/docs/node/install
_16const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_16
_16// Find your Account SID and Auth Token at twilio.com/console
_16// and set the environment variables. See http://twil.io/secure
_16const accountSid = process.env.TWILIO_ACCOUNT_SID;
_16const authToken = process.env.TWILIO_AUTH_TOKEN;
_16const client = twilio(accountSid, authToken);
_16
_16async function listService() {
_16  const services = await client.serverless.v1.services.list({ limit: 20 });
_16
_16  services.forEach((s) => console.log(s.sid));
_16}
_16
_16listService();

Output


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

Update a Service resource

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

Path parameters

Property nameTypeRequiredPIIDescription

Sidstringrequired

Not PII

The sid or unique_name of the Service resource to update.

Request body parameters

Property nameTypeRequiredPIIDescription

IncludeCredentialsbooleanOptional

Not PII

Whether to inject Account credentials into a function invocation context.

FriendlyNamestringOptional

PII MTL: 7 days

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

UiEditablebooleanOptional

Not PII

Whether the Service resource's properties and subresources can be edited via the UI. The default value is false.

Update a Service to be editable in the Console UI

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function updateService() {
_18  const service = await client.serverless.v1
_18    .services("Sid")
_18    .update({ uiEditable: true });
_18
_18  console.log(service.sid);
_18}
_18
_18updateService();

Output


_18{
_18  "sid": "Sid",
_18  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_18  "friendly_name": "service-friendly-update",
_18  "unique_name": "service-unique-update",
_18  "include_credentials": true,
_18  "ui_editable": true,
_18  "domain_base": "service-unique-update-1234",
_18  "date_created": "2018-11-10T20:00:00Z",
_18  "date_updated": "2018-11-10T20:00:00Z",
_18  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000",
_18  "links": {
_18    "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments",
_18    "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions",
_18    "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets",
_18    "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds"
_18  }
_18}

Delete a Service resource

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

Path parameters

Property nameTypeRequiredPIIDescription

Sidstringrequired

Not PII

The sid or unique_name of the Service resource to delete.

Delete a Service

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_14// Download the helper library from https://www.twilio.com/docs/node/install
_14const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_14
_14// Find your Account SID and Auth Token at twilio.com/console
_14// and set the environment variables. See http://twil.io/secure
_14const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14const authToken = process.env.TWILIO_AUTH_TOKEN;
_14const client = twilio(accountSid, authToken);
_14
_14async function deleteService() {
_14  await client.serverless.v1.services("Sid").remove();
_14}
_14
_14deleteService();