Chapter 8. Cloud Sources Service
8.1. Cloud Sources Service Copy linkLink copied to clipboard!
8.1.1. CountCloudSources Copy linkLink copied to clipboard!
GET /v1/count/cloud-sources
CountCloudSources returns the number of cloud sources after filtering by requested fields.
8.1.1.1. Description Copy linkLink copied to clipboard!
8.1.1.2. Parameters Copy linkLink copied to clipboard!
8.1.1.2.1. Query Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| filter.names |
Matches cloud sources based on their name. | - | null | |
| filter.types |
Matches cloud sources based on their type. | - | null |
8.1.1.3. Return Type Copy linkLink copied to clipboard!
8.1.1.4. Content Type Copy linkLink copied to clipboard!
- application/json
8.1.1.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
8.1.1.6. Samples Copy linkLink copied to clipboard!
8.1.2. CreateCloudSource Copy linkLink copied to clipboard!
POST /v1/cloud-sources
CreateCloudSource creates a cloud source.
8.1.2.1. Description Copy linkLink copied to clipboard!
8.1.2.2. Parameters Copy linkLink copied to clipboard!
8.1.2.2.1. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
8.1.2.3. Return Type Copy linkLink copied to clipboard!
8.1.2.4. Content Type Copy linkLink copied to clipboard!
- application/json
8.1.2.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
8.1.2.6. Samples Copy linkLink copied to clipboard!
8.1.3. DeleteCloudSource Copy linkLink copied to clipboard!
DELETE /v1/cloud-sources/{id}
DeleteCloudSource removes a cloud source.
8.1.3.1. Description Copy linkLink copied to clipboard!
8.1.3.2. Parameters Copy linkLink copied to clipboard!
8.1.3.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
8.1.3.3. Return Type Copy linkLink copied to clipboard!
Object
8.1.3.4. Content Type Copy linkLink copied to clipboard!
- application/json
8.1.3.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
8.1.3.6. Samples Copy linkLink copied to clipboard!
8.1.4. GetCloudSource Copy linkLink copied to clipboard!
GET /v1/cloud-sources/{id}
GetCloudSource retrieves a cloud source by ID.
8.1.4.1. Description Copy linkLink copied to clipboard!
8.1.4.2. Parameters Copy linkLink copied to clipboard!
8.1.4.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
8.1.4.3. Return Type Copy linkLink copied to clipboard!
8.1.4.4. Content Type Copy linkLink copied to clipboard!
- application/json
8.1.4.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
8.1.4.6. Samples Copy linkLink copied to clipboard!
8.1.5. ListCloudSources Copy linkLink copied to clipboard!
GET /v1/cloud-sources
ListCloudSources returns the list of cloud sources after filtered by requested fields.
8.1.5.1. Description Copy linkLink copied to clipboard!
8.1.5.2. Parameters Copy linkLink copied to clipboard!
8.1.5.2.1. Query Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null | ||
| filter.names |
Matches cloud sources based on their name. | - | null | |
| filter.types |
Matches cloud sources based on their type. | - | null |
8.1.5.3. Return Type Copy linkLink copied to clipboard!
8.1.5.4. Content Type Copy linkLink copied to clipboard!
- application/json
8.1.5.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
8.1.5.6. Samples Copy linkLink copied to clipboard!
8.1.6. TestCloudSource Copy linkLink copied to clipboard!
POST /v1/cloud-sources/test
TestCloudSource tests a cloud source.
8.1.6.1. Description Copy linkLink copied to clipboard!
8.1.6.2. Parameters Copy linkLink copied to clipboard!
8.1.6.2.1. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
8.1.6.3. Return Type Copy linkLink copied to clipboard!
Object
8.1.6.4. Content Type Copy linkLink copied to clipboard!
- application/json
8.1.6.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
8.1.6.6. Samples Copy linkLink copied to clipboard!
8.1.7. UpdateCloudSource Copy linkLink copied to clipboard!
PUT /v1/cloud-sources/{cloudSource.id}
UpdateCloudSource creates or replaces a cloud source.
8.1.7.1. Description Copy linkLink copied to clipboard!
8.1.7.2. Parameters Copy linkLink copied to clipboard!
8.1.7.2.1. Path Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| cloudSource.id | X | null |
8.1.7.2.2. Body Parameter Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
8.1.7.3. Return Type Copy linkLink copied to clipboard!
Object
8.1.7.4. Content Type Copy linkLink copied to clipboard!
- application/json
8.1.7.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |