Addresses | Core API

Addresses API

Attach a address to a server
Create a address
Destroy an address
Detach a address
List a provider's addresses
List all addresses
List an account's addresses
Show a address

Attach a address to a server

PUT /addresses/:address/attach

Parameters

server: required: false
Server to attach address to

Request

          Accept: application/json
          Content-Type: application/json

            
          {
            "server": 59
          }

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8

            
          {
            "request": {
              "type": "attach_address",
              "id": "1aeb894b-560c-4dd9-9aa9-1a89d4fdb04f",
              "created_at": "2018-05-29T10:53:43+00:00",
              "started_at": "2018-05-29T10:53:43+00:00",
              "finished_at": "2018-05-29T10:53:43+00:00",
              "message": null,
              "request_status": "Finished: Attach address (1aeb894b-560c-4dd9-9aa9-1a89d4fdb04f) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:53:44+00:00",
              "read_channel": null,
              "stage": "update",
              "dependencies": "https://api.engineyard.com/requests/1aeb894b-560c-4dd9-9aa9-1a89d4fdb04f/dependencies",
              "stages": "https://api.engineyard.com/requests/1aeb894b-560c-4dd9-9aa9-1a89d4fdb04f/stages",
              "account": "https://api.engineyard.com/accounts/5001bd0c-f9a9-488e-aa36-70f8f4d96476",
              "requester": "https://api.engineyard.com/requests/1aeb894b-560c-4dd9-9aa9-1a89d4fdb04f/requester",
              "messages": "https://api.engineyard.com/requests/1aeb894b-560c-4dd9-9aa9-1a89d4fdb04f/messages",
              "callback_url": "https://api.engineyard.com/requests/1aeb894b-560c-4dd9-9aa9-1a89d4fdb04f/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/addresses/32"
            }
          }

Create a address

POST /addresses

Parameters

provider: required: false
Provider to create address with

Request

          Accept: application/json
          Content-Type: application/json

            
          {
            "provider": 178,
            "address": {
              "location": "us-west-2",
              "scope": "vpc"
            }
          }

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8

            
          {
            "request": {
              "type": "address_provision",
              "id": "1b591467-d718-4350-b5d0-d2665db52438",
              "created_at": "2018-05-29T10:53:19+00:00",
              "started_at": "2018-05-29T10:53:19+00:00",
              "finished_at": "2018-05-29T10:53:20+00:00",
              "message": null,
              "request_status": "Finished: Address provision (1b591467-d718-4350-b5d0-d2665db52438) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:53:20+00:00",
              "read_channel": null,
              "stage": "create",
              "dependencies": "https://api.engineyard.com/requests/1b591467-d718-4350-b5d0-d2665db52438/dependencies",
              "stages": "https://api.engineyard.com/requests/1b591467-d718-4350-b5d0-d2665db52438/stages",
              "account": "https://api.engineyard.com/accounts/059252c6-a3e8-42d4-af97-1a61db9d30d0",
              "requester": "https://api.engineyard.com/requests/1b591467-d718-4350-b5d0-d2665db52438/requester",
              "messages": "https://api.engineyard.com/requests/1b591467-d718-4350-b5d0-d2665db52438/messages",
              "callback_url": "https://api.engineyard.com/requests/1b591467-d718-4350-b5d0-d2665db52438/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/addresses/23"
            }
          }

Destroy an address

DELETE /addresses/:address

Request

          Accept: application/json
          Content-Type: application/json

            
          {
          }

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8

            
          {
            "request": {
              "type": "deprovision_address_request",
              "id": "df9a91c9-7b7e-49fa-93fa-bbb4bc90cbdf",
              "created_at": "2018-05-29T10:54:00+00:00",
              "started_at": "2018-05-29T10:54:00+00:00",
              "finished_at": "2018-05-29T10:54:01+00:00",
              "message": null,
              "request_status": "Finished: Deprovision address request (df9a91c9-7b7e-49fa-93fa-bbb4bc90cbdf) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:54:01+00:00",
              "read_channel": null,
              "stage": "address.cleanup",
              "dependencies": "https://api.engineyard.com/requests/df9a91c9-7b7e-49fa-93fa-bbb4bc90cbdf/dependencies",
              "stages": "https://api.engineyard.com/requests/df9a91c9-7b7e-49fa-93fa-bbb4bc90cbdf/stages",
              "account": "https://api.engineyard.com/accounts/a93cab9b-b226-44a1-8c9d-9dbe6a921444",
              "requester": "https://api.engineyard.com/requests/df9a91c9-7b7e-49fa-93fa-bbb4bc90cbdf/requester",
              "messages": "https://api.engineyard.com/requests/df9a91c9-7b7e-49fa-93fa-bbb4bc90cbdf/messages",
              "callback_url": "https://api.engineyard.com/requests/df9a91c9-7b7e-49fa-93fa-bbb4bc90cbdf/callback",
              "progress": false,
              "resource": false
            }
          }

