Expand

Environment

Environments define the different domains your Functions and Assets are available under. You can only have one environment, or you can have many, e.g. a dev, stage and prod. You can deploy Builds to many environments.

Environment properties

Names in REST API format
`sid`	sid<ZE> Not PII The unique string that we created to identify the Environment resource.
`account_sid`	sid<AC> Not PII The SID of the Account that created the Environment resource.
`service_sid`	sid<ZS> Not PII The SID of the Service that the Environment resource is associated with.
`build_sid`	sid<ZB> Not PII The SID of the build deployed in the environment.
`unique_name`	string PII MTL: 7 DAYS An application-defined string that uniquely identifies the Environment resource. It can be used in place of the Environment resource's `sid` in the URL to address the Environment resource.
`domain_suffix`	string PII MTL: 7 DAYS A URL-friendly name that represents the environment and forms part of the domain name.
`domain_name`	string PII MTL: 7 DAYS The base domain name for all Functions and Assets deployed in the environment, using the Service unique name and environment domain suffix.
`date_created`	date_time<iso8601> Not PII The date and time in GMT when the Environment resource was created specified in ISO 8601 format.
`date_updated`	date_time<iso8601> Not PII The date and time in GMT when the Environment resource was last updated specified in ISO 8601 format.
`url`	url Not PII The absolute URL of the Environment resource.
`links`	uri_map Not PII The URLs of the environment's nested resources.

Create an Environment resource

post

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

Parameters

Names in REST API format

service_sid

Path

post sid_like<ZS> Not PII

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

unique_name

Required

post string PII MTL: 7 DAYS

An application-defined string that uniquely identifies the Environment resource. It can be used as an alternative to the sid in the URL path to address the Environment resource. This value must have fewer than 256 characters.

domain_suffix

Optional

post string PII MTL: 7 DAYS

A URL-friendly name that represents the environment and forms part of the domain name. Must have fewer than 32 characters.

Example 1

Loading Code Sample...

Show sample response

Example JSON API response

Create Environment

Fetch an Environment resource

get

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

Parameters

Names in REST API format

service_sid

Path

get sid_like<ZS> Not PII

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

sid

Path

get sid<ZE> Not PII

The SID of the Environment resource to fetch.

Example

Loading Code Sample...

Show sample response

Example JSON API response

Fetch Environment

Read multiple Environment resources

get

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

Parameters

Names in REST API format

service_sid

Path

get sid_like<ZS> Not PII

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

Example

Loading Code Sample...

Show sample response

Example JSON API response

Read Environment

Delete an Environment resource

delete

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

Parameters

Names in REST API format

service_sid

Path

delete sid_like<ZS> Not PII

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

sid

Path

delete sid<ZE> Not PII

The SID of the Environment resource to delete.

Example

Loading Code Sample...

Show sample response

Example JSON API response

Delete Environment

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

Loading Code Sample...

Example JSON API response