Farms / Cloud Services: Create

Description

Link Cloud Service to the current Farm.

HTTP Request

POST /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

The JSON representation of a FarmCloudServiceLink object.

FarmCloudServiceLink is an abstract type, you need to provide an object of a concrete type implementing it:

Successful Response (Status 201)

The JSON representation of a FarmCloudServiceLink object.

The API replies with a FarmCloudServiceLinkDetailsResponse object. Example response body: 

{
  "data": {
    "cloudLocation": "string",
    "cloudPlatform": "aws",
    "cloudServiceId": "string",
    "id": "string",
    "type": "FarmCloudServiceLink"
  },
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "meta": {
    "sample": "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

Try it out!

Parameter Value Description
envId

The ID of the Environment scoping this request.
farmId

The ID of a Farm object.
body
 - Definition

The JSON representation of a FarmCloudServiceLink object.