Farms / Cloud Services: List
Description
List of the Cloud Services linked to the current Farm.
HTTP Request
GET /api/v1beta0/user/envId/farms/farmId/cloud-services/
Parameters
Name | Required | Description | Location |
---|---|---|---|
envId integer |
Yes | The ID of the Environment scoping this request. |
path |
farmId integer |
Yes | The ID of a Farm object. |
path |
Request body
Do not supply a body with this request.
Successful Response (Status 200)
A list of FarmCloudServiceLink objects.
The API replies with a FarmCloudServiceLinkListResponse object. Example response body:
{
"data": [
{
"cloudLocation": "string",
"cloudPlatform": "aws",
"cloudServiceId": "string",
"id": "string",
"type": "FarmCloudServiceLink"
}
],
"errors": [
{
"code": "string",
"message": "string"
}
],
"meta": {
"sample": "string"
},
"pagination": {
"first": "string",
"last": "string",
"next": "string",
"prev": "string"
},
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
Other Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | A client-side error was made. |
An ApiErrorResponse object |
401 | The request was not authenticated. |
An ApiErrorResponse object |
403 | Insufficient permissions. |
An ApiErrorResponse object |
404 | Resource not found. |
An ApiErrorResponse object |
409 | Conflict with current state. |
An ApiErrorResponse object |
422 | This request was well-formed but was rejected due to semantic errors. |
An ApiErrorResponse object |
500 | A server-side error occurred. |
An ApiErrorResponse object |
501 | This feature is not implemented in Scalr. |
An ApiErrorResponse object |
503 | The service is currently unavailable. |
An ApiErrorResponse object |