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.

application/x-www-form-urlencoded

Body

  • UniqueName string Required

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

  • 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.

Responses

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

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

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

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

    • 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}$.

    • 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}$.

    • 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}$.

    • unique_name string | null

      A user-defined string that uniquely identifies the Environment resource.

    • domain_suffix string | null

      A URL-friendly name that represents the environment and forms part of the domain name.

    • domain_name string | null

      The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • url string(uri) | null

      The absolute URL of the Environment resource.

POST /v1/Services/{ServiceSid}/Environments
curl \
 --request POST 'https://serverless.twilio.com/v1/Services/{ServiceSid}/Environments' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'UniqueName=staging&DomainSuffix=stage'
Request example
{"UniqueName"=>"staging", "DomainSuffix"=>"stage"}
Response examples (201)
{
  "sid": "ZE00000000000000000000000000000000",
  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000",
  "links": {
    "logs": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs",
    "variables": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables",
    "deployments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments"
  },
  "build_sid": null,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "domain_name": "foobar-1234-stage.twil.io",
  "service_sid": "ZS00000000000000000000000000000000",
  "unique_name": "staging",
  "date_created": "2018-11-10T20:00:00Z",
  "date_updated": "2018-11-10T20:00:00Z",
  "domain_suffix": "stage",
  "custom_domain_name": null
}