Farm Roles / Actions: Import Server

Description

Import a running server from a Cloud Platform to a Scalr Farm Role.

HTTP Request

POST /api/v1beta0/user/envId/farm-roles/farmRoleId/actions/import-server/

Parameters

Name Required Description Location
envId
integer		 Yes

The ID of the Environment scoping this request.

 path
farmRoleId
integer		 Yes

The ID of a FarmRole object.

 path

Request body

Server import settings.

Example value: 

{
  "cloudServerId": "string",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

Fields description:

Name Required Description
cloudServerId
string		 Yes

Identifier of the instance on the cloud to import.
tags
array		 No

The list of tags that should be applied to the server on the Cloud.

Successful Response (Status 201)

The JSON representation of a ServerSummary object.

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

{
  "data": {
    "alerts": [
      {
        "message": "string",
        "occurred": "2013-01-01T12:34:56.789Z",
        "status": "failed",
        "type": "SCALARIZR_CONNECT"
      }
    ],
    "cloudLocation": "string",
    "cloudPlatform": "ec2",
    "cloudServerId": "string",
    "farm": {
      "id": 1
    },
    "farmRole": {
      "id": 1
    },
    "hostname": "string",
    "id": "string",
    "index": 1,
    "instanceType": {
      "id": "string"
    },
    "launchReason": "string",
    "launched": "2013-01-01T12:34:56.789Z",
    "launchedBy": {
      "email": "string",
      "id": 1
    },
    "operations": [
      {
        "name": "resizing"
      }
    ],
    "privateIp": [
      "string"
    ],
    "publicIp": [
      "string"
    ],
    "scalrAgent": {
      "deployCommand": "string",
      "initializationStatus": {
        "message": "string",
        "status": "insufficient-data"
      },
      "reachabilityStatus": {
        "message": "string",
        "status": "insufficient-data"
      },
      "version": "string"
    },
    "status": "temporary",
    "suspended": "2013-01-01T12:34:56.789Z"
  },
  "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.
farmRoleId

The ID of a FarmRole object.
body

Server import settings.