Create a new Service resource

POST /v1/Services

The top-level resource for a Serverless application, which serves as a container for the application environments.

Create a new Service resource.

Body

  • FriendlyName string Required

    A descriptive string that you create to describe the Service resource. It can be a maximum of 255 characters.

  • IncludeCredentials boolean

    Whether to inject Account credentials into a function invocation context. The default value is true.

  • UiEditable boolean

    Whether the Service's properties and subresources can be edited via the UI. The default value is false.

  • UniqueName string Required

    A user-defined string that uniquely identifies the Service resource. It can be used as an alternative to the sid in the URL path to address the Service resource. This value must be 50 characters or less in length and be unique.

Responses

  • 201

    Created

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

      The SID of the Account that created the Service resource

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

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • domain_base string | null

      The base domain name for this Service, which is a combination of the unique name and a randomly generated string

    • friendly_name string | null

      The string that you assigned to describe the Service resource

    • include_credentials boolean | null

      Whether to inject Account credentials into a function invocation context

    • links object(uri-map) | null

      The URLs of the Service's nested resources

    • sid string | null

      The unique string that identifies the Service resource

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

    • ui_editable boolean | null

      Whether the Service resource's properties and subresources can be edited via the UI

    • unique_name string | null

      A user-defined string that uniquely identifies the Service resource

    • url string(uri) | null

      The absolute URL of the Service resource
POST /v1/Services 
curl \
 -X POST https://serverless.twilio.com/v1/Services \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'FriendlyName=string&IncludeCredentials=true&UiEditable=true&UniqueName=string'
Request example 
{
  "FriendlyName": "string",
  "IncludeCredentials": true,
  "UiEditable": true,
  "UniqueName": "string"
}
Request examples 
{
  "FriendlyName": "string",
  "IncludeCredentials": true,
  "UiEditable": true,
  "UniqueName": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "domain_base": "string",
  "friendly_name": "string",
  "include_credentials": true,
  "links": {},
  "sid": "string",
  "ui_editable": true,
  "unique_name": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "domain_base": "string",
  "friendly_name": "string",
  "include_credentials": true,
  "links": {},
  "sid": "string",
  "ui_editable": true,
  "unique_name": "string",
  "url": "https://example.com"
}