Skip to content

Latest commit

 

History

History
224 lines (127 loc) · 6.44 KB

ServicesApi.md

File metadata and controls

224 lines (127 loc) · 6.44 KB

ServicesApi

All URIs are relative to https://serverless.twilio.com

Method HTTP request Description
CreateService Post /v1/Services Create a new Service resource.
DeleteService Delete /v1/Services/{Sid} Delete a Service resource.
FetchService Get /v1/Services/{Sid} Retrieve a specific Service resource.
ListService Get /v1/Services Retrieve a list of all Services.
UpdateService Post /v1/Services/{Sid} Update a specific Service resource.

CreateService

ServerlessV1Service CreateService(ctx, optional)

Create a new Service resource.

Create a new Service resource.

Path Parameters

This endpoint does not need any path parameter.

Other Parameters

Other parameters are passed through a pointer to a CreateServiceParams struct

Name Type Description
UniqueName string 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 string A descriptive string that you create to describe the Service resource. It can be a maximum of 255 characters.
IncludeCredentials bool Whether to inject Account credentials into a function invocation context. The default value is true.
UiEditable bool Whether the Service's properties and subresources can be edited via the UI. The default value is false.

Return type

ServerlessV1Service

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteService

DeleteService(ctx, Sid)

Delete a Service resource.

Delete a Service resource.

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
Sid string The sid or unique_name of the Service resource to delete.

Other Parameters

Other parameters are passed through a pointer to a DeleteServiceParams struct

Name Type Description

Return type

(empty response body)

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FetchService

ServerlessV1Service FetchService(ctx, Sid)

Retrieve a specific Service resource.

Retrieve a specific Service resource.

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
Sid string The sid or unique_name of the Service resource to fetch.

Other Parameters

Other parameters are passed through a pointer to a FetchServiceParams struct

Name Type Description

Return type

ServerlessV1Service

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListService

[]ServerlessV1Service ListService(ctx, optional)

Retrieve a list of all Services.

Retrieve a list of all Services.

Path Parameters

This endpoint does not need any path parameter.

Other Parameters

Other parameters are passed through a pointer to a ListServiceParams struct

Name Type Description
PageSize int How many resources to return in each list page. The default is 50, and the maximum is 1000.
Limit int Max number of records to return.

Return type

[]ServerlessV1Service

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateService

ServerlessV1Service UpdateService(ctx, Sidoptional)

Update a specific Service resource.

Update a specific Service resource.

Path Parameters

Name Type Description
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
Sid string The sid or unique_name of the Service resource to update.

Other Parameters

Other parameters are passed through a pointer to a UpdateServiceParams struct

Name Type Description
IncludeCredentials bool Whether to inject Account credentials into a function invocation context.
FriendlyName string A descriptive string that you create to describe the Service resource. It can be a maximum of 255 characters.
UiEditable bool Whether the Service resource's properties and subresources can be edited via the UI. The default value is false.

Return type

ServerlessV1Service

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]