Detach a address

PUT /addresses/:address/detach

Request

          Accept: application/json
          Content-Type: application/json

            
          {
          }

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8

            
          {
            "request": {
              "type": "detach_address",
              "id": "d88450b7-ac8e-4e72-90b6-c9389e33eab8",
              "created_at": "2018-05-29T10:53:57+00:00",
              "started_at": "2018-05-29T10:53:58+00:00",
              "finished_at": "2018-05-29T10:53:58+00:00",
              "message": null,
              "request_status": "Finished: Detach address (d88450b7-ac8e-4e72-90b6-c9389e33eab8) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:53:58+00:00",
              "read_channel": null,
              "stage": "update",
              "dependencies": "https://api.engineyard.com/requests/d88450b7-ac8e-4e72-90b6-c9389e33eab8/dependencies",
              "stages": "https://api.engineyard.com/requests/d88450b7-ac8e-4e72-90b6-c9389e33eab8/stages",
              "account": "https://api.engineyard.com/accounts/b28cf65c-f913-48ea-8382-01f1ed4eb085",
              "requester": "https://api.engineyard.com/requests/d88450b7-ac8e-4e72-90b6-c9389e33eab8/requester",
              "messages": "https://api.engineyard.com/requests/d88450b7-ac8e-4e72-90b6-c9389e33eab8/messages",
              "callback_url": "https://api.engineyard.com/requests/d88450b7-ac8e-4e72-90b6-c9389e33eab8/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/addresses/34"
            }
          }

List a provider's addresses

GET /providers/:provider/addresses

Request

          Accept: application/json
          Content-Type: application/json

            
          {
          }

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8

            
          {
            "addresses": [
              {
                "id": 30,
                "created_at": "2018-05-29T10:53:30+00:00",
                "updated_at": "2018-05-29T10:53:30+00:00",
                "provisioned_id": "86.916.336.727",
                "ip_address": "86.916.336.727",
                "location": "us-west-2",
                "provider": "https://api.engineyard.com/providers/182",
                "server": null
              },
              {
                "id": 29,
                "created_at": "2018-05-29T10:53:29+00:00",
                "updated_at": "2018-05-29T10:53:29+00:00",
                "provisioned_id": "79.615.818.288",
                "ip_address": "79.615.818.288",
                "location": "us-west-2",
                "provider": "https://api.engineyard.com/providers/182",
                "server": null
              }
            ]
          }

List all addresses

GET /addresses

Parameters

account: required: false
Account to which the addresses belong
provider: required: false
Provider to which the addresses belong

Request

          Accept: application/json
          Content-Type: application/json

            
          {
          }

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8

            
          {
            "addresses": [
              {
                "id": 25,
                "created_at": "2018-05-29T10:53:24+00:00",
                "updated_at": "2018-05-29T10:53:24+00:00",
                "provisioned_id": "294.218.784.131",
                "ip_address": "294.218.784.131",
                "location": "us-east-1",
                "provider": "https://api.engineyard.com/providers/180",
                "server": null
              },
              {
                "id": 26,
                "created_at": "2018-05-29T10:53:24+00:00",
                "updated_at": "2018-05-29T10:53:24+00:00",
                "provisioned_id": "290.302.745.68",
                "ip_address": "290.302.745.68",
                "location": "us-east-1",
                "provider": "https://api.engineyard.com/providers/180",
                "server": null
              }
            ]
          }

List an account's addresses

GET /accounts/:account/addresses

Request

          Accept: application/json
          Content-Type: application/json

            
          {
          }

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8

            
          {
            "addresses": [
              {
                "id": 27,
                "created_at": "2018-05-29T10:53:27+00:00",
                "updated_at": "2018-05-29T10:53:27+00:00",
                "provisioned_id": "216.142.616.636",
                "ip_address": "216.142.616.636",
                "location": "us-east-1",
                "provider": "https://api.engineyard.com/providers/181",
                "server": null
              },
              {
                "id": 28,
                "created_at": "2018-05-29T10:53:27+00:00",
                "updated_at": "2018-05-29T10:53:27+00:00",
                "provisioned_id": "726.9.700.633",
                "ip_address": "726.9.700.633",
                "location": "us-east-1",
                "provider": "https://api.engineyard.com/providers/181",
                "server": null
              }
            ]
          }

Show a address

GET /addresses/:address

Request

          Accept: application/json
          Content-Type: application/json

            
          {
          }

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8

            
          {
            "address": {
              "id": 24,
              "created_at": "2018-05-29T10:53:22+00:00",
              "ip_address": "701.444.306.847",
              "location": "us-east-1",
              "provider": "https://api.engineyard.com/providers/179",
              "provisioned_id": "701.444.306.847",
              "server": null,
              "updated_at": "2018-05-29T10:53:22+00:00"
            }
          }