All URIs are relative to http://localhost/api/v1
| Method | HTTP request | Description |
|---|---|---|
| DeleteConnection | Delete /connections/{connection_id} | Delete a connection entry |
| GetConnection | Get /connections/{connection_id} | Get a connection entry |
| GetConnections | Get /connections | Get all connection entries |
| PatchConnection | Patch /connections/{connection_id} | Update a connection entry |
| PostConnection | Post /connections | Create connection entry |
DeleteConnection(ctx, connectionId)
Delete a connection entry
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| connectionId | string | The Connection ID. |
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Connection GetConnection(ctx, connectionId)
Get a connection entry
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| connectionId | string | The Connection ID. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ConnectionCollection GetConnections(ctx, optional)
Get all connection entries
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetConnectionsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetConnectionsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int32 | The numbers of items to return. | [default to 100] |
| offset | optional.Int32 | The number of items to skip before starting to collect the result set. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Connection PatchConnection(ctx, connectionId, connection, optional)
Update a connection entry
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| connectionId | string | The Connection ID. | |
| connection | Connection | ||
| optional | *PatchConnectionOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PatchConnectionOpts struct
| Name | Type | Description | Notes |
|---|
updateMask | optional.Interface of []string| The fields to update on the connection (connection, pool etc). If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Connection PostConnection(ctx, connection)
Create connection entry
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| connection | Connection |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]