Developer Network

Documentação

Informações e instruções das APIs dos produtos Locaweb.

Servidores Dedicados

Manipulando Servidores Dedicados via API.

Listagem de servidores

Lista todos os servidores Dedicados vinculado ao usuário.

GET:
• https://DOMINIO/v1/dedicated/servers

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
  "data": [
    {
      "type": "servers",
      "id": "xxxdnn2299",
      "attributes": {
        "title": "dedicated-one",
        "server_type": "dedicated",
        "provisioning": 60357258,
        "transfer": 179200,
        "status": "installed",
        "domain": "xxxdnn2299.locaweb.com.br",
        "public_ip": "186.202.136.252",
        "private_ip": "10.10.10.10",
        "operating_system": "Linux Debian 7",
        "base_hardware": {
          "cpus": 2,
          "cores_per_cpu": 4,
          "memory": 8192,
          "hdd": 250
        }
      }
    },
    {
      "type": "servers",
      "id": "xxxdnn5010",
      "attributes": {
        "title": "application-server",
        "server_type": "dedicated",
        "provisioning": 62430547,
        "transfer": 179200,
        "status": "installed",
        "domain": "xxxdnn5010.locaweb.com.br",
        "public_ip": "186.202.121.120",
        "private_ip": "10.10.10.10",
        "operating_system": "Linux Debian 7",
        "base_hardware": {
            "memory": 73728,
            "cpus": 2,
            "cores_per_cpu": 8,
            "hdd": 300
        }
      }
    }
  ],
  "links": {
    "self": "https://DOMINIO/v1/dedicated/servers?page%5Bnumber%5D=2&page%5Bsize%5D=1",
    "first": "https://DOMINIO/v1/dedicated/servers?page%5Bnumber%5D=1&page%5Bsize%5D=2",
    "prev": "https://DOMINIO/v1/dedicated/servers?page%5Bnumber%5D=1&page%5Bsize%5D=2",
    "next": "https://DOMINIO/v1/dedicated/servers?page%5Bnumber%5D=3&page%5Bsize%5D=2",
    "last": "https://DOMINIO/v1/dedicated/servers?page%5Bnumber%5D=3&page%5Bsize%5D=2"
  },
  "meta": {
    "total": 6
  }
}

Detalhe do servidor

Exibe as informações sobre um servidor dedicado.

Caso queira especificar os campos de retorno, informe os campos desejados como parâmetro fields[servers] na requisição. Para mais detalhes, verificar a documentação do JSON API.

Parâmetro Descrição Retornado por padrão
title Apelido do servidor, fornecido pelo cliente durante a instalação Sim
server_type Tipo de servidor Sim
provisioning Número do provisioning Sim
zone Zona que o servidor esta instalado Sim
transfer Transfêrencia contratada em Megabytes. Sim
billing_type

Tipo de pagamento do servidor.

  • (Servidores Dedicados) postpaid
Sim
status

Status atual do servidor. Os possíveis valores são:

  • waiting_payment
  • installing
  • deactivating
  • uninstalling
  • reinstalling
  • deactivated
  • installed
  • installing
  • uninstalled
  • cancelled
Sim
plan_status Status do plano Sim
domain Domínio do servidor Sim
public_ip Ip público Sim
private_ip Ip privado Sim
additional_ips Ips adicionais Sim
base_hardware Memóra em Megabytes, número de CPUS, cores por CPU e HD em Gigabytes contratatos. Sim
created_at Data de criação do servidor Sim
network_version

Versão da rede na qual o servidor está hospedado

Não

GET:
• https://DOMINIO/v1/dedicated/servers/SERVER_NAME

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
  "data": {
    "type": "servers",
    "id": "xxxdnn2299",
    "attributes": {
      "title": "",
      "server_type": "dedicated",
      "provisioning": 60357258,
      "zone": "",
      "operating_system": "Linux Debian 7",
      "transfer": 187904819200,
      "billing_type": "postpaid",
      "status": "installed",
      "plan_status": "active",
      "domain": "xxxdnn2299.locaweb.com.br",
      "public_ip": "186.202.136.252",
      "private_ip": null,
      "additional_ips": [
        "186.202.136.252"
      ],
      "base_hardware": {
        "cpus": 2,
        "cores_per_cpu": 4,
        "memory": 8192,
        "hdd": 250
      },
      "created_at": "2015-02-18T15:35:13-02:00"
    }
  },
  "links": {
    "self": "https://DOMINIO/v1/dedicated/servers/SERVER_NAME"
  },
  "meta": {
    "actions": []
  }
}

Alterar apelido do servidor

Alterar apelido de um determinado servidor dedicado.

PUT:
• https://DOMINIO/v1/dedicated/servers/SERVER_NAME

Parâmetros:

Parâmetro Descrição Exemplo Obrigatório
type Nome do tipo do recurso 'servers' Sim
title Novo apelido 'new_title' Sim
1
2
3
4
5
6
7
8
{
  "data":{
    "type": "servers",
    "attributes": {
      "title": "new_title"
    }
  }
}

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
  "data": {
    "type": "servers",
    "id": "xxxdnn11270000",
    "attributes": {
      "title": "new_title",
      "server_type": "dedicated",
      "provisioning": 60121175,
      "transfer": 179200,
      "billing_type": "prepaid",
      "status": "installed",
      "plan_status": "active",
      "domain": "xxxdnn11270000.locaweb.com.br",
      "zone": "",
      "public_ip": null,
      "private_ip": null,
      "additional_ips": [],
      "operating_system": "Linux Debian 7",
      "architecture": "",
      "base_hardware": {
        "cpus": 1,
        "cores_per_cpu": 6,
        "memory": 12288,
        "hdd": 600
      },
      "vlan_available": false,
      "created_at": "2014-05-28T17:52:40-03:00"
    }
  },
  "links": {
    "self": "https://api-servidores.qa.locaweb.com.br/v1/dedicated/servers/xxxdnn11270000"
  },
  "meta": {
    "actions": []
  }
}

Recuperar atributos do servidor

Recuperar atributos [network_version] de um determinado servidor dedicado.

GET:
• https://DOMINIO/v1/dedicated/servers/SERVER_NAME?fields[servers]=network_version

Retorno:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "data": {
    "type": "servers",
    "id": "SERVER_NAME",
    "attributes": {
      "network_version": "2.0"
    }
  },
  "links": {
    "self": "https://DOMINIO/v1/dedicated/servers/SERVER_NAME"
  },
  "meta": {
    "actions": []
  }
}