Tenants

Tenant lifecycle management

List all tenants in a fabric

get

https://localhost:8443http://localhost:8787

/fabrics/{fabricName}/tenants

Retrieves all tenants in a given fabric.

Path parameters

fabricNamestringRequired

Name of the fabric. Required in every API request.

Example: Fabric2SU

Responses

200

List of tenants retrieved successfully

application/json

404

Fabric does not exist

application/json

get

/fabrics/{fabricName}/tenants

HTTPcURLJavaScriptPython

GET /fabrics/{fabricName}/tenants HTTP/1.1
Host: localhost:8443
Accept: */*

{
  "tenants": [
    {
      "id": 5,
      "name": "coke",
      "description": "Test",
      "fabricName": "Fabric2SU",
      "maxGpusAllowed": -1,
      "gpusAllocated": 0,
      "allotedGpus": "",
      "vniId": 4009,
      "vlanId": 101,
      "vlanVniId": 4010,
      "vlanSubnetCPU": "192.3.3.32/29",
      "vlanSubnetStorage": "192.4.3.32/29",
      "config_status": "1",
      "createdAt": 1766580401662,
      "updatedAt": 1766581384352,
      "networks": [
        "Fabric2SU-north-south",
        "Fabric2SU-east-west"
      ],
      "tags": [
        {
          "east-west-vni": "vniId = 4009"
        },
        {
          "north-south-vlan": "vlanId = 101"
        }
      ],
      "vnets": {
        "name": "coke-Fabric2SU-north-south",
        "description": "Tenant coke for North-South VNet",
        "tenant IP Pool": {
          "gateway": "10.4.0.80",
          "subnet": "10.4.0.80/28"
        }
      }
    }
  ]
}

Create a new tenant

post

https://localhost:8443http://localhost:8787

/fabrics/{fabricName}/tenants

Creates a new tenant in the specified fabric. ONES provisions network-level isolation across East-West, North-South, and Storage networks.

Tenant name rules: Must start with a letter and contain only letters, numbers, underscores (_), or dashes (-). No spaces or special characters allowed.

Path parameters

fabricNamestringRequired

Name of the fabric. Required in every API request.

Example: Fabric2SU

Body

application/json

tenantNamestringRequired

Unique name for the tenant within the fabric. Must start with a letter; only letters, numbers, underscores (_), and dashes (-) are allowed.

Example: pepsiPattern: ^[a-zA-Z][a-zA-Z0-9_-]*$

descriptionstringRequired

Human-readable description of the tenant's purpose.

Example: GPU cluster for ML training workloads

maxGpusAllowedintegerRequired

Maximum number of GPU servers allowed for this tenant. Use -1 for unlimited.

Example: 16

sharedbooleanOptional

If true, this tenant operates in shared mode. Only applicable on fabrics created with tenant-unaware options. Network segmentation is managed by VMs on the server, not by ONES.

Default: falseExample: false

Responses

201

Tenant created successfully

application/json

400

Invalid input — fabric does not exist, missing required fields, or invalid tenant name format

application/json

409

A tenant with the same name already exists in this fabric

application/json

post

/fabrics/{fabricName}/tenants

HTTPcURLJavaScriptPython

POST /fabrics/{fabricName}/tenants HTTP/1.1
Host: localhost:8443
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "tenantName": "pepsi",
  "description": "Test",
  "maxGpusAllowed": 16,
  "shared": false
}

{
  "tenant": {
    "id": 18,
    "name": "pepsi",
    "description": "Test",
    "fabricName": "check",
    "maxGpusAllowed": 16,
    "gpusAllocated": 0,
    "allotedGpus": "",
    "vniId": 4035,
    "vlanId": 100,
    "vlanVniId": 4036,
    "vlanSubnetCPU": "10.2.3.24/29",
    "vlanSubnetStorage": "10.2.3.24/29",
    "config_status": "2",
    "createdAt": 1765801074115,
    "updatedAt": 1765801074121,
    "networks": [
      "check-north-south",
      "check-east-west"
    ],
    "tags": [
      {
        "east-west-vni": "vniId = 4035"
      },
      {
        "north-south-vlan": "vlanId = 100"
      }
    ],
    "vnets": {
      "name": "pepsi-check-north-south",
      "description": "Tenant pepsi for North-South VNet",
      "tenant IP Pool": {
        "gateway": "10.4.1.1",
        "subnet": "10.4.1.128/24 - 10.4.1.255/24"
      }
    }
  }
}

Get tenant details

get

https://localhost:8443http://localhost:8787

/fabrics/{fabricName}/tenants/{tenantName}

Retrieves detailed information for a specified tenant, including network constructs, allocated hosts, VLAN/VNI assignments, and IP pool details.

Path parameters

fabricNamestringRequired

Name of the fabric. Required in every API request.

Example: Fabric2SU

tenantNamestringRequired

Name of the tenant.

Example: coke

Responses

200

Tenant details retrieved successfully

application/json

404

Tenant or fabric does not exist

application/json

get

/fabrics/{fabricName}/tenants/{tenantName}

HTTPcURLJavaScriptPython

GET /fabrics/{fabricName}/tenants/{tenantName} HTTP/1.1
Host: localhost:8443
Accept: */*

{
  "tenant": {
    "id": 5,
    "name": "coke",
    "description": "Test",
    "fabricName": "Fabric2SU",
    "maxGpusAllowed": -1,
    "gpusAllocated": 16,
    "allotedGpus": "hgx-su01-h00,hgx-su01-h01",
    "vniId": 4009,
    "vlanId": 101,
    "vlanVniId": 4010,
    "vlanSubnetCPU": "192.3.3.32/29",
    "vlanSubnetStorage": "192.4.3.32/29",
    "config_status": "1",
    "createdAt": 1766580401662,
    "updatedAt": 1766580774122,
    "networks": [
      "Fabric2SU-north-south",
      "Fabric2SU-east-west"
    ],
    "tags": [
      {
        "east-west-vni": "vniId = 4009"
      },
      {
        "north-south-vlan": "vlanId = 101"
      }
    ],
    "vnets": {
      "name": "coke-Fabric2SU-north-south",
      "description": "Tenant coke for North-South VNet",
      "tenant IP Pool": {
        "gateway": "10.4.0.80",
        "subnet": "10.4.0.80/28"
      }
    }
  }
}

Delete a tenant

delete

https://localhost:8443http://localhost:8787

/fabrics/{fabricName}/tenants/{tenantName}

Deletes a tenant from the specified fabric.

Deletion Policy: A tenant cannot be deleted while any GPUs remain allocated to it. Deallocate all GPU servers first. If allocations still exist, the API returns a 409 with a warning message.

Path parameters

fabricNamestringRequired

Name of the fabric. Required in every API request.

Example: Fabric2SU

tenantNamestringRequired

Name of the tenant.

Example: coke

Responses

200

Tenant deleted successfully

application/json

messagestringOptionalExample: Tenant deleted successfully.

404

Tenant does not exist

application/json

409

Tenant has GPUs allocated — deallocate all GPU servers before deleting

application/json

delete

/fabrics/{fabricName}/tenants/{tenantName}

HTTPcURLJavaScriptPython

DELETE /fabrics/{fabricName}/tenants/{tenantName} HTTP/1.1
Host: localhost:8443
Accept: */*

{
  "message": "Tenant deleted successfully."
}