{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "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": { "$ref": "#/components/schemas/asset_version_enum_visibility" }, "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" ], "description": "The access control that determines how the Asset Version resource can be accessed. Can be: `public`, `protected`, or `private`." }, "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": { "$ref": "#/components/schemas/build_enum_status" }, "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": { "$ref": "#/components/schemas/build_enum_runtime" }, "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" ], "description": "The status of the Build. Can be: `building`, `completed`, or `failed`." }, "build_enum_runtime": { "type": "string", "enum": [ "node8", "node10", "node12", "node14", "node16", "node18", "node20", "node22" ], "description": "The Runtime version that will be used to run the Build resource when it is deployed." }, "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": { "$ref": "#/components/schemas/build_status_enum_status" }, "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" ], "description": "The status of the Build. Can be: `building`, `completed`, or `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": { "$ref": "#/components/schemas/function_version_enum_visibility" }, "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" ], "description": "The access control that determines how the Function Version resource can be accessed. Can be: `public`, `protected`, or `private`." }, "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", "nullable": true, "description": "The log level." }, "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." } } }, "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." } } } } }, "info": { "title": "Twilio - Serverless", "description": "This is the public Twilio REST API.", "termsOfService": "https://www.twilio.com/legal/tos", "contact": { "name": "Twilio Support", "url": "https://support.twilio.com", "email": "support@twilio.com" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0", "x-twilio": { "apiStandards": "v0.1" } }, "openapi": "3.0.1", "paths": { "/v1/Services/{ServiceSid}/Assets": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A wrapper that represents a static file and groups the different Versions of the static file.", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "dependentProperties": { "asset_versions": { "mapping": { "service_sid": "service_sid", "asset_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Assets/{asset_sid}/Versions" } }, "parent": "/Services/{Sid}", "pathType": "list" }, "get": { "description": "Retrieve a list of all Assets.", "summary": "Retrieve a list of all Assets.", "tags": [ "ServerlessV1Asset" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to read the Asset resources from.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "assets": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service.asset" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListAssetResponse" }, "examples": { "readEmpty": { "value": { "assets": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0", "key": "assets", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListAsset" }, "post": { "description": "Create a new Asset resource.", "summary": "Create a new Asset resource.", "tags": [ "ServerlessV1Asset" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to create the Asset resource under.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset" }, "examples": { "create": { "value": { "sid": "ZH00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "friendly_name": "asset-friendly", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000", "links": { "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateAsset", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateAssetRequest", "properties": { "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the Asset resource. It can be a maximum of 255 characters." } }, "required": [ "FriendlyName" ] }, "examples": { "create": { "value": { "FriendlyName": "asset-friendly" } } } } } } } }, "/v1/Services/{ServiceSid}/Assets/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A wrapper that represents a static file and groups the different Versions of the static file.", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "dependentProperties": { "asset_versions": { "mapping": { "service_sid": "service_sid", "asset_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Assets/{asset_sid}/Versions" } }, "parent": "/Services/{Sid}", "pathType": "instance" }, "get": { "description": "Retrieve a specific Asset resource.", "summary": "Retrieve a specific Asset resource.", "tags": [ "ServerlessV1Asset" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Asset resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID that identifies the Asset resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset" }, "examples": { "fetch": { "value": { "sid": "ZH00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "friendly_name": "test-asset", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000", "links": { "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchAsset" }, "delete": { "description": "Delete an Asset resource.", "summary": "Delete an Asset resource.", "tags": [ "ServerlessV1Asset" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to delete the Asset resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID that identifies the Asset resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteAsset" }, "post": { "description": "Update a specific Asset resource.", "summary": "Update a specific Asset resource.", "tags": [ "ServerlessV1Asset" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to update the Asset resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID that identifies the Asset resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset" }, "examples": { "update": { "value": { "sid": "ZH00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "friendly_name": "asset-friendly-update", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000", "links": { "asset_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateAsset", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateAssetRequest", "properties": { "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the Asset resource. It can be a maximum of 255 characters." } }, "required": [ "FriendlyName" ] }, "examples": { "update": { "value": { "FriendlyName": "asset-friendly-update" } } } } } } } }, "/v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "The content of an Asset.", "x-twilio": { "defaultOutputProperties": [ "sid", "path", "visibility", "date_created" ], "parent": "/Services/{ServiceSid}/Assets/{Sid}", "mountName": "asset_versions", "pathType": "list" }, "get": { "description": "Retrieve a list of all Asset Versions.", "summary": "Retrieve a list of all Asset Versions.", "tags": [ "ServerlessV1AssetVersion" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to read the Asset Version resource from.", "schema": { "type": "string" }, "required": true }, { "name": "AssetSid", "in": "path", "description": "The SID of the Asset resource that is the parent of the Asset Version resources to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "asset_versions": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service.asset.asset_version" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListAssetVersionResponse" }, "examples": { "readEmpty": { "value": { "asset_versions": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0", "key": "asset_versions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListAssetVersion" } }, "/v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "The content of an Asset.", "x-twilio": { "defaultOutputProperties": [ "sid", "path", "visibility", "date_created" ], "parent": "/Services/{ServiceSid}/Assets/{Sid}", "mountName": "asset_versions", "pathType": "instance" }, "get": { "description": "Retrieve a specific Asset Version.", "summary": "Retrieve a specific Asset Version.", "tags": [ "ServerlessV1AssetVersion" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Asset Version resource from.", "schema": { "type": "string" }, "required": true }, { "name": "AssetSid", "in": "path", "description": "The SID of the Asset resource that is the parent of the Asset Version resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Asset Version resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZN[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.asset.asset_version" }, "examples": { "fetch": { "value": { "sid": "ZN00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "asset_sid": "ZH00000000000000000000000000000000", "path": "/test-path", "visibility": "public", "date_created": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchAssetVersion" } }, "/v1/Services/{ServiceSid}/Builds": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A collection of Function Versions, Asset Versions, Dependencies, and a Runtime that form a deployable unit.", "x-twilio": { "defaultOutputProperties": [ "sid", "status", "date_created" ], "dependentProperties": { "build_status": { "mapping": { "service_sid": "service_sid", "sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Builds/{sid}/Status" } }, "parent": "/Services/{Sid}", "pathType": "list" }, "get": { "description": "Retrieve a list of all Builds.", "summary": "Retrieve a list of all Builds.", "tags": [ "ServerlessV1Build" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to read the Build resources from.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "builds": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service.build" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListBuildResponse" }, "examples": { "readEmpty": { "value": { "builds": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0", "key": "builds", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListBuild" }, "post": { "description": "Create a new Build resource. At least one function version or asset version is required.", "summary": "Create a new Build resource. At least one function version or asset version is required.", "tags": [ "ServerlessV1Build" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to create the Build resource under.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.build" }, "examples": { "create": { "value": { "sid": "ZB00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "asset_versions": [ { "sid": "ZN00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "asset_sid": "ZH00000000000000000000000000000000", "date_created": "2018-11-10T20:00:00Z", "path": "/asset-path", "visibility": "PUBLIC" } ], "function_versions": [ { "sid": "ZN00000000000000000000000000000001", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "function_sid": "ZH00000000000000000000000000000001", "date_created": "2018-11-10T20:00:00Z", "path": "/function-path", "visibility": "PUBLIC" } ], "dependencies": [ { "name": "twilio", "version": "3.29.2" }, { "name": "@twilio/runtime-handler", "version": "1.0.1" } ], "runtime": "node22", "status": "building", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000", "links": { "build_status": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateBuild", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateBuildRequest", "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", "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", "description": "The Runtime version that will be used to run the Build resource when it is deployed." } } }, "examples": { "create": { "value": { "AssetVersions": [ "ZN00000000000000000000000000000000" ], "FunctionVersions": [ "ZN00000000000000000000000000000001" ], "Dependencies": "[{\"name\":\"twilio\", \"version\":\"3.29.2\"}, {\"name\":\"@twilio/runtime-handler\", \"version\": \"1.0.1\"}]" } } } } } } } }, "/v1/Services/{ServiceSid}/Builds/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A collection of Function Versions, Asset Versions, Dependencies, and a Runtime that form a deployable unit.", "x-twilio": { "defaultOutputProperties": [ "sid", "status", "date_created" ], "dependentProperties": { "build_status": { "mapping": { "service_sid": "service_sid", "sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Builds/{sid}/Status" } }, "parent": "/Services/{Sid}", "pathType": "instance" }, "get": { "description": "Retrieve a specific Build resource.", "summary": "Retrieve a specific Build resource.", "tags": [ "ServerlessV1Build" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Build resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Build resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.build" }, "examples": { "fetch": { "value": { "sid": "ZB00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "asset_versions": [ { "sid": "ZN00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "asset_sid": "ZH00000000000000000000000000000000", "date_created": "2018-11-10T20:00:00Z", "path": "/asset-path", "visibility": "PUBLIC" } ], "function_versions": [ { "sid": "ZN00000000000000000000000000000001", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "function_sid": "ZH00000000000000000000000000000001", "date_created": "2018-11-10T20:00:00Z", "path": "/function-path", "visibility": "PUBLIC" } ], "dependencies": [ { "name": "twilio", "version": "3.29.2" }, { "name": "@twilio/runtime-handler", "version": "1.0.1" } ], "runtime": "node22", "status": "building", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000", "links": { "build_status": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchBuild" }, "delete": { "description": "Delete a Build resource.", "summary": "Delete a Build resource.", "tags": [ "ServerlessV1Build" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to delete the Build resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Build resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteBuild" } }, "/v1/Services/{ServiceSid}/Builds/{Sid}/Status": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "The status of a Build resource.", "x-twilio": { "defaultOutputProperties": [ "sid", "status" ], "parent": "/Services/{ServiceSid}/Builds/{Sid}", "mountName": "build_status", "pathType": "instance" }, "get": { "description": "Retrieve a specific Build resource.", "summary": "Retrieve a specific Build resource.", "tags": [ "ServerlessV1BuildStatus" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Build resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Build resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZB[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.build.build_status" }, "examples": { "fetch": { "value": { "sid": "ZB00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "status": "completed", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds/ZB00000000000000000000000000000000/Status" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchBuildStatus" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "An association of a Build with an Environment so that the Build is published in the Environment.", "x-twilio": { "defaultOutputProperties": [ "sid", "build_sid", "date_created" ], "parent": "/Services/{ServiceSid}/Environments/{Sid}", "pathType": "list" }, "get": { "description": "Retrieve a list of all Deployments.", "summary": "Retrieve a list of all Deployments.", "tags": [ "ServerlessV1Deployment" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to read the Deployment resources from.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the Environment used by the Deployment resources to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "deployments": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service.environment.deployment" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListDeploymentResponse" }, "examples": { "readEmpty": { "value": { "deployments": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0", "key": "deployments", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListDeployment" }, "post": { "description": "Create a new Deployment.", "summary": "Create a new Deployment.", "tags": [ "ServerlessV1Deployment" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to create the Deployment resource under.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the Environment for the Deployment.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.deployment" }, "examples": { "create": { "value": { "sid": "ZD00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "environment_sid": "ZE00000000000000000000000000000000", "build_sid": "ZB00000000000000000000000000000000", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateDeployment", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateDeploymentRequest", "properties": { "BuildSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZB[0-9a-fA-F]{32}$", "description": "The SID of the Build for the Deployment." }, "IsPlugin": { "type": "boolean", "description": "Whether the Deployment is a plugin." } } }, "examples": { "create": { "value": { "BuildSid": "ZB00000000000000000000000000000000", "IsPlugin": false } } } } } } } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "An association of a Build with an Environment so that the Build is published in the Environment.", "x-twilio": { "defaultOutputProperties": [ "sid", "build_sid", "date_created" ], "parent": "/Services/{ServiceSid}/Environments/{Sid}", "pathType": "instance" }, "get": { "description": "Retrieve a specific Deployment.", "summary": "Retrieve a specific Deployment.", "tags": [ "ServerlessV1Deployment" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Deployment resource from.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the Environment used by the Deployment to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID that identifies the Deployment resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZD[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.deployment" }, "examples": { "fetch": { "value": { "sid": "ZD00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "environment_sid": "ZE00000000000000000000000000000000", "build_sid": "ZB00000000000000000000000000000000", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments/ZD00000000000000000000000000000000" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchDeployment" } }, "/v1/Services/{ServiceSid}/Environments": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "Represents a deployed build of a given set of Functions and/or Assets at a specific URL.", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "domain_name", "build_sid" ], "dependentProperties": { "variables": { "mapping": { "service_sid": "service_sid", "environment_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Variables" }, "deployments": { "mapping": { "service_sid": "service_sid", "environment_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Deployments" }, "logs": { "mapping": { "service_sid": "service_sid", "environment_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Logs" } }, "parent": "/Services/{Sid}", "pathType": "list" }, "get": { "description": "Retrieve a list of all environments.", "summary": "Retrieve a list of all environments.", "tags": [ "ServerlessV1Environment" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to read the Environment resources from.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "environments": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service.environment" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListEnvironmentResponse" }, "examples": { "readEmpty": { "value": { "environments": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0", "key": "environments", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListEnvironment" }, "post": { "description": "Create a new environment.", "summary": "Create a new environment.", "tags": [ "ServerlessV1Environment" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to create the Environment resource under.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment" }, "examples": { "create": { "value": { "sid": "ZE00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "build_sid": null, "unique_name": "staging", "domain_suffix": "stage", "domain_name": "foobar-1234-stage.twil.io", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000", "links": { "variables": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables", "deployments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments", "logs": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateEnvironment", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateEnvironmentRequest", "properties": { "UniqueName": { "type": "string", "description": "A user-defined string that uniquely identifies the Environment resource. It can be a maximum of 100 characters." }, "DomainSuffix": { "type": "string", "description": "A URL-friendly name that represents the environment and forms part of the domain name. It can be a maximum of 16 characters." } }, "required": [ "UniqueName" ] }, "examples": { "create": { "value": { "UniqueName": "staging", "DomainSuffix": "stage" } } } } } } } }, "/v1/Services/{ServiceSid}/Environments/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "Represents a deployed build of a given set of Functions and/or Assets at a specific URL.", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "domain_name", "build_sid" ], "dependentProperties": { "variables": { "mapping": { "service_sid": "service_sid", "environment_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Variables" }, "deployments": { "mapping": { "service_sid": "service_sid", "environment_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Deployments" }, "logs": { "mapping": { "service_sid": "service_sid", "environment_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Environments/{environment_sid}/Logs" } }, "parent": "/Services/{Sid}", "pathType": "instance" }, "get": { "description": "Retrieve a specific environment.", "summary": "Retrieve a specific environment.", "tags": [ "ServerlessV1Environment" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Environment resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Environment resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment" }, "examples": { "fetch": { "value": { "sid": "ZE00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "build_sid": "ZB00000000000000000000000000000000", "unique_name": "testing-environment", "domain_suffix": "testing", "domain_name": "foobar-1234-testing.twil.io", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000", "links": { "variables": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables", "deployments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Deployments", "logs": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchEnvironment" }, "delete": { "description": "Delete a specific environment.", "summary": "Delete a specific environment.", "tags": [ "ServerlessV1Environment" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to delete the Environment resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Environment resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteEnvironment" } }, "/v1/Services/{ServiceSid}/Functions": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A wrapper that represents a Serverless JavaScript function and groups the different and groups the different Versions of this code.", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "dependentProperties": { "function_versions": { "mapping": { "service_sid": "service_sid", "function_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions" } }, "parent": "/Services/{Sid}", "pathType": "list" }, "get": { "description": "Retrieve a list of all Functions.", "summary": "Retrieve a list of all Functions.", "tags": [ "ServerlessV1Function" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to read the Function resources from.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "functions": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service.function" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListFunctionResponse" }, "examples": { "readEmpty": { "value": { "functions": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0", "key": "functions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListFunction" }, "post": { "description": "Create a new Function resource.", "summary": "Create a new Function resource.", "tags": [ "ServerlessV1Function" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to create the Function resource under.", "schema": { "type": "string" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function" }, "examples": { "create": { "value": { "sid": "ZH00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "friendly_name": "function-friendly", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000", "links": { "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateFunction", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateFunctionRequest", "properties": { "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters." } }, "required": [ "FriendlyName" ] }, "examples": { "create": { "value": { "FriendlyName": "function-friendly" } } } } } } } }, "/v1/Services/{ServiceSid}/Functions/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A wrapper that represents a Serverless JavaScript function and groups the different and groups the different Versions of this code.", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "dependentProperties": { "function_versions": { "mapping": { "service_sid": "service_sid", "function_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions" } }, "parent": "/Services/{Sid}", "pathType": "instance" }, "get": { "description": "Retrieve a specific Function resource.", "summary": "Retrieve a specific Function resource.", "tags": [ "ServerlessV1Function" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Function resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Function resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function" }, "examples": { "fetch": { "value": { "sid": "ZH00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "friendly_name": "test-function", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000", "links": { "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchFunction" }, "delete": { "description": "Delete a Function resource.", "summary": "Delete a Function resource.", "tags": [ "ServerlessV1Function" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to delete the Function resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Function resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteFunction" }, "post": { "description": "Update a specific Function resource.", "summary": "Update a specific Function resource.", "tags": [ "ServerlessV1Function" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to update the Function resource from.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Function resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function" }, "examples": { "update": { "value": { "sid": "ZH00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "friendly_name": "function-friendly-update", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000", "links": { "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateFunction", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateFunctionRequest", "properties": { "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters." } }, "required": [ "FriendlyName" ] }, "examples": { "update": { "value": { "FriendlyName": "function-friendly-update" } } } } } } } }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "The content of a Function.", "x-twilio": { "defaultOutputProperties": [ "sid", "path", "visibility", "date_created" ], "dependentProperties": { "function_version_content": { "mapping": { "service_sid": "service_sid", "function_sid": "function_sid", "sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content" } }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", "mountName": "function_versions", "pathType": "list" }, "get": { "description": "Retrieve a list of all Function Version resources.", "summary": "Retrieve a list of all Function Version resources.", "tags": [ "ServerlessV1FunctionVersion" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to read the Function Version resources from.", "schema": { "type": "string" }, "required": true }, { "name": "FunctionSid", "in": "path", "description": "The SID of the function that is the parent of the Function Version resources to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "function_versions": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service.function.function_version" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListFunctionVersionResponse" }, "examples": { "readEmpty": { "value": { "function_versions": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0", "key": "function_versions", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListFunctionVersion" } }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "The content of a Function.", "x-twilio": { "defaultOutputProperties": [ "sid", "path", "visibility", "date_created" ], "dependentProperties": { "function_version_content": { "mapping": { "service_sid": "service_sid", "function_sid": "function_sid", "sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Functions/{function_sid}/Versions/{sid}/Content" } }, "parent": "/Services/{ServiceSid}/Functions/{Sid}", "mountName": "function_versions", "pathType": "instance" }, "get": { "description": "Retrieve a specific Function Version resource.", "summary": "Retrieve a specific Function Version resource.", "tags": [ "ServerlessV1FunctionVersion" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Function Version resource from.", "schema": { "type": "string" }, "required": true }, { "name": "FunctionSid", "in": "path", "description": "The SID of the function that is the parent of the Function Version resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Function Version resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZN[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function.function_version" }, "examples": { "fetch": { "value": { "sid": "ZN00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "function_sid": "ZH00000000000000000000000000000000", "path": "/test-path", "visibility": "public", "date_created": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000", "links": { "function_version_content": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchFunctionVersion" } }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}/Content": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "The code of a Function Version.", "x-twilio": { "defaultOutputProperties": [ "sid", "content" ], "parent": "/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}", "mountName": "function_version_content", "pathType": "instance" }, "get": { "description": "Retrieve a the content of a specific Function Version resource.", "summary": "Retrieve a the content of a specific Function Version resource.", "tags": [ "ServerlessV1FunctionVersionContent" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Function Version content from.", "schema": { "type": "string" }, "required": true }, { "name": "FunctionSid", "in": "path", "description": "The SID of the Function that is the parent of the Function Version content to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Function Version content to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZN[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.function.function_version.function_version_content" }, "examples": { "fetch": { "value": { "sid": "ZN00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "function_sid": "ZH00000000000000000000000000000000", "content": "exports.handler = function (context, event, callback) {\n const request = require(\"request\");\n return request(\"http://www.google.com\", function (error, response, body) {\n callback(null, response.statusCode);\n });\n};", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions/ZN00000000000000000000000000000000/Content" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchFunctionVersionContent" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A record of an event that occurred related to a function invocation.", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Environments/{Sid}", "pathType": "list" }, "get": { "description": "Retrieve a list of all logs.", "summary": "Retrieve a list of all logs.", "tags": [ "ServerlessV1Log" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to read the Log resource from.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the environment with the Log resources to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "FunctionSid", "in": "query", "description": "The SID of the function whose invocation produced the Log resources to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZH[0-9a-fA-F]{32}$" }, "examples": { "readEmpty": { "value": "ZH00000000000000000000000000000000" } } }, { "name": "StartDate", "in": "query", "description": "The date/time (in GMT, ISO 8601) after which the Log resources must have been created. Defaults to 1 day prior to current date/time.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readEmpty": { "value": "2018-11-10T20:00:00Z" } } }, { "name": "EndDate", "in": "query", "description": "The date/time (in GMT, ISO 8601) before which the Log resources must have been created. Defaults to current date/time.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readEmpty": { "value": "2018-12-10T20:00:00Z" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "logs": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service.environment.log" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListLogResponse" }, "examples": { "readEmpty": { "value": { "logs": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0", "key": "logs", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs?StartDate=2018-11-10T20%3A00%3A00Z&EndDate=2018-12-10T20%3A00%3A00Z&FunctionSid=ZH00000000000000000000000000000000&PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListLog" } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Logs/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A record of an event that occurred related to a function invocation.", "x-twilio": { "defaultOutputProperties": [], "parent": "/Services/{ServiceSid}/Environments/{Sid}", "pathType": "instance" }, "get": { "description": "Retrieve a specific log.", "summary": "Retrieve a specific log.", "tags": [ "ServerlessV1Log" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Log resource from.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the environment with the Log resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Log resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^NO[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.log" }, "examples": { "fetch": { "value": { "sid": "NO00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "environment_sid": "ZE00000000000000000000000000000000", "build_sid": "ZB00000000000000000000000000000000", "deployment_sid": "ZD00000000000000000000000000000000", "function_sid": "ZH00000000000000000000000000000000", "request_sid": "RQ00000000000000000000000000000000", "level": "warning", "message": "This is a warning", "date_created": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Logs/NO00000000000000000000000000000000" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchLog" } }, "/v1/Services": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "The top-level resource for a Serverless application, which serves as a container for the application environments.", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], "dependentProperties": { "environments": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Environments" }, "functions": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Functions" }, "assets": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Assets" }, "builds": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Builds" } }, "pathType": "list" }, "get": { "description": "Retrieve a list of all Services.", "summary": "Retrieve a list of all Services.", "tags": [ "ServerlessV1Service" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListServiceResponse" }, "examples": { "readEmpty": { "value": { "services": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services?PageSize=50&Page=0", "key": "services", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListService" }, "post": { "description": "Create a new Service resource.", "summary": "Create a new Service resource.", "tags": [ "ServerlessV1Service" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service" }, "examples": { "create": { "value": { "sid": "ZS00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "service-friendly", "unique_name": "service-unique", "include_credentials": true, "ui_editable": false, "domain_base": "service-unique-1234", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000", "links": { "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments", "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions", "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets", "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateServiceRequest", "properties": { "UniqueName": { "type": "string", "description": "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." }, "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the Service resource. It can be a maximum of 255 characters." }, "IncludeCredentials": { "type": "boolean", "description": "Whether to inject Account credentials into a function invocation context. The default value is `true`." }, "UiEditable": { "type": "boolean", "description": "Whether the Service's properties and subresources can be edited via the UI. The default value is `false`." } }, "required": [ "UniqueName", "FriendlyName" ] }, "examples": { "create": { "value": { "FriendlyName": "service-friendly", "UniqueName": "service-unique" } } } } } } } }, "/v1/Services/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "The top-level resource for a Serverless application, which serves as a container for the application environments.", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name" ], "dependentProperties": { "environments": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Environments" }, "functions": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Functions" }, "assets": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Assets" }, "builds": { "mapping": { "service_sid": "sid" }, "resource_url": "/v1/Services/{service_sid}/Builds" } }, "pathType": "instance" }, "get": { "description": "Retrieve a specific Service resource.", "summary": "Retrieve a specific Service resource.", "tags": [ "ServerlessV1Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The `sid` or `unique_name` of the Service resource to fetch.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service" }, "examples": { "fetch": { "value": { "sid": "ZS00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "test-service", "unique_name": "test-service-1", "include_credentials": true, "ui_editable": false, "domain_base": "test-service-1-1234", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000", "links": { "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments", "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions", "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets", "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchService" }, "delete": { "description": "Delete a Service resource.", "summary": "Delete a Service resource.", "tags": [ "ServerlessV1Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The `sid` or `unique_name` of the Service resource to delete.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteService" }, "post": { "description": "Update a specific Service resource.", "summary": "Update a specific Service resource.", "tags": [ "ServerlessV1Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The `sid` or `unique_name` of the Service resource to update.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service" }, "examples": { "update": { "value": { "sid": "ZS00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "service-friendly-update", "unique_name": "service-unique-update", "include_credentials": true, "ui_editable": true, "domain_base": "service-unique-update-1234", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000", "links": { "environments": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments", "functions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions", "assets": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Assets", "builds": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Builds" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateServiceRequest", "properties": { "IncludeCredentials": { "type": "boolean", "description": "Whether to inject Account credentials into a function invocation context." }, "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the Service resource. It can be a maximum of 255 characters." }, "UiEditable": { "type": "boolean", "description": "Whether the Service resource's properties and subresources can be edited via the UI. The default value is `false`." } } }, "examples": { "update": { "value": { "FriendlyName": "service-friendly-update", "IncludeCredentials": true, "UiEditable": true } } } } } } } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A key and value pair that is specific to an Environment.", "x-twilio": { "defaultOutputProperties": [ "sid", "key", "date_created" ], "parent": "/Services/{ServiceSid}/Environments/{Sid}", "pathType": "list" }, "get": { "description": "Retrieve a list of all Variables.", "summary": "Retrieve a list of all Variables.", "tags": [ "ServerlessV1Variable" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to read the Variable resources from.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the Environment with the Variable resources to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "variables": { "type": "array", "items": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListVariableResponse" }, "examples": { "readEmpty": { "value": { "variables": [], "meta": { "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0", "key": "variables", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables?PageSize=50&Page=0" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListVariable" }, "post": { "description": "Create a new Variable.", "summary": "Create a new Variable.", "tags": [ "ServerlessV1Variable" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to create the Variable resource under.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the Environment in which the Variable resource exists.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" }, "examples": { "create": { "value": { "sid": "ZV00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "environment_sid": "ZE00000000000000000000000000000000", "key": "new-key", "value": "new-value", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateVariable", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateVariableRequest", "properties": { "Key": { "type": "string", "description": "A string by which the Variable resource can be referenced. It can be a maximum of 128 characters." }, "Value": { "type": "string", "description": "A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size." } }, "required": [ "Key", "Value" ] }, "examples": { "create": { "value": { "Key": "new-key", "Value": "new-value" } } } } } } } }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid}": { "servers": [ { "url": "https://serverless.twilio.com" } ], "description": "A key and value pair that is specific to an Environment.", "x-twilio": { "defaultOutputProperties": [ "sid", "key", "date_created" ], "parent": "/Services/{ServiceSid}/Environments/{Sid}", "pathType": "instance" }, "get": { "description": "Retrieve a specific Variable.", "summary": "Retrieve a specific Variable.", "tags": [ "ServerlessV1Variable" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to fetch the Variable resource from.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the Environment with the Variable resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Variable resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZV[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" }, "examples": { "fetch": { "value": { "sid": "ZV00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "environment_sid": "ZE00000000000000000000000000000000", "key": "test-key", "value": "test-value", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-10T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchVariable" }, "post": { "description": "Update a specific Variable.", "summary": "Update a specific Variable.", "tags": [ "ServerlessV1Variable" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to update the Variable resource under.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the Environment with the Variable resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Variable resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZV[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serverless.v1.service.environment.variable" }, "examples": { "update": { "value": { "sid": "ZV00000000000000000000000000000000", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "ZS00000000000000000000000000000000", "environment_sid": "ZE00000000000000000000000000000000", "key": "update-key", "value": "update-value", "date_created": "2018-11-10T20:00:00Z", "date_updated": "2018-11-11T20:00:00Z", "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Environments/ZE00000000000000000000000000000000/Variables/ZV00000000000000000000000000000000" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateVariable", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateVariableRequest", "properties": { "Key": { "type": "string", "description": "A string by which the Variable resource can be referenced. It can be a maximum of 128 characters." }, "Value": { "type": "string", "description": "A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size." } } }, "examples": { "update": { "value": { "Key": "update-key", "Value": "update-value" } } } } } } }, "delete": { "description": "Delete a specific Variable.", "summary": "Delete a specific Variable.", "tags": [ "ServerlessV1Variable" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The SID of the Service to delete the Variable resource from.", "schema": { "type": "string" }, "required": true }, { "name": "EnvironmentSid", "in": "path", "description": "The SID of the Environment with the Variables to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZE[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the Variable resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^ZV[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteVariable" } } }, "servers": [ { "url": "https://serverless.twilio.com" } ], "tags": [ { "name": "ServerlessV1Asset" }, { "name": "ServerlessV1AssetVersion" }, { "name": "ServerlessV1Build" }, { "name": "ServerlessV1BuildStatus" }, { "name": "ServerlessV1Deployment" }, { "name": "ServerlessV1Environment" }, { "name": "ServerlessV1Function" }, { "name": "ServerlessV1FunctionVersion" }, { "name": "ServerlessV1FunctionVersionContent" }, { "name": "ServerlessV1Log" }, { "name": "ServerlessV1Service" }, { "name": "ServerlessV1Variable" } ], "security": [ { "accountSid_authToken": [] } ] }