Configuration & Settings
Services
(services)
Overview
Operations related to service configuration. A service is a collection of tools.
Available Operations
- list - Service List
- create - Create Service
- update - Update Service
- getById - Get Service By Id
- delete - Delete Service
list
List the existing services
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | operations.ServiceListRequest | TRUE | The request object to use for the request. |
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.ListResponseServiceResponse>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
create
Create a new service.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | components.ServiceCreateRequest | TRUE | The request object to use for the request. |
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.ServiceResponse>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
update
Update an existing service.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | components.ServiceUpdateRequest | TRUE | The request object to use for the request. |
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.ServiceResponse>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
getById
Get a service by its ID
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | operations.ServicesGetByIdRequest | TRUE | The request object to use for the request. |
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.ServiceResponse>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |
delete
Delete a service. A service with linked tools cannot be deleted.
Example Usage
Standalone function
The standalone function version of this method:
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | operations.ServiceDeleteRequest | TRUE | The request object to use for the request. |
options | RequestOptions | FALSE | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | FALSE | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body , are allowed. |
options.retries | RetryConfig | FALSE | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise\ANY>
Errors
Error Type | Status Code | Content Type |
---|---|---|
errors.HTTPValidationError | 422 | application/json |
errors.SDKError | 4XX, 5XX | */* |