Retrieve a list of all environments

GET /v1/Services/{ServiceSid}/Environments

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

Retrieve a list of all environments.

Path parameters

  • ServiceSid string Required

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

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • environments array[object]
      Hide environments attributes Show environments attributes
      • 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

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Services/{ServiceSid}/Environments 
curl \
 -X GET https://serverless.twilio.com/v1/Services/{ServiceSid}/Environments \
 --user "username:password"
Response examples (200) 
{
  "environments": [
    {
      "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"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}