github.com/twilio/twilio-go@v1.20.1/rest/serverless/v1/docs/ServicesEnvironmentsDeploymentsApi.md (about)

     1  # ServicesEnvironmentsDeploymentsApi
     2  
     3  All URIs are relative to *https://serverless.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateDeployment**](ServicesEnvironmentsDeploymentsApi.md#CreateDeployment) | **Post** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments | 
     8  [**FetchDeployment**](ServicesEnvironmentsDeploymentsApi.md#FetchDeployment) | **Get** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments/{Sid} | 
     9  [**ListDeployment**](ServicesEnvironmentsDeploymentsApi.md#ListDeployment) | **Get** /v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments | 
    10  
    11  
    12  
    13  ## CreateDeployment
    14  
    15  > ServerlessV1Deployment CreateDeployment(ctx, ServiceSidEnvironmentSidoptional)
    16  
    17  
    18  
    19  Create a new Deployment.
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **ServiceSid** | **string** | The SID of the Service to create the Deployment resource under.
    28  **EnvironmentSid** | **string** | The SID of the Environment for the Deployment.
    29  
    30  ### Other Parameters
    31  
    32  Other parameters are passed through a pointer to a CreateDeploymentParams struct
    33  
    34  
    35  Name | Type | Description
    36  ------------- | ------------- | -------------
    37  **BuildSid** | **string** | The SID of the Build for the Deployment.
    38  
    39  ### Return type
    40  
    41  [**ServerlessV1Deployment**](ServerlessV1Deployment.md)
    42  
    43  ### Authorization
    44  
    45  [accountSid_authToken](../README.md#accountSid_authToken)
    46  
    47  ### HTTP request headers
    48  
    49  - **Content-Type**: application/x-www-form-urlencoded
    50  - **Accept**: application/json
    51  
    52  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    53  [[Back to Model list]](../README.md#documentation-for-models)
    54  [[Back to README]](../README.md)
    55  
    56  
    57  ## FetchDeployment
    58  
    59  > ServerlessV1Deployment FetchDeployment(ctx, ServiceSidEnvironmentSidSid)
    60  
    61  
    62  
    63  Retrieve a specific Deployment.
    64  
    65  ### Path Parameters
    66  
    67  
    68  Name | Type | Description
    69  ------------- | ------------- | -------------
    70  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71  **ServiceSid** | **string** | The SID of the Service to fetch the Deployment resource from.
    72  **EnvironmentSid** | **string** | The SID of the Environment used by the Deployment to fetch.
    73  **Sid** | **string** | The SID that identifies the Deployment resource to fetch.
    74  
    75  ### Other Parameters
    76  
    77  Other parameters are passed through a pointer to a FetchDeploymentParams struct
    78  
    79  
    80  Name | Type | Description
    81  ------------- | ------------- | -------------
    82  
    83  ### Return type
    84  
    85  [**ServerlessV1Deployment**](ServerlessV1Deployment.md)
    86  
    87  ### Authorization
    88  
    89  [accountSid_authToken](../README.md#accountSid_authToken)
    90  
    91  ### HTTP request headers
    92  
    93  - **Content-Type**: Not defined
    94  - **Accept**: application/json
    95  
    96  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    97  [[Back to Model list]](../README.md#documentation-for-models)
    98  [[Back to README]](../README.md)
    99  
   100  
   101  ## ListDeployment
   102  
   103  > []ServerlessV1Deployment ListDeployment(ctx, ServiceSidEnvironmentSidoptional)
   104  
   105  
   106  
   107  Retrieve a list of all Deployments.
   108  
   109  ### Path Parameters
   110  
   111  
   112  Name | Type | Description
   113  ------------- | ------------- | -------------
   114  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   115  **ServiceSid** | **string** | The SID of the Service to read the Deployment resources from.
   116  **EnvironmentSid** | **string** | The SID of the Environment used by the Deployment resources to read.
   117  
   118  ### Other Parameters
   119  
   120  Other parameters are passed through a pointer to a ListDeploymentParams struct
   121  
   122  
   123  Name | Type | Description
   124  ------------- | ------------- | -------------
   125  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   126  **Limit** | **int** | Max number of records to return.
   127  
   128  ### Return type
   129  
   130  [**[]ServerlessV1Deployment**](ServerlessV1Deployment.md)
   131  
   132  ### Authorization
   133  
   134  [accountSid_authToken](../README.md#accountSid_authToken)
   135  
   136  ### HTTP request headers
   137  
   138  - **Content-Type**: Not defined
   139  - **Accept**: application/json
   140  
   141  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   142  [[Back to Model list]](../README.md#documentation-for-models)
   143  [[Back to README]](../README.md)
   144