Twilio Serverless API is a platform that allows developers to build and deploy software applications without having to manage infrastructure. With Twilio Serverless API, developers can easily create and deploy functions, or pieces of code, that can be executed on demand. This streamlined approach to development means that developers can focus on writing code, instead of worrying about servers or scaling.
components:
schemas:
serverless.v1.service.asset:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZH[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Asset resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Asset resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Service that the Asset resource is associated with.
friendly_name:
type: string
nullable: true
description: >-
The string that you assigned to describe the Asset resource. It can
be a maximum of 255 characters.
x-twilio:
pii:
handling: standard
deleteSla: 7
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Asset resource was created
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Asset resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Asset resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of the Asset resource's nested resources.
serverless.v1.service.asset.asset_version:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZN[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Asset Version
resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Asset Version resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Service that the Asset Version resource is associated
with.
asset_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZH[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Asset resource that is the parent of the Asset
Version.
path:
type: string
nullable: true
description: >-
The URL-friendly string by which the Asset Version can be
referenced. It can be a maximum of 255 characters. All paths begin
with a forward slash ('/'). If an Asset Version creation request is
submitted with a path not containing a leading slash, the path will
automatically be prepended with one.
x-twilio:
pii:
handling: standard
deleteSla: 7
visibility:
type: string
$ref: '#/components/schemas/asset_version_enum_visibility'
nullable: true
description: >-
The access control that determines how the Asset Version resource
can be accessed. Can be: `public`, `protected`, or `private`.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Asset Version resource was created
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Asset Version resource.
asset_version_enum_visibility:
type: string
enum:
- public
- private
- protected
serverless.v1.service.build:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZB[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Build resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Build resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Service that the Build resource is associated with.
status:
type: string
$ref: '#/components/schemas/build_enum_status'
nullable: true
description: >-
The status of the Build. Can be: `building`, `completed`, or
`failed`.
asset_versions:
type: array
items: {}
nullable: true
description: >-
The list of Asset Version resource SIDs that are included in the
Build.
function_versions:
type: array
items: {}
nullable: true
description: >-
The list of Function Version resource SIDs that are included in the
Build.
dependencies:
type: array
items: {}
nullable: true
description: >-
A list of objects that describe the Dependencies included in the
Build. Each object contains the `name` and `version` of the
dependency.
runtime:
type: string
$ref: '#/components/schemas/build_enum_runtime'
nullable: true
description: >-
The Runtime version that will be used to run the Build resource when
it is deployed.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Build resource was created
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Build resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Build resource.
links:
type: object
format: uri-map
nullable: true
build_enum_status:
type: string
enum:
- building
- completed
- failed
build_enum_runtime:
type: string
enum:
- node8
- node10
- node12
- node14
- node16
- node18
serverless.v1.service.build.build_status:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZB[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Build resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Build resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Service that the Build resource is associated with.
status:
type: string
$ref: '#/components/schemas/build_status_enum_status'
nullable: true
description: >-
The status of the Build. Can be: `building`, `completed`, or
`failed`.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Build Status resource.
build_status_enum_status:
type: string
enum:
- building
- completed
- failed
serverless.v1.service.environment.deployment:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZD[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Deployment
resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Deployment resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Service that the Deployment resource is associated
with.
environment_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZE[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Environment for the Deployment.
build_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZB[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Build for the deployment.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Deployment resource was created
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Deployment resource was last
updated specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Deployment resource.
serverless.v1.service.environment:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZE[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Environment
resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Environment resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Service that the Environment resource is associated
with.
build_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZB[0-9a-fA-F]{32}$
nullable: true
description: The SID of the build deployed in the environment.
unique_name:
type: string
nullable: true
description: >-
A user-defined string that uniquely identifies the Environment
resource.
x-twilio:
pii:
handling: standard
deleteSla: 7
domain_suffix:
type: string
nullable: true
description: >-
A URL-friendly name that represents the environment and forms part
of the domain name.
x-twilio:
pii:
handling: standard
deleteSla: 7
domain_name:
type: string
nullable: true
description: >-
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.
x-twilio:
pii:
handling: standard
deleteSla: 7
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Environment resource was created
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Environment resource was last
updated specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Environment resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of the Environment resource's nested resources.
serverless.v1.service.function:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZH[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Function resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Function resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Service that the Function resource is associated
with.
friendly_name:
type: string
nullable: true
description: >-
The string that you assigned to describe the Function resource. It
can be a maximum of 255 characters.
x-twilio:
pii:
handling: standard
deleteSla: 7
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Function resource was created
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Function resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Function resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of nested resources of the Function resource.
serverless.v1.service.function.function_version:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZN[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Function Version
resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Function Version resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Service that the Function Version resource is
associated with.
function_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZH[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Function resource that is the parent of the Function
Version resource.
path:
type: string
nullable: true
description: >-
The URL-friendly string by which the Function Version resource can
be referenced. It can be a maximum of 255 characters. All paths
begin with a forward slash ('/'). If a Function Version creation
request is submitted with a path not containing a leading slash, the
path will automatically be prepended with one.
x-twilio:
pii:
handling: standard
deleteSla: 7
visibility:
type: string
$ref: '#/components/schemas/function_version_enum_visibility'
nullable: true
description: >-
The access control that determines how the Function Version resource
can be accessed. Can be: `public`, `protected`, or `private`.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Function Version resource was
created specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Function Version resource.
links:
type: object
format: uri-map
nullable: true
function_version_enum_visibility:
type: string
enum:
- public
- private
- protected
serverless.v1.service.function.function_version.function_version_content:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZN[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Function Version
resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Function Version resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Service that the Function Version resource is
associated with.
function_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZH[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Function that is the parent of the Function Version.
content:
type: string
nullable: true
description: The content of the Function Version resource.
url:
type: string
format: uri
nullable: true
serverless.v1.service.environment.log:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^NO[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Log resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Log resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Service that the Log resource is associated with.
environment_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZE[0-9a-fA-F]{32}$
nullable: true
description: The SID of the environment in which the log occurred.
build_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZB[0-9a-fA-F]{32}$
nullable: true
description: The SID of the build that corresponds to the log.
deployment_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZD[0-9a-fA-F]{32}$
nullable: true
description: The SID of the deployment that corresponds to the log.
function_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZH[0-9a-fA-F]{32}$
nullable: true
description: The SID of the function whose invocation produced the log.
request_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^RQ[0-9a-fA-F]{32}$
nullable: true
description: The SID of the request associated with the log.
level:
type: string
$ref: '#/components/schemas/log_enum_level'
nullable: true
description: 'The log level. Can be: `info`, `warn`, or `error`.'
message:
type: string
nullable: true
description: The log message.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Log resource was created specified
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Log resource.
log_enum_level:
type: string
enum:
- info
- warn
- error
serverless.v1.service:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Service resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Service resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the Service resource.
x-twilio:
pii:
handling: standard
deleteSla: 7
unique_name:
type: string
nullable: true
description: >-
A user-defined string that uniquely identifies the Service resource.
It can be used in place of the Service resource's `sid` in the URL
to address the Service resource.
x-twilio:
pii:
handling: standard
deleteSla: 7
include_credentials:
type: boolean
nullable: true
description: >-
Whether to inject Account credentials into a function invocation
context.
ui_editable:
type: boolean
nullable: true
description: >-
Whether the Service resource's properties and subresources can be
edited via the UI.
domain_base:
type: string
nullable: true
description: >-
The base domain name for this Service, which is a combination of the
unique name and a randomly generated string.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Service resource was created
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Service resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Service resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of the Service's nested resources.
serverless.v1.service.environment.variable:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZV[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Variable resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Variable resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Service that the Variable resource is associated
with.
environment_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ZE[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Environment in which the Variable exists.
key:
type: string
nullable: true
description: A string by which the Variable resource can be referenced.
x-twilio:
pii:
handling: standard
deleteSla: 7
value:
type: string
nullable: true
description: A string that contains the actual value of the Variable.
x-twilio:
pii:
handling: standard
deleteSla: 7
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Variable resource was created
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Variable resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Variable resource.
ListAssetResponse:
type: object
properties:
assets:
type: array
items:
$ref: '#/components/schemas/serverless.v1.service.asset'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
CreateAssetRequest:
type: object
required:
- FriendlyName
properties:
FriendlyName:
type: string
description: >-
A descriptive string that you create to describe the Asset resource.
It can be a maximum of 255 characters.
UpdateAssetRequest:
type: object
required:
- FriendlyName
properties:
FriendlyName:
type: string
description: >-
A descriptive string that you create to describe the Asset resource.
It can be a maximum of 255 characters.
ListAssetVersionResponse:
type: object
properties:
asset_versions:
type: array
items:
$ref: '#/components/schemas/serverless.v1.service.asset.asset_version'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
ListBuildResponse:
type: object
properties:
builds:
type: array
items:
$ref: '#/components/schemas/serverless.v1.service.build'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
CreateBuildRequest:
type: object
properties:
AssetVersions:
type: array
items:
type: string
minLength: 34
maxLength: 34
pattern: ^ZN[0-9a-fA-F]{32}$
description: The list of Asset Version resource SIDs to include in the Build.
FunctionVersions:
type: array
items:
type: string
minLength: 34
maxLength: 34
pattern: ^ZN[0-9a-fA-F]{32}$
description: >-
The list of the Function Version resource SIDs to include in the
Build.
Dependencies:
type: string
descri
# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/serverless-openapi-original.yml