Create a new environment

POST /v1/Services/{ServiceSid}/Environments

Represents a deployed build of a given set of Functions and/or Assets at a specific URL.

Create a new environment.

Path parameters

  • ServiceSid string Required

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

Body

  • DomainSuffix string

    A URL-friendly name that represents the environment and forms part of the domain name. It can be a maximum of 16 characters.

  • UniqueName string Required

    A user-defined string that uniquely identifies the Environment resource. It can be a maximum of 100 characters.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the Environment resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • build_sid string | null

      The SID of the build deployed in the environment

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ZB[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the Environment resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the Environment resource was last updated

    • domain_name string | null

      The domain name for all Functions and Assets deployed in the Environment

    • domain_suffix string | null

      A URL-friendly name that represents the environment

    • links object(uri-map) | null

      The URLs of the Environment resource's nested resources

    • service_sid string | null

      The SID of the Service that the Environment resource is associated with

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ZS[0-9a-fA-F]{32}$.

    • sid string | null

      The unique string that identifies the Environment resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ZE[0-9a-fA-F]{32}$.

    • unique_name string | null

      A user-defined string that uniquely identifies the Environment resource

    • url string(uri) | null

      The absolute URL of the Environment resource
POST /v1/Services/{ServiceSid}/Environments 
curl \
 -X POST https://serverless.twilio.com/v1/Services/{ServiceSid}/Environments \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'DomainSuffix=string&UniqueName=string'
Request example 
{
  "DomainSuffix": "string",
  "UniqueName": "string"
}
Request examples 
{
  "DomainSuffix": "string",
  "UniqueName": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "build_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "domain_name": "string",
  "domain_suffix": "string",
  "links": {},
  "service_sid": "string",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "build_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "domain_name": "string",
  "domain_suffix": "string",
  "links": {},
  "service_sid": "string",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}