Tenants

Tenants

List tenants

List summary of tenants.

GET /tenants

Response

• 200 : OK
• 500 : Internal error. (Failed to retrieve details of the specified tenant.)

[	  
  { 
    "id" : "tenant1",
    "description" : "description for tenant1"
  },
  {
    "id" : "tenant2",
    "description" : "description for tenant2"
  }
]

Create a tenant

Create a new tenant.

POST /tenants

Input

• id : a unique id of the tenant (option). 'id' is automatically assigned if it is not specified.
• description : description of the creating tenant (option)

{ 
  "id": "tenant_created_via_rest_if", 
  "description": "description here" 
}

Response

• 200 : OK
• 404 : Not found the specified tenant.
• 500 : Internal error. (Failed to retrieve details of the specified tenant.)

{ 
  "id" : "tenant_created_via_rest_if", 
  "description" : "description here" 
}

Show details of a tenant

Show details of a tenant identified by tenant_id.

• tenant_id : a unique id of the tenant (required).

GET /tenants/:tenant_id

Response

• 200 : OK
• 404 : Not found the specified tenant.
• 500 : Internal error. (Failed to retrieve detail of the specified tenant.)

{
  "networks" : [	  
    { 
      "id" : "slice1",
      "description" : "description for slice1"
    },
    {
      "id" : "slice2",
      "description" : "description for slice2"
    }
  },
  "description" : "description here" 
]

Update details of a tenant

Update details of tenant identified by tenant_id.

• tenant_id : a unique id of the tenant (required).

PUT /tenants/:tenant_id

Input

• description : description of the creating tenant (option).

{ 
  "description" : "new description here" 
}

Response

• 202 : Succeeded.
• 404 : Not found the specified tenant.
• 422 : The specified parameters are unacceptable.
• 500 : Internal error. (Failed to modify the specified tenant.)

Remove a tenant

Remove the tenant identified by tenant_id.

• tenant_id : a unique id of the tenant (required).

DELETE /tenants/:tenant_id

Response

• 202 : Succeeded.
• 404 : Not found the specified tenant or network.
• 500 : Internal error. (Failed to destroy the specified tenant.)