Path parameters

• ServiceSid string Required

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

Query parameters

• PageSize integer(int64)

  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.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  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

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

    • links object(uri-map) | null

      The URLs of the Environment resource's nested resources.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)