Networks | Core API

Networks API

Create a network
Create a subnet
Deprovision a network
Deprovision a subnet
Get a network
Get a subnet
List networks
List subnets

Create a network

POST /networks

Parameters

cidr: required: true

scope: network
CIDR range to use for the network
tenancy: required: false

scope: network
Tenancy of the network
location: required: true

scope: network
Region for the network
provider: required: true
Provider ID
skip_subnets: required: false

scope: network
Skip automatic subnet creation

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json

            
          {
            "provider": 214,
            "network": {
              "cidr": "172.16.0.0/12",
              "location": "us-east-2",
              "skip_subnets": true
            }
          }

Response

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

            
          {
            "request": {
              "type": "provision_network",
              "id": "057c909f-57e2-490a-9611-38427e17bf49",
              "created_at": "2018-05-29T11:04:20+00:00",
              "started_at": "2018-05-29T11:04:20+00:00",
              "finished_at": "2018-05-29T11:04:21+00:00",
              "message": null,
              "request_status": "Finished: Provision network (057c909f-57e2-490a-9611-38427e17bf49) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T11:04:21+00:00",
              "read_channel": null,
              "stage": "create",
              "dependencies": "https://api.engineyard.com/requests/057c909f-57e2-490a-9611-38427e17bf49/dependencies",
              "stages": "https://api.engineyard.com/requests/057c909f-57e2-490a-9611-38427e17bf49/stages",
              "account": "https://api.engineyard.com/accounts/49c10d5d-00b9-49be-894a-ab3a231196f5",
              "requester": "https://api.engineyard.com/requests/057c909f-57e2-490a-9611-38427e17bf49/requester",
              "messages": "https://api.engineyard.com/requests/057c909f-57e2-490a-9611-38427e17bf49/messages",
              "callback_url": "https://api.engineyard.com/requests/057c909f-57e2-490a-9611-38427e17bf49/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/networks/d74521a1-3577-416c-97e9-103008ebf658"
            }
          }

Create a subnet

POST /subnets

Parameters

cidr: required: true

scope: subnet
CIDR range to use for the subnet
location: required: true

scope: subnet
AZ for the subnet
network: required: true
Network ID for the subnet
name: required: false

scope: subnet
Name of the subnet

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json

            
          {
            "network": "043db1bf-d6f3-416d-837f-dfd125b493cc",
            "subnet": {
              "cidr": "172.16.0.0/24",
              "location": "us-east-2b"
            }
          }

Response

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

            
          {
            "request": {
              "type": "provision_subnet",
              "id": "9e0c76a7-19b4-41d3-8f12-1e97d0d3b194",
              "created_at": "2018-05-29T11:04:33+00:00",
              "started_at": "2018-05-29T11:04:33+00:00",
              "finished_at": "2018-05-29T11:04:33+00:00",
              "message": null,
              "request_status": "Finished: Provision subnet (9e0c76a7-19b4-41d3-8f12-1e97d0d3b194) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T11:04:33+00:00",
              "read_channel": null,
              "stage": "create",
              "dependencies": "https://api.engineyard.com/requests/9e0c76a7-19b4-41d3-8f12-1e97d0d3b194/dependencies",
              "stages": "https://api.engineyard.com/requests/9e0c76a7-19b4-41d3-8f12-1e97d0d3b194/stages",
              "account": "https://api.engineyard.com/accounts/9c886199-f5ad-427e-bdb0-f51c8574f979",
              "requester": "https://api.engineyard.com/requests/9e0c76a7-19b4-41d3-8f12-1e97d0d3b194/requester",
              "messages": "https://api.engineyard.com/requests/9e0c76a7-19b4-41d3-8f12-1e97d0d3b194/messages",
              "callback_url": "https://api.engineyard.com/requests/9e0c76a7-19b4-41d3-8f12-1e97d0d3b194/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/subnets/35655bb6-7a04-4811-bde9-646f7c994be6"
            }
          }

Deprovision a network

DELETE /networks/:network

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json

            
          {
          }

Response

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

            
          {
            "request": {
              "type": "deprovision_network",
              "id": "aa8ef907-fc77-4298-a423-062b379c9cb9",
              "created_at": "2018-05-29T11:04:29+00:00",
              "started_at": "2018-05-29T11:04:30+00:00",
              "finished_at": "2018-05-29T11:04:30+00:00",
              "message": null,
              "request_status": "Finished: Deprovision network (aa8ef907-fc77-4298-a423-062b379c9cb9) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T11:04:30+00:00",
              "read_channel": null,
              "stage": "destroy",
              "dependencies": "https://api.engineyard.com/requests/aa8ef907-fc77-4298-a423-062b379c9cb9/dependencies",
              "stages": "https://api.engineyard.com/requests/aa8ef907-fc77-4298-a423-062b379c9cb9/stages",
              "account": "https://api.engineyard.com/accounts/a4ee51e0-2a16-4758-9ff8-911e600e4c77",
              "requester": "https://api.engineyard.com/requests/aa8ef907-fc77-4298-a423-062b379c9cb9/requester",
              "messages": "https://api.engineyard.com/requests/aa8ef907-fc77-4298-a423-062b379c9cb9/messages",
              "callback_url": "https://api.engineyard.com/requests/aa8ef907-fc77-4298-a423-062b379c9cb9/callback",
              "progress": false,
              "resource": false
            }
          }

Deprovision a subnet

DELETE /subnets/:subnet

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json

            
          {
          }

Response

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

            
          {
            "request": {
              "type": "deprovision_subnet",
              "id": "80f1dda6-946a-4d4d-9460-3b8cc7b40437",
              "created_at": "2018-05-29T11:04:42+00:00",
              "started_at": "2018-05-29T11:04:43+00:00",
              "finished_at": "2018-05-29T11:04:43+00:00",
              "message": null,
              "request_status": "Finished: Deprovision subnet (80f1dda6-946a-4d4d-9460-3b8cc7b40437) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T11:04:43+00:00",
              "read_channel": null,
              "stage": "destroy",
              "dependencies": "https://api.engineyard.com/requests/80f1dda6-946a-4d4d-9460-3b8cc7b40437/dependencies",
              "stages": "https://api.engineyard.com/requests/80f1dda6-946a-4d4d-9460-3b8cc7b40437/stages",
              "account": "https://api.engineyard.com/accounts/685242d7-da38-402f-adfd-b73f10ca56fa",
              "requester": "https://api.engineyard.com/requests/80f1dda6-946a-4d4d-9460-3b8cc7b40437/requester",
              "messages": "https://api.engineyard.com/requests/80f1dda6-946a-4d4d-9460-3b8cc7b40437/messages",
              "callback_url": "https://api.engineyard.com/requests/80f1dda6-946a-4d4d-9460-3b8cc7b40437/callback",
              "progress": false,
              "resource": false
            }
          }

Get a network

GET /networks/:network

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json

            
          {
          }

Response

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

            
          {
            "network": {
              "created_at": "2018-05-29T11:04:26+00:00",
              "deleted_at": null,
              "id": "8ebdff18-2888-44a4-89dd-fcc47a79111c",
              "cidr": "172.16.0.0/12",
              "tenancy": "default",
              "provisioned_id": "vpc-8aad1c9e",
              "provider": "https://api.engineyard.com/providers/216",
              "location": "us-east-2",
              "subnets": "https://api.engineyard.com/subnets?network=8ebdff18-2888-44a4-89dd-fcc47a79111c"
            }
          }

Get a subnet

GET /subnets/:subnet

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json

            
          {
          }

Response

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

            
          {
            "subnet": {
              "created_at": "2018-05-29T11:04:39+00:00",
              "deleted_at": null,
              "id": "fcdd81f0-1206-4c85-8978-388108c089aa",
              "provisioned_id": "subnet-c2a9f9c9",
              "cidr": "172.16.0.0/24",
              "location": "us-east-2b",
              "network": "https://api.engineyard.com/networks/791f43b1-5cd6-4e2b-a320-a9efdbffe0b5",
              "primary": true
            }
          }

List networks

GET /networks

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json

            
          {
          }

Response

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

            
          {
            "networks": [
              {
                "created_at": "2018-05-29T11:04:23+00:00",
                "deleted_at": null,
                "id": "07de531b-b797-42f9-b26c-0d04b5d2d443",
                "cidr": "172.16.0.0/12",
                "tenancy": "default",
                "provisioned_id": "vpc-aace270b",
                "provider": "https://api.engineyard.com/providers/215",
                "location": "us-east-2",
                "subnets": "https://api.engineyard.com/subnets?network=07de531b-b797-42f9-b26c-0d04b5d2d443"
              }
            ]
          }

List subnets

GET /subnets

Request

          Accept: application/vnd.engineyard.v3+json
          Content-Type: application/json

            
          {
          }

Response

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

            
          {
            "subnets": [
              {
                "created_at": "2018-05-29T11:04:36+00:00",
                "deleted_at": null,
                "id": "b044d6ba-5067-4dfe-b5d0-0e7fea5b6516",
                "provisioned_id": "subnet-6341fe6c",
                "cidr": "172.16.0.0/24",
                "location": "us-east-2b",
                "network": "https://api.engineyard.com/networks/a3514c16-f514-44cd-aed6-f65cc4d1a893",
                "primary": true
              }
            ]
          }