Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Devices REST: Deployments

Each Fleet can contain one or more Deployments. A Deployment is a grouping and configuration construct for Devices, which provides the mechanism with which Devices are provisioned and authorized to interact with eligible Twilio services.

Deployments allow the developer to:

  • Configure a group of the provisioned Devices with a single point of change
  • Split the larger Fleet into segments, with different data access requirements or patterns

For more information on managing device deployments and their dependencies, please refer to Deploying Devices documentation.

Twilio Console

You can manage Deployments of your Devices using your Twilio console when logged in to the console.

Properties

Each Deployment resource has the following properties. Some of them are optional and allowed to be null:

Names in PHP format
sid
sid<DL> Not PII

Contains a 34 character string that uniquely identifies this Deployment resource.

url
url Not PII

Contains an absolute URL for this Deployment resource.

friendlyName
string Not PII

Contains a human readable descriptive text for this Deployment, up to 64 characters long

fleetSid
sid_like<FL> Not PII

Specifies the unique string identifier of the Fleet that the given Deployment belongs to.

accountSid
sid<AC> Not PII

Specifies the unique string identifier of the Account responsible for this Deployment.

syncServiceSid
sid<IS> Not PII

Specifies the unique string identifier of the Twilio Sync service instance linked to and accessible by this Deployment.

dateCreated
date_time<iso8601> Not PII

Specifies the date this Deployment was created, given in UTC ISO 8601 format.

dateUpdated
date_time<iso8601> Not PII

Specifies the date this Deployment was last updated, given in UTC ISO 8601 format.

GET /Fleets/{FLxx|UniqueName}/Deployments

Retrieve a list of all Deployments belonging to the Fleet.

Note: By default, this will return the first 50 Deployments. Supply a PageSize parameter to fetch up to 100 items at once. See paging for more information.

        
        
        
        

        Create a Deployment

        POST /Fleets/{FLxx|UniqueName}/Deployments
        

        Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.

        Parameters

        Names in PHP format
        friendlyName
        Optional
        post string Not PII

        Provides a human readable descriptive text for this Deployment, up to 256 characters long.

        syncServiceSid
        Optional
        post sid<IS> Not PII

        Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.

              
              
              
              

              Retrieve a Deployment

              GET /Fleets/{FLxx|UniqueName}/Deployments/{DLxx}
              

              Fetch information about a specific Deployment in the Fleet.

                    
                    
                    
                    

                    Update a Deployment

                    POST /Fleets/{FLxx|UniqueName}/Deployments/{DLxx}
                    

                    Update the given properties of a specific Deployment in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.

                    Parameters

                    Names in PHP format
                    sid
                    Required
                    post sid<DL> Not PII

                    Provides a 34 character string that uniquely identifies the requested Deployment resource.

                    friendlyName
                    Optional
                    post string Not PII

                    Provides a human readable descriptive text for this Deployment, up to 64 characters long

                    syncServiceSid
                    Optional
                    post sid<IS> Not PII

                    Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.

                          
                          
                          
                          

                          Delete a Deployment

                          DELETE /Fleets/{FLxx|UniqueName}/Deployments/{DLxx}
                          

                          Delete a specific Deployment from the Fleet, leaving associated devices effectively non-deployed. Their deployment_sid attribute will automatically reset to null.

                                
                                
                                
                                
                                Rate this page:

                                Need some help?

                                We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.