Jump to: navigation, search

Designate/Blueprints/Server Pools/API

Overview

Gerrit Patch []
Launchpad Blueprint []

Summary

Quick overview of the change

API Changes

List of changes to the HTTP API

Verb Resource Description
GET /v2/pools Get a list of all pools a tenant has access to.
GET /v2/pools/{id} Get individual pool details
POST /v2/pools/ Create a new pool
PATCH /v2/pools/{id} Update a pool's details

All Zone and Server Operations will now be scoped under a pool, like such

Verb Resource Description
GET /v2/pools/{id}/zones Get a list of zones a tenant has access in pool id
POST /v2/pools/{id}/zones Create a new zone in pool id
PATCH /v2/pools/{pool_id}/zones/{zone_id} Update a pool's details in zone zone_id

Example of Call (GET /v2/pools/)

Overview of call

Response

   {
       “pools”: [
             {
                 "pool":{
                     "id":"UUID STRING",
                     "name":"Pool Name",
                     "labels":["anycast","premium"],
                     "servers":[
                         {"id":"UUID STRING"},
                         {"id":"UUID STRING"},
                         {"id":"UUID STRING"} 
                     ],
                     "project_id":"{project_id}"
                 }
             }
         ]
   }

Database Changes

None