Addresses API


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": "18f4fe79-20a0-482c-ba83-ffc6d543dd4e",
              "created_at": "2018-04-12T18:06:33+00:00",
              "started_at": "2018-04-12T18:06:33+00:00",
              "finished_at": "2018-04-12T18:06:34+00:00",
              "message": null,
              "request_status": "Finished: Attach address (18f4fe79-20a0-482c-ba83-ffc6d543dd4e) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:06:34+00:00",
              "read_channel": null,
              "stage": "update",
              "dependencies": "https://api.engineyard.com/requests/18f4fe79-20a0-482c-ba83-ffc6d543dd4e/dependencies",
              "stages": "https://api.engineyard.com/requests/18f4fe79-20a0-482c-ba83-ffc6d543dd4e/stages",
              "account": "https://api.engineyard.com/accounts/7af07459-6b31-469b-8a3d-a9af2cbe63d2",
              "requester": "https://api.engineyard.com/requests/18f4fe79-20a0-482c-ba83-ffc6d543dd4e/requester",
              "messages": "https://api.engineyard.com/requests/18f4fe79-20a0-482c-ba83-ffc6d543dd4e/messages",
              "callback_url": "https://api.engineyard.com/requests/18f4fe79-20a0-482c-ba83-ffc6d543dd4e/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": "eedfd804-7054-4c9e-8907-cd702e8c2242",
              "created_at": "2018-04-12T18:06:12+00:00",
              "started_at": "2018-04-12T18:06:12+00:00",
              "finished_at": "2018-04-12T18:06:12+00:00",
              "message": null,
              "request_status": "Finished: Address provision (eedfd804-7054-4c9e-8907-cd702e8c2242) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:06:12+00:00",
              "read_channel": null,
              "stage": "create",
              "dependencies": "https://api.engineyard.com/requests/eedfd804-7054-4c9e-8907-cd702e8c2242/dependencies",
              "stages": "https://api.engineyard.com/requests/eedfd804-7054-4c9e-8907-cd702e8c2242/stages",
              "account": "https://api.engineyard.com/accounts/52e6f5b9-76ba-43e9-8ba6-f54397b61ed8",
              "requester": "https://api.engineyard.com/requests/eedfd804-7054-4c9e-8907-cd702e8c2242/requester",
              "messages": "https://api.engineyard.com/requests/eedfd804-7054-4c9e-8907-cd702e8c2242/messages",
              "callback_url": "https://api.engineyard.com/requests/eedfd804-7054-4c9e-8907-cd702e8c2242/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": "321a7f6c-fc28-4263-acea-ea20a93eb6c4",
              "created_at": "2018-04-12T18:06:49+00:00",
              "started_at": "2018-04-12T18:06:50+00:00",
              "finished_at": "2018-04-12T18:06:50+00:00",
              "message": null,
              "request_status": "Finished: Deprovision address request (321a7f6c-fc28-4263-acea-ea20a93eb6c4) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:06:50+00:00",
              "read_channel": null,
              "stage": "address.cleanup",
              "dependencies": "https://api.engineyard.com/requests/321a7f6c-fc28-4263-acea-ea20a93eb6c4/dependencies",
              "stages": "https://api.engineyard.com/requests/321a7f6c-fc28-4263-acea-ea20a93eb6c4/stages",
              "account": "https://api.engineyard.com/accounts/d9cc1e01-e173-4880-b692-dfe77af45d21",
              "requester": "https://api.engineyard.com/requests/321a7f6c-fc28-4263-acea-ea20a93eb6c4/requester",
              "messages": "https://api.engineyard.com/requests/321a7f6c-fc28-4263-acea-ea20a93eb6c4/messages",
              "callback_url": "https://api.engineyard.com/requests/321a7f6c-fc28-4263-acea-ea20a93eb6c4/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": "85bda009-2d2c-4048-bac2-c487ea151079",
              "created_at": "2018-04-12T18:06:47+00:00",
              "started_at": "2018-04-12T18:06:47+00:00",
              "finished_at": "2018-04-12T18:06:47+00:00",
              "message": null,
              "request_status": "Finished: Detach address (85bda009-2d2c-4048-bac2-c487ea151079) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:06:47+00:00",
              "read_channel": null,
              "stage": "update",
              "dependencies": "https://api.engineyard.com/requests/85bda009-2d2c-4048-bac2-c487ea151079/dependencies",
              "stages": "https://api.engineyard.com/requests/85bda009-2d2c-4048-bac2-c487ea151079/stages",
              "account": "https://api.engineyard.com/accounts/fb3a7717-bab6-4d73-a951-4f39894d4282",
              "requester": "https://api.engineyard.com/requests/85bda009-2d2c-4048-bac2-c487ea151079/requester",
              "messages": "https://api.engineyard.com/requests/85bda009-2d2c-4048-bac2-c487ea151079/messages",
              "callback_url": "https://api.engineyard.com/requests/85bda009-2d2c-4048-bac2-c487ea151079/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": 29,
                "created_at": "2018-04-12T18:06:21+00:00",
                "updated_at": "2018-04-12T18:06:21+00:00",
                "provisioned_id": "657.550.563.836",
                "ip_address": "657.550.563.836",
                "location": "us-west-2",
                "provider": "https://api.engineyard.com/providers/182",
                "server": null
              },
              {
                "id": 30,
                "created_at": "2018-04-12T18:06:21+00:00",
                "updated_at": "2018-04-12T18:06:21+00:00",
                "provisioned_id": "401.891.773.864",
                "ip_address": "401.891.773.864",
                "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-04-12T18:06:16+00:00",
                "updated_at": "2018-04-12T18:06:16+00:00",
                "provisioned_id": "50.792.285.268",
                "ip_address": "50.792.285.268",
                "location": "us-west-2",
                "provider": "https://api.engineyard.com/providers/180",
                "server": null
              },
              {
                "id": 26,
                "created_at": "2018-04-12T18:06:16+00:00",
                "updated_at": "2018-04-12T18:06:16+00:00",
                "provisioned_id": "355.748.512.258",
                "ip_address": "355.748.512.258",
                "location": "us-west-2",
                "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": 28,
                "created_at": "2018-04-12T18:06:19+00:00",
                "updated_at": "2018-04-12T18:06:19+00:00",
                "provisioned_id": "303.29.529.525",
                "ip_address": "303.29.529.525",
                "location": "us-west-2",
                "provider": "https://api.engineyard.com/providers/181",
                "server": null
              },
              {
                "id": 27,
                "created_at": "2018-04-12T18:06:18+00:00",
                "updated_at": "2018-04-12T18:06:18+00:00",
                "provisioned_id": "747.89.14.570",
                "ip_address": "747.89.14.570",
                "location": "us-west-2",
                "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-04-12T18:06:14+00:00",
              "ip_address": "404.779.921.908",
              "location": "us-west-2",
              "provider": "https://api.engineyard.com/providers/179",
              "provisioned_id": "404.779.921.908",
              "server": null,
              "updated_at": "2018-04-12T18:06:14+00:00"
            }
          }