From ee39bacdf6dc86a0126629b4bc1ec9f058faa6cf Mon Sep 17 00:00:00 2001 From: Hitesh Wadekar Date: Thu, 9 Jul 2026 17:50:06 -0700 Subject: [PATCH 1/2] feat(rest-api): add VPC config/runtimeStatus response shape with backward compatibility --- rest-api/api/pkg/api/handler/vpc.go | 5 +- rest-api/api/pkg/api/model/vpc.go | 63 + rest-api/api/pkg/api/model/vpc_test.go | 10 + rest-api/db/pkg/db/model/vpc.go | 235 +- rest-api/db/pkg/db/model/vpc_test.go | 140 + rest-api/docs/index.html | 26520 ++++++++-------- rest-api/openapi/spec.yaml | 96 +- rest-api/proto/core/src/v1/common_nico.proto | 2 - rest-api/proto/core/src/v1/dns_nico.proto | 15 +- rest-api/proto/core/src/v1/fmds_nico.proto | 10 +- rest-api/proto/core/src/v1/health_nico.proto | 6 +- .../core/src/v1/machine_discovery_nico.proto | 4 +- .../core/src/v1/measured_boot_nico.proto | 12 +- .../proto/core/src/v1/mlx_device_nico.proto | 64 +- rest-api/proto/core/src/v1/nico_nico.proto | 371 +- rest-api/proto/core/src/v1/nmx_c_nico.proto | 24 +- .../src/v1/scout_firmware_upgrade_nico.proto | 2 - .../core/src/v1/site_explorer_nico.proto | 9 +- rest-api/sdk/standard/client.go | 5 +- .../model_batch_instance_create_request.go | 5 +- .../sdk/standard/model_expected_machine.go | 5 +- .../model_expected_machine_create_request.go | 5 +- .../model_expected_machine_update_request.go | 5 +- .../standard/model_expected_power_shelf.go | 3 +- ...del_expected_power_shelf_create_request.go | 3 +- ...del_expected_power_shelf_update_request.go | 3 +- rest-api/sdk/standard/model_expected_rack.go | 5 +- .../model_expected_rack_create_request.go | 5 +- .../model_expected_rack_update_request.go | 5 +- .../sdk/standard/model_expected_switch.go | 3 +- .../model_expected_switch_create_request.go | 3 +- .../model_expected_switch_update_request.go | 3 +- .../standard/model_infini_band_partition.go | 5 +- ...el_infini_band_partition_create_request.go | 3 +- ...el_infini_band_partition_update_request.go | 5 +- rest-api/sdk/standard/model_instance.go | 5 +- .../standard/model_instance_create_request.go | 5 +- rest-api/sdk/standard/model_instance_type.go | 3 +- .../model_instance_type_create_request.go | 3 +- .../model_instance_type_update_request.go | 5 +- .../standard/model_instance_update_request.go | 5 +- rest-api/sdk/standard/model_interface.go | 3 +- .../model_interface_create_request.go | 3 +- rest-api/sdk/standard/model_machine.go | 5 +- .../standard/model_machine_update_request.go | 5 +- .../standard/model_network_security_group.go | 3 +- ...l_network_security_group_create_request.go | 5 +- ...l_network_security_group_update_request.go | 5 +- rest-api/sdk/standard/model_vpc.go | 115 +- rest-api/sdk/standard/model_vpc_config.go | 497 + .../sdk/standard/model_vpc_create_request.go | 5 +- .../sdk/standard/model_vpc_runtime_status.go | 136 + .../sdk/standard/model_vpc_update_request.go | 5 +- rest-api/workflow/pkg/activity/vpc/vpc.go | 19 +- 54 files changed, 14885 insertions(+), 13606 deletions(-) create mode 100644 rest-api/sdk/standard/model_vpc_config.go create mode 100644 rest-api/sdk/standard/model_vpc_runtime_status.go diff --git a/rest-api/api/pkg/api/handler/vpc.go b/rest-api/api/pkg/api/handler/vpc.go index a9c51b59b6..3fe241ffb3 100644 --- a/rest-api/api/pkg/api/handler/vpc.go +++ b/rest-api/api/pkg/api/handler/vpc.go @@ -16,7 +16,6 @@ import ( "github.com/NVIDIA/infra-controller/rest-api/db/pkg/db/paginator" cdbp "github.com/NVIDIA/infra-controller/rest-api/db/pkg/db/paginator" swe "github.com/NVIDIA/infra-controller/rest-api/site-workflow/pkg/error" - wutil "github.com/NVIDIA/infra-controller/rest-api/workflow/pkg/util" "github.com/labstack/echo/v4" "go.opentelemetry.io/otel/attribute" @@ -435,9 +434,7 @@ func (cvh CreateVPCHandler) Handle(c echo.Context) error { statusDetails := []cdbm.StatusDetail{*ssd} // Make a best-effort attempt to return a response with the allocated VNI. - if controllerVpc.GetStatus() != nil { - activeVni := wutil.GetUint32PtrToIntPtr(controllerVpc.GetStatus().Vni) - + if activeVni := cdbm.VpcProtoAllocatedVNI(controllerVpc); activeVni != nil { uvpcInput := cdbm.VpcUpdateInput{ VpcID: vpc.ID, ActiveVni: activeVni, diff --git a/rest-api/api/pkg/api/model/vpc.go b/rest-api/api/pkg/api/model/vpc.go index cdac5ff032..52b67484a4 100644 --- a/rest-api/api/pkg/api/model/vpc.go +++ b/rest-api/api/pkg/api/model/vpc.go @@ -287,6 +287,63 @@ func (avvur APIVpcVirtualizationUpdateRequest) Validate(existingVpc *cdbm.Vpc) e return nil } +// APIVpcConfig captures the desired configuration for a VPC. +type APIVpcConfig struct { + // Name is the name of the VPC + Name string `json:"name"` + // Description is the description of the VPC + Description *string `json:"description"` + // SiteID is the ID of the Site + SiteID *string `json:"siteId"` + // NetworkVirtualizationType is a VPC virtualization type + NetworkVirtualizationType *string `json:"networkVirtualizationType"` + // RoutingProfile is the applied routing profile for the VPC, when known. + RoutingProfile *string `json:"routingProfile"` + // RequestedVni is the explicitly requested VPC VNI at creation time _if_ one was requested. + RequestedVni *int `json:"requestedVni"` + // NetworkSecurityGroupID is the ID of attached NSG, if any + NetworkSecurityGroupID *string `json:"networkSecurityGroupId"` + // NVLinkLogicalPartitionID is the ID of the NVLinkLogicalPartition + NVLinkLogicalPartitionID *string `json:"nvLinkLogicalPartitionId"` + // Labels is VPC labels specified by user + Labels map[string]string `json:"labels"` +} + +// APIVpcRuntimeStatus captures observed runtime status for a VPC. +type APIVpcRuntimeStatus struct { + // Vni is the active/actual VNI of the VPC, regardless of whether it was + // explicitly requested or auto-allocated. + Vni *int `json:"vni"` +} + +func newAPIVpcConfig(dbVpc cdbm.Vpc) APIVpcConfig { + cfg := APIVpcConfig{ + Name: dbVpc.Name, + Description: dbVpc.Description, + SiteID: util.GetUUIDPtrToStrPtr(&dbVpc.SiteID), + Labels: dbVpc.Labels, + NetworkSecurityGroupID: dbVpc.NetworkSecurityGroupID, + RequestedVni: dbVpc.Vni, + } + if dbVpc.NetworkVirtualizationType != nil { + cfg.NetworkVirtualizationType = dbVpc.NetworkVirtualizationType + } + if dbVpc.RoutingProfile != nil { + routingProfile := normalizeAPIVpcRoutingProfileFromSite(*dbVpc.RoutingProfile) + cfg.RoutingProfile = &routingProfile + } + if dbVpc.NVLinkLogicalPartitionID != nil { + cfg.NVLinkLogicalPartitionID = util.GetUUIDPtrToStrPtr(dbVpc.NVLinkLogicalPartitionID) + } + return cfg +} + +func newAPIVpcRuntimeStatus(dbVpc cdbm.Vpc) APIVpcRuntimeStatus { + return APIVpcRuntimeStatus{ + Vni: dbVpc.ActiveVni, + } +} + // APIVpc is a data structure to capture information about VPC at the API layer type APIVpc struct { // ID is the unique UUID v4 identifier of the VPC in NICo Cloud @@ -336,6 +393,10 @@ type APIVpc struct { Status string `json:"status"` // StatusHistory is the status detail records for the VPC over time StatusHistory []APIStatusDetail `json:"statusHistory"` + // Config is the desired configuration for the VPC + Config APIVpcConfig `json:"config"` + // RuntimeStatus is the observed runtime status for the VPC + RuntimeStatus APIVpcRuntimeStatus `json:"runtimeStatus"` // CreatedAt indicates the ISO datetime string for when the entity was created Created time.Time `json:"created"` // Updated indicates the ISO datetime string for when the VPC was last updated @@ -360,6 +421,8 @@ func NewAPIVpc(dbVpc cdbm.Vpc, dbsds []cdbm.StatusDetail) APIVpc { Updated: dbVpc.Updated, RequestedVni: dbVpc.Vni, Vni: dbVpc.ActiveVni, + Config: newAPIVpcConfig(dbVpc), + RuntimeStatus: newAPIVpcRuntimeStatus(dbVpc), } if dbVpc.NetworkVirtualizationType != nil { diff --git a/rest-api/api/pkg/api/model/vpc_test.go b/rest-api/api/pkg/api/model/vpc_test.go index d90daf09c5..bc5fc42ce3 100644 --- a/rest-api/api/pkg/api/model/vpc_test.go +++ b/rest-api/api/pkg/api/model/vpc_test.go @@ -534,6 +534,16 @@ func TestNewAPIVpc(t *testing.T) { assert.Equal(t, tt.want.StatusHistory, got.StatusHistory) assert.Equal(t, tt.want.Created, got.Created) assert.Equal(t, tt.want.Updated, got.Updated) + + assert.Equal(t, tt.want.Name, got.Config.Name) + assert.Equal(t, tt.want.Description, got.Config.Description) + assert.Equal(t, tt.want.SiteID, got.Config.SiteID) + assert.Equal(t, tt.want.NetworkVirtualizationType, got.Config.NetworkVirtualizationType) + assert.Equal(t, tt.want.RoutingProfile, got.Config.RoutingProfile) + assert.Equal(t, tt.want.RequestedVni, got.Config.RequestedVni) + assert.Equal(t, tt.want.NetworkSecurityGroupID, got.Config.NetworkSecurityGroupID) + assert.Equal(t, tt.want.Labels, got.Config.Labels) + assert.Equal(t, tt.want.Vni, got.RuntimeStatus.Vni) }) } } diff --git a/rest-api/db/pkg/db/model/vpc.go b/rest-api/db/pkg/db/model/vpc.go index 9a740b83b7..6f3571a118 100644 --- a/rest-api/db/pkg/db/model/vpc.go +++ b/rest-api/db/pkg/db/model/vpc.go @@ -181,36 +181,179 @@ func (vpc *Vpc) toMetadataProto() *corev1.Metadata { return md } +func vpcStringToProtoVirtualizationType(virtType *string) *corev1.VpcVirtualizationType { + if virtType == nil { + return nil + } + nwvt := corev1.VpcVirtualizationType_ETHERNET_VIRTUALIZER + switch *virtType { + case corev1.VpcVirtualizationType_FNN.String(): + nwvt = corev1.VpcVirtualizationType_FNN + case corev1.VpcVirtualizationType_FLAT.String(): + nwvt = corev1.VpcVirtualizationType_FLAT + } + return &nwvt +} + +func vpcProtoVirtualizationTypeToString(virtType corev1.VpcVirtualizationType) string { + switch virtType { + case corev1.VpcVirtualizationType_FNN: + return VpcFNN + case corev1.VpcVirtualizationType_FLAT: + return VpcFlat + default: + return VpcEthernetVirtualizer + } +} + +func intPtrToUint32Ptr(v *int) *uint32 { + if v == nil { + return nil + } + u := uint32(*v) + return &u +} + +func uint32PtrToIntPtr(v *uint32) *int { + if v == nil { + return nil + } + i := int(*v) + return &i +} + +// VpcProtoConfig returns the canonical desired configuration from a +// site-reported Vpc proto, falling back to deprecated flat fields when +// config is unset. +func VpcProtoConfig(proto *corev1.Vpc) *corev1.VpcConfig { + if proto == nil { + return nil + } + if proto.Config != nil { + return proto.Config + } + cfg := &corev1.VpcConfig{ + TenantOrganizationId: proto.TenantOrganizationId, + TenantKeysetId: proto.TenantKeysetId, + NetworkSecurityGroupId: proto.NetworkSecurityGroupId, + Vni: proto.Vni, + RoutingProfileType: proto.RoutingProfileType, + } + if proto.NetworkVirtualizationType != nil { + cfg.NetworkVirtualizationType = proto.NetworkVirtualizationType + } + if proto.DefaultNvlinkLogicalPartitionId != nil { + cfg.DefaultNvlinkLogicalPartitionId = proto.DefaultNvlinkLogicalPartitionId + } + return cfg +} + +// VpcProtoAllocatedVNI returns the active VNI from a site-reported Vpc +// proto, preferring status.vni and falling back to deprecated_vni. +func VpcProtoAllocatedVNI(proto *corev1.Vpc) *int { + if proto == nil { + return nil + } + if proto.Status != nil && proto.Status.Vni != nil { + return uint32PtrToIntPtr(proto.Status.Vni) + } + if proto.DeprecatedVni != nil { + return uint32PtrToIntPtr(proto.DeprecatedVni) + } + return nil +} + +// VpcProtoNetworkVirtualizationType returns the network virtualization +// type string from a site-reported Vpc proto, preferring config and +// falling back to the deprecated flat field. +func VpcProtoNetworkVirtualizationType(proto *corev1.Vpc) *string { + cfg := VpcProtoConfig(proto) + if cfg != nil && cfg.NetworkVirtualizationType != nil { + s := vpcProtoVirtualizationTypeToString(*cfg.NetworkVirtualizationType) + return &s + } + if proto != nil && proto.NetworkVirtualizationType != nil { + s := vpcProtoVirtualizationTypeToString(*proto.NetworkVirtualizationType) + return &s + } + return nil +} + +// VpcProtoRoutingProfile returns the routing profile from a +// site-reported Vpc proto, preferring config and falling back to the +// deprecated flat field. +func VpcProtoRoutingProfile(proto *corev1.Vpc) *string { + cfg := VpcProtoConfig(proto) + if cfg != nil && cfg.RoutingProfileType != nil { + return cfg.RoutingProfileType + } + if proto != nil { + return proto.RoutingProfileType + } + return nil +} + +// VpcProtoNetworkSecurityGroupID returns the NSG ID from a site-reported +// Vpc proto, preferring config and falling back to the deprecated flat +// field. +func VpcProtoNetworkSecurityGroupID(proto *corev1.Vpc) *string { + cfg := VpcProtoConfig(proto) + if cfg != nil { + return cfg.NetworkSecurityGroupId + } + if proto != nil { + return proto.NetworkSecurityGroupId + } + return nil +} + // ToProto converts this VPC into its workflow proto representation. // Used as the canonical entity-to-proto conversion; request-shape // protos (create / update) are produced by `ToProto` methods on the // corresponding API request types in api/pkg/api/model/vpc.go. // -// `NetworkVirtualizationType` is mapped from the DB column's string -// value to the workflow enum (defaulting to `ETHERNET_VIRTUALIZER` -// when the string is set but unrecognized, matching the pre-refactor -// handler behaviour). It is omitted from the proto when the DB -// column is nil. +// Populates structured `config` and `status` as canonical fields and +// mirrors deprecated flat fields for backward compatibility with older +// site agents and clients. func (vpc *Vpc) ToProto() *corev1.Vpc { - proto := &corev1.Vpc{ - Id: &corev1.VpcId{Value: vpc.GetSiteID().String()}, - Name: vpc.Name, - TenantOrganizationId: vpc.Org, - NetworkSecurityGroupId: vpc.NetworkSecurityGroupID, - Metadata: vpc.toMetadataProto(), - } + metadata := vpc.toMetadataProto() + virtType := vpcStringToProtoVirtualizationType(vpc.NetworkVirtualizationType) + desiredVni := intPtrToUint32Ptr(vpc.Vni) + allocatedVni := intPtrToUint32Ptr(vpc.ActiveVni) + + var nvllpProto *corev1.NVLinkLogicalPartitionId if vpc.NVLinkLogicalPartitionID != nil { - proto.DefaultNvlinkLogicalPartitionId = &corev1.NVLinkLogicalPartitionId{Value: vpc.NVLinkLogicalPartitionID.String()} - } - if vpc.NetworkVirtualizationType != nil { - nwvt := corev1.VpcVirtualizationType_ETHERNET_VIRTUALIZER - switch *vpc.NetworkVirtualizationType { - case corev1.VpcVirtualizationType_FNN.String(): - nwvt = corev1.VpcVirtualizationType_FNN - case corev1.VpcVirtualizationType_FLAT.String(): - nwvt = corev1.VpcVirtualizationType_FLAT - } - proto.NetworkVirtualizationType = &nwvt + nvllpProto = &corev1.NVLinkLogicalPartitionId{Value: vpc.NVLinkLogicalPartitionID.String()} + } + + config := &corev1.VpcConfig{ + TenantOrganizationId: vpc.Org, + NetworkSecurityGroupId: vpc.NetworkSecurityGroupID, + DefaultNvlinkLogicalPartitionId: nvllpProto, + Vni: desiredVni, + RoutingProfileType: vpc.RoutingProfile, + } + if virtType != nil { + config.NetworkVirtualizationType = virtType + } + + proto := &corev1.Vpc{ + Id: &corev1.VpcId{Value: vpc.GetSiteID().String()}, + Metadata: metadata, + Config: config, + Name: vpc.Name, + TenantOrganizationId: vpc.Org, + NetworkSecurityGroupId: vpc.NetworkSecurityGroupID, + DefaultNvlinkLogicalPartitionId: nvllpProto, + Vni: desiredVni, + DeprecatedVni: allocatedVni, + RoutingProfileType: vpc.RoutingProfile, + } + if virtType != nil { + proto.NetworkVirtualizationType = virtType + } + if allocatedVni != nil { + proto.Status = &corev1.VpcStatus{Vni: allocatedVni} } return proto } @@ -228,6 +371,8 @@ func (vpc *Vpc) ToProto() *corev1.Vpc { // - `Name` is sourced from `proto.Metadata.Name` when set, falling // back to the (deprecated) top-level `proto.Name` so the method // keeps working through the deprecation window. +// - Config fields are preferred over deprecated flat mirrors when +// both are present. // - Optional pointer fields (NetworkSecurityGroupID, // NVLinkLogicalPartitionID) are cleared when the proto omits them // OR when the proto value is invalid (e.g. an unparseable UUID). @@ -246,10 +391,26 @@ func (vpc *Vpc) FromProto(proto *corev1.Vpc) { if proto.Metadata != nil && proto.Metadata.Name != "" { vpc.Name = proto.Metadata.Name } - vpc.Org = proto.TenantOrganizationId - vpc.NetworkSecurityGroupID = proto.NetworkSecurityGroupId - if proto.DefaultNvlinkLogicalPartitionId != nil { - if id, err := uuid.Parse(proto.DefaultNvlinkLogicalPartitionId.Value); err == nil { + + cfg := VpcProtoConfig(proto) + if cfg != nil && cfg.TenantOrganizationId != "" { + vpc.Org = cfg.TenantOrganizationId + } else { + vpc.Org = proto.TenantOrganizationId + } + + nsgID := VpcProtoNetworkSecurityGroupID(proto) + vpc.NetworkSecurityGroupID = nsgID + + var nvllpProto *corev1.NVLinkLogicalPartitionId + if cfg != nil { + nvllpProto = cfg.DefaultNvlinkLogicalPartitionId + } + if nvllpProto == nil { + nvllpProto = proto.DefaultNvlinkLogicalPartitionId + } + if nvllpProto != nil { + if id, err := uuid.Parse(nvllpProto.Value); err == nil { vpc.NVLinkLogicalPartitionID = &id } else { vpc.NVLinkLogicalPartitionID = nil @@ -257,6 +418,26 @@ func (vpc *Vpc) FromProto(proto *corev1.Vpc) { } else { vpc.NVLinkLogicalPartitionID = nil } + + if virtType := VpcProtoNetworkVirtualizationType(proto); virtType != nil { + vpc.NetworkVirtualizationType = virtType + } else { + vpc.NetworkVirtualizationType = nil + } + + if routingProfile := VpcProtoRoutingProfile(proto); routingProfile != nil { + vpc.RoutingProfile = routingProfile + } else { + vpc.RoutingProfile = nil + } + + if cfg != nil && cfg.Vni != nil { + vpc.Vni = uint32PtrToIntPtr(cfg.Vni) + } else { + vpc.Vni = uint32PtrToIntPtr(proto.Vni) + } + vpc.ActiveVni = VpcProtoAllocatedVNI(proto) + if proto.Metadata != nil { vpc.Description = nil if proto.Metadata.Description != "" { diff --git a/rest-api/db/pkg/db/model/vpc_test.go b/rest-api/db/pkg/db/model/vpc_test.go index 635c7f314d..023107dfbe 100644 --- a/rest-api/db/pkg/db/model/vpc_test.go +++ b/rest-api/db/pkg/db/model/vpc_test.go @@ -1530,6 +1530,13 @@ func TestVpc_ToProto(t *testing.T) { assert.Equal(t, "prod", *got.Metadata.Labels[0].Value) require.NotNil(t, got.DefaultNvlinkLogicalPartitionId) assert.Equal(t, nvllpID.String(), got.DefaultNvlinkLogicalPartitionId.Value) + + require.NotNil(t, got.Config) + assert.Equal(t, "org-1", got.Config.TenantOrganizationId) + require.NotNil(t, got.Config.NetworkSecurityGroupId) + assert.Equal(t, "nsg-1", *got.Config.NetworkSecurityGroupId) + require.NotNil(t, got.Config.DefaultNvlinkLogicalPartitionId) + assert.Equal(t, nvllpID.String(), got.Config.DefaultNvlinkLogicalPartitionId.Value) }) t.Run("nil description and labels yield zero-value metadata", func(t *testing.T) { @@ -1683,3 +1690,136 @@ func TestVpc_FromProto(t *testing.T) { assert.Equal(t, "top-level-fallback", v.Name) }) } + +func TestVpc_ToProto_ConfigStatusCompat(t *testing.T) { + id := uuid.New() + fnn := VpcFNN + requestedVni := 4242 + activeVni := 9999 + routingProfile := "INTERNAL" + nsg := "nsg-42" + + v := &Vpc{ + ID: id, + Org: "org-1", + Name: "vpc-a", + NetworkVirtualizationType: &fnn, + Vni: &requestedVni, + ActiveVni: &activeVni, + RoutingProfile: &routingProfile, + NetworkSecurityGroupID: &nsg, + } + + got := v.ToProto() + require.NotNil(t, got.Config) + assert.Equal(t, "org-1", got.Config.TenantOrganizationId) + require.NotNil(t, got.Config.NetworkVirtualizationType) + assert.Equal(t, corev1.VpcVirtualizationType_FNN, *got.Config.NetworkVirtualizationType) + require.NotNil(t, got.Config.Vni) + assert.Equal(t, uint32(requestedVni), *got.Config.Vni) + require.NotNil(t, got.Config.RoutingProfileType) + assert.Equal(t, routingProfile, *got.Config.RoutingProfileType) + require.NotNil(t, got.Config.NetworkSecurityGroupId) + assert.Equal(t, nsg, *got.Config.NetworkSecurityGroupId) + + require.NotNil(t, got.Status) + require.NotNil(t, got.Status.Vni) + assert.Equal(t, uint32(activeVni), *got.Status.Vni) + + // Deprecated flat mirrors stay populated for compatibility. + assert.Equal(t, "org-1", got.TenantOrganizationId) + require.NotNil(t, got.NetworkVirtualizationType) + assert.Equal(t, corev1.VpcVirtualizationType_FNN, *got.NetworkVirtualizationType) + require.NotNil(t, got.Vni) + assert.Equal(t, uint32(requestedVni), *got.Vni) + require.NotNil(t, got.DeprecatedVni) + assert.Equal(t, uint32(activeVni), *got.DeprecatedVni) + require.NotNil(t, got.RoutingProfileType) + assert.Equal(t, routingProfile, *got.RoutingProfileType) + require.NotNil(t, got.NetworkSecurityGroupId) + assert.Equal(t, nsg, *got.NetworkSecurityGroupId) +} + +func TestVpc_FromProto_ConfigFallback(t *testing.T) { + id := uuid.New() + nvllpID := uuid.New() + nsg := "nsg-config" + fnnEnum := corev1.VpcVirtualizationType_FNN + requestedVni := uint32(12001) + activeVni := uint32(12002) + routingProfile := "INTERNAL" + + v := &Vpc{} + v.FromProto(&corev1.Vpc{ + Id: &corev1.VpcId{Value: id.String()}, + Config: &corev1.VpcConfig{ + TenantOrganizationId: "org-config", + NetworkSecurityGroupId: &nsg, + NetworkVirtualizationType: &fnnEnum, + Vni: &requestedVni, + RoutingProfileType: &routingProfile, + DefaultNvlinkLogicalPartitionId: &corev1.NVLinkLogicalPartitionId{Value: nvllpID.String()}, + }, + Status: &corev1.VpcStatus{Vni: &activeVni}, + Metadata: &corev1.Metadata{Name: "vpc-config"}, + }) + + assert.Equal(t, "org-config", v.Org) + require.NotNil(t, v.NetworkSecurityGroupID) + assert.Equal(t, nsg, *v.NetworkSecurityGroupID) + require.NotNil(t, v.NetworkVirtualizationType) + assert.Equal(t, VpcFNN, *v.NetworkVirtualizationType) + require.NotNil(t, v.Vni) + assert.Equal(t, int(requestedVni), *v.Vni) + require.NotNil(t, v.ActiveVni) + assert.Equal(t, int(activeVni), *v.ActiveVni) + require.NotNil(t, v.RoutingProfile) + assert.Equal(t, routingProfile, *v.RoutingProfile) + require.NotNil(t, v.NVLinkLogicalPartitionID) + assert.Equal(t, nvllpID, *v.NVLinkLogicalPartitionID) +} + +func TestVpcProtoCompatHelpers(t *testing.T) { + fnnEnum := corev1.VpcVirtualizationType_FNN + routingProfile := "EXTERNAL" + nsg := "nsg-flat" + + t.Run("prefers structured config over deprecated flat fields", func(t *testing.T) { + proto := &corev1.Vpc{ + Config: &corev1.VpcConfig{ + NetworkVirtualizationType: &fnnEnum, + RoutingProfileType: &routingProfile, + NetworkSecurityGroupId: &nsg, + }, + NetworkVirtualizationType: cutil.GetPtr(corev1.VpcVirtualizationType_ETHERNET_VIRTUALIZER), + RoutingProfileType: cutil.GetPtr("INTERNAL"), + NetworkSecurityGroupId: cutil.GetPtr("nsg-deprecated"), + } + + virtType := VpcProtoNetworkVirtualizationType(proto) + require.NotNil(t, virtType) + assert.Equal(t, VpcFNN, *virtType) + assert.Equal(t, routingProfile, *VpcProtoRoutingProfile(proto)) + assert.Equal(t, nsg, *VpcProtoNetworkSecurityGroupID(proto)) + }) + + t.Run("allocated VNI prefers status.vni over deprecated_vni", func(t *testing.T) { + statusVni := uint32(100) + deprecatedVni := uint32(200) + proto := &corev1.Vpc{ + Status: &corev1.VpcStatus{Vni: &statusVni}, + DeprecatedVni: &deprecatedVni, + } + got := VpcProtoAllocatedVNI(proto) + require.NotNil(t, got) + assert.Equal(t, 100, *got) + }) + + t.Run("allocated VNI falls back to deprecated_vni when status is absent", func(t *testing.T) { + deprecatedVni := uint32(200) + proto := &corev1.Vpc{DeprecatedVni: &deprecatedVni} + got := VpcProtoAllocatedVNI(proto) + require.NotNil(t, got) + assert.Equal(t, 200, *got) + }) +} diff --git a/rest-api/docs/index.html b/rest-api/docs/index.html index 3d1be1f1ad..1c70dde431 100644 --- a/rest-api/docs/index.html +++ b/rest-api/docs/index.html @@ -12,459 +12,459 @@ margin: 0; } - -
API docs by Redocly
API docs by Redocly

NVIDIA Infra Controller REST API (2.0.0)

Download OpenAPI specification:

License: Apache-2.0

NVIDIA Infra Controller REST API is the RESTful gateway for accessing the NVIDIA Infra Controller service

+ " fill="currentColor">

NVIDIA Infra Controller REST API (2.0.0)

Download OpenAPI specification:

License: Apache-2.0

NVIDIA Infra Controller REST API is the RESTful gateway for accessing the NVIDIA Infra Controller service

NVIDIA Infra Controller REST API allows users to create and manage resources, e.g., VPCs, Subnets, and Instances, across all connected NVIDIA Infra Controller datacenters, also referred to as Sites.

-

Getting Started

NVIDIA Infra Controller REST API allows users to create and manage resources, e.g., VPCs, Subnets, and Instances, across all connected NVIDIA Infra Controller datacenters, also referred to as Sites.

+

Getting Started

Typical API Call Flow for Tenant the Tenant has received a Compute Allocation from the Provider will be returned.
  • Create an Instance specifying the VPC, VPC Prefix or Subnet, Operating System, and Instance Type.
    • -

    Service Account

    Service Account

    When the API service is configured in Service Account mode, API users can act as both Provider and Tenant. For service accounts, the Tenant entity is initialized as a privileged Tenant with targetedInstanceCreation capability enabled.

    -

    Retrieve Service Account status for current org

    Retrieve Service Account status for current org

    Retrieve Service Account status for current org

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve Service Account status for current org

    API service must be configured for Service Account access at the time of deployment. It cannot be enabled or disabled via API.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -

    Responses

    Response Schema: application/json
    enabled
    boolean
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +

    Responses

    Response Schema: application/json
    enabled
    boolean
    Typical API Call Flow for Tenant </ul> <p>For details on issuer origins and configuration, see the NICo REST <code>auth</code> module <a href="https://github.com/NVIDIA/infra-controller/rest-api/tree/main/auth">README</a>.</p> -" class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

    Indicates whether the calling token is authenticated as a Service Account. +" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    Indicates whether the calling token is authenticated as a Service Account. This is determined per request from how the token's issuer is configured at deployment time (the issuer config in the nico-rest-api-config ConfigMap); it cannot be toggled via the API. Rules by issuer origin:

    @@ -684,233 +684,233 @@

    Typical API Call Flow for Tenant

    For details on issuer origins and configuration, see the NICo REST auth module README.

    -
    infrastructureProviderId
    string or null <uuid>

    ID of the Infrastructure Provider associated with Service Account

    -
    tenantId
    string or null <uuid>

    ID of the Tenant associated with Service Account

    -

    Response samples

    Content type
    application/json
    {
    • "enabled": true,
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
    }

    Infrastructure Provider

    		infrastructureProviderId
    string or null <uuid>

    ID of the Infrastructure Provider associated with Service Account

    +
    tenantId
    string or null <uuid>

    ID of the Tenant associated with Service Account

    +

    Response samples

    Content type
    application/json
    {
    • "enabled": true,
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0"
    }

    Infrastructure Provider

    Infrastructure Provider is the anchor entity for an organization that owns and manages Site resources.

    -

    Retrieve Infrastructure Provider for current Org

    Retrieve Infrastructure Provider for current Org

    Retrieve Infrastructure Provider entity for current Org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve Infrastructure Provider entity for current Org.

    User must have authorization role with PROVIDER_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Infrastructure Provider

    -
    org
    string

    Name of the org this Infrastructure Provider belongs to

    -
    orgDisplayName
    string or null

    Display name of the org this Infrastructure Provider belongs to

    -
    created
    string <date-time>

    Date/time when the Infrastructure Provider was created

    -
    updated
    string <date-time>

    Date/time when the Infrastructure Provider was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "org": "rf43bbtnb9c5",
    • "orgDisplayName": "Dell Corporation",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve Stats for current Infrastructure Provider

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Infrastructure Provider

    +
    org
    string

    Name of the org this Infrastructure Provider belongs to

    +
    orgDisplayName
    string or null

    Display name of the org this Infrastructure Provider belongs to

    +
    created
    string <date-time>

    Date/time when the Infrastructure Provider was created

    +
    updated
    string <date-time>

    Date/time when the Infrastructure Provider was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "org": "rf43bbtnb9c5",
    • "orgDisplayName": "Dell Corporation",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve Stats for current Infrastructure Provider

    Retrieve stats for current Infrastructure Provider.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve stats for current Infrastructure Provider.

    User must have authorization role with PROVIDER_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -

    Responses

    Response Schema: application/json
    object (MachineCountByStatus)

    Machine status counts for the Infrastructure Provider

    -
    total
    integer

    Total number of Machines

    -
    initializing
    integer

    Number of Machines in Initializing status

    -
    reset
    integer

    Number of Machines in Reset status

    -
    assigned
    integer

    Number of Machines in Assigned status

    -
    ready
    integer

    Number of Machines in Ready status

    -
    error
    integer

    Number of Machines in Error status

    -
    decommissioned
    integer

    Number of Machines in Decommissioned status

    -
    unknown
    integer

    Number of Machines in Unknown status

    -
    object (IpBlockCountByStatus)

    IP Block status counts for the Infrastructure Provider

    -
    total
    integer

    Total number of IP Blocks

    -
    pending
    integer

    Number of IP Blocks in Pending status

    -
    provisioning
    integer

    Number of IP Blocks in Provisioning status

    -
    ready
    integer

    Number of IP Blocks in Ready status

    -
    deleting
    integer

    Number of IP Blocks in Deleting status

    -
    error
    integer

    Number of IP Blocks in Error status

    -
    object (TenantAccountCountByStatus)

    Tenant Account status counts for the Infrastructure Provider

    -
    total
    integer

    Total number of Tenant Accounts

    -
    pending
    integer

    Number of Tenant Accounts in Pending status

    -
    invited
    integer

    Number of Tenant Accounts in Invited status

    -
    ready
    integer

    Number of Tenant Accounts in Ready status

    -
    error
    integer

    Number of Tenant Accounts in Error status

    -

    Response samples

    Content type
    application/json
    {
    • "machine": {
      },
    • "ipBlock": {
      },
    • "tenantAccount": {
      }
    }

    Tenant

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +

    Responses

    Response Schema: application/json
    object (MachineCountByStatus)

    Machine status counts for the Infrastructure Provider

    +
    total
    integer

    Total number of Machines

    +
    initializing
    integer

    Number of Machines in Initializing status

    +
    reset
    integer

    Number of Machines in Reset status

    +
    assigned
    integer

    Number of Machines in Assigned status

    +
    ready
    integer

    Number of Machines in Ready status

    +
    error
    integer

    Number of Machines in Error status

    +
    decommissioned
    integer

    Number of Machines in Decommissioned status

    +
    unknown
    integer

    Number of Machines in Unknown status

    +
    object (IpBlockCountByStatus)

    IP Block status counts for the Infrastructure Provider

    +
    total
    integer

    Total number of IP Blocks

    +
    pending
    integer

    Number of IP Blocks in Pending status

    +
    provisioning
    integer

    Number of IP Blocks in Provisioning status

    +
    ready
    integer

    Number of IP Blocks in Ready status

    +
    deleting
    integer

    Number of IP Blocks in Deleting status

    +
    error
    integer

    Number of IP Blocks in Error status

    +
    object (TenantAccountCountByStatus)

    Tenant Account status counts for the Infrastructure Provider

    +
    total
    integer

    Total number of Tenant Accounts

    +
    pending
    integer

    Number of Tenant Accounts in Pending status

    +
    invited
    integer

    Number of Tenant Accounts in Invited status

    +
    ready
    integer

    Number of Tenant Accounts in Ready status

    +
    error
    integer

    Number of Tenant Accounts in Error status

    +

    Response samples

    Content type
    application/json
    {
    • "machine": {
      },
    • "ipBlock": {
      },
    • "tenantAccount": {
      }
    }

    Tenant

    Tenant is the anchor entity for an organization that consumes Network and Compute resources on a Site.

    -

    Retrieve Tenant for current Org

    Retrieve Tenant for current Org

    Retrieve Tenant entity for current Org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve Tenant entity for current Org.

    User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique ID of the Tenant

    -
    org
    string

    Name/external ID of Tenant's organization

    -
    orgDisplayName
    string or null

    Display name of Tenant's organization

    -
    created
    string <date-time>

    Date/time the Tenant was created

    -
    updated
    string <date-time>

    Date/time when Tenant was last updated

    -
    object (TenantCapabilities)

    Features that are enabled/disabled for Tenant

    -
    targetedInstanceCreation
    boolean <uuid>

    Indicates whether Tenant can create Instances by specifying Machine ID

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "org": "qygdmg8oqik8",
    • "orgDisplayName": "Echo Corporation",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "capabilities": {
      }
    }

    Retrieve Stats for current Tenant

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique ID of the Tenant

    +
    org
    string

    Name/external ID of Tenant's organization

    +
    orgDisplayName
    string or null

    Display name of Tenant's organization

    +
    created
    string <date-time>

    Date/time the Tenant was created

    +
    updated
    string <date-time>

    Date/time when Tenant was last updated

    +
    object (TenantCapabilities)

    Features that are enabled/disabled for Tenant

    +
    targetedInstanceCreation
    boolean <uuid>

    Indicates whether Tenant can create Instances by specifying Machine ID

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "org": "qygdmg8oqik8",
    • "orgDisplayName": "Echo Corporation",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "capabilities": {
      }
    }

    Retrieve Stats for current Tenant

    Retrieve stats for current Tenant.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve stats for current Tenant.

    User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -

    Responses

    Response Schema: application/json
    object (InstanceCountByStatus)

    Instance status counts for the Tenant

    -
    total
    integer

    Total number of Instances

    -
    pending
    integer

    Number of Instances in Pending status

    -
    provisioning
    integer

    Number of Instances in Provisioning status

    -
    configuring
    integer

    Number of Instances in Configuring status

    -
    ready
    integer

    Number of Instances in Ready status

    -
    rebooting
    integer

    Number of Instances in Rebooting status

    -
    repairing
    integer

    Number of Instances in Repairing status

    -
    terminating
    integer

    Number of Instances in Terminating status

    -
    error
    integer

    Number of Instances in Error status

    -
    updating
    integer

    Number of Instances in Updating status

    -
    unknown
    integer

    Number of Instances in Unknown status

    -
    object (VpcCountByStatus)

    VPC status counts for the Tenant

    -
    total
    integer

    Total number of VPCs

    -
    pending
    integer

    Number of VPCs in Pending status

    -
    provisioning
    integer

    Number of VPCs in Provisioning status

    -
    ready
    integer

    Number of VPCs in Ready status

    -
    deleting
    integer

    Number of VPCs in Deleting status

    -
    error
    integer

    Number of VPCs in Error status

    -
    object (SubnetCountByStatus)

    Subnet status counts for the Tenant

    -
    total
    integer

    Total number of Subnets

    -
    pending
    integer

    Number of Subnets in Pending status

    -
    provisioning
    integer

    Number of Subnets in Provisioning status

    -
    ready
    integer

    Number of Subnets in Ready status

    -
    deleting
    integer

    Number of Subnets in Deleting status

    -
    error
    integer

    Number of Subnets in Error status

    -
    object (TenantAccountCountByStatus)

    Tenant Account status counts for the Tenant

    -
    total
    integer

    Total number of Tenant Accounts

    -
    pending
    integer

    Number of Tenant Accounts in Pending status

    -
    invited
    integer

    Number of Tenant Accounts in Invited status

    -
    ready
    integer

    Number of Tenant Accounts in Ready status

    -
    error
    integer

    Number of Tenant Accounts in Error status

    -

    Response samples

    Content type
    application/json
    {
    • "instance": {
      },
    • "vpc": {
      },
    • "subnet": {
      },
    • "tenantAccount": {
      }
    }

    Retrieve per-tenant instance type allocation stats for a site

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +

    Responses

    Response Schema: application/json
    object (InstanceCountByStatus)

    Instance status counts for the Tenant

    +
    total
    integer

    Total number of Instances

    +
    pending
    integer

    Number of Instances in Pending status

    +
    provisioning
    integer

    Number of Instances in Provisioning status

    +
    configuring
    integer

    Number of Instances in Configuring status

    +
    ready
    integer

    Number of Instances in Ready status

    +
    rebooting
    integer

    Number of Instances in Rebooting status

    +
    repairing
    integer

    Number of Instances in Repairing status

    +
    terminating
    integer

    Number of Instances in Terminating status

    +
    error
    integer

    Number of Instances in Error status

    +
    updating
    integer

    Number of Instances in Updating status

    +
    unknown
    integer

    Number of Instances in Unknown status

    +
    object (VpcCountByStatus)

    VPC status counts for the Tenant

    +
    total
    integer

    Total number of VPCs

    +
    pending
    integer

    Number of VPCs in Pending status

    +
    provisioning
    integer

    Number of VPCs in Provisioning status

    +
    ready
    integer

    Number of VPCs in Ready status

    +
    deleting
    integer

    Number of VPCs in Deleting status

    +
    error
    integer

    Number of VPCs in Error status

    +
    object (SubnetCountByStatus)

    Subnet status counts for the Tenant

    +
    total
    integer

    Total number of Subnets

    +
    pending
    integer

    Number of Subnets in Pending status

    +
    provisioning
    integer

    Number of Subnets in Provisioning status

    +
    ready
    integer

    Number of Subnets in Ready status

    +
    deleting
    integer

    Number of Subnets in Deleting status

    +
    error
    integer

    Number of Subnets in Error status

    +
    object (TenantAccountCountByStatus)

    Tenant Account status counts for the Tenant

    +
    total
    integer

    Total number of Tenant Accounts

    +
    pending
    integer

    Number of Tenant Accounts in Pending status

    +
    invited
    integer

    Number of Tenant Accounts in Invited status

    +
    ready
    integer

    Number of Tenant Accounts in Ready status

    +
    error
    integer

    Number of Tenant Accounts in Error status

    +

    Response samples

    Content type
    application/json
    {
    • "instance": {
      },
    • "vpc": {
      },
    • "subnet": {
      },
    • "tenantAccount": {
      }
    }

    Retrieve per-tenant instance type allocation stats for a site

    Returns instance type allocation stats grouped by tenant for the specified site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Returns instance type allocation stats grouped by tenant for the specified site.

    User must have authorization role with PROVIDER_ADMIN suffix. The specified site must belong to the Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    required
    string <uuid>

    ID of the Site

    -

    Responses

    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Tenant

    -
    org
    string

    Organization name for the Tenant

    -
    orgDisplayName
    string

    Display name for the Tenant's organization

    -
    Array of objects (InstanceTypeStats)

    Instance Type statistics for this Tenant

    -
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the Instance Type

    -
    name
    string

    Name of the Instance Type

    -
    allocated
    integer

    Number of Machines allocated for this Instance Type

    -
    object (MachineStatusBreakdown)

    Usage statistics for Machines allocated to this Instance Type

    -
    maxAllocatable
    integer

    Maximum number of Machines of this Instance Type that can be allocated

    -
    Array of objects (TenantInstanceTypeAllocationStats)

    Allocation statistics for this Instance Type

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Tenant Account

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    required
    string <uuid>

    ID of the Site

    +

    Responses

    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Tenant

    +
    org
    string

    Organization name for the Tenant

    +
    orgDisplayName
    string

    Display name for the Tenant's organization

    +
    Array of objects (InstanceTypeStats)

    Instance Type statistics for this Tenant

    +
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the Instance Type

    +
    name
    string

    Name of the Instance Type

    +
    allocated
    integer

    Number of Machines allocated for this Instance Type

    +
    object (MachineStatusBreakdown)

    Usage statistics for Machines allocated to this Instance Type

    +
    maxAllocatable
    integer

    Maximum number of Machines of this Instance Type that can be allocated

    +
    Array of objects (TenantInstanceTypeAllocationStats)

    Allocation statistics for this Instance Type

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Tenant Account

    Typical API Call Flow for Tenant
    • accountNumber, subscriptionId, and subscriptionTier attributes were deprecated and will be removed on July 9th, 2026 0:00 UTC. Please update your usage accordingly.
    -

    Retrieve all Tenant Accounts

    Retrieve all Tenant Accounts

    Retrieve all Tenant Accounts for the org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all Tenant Accounts for the org.

    The Infrastructure Provider and Tenant are inferred from the org's membership. User must have authorization role with PROVIDER_ADMIN, PROVIDER_VIEWER, or TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    infrastructureProviderId
    string <uuid>
    Deprecated

    Filter Tenant Accounts by Infrastructure Provider ID. Deprecated: Infrastructure Provider is now inferred from the org's membership.

    -
    tenantId
    string <uuid>

    Filter Tenant Accounts by Tenant ID

    -
    query
    string

    Search string to filter Tenant Accounts by account number, tenant org, or tenant org display name

    -
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC" "ACCOUNT_NUMBER_ASC" "ACCOUNT_NUMBER_DESC" "TENANT_ORG_NAME_ASC" "TENANT_ORG_NAME_DESC" "TENANT_ORG_DISPLAY_NAME_ASC" "TENANT_ORG_DISPLAY_NAME_DESC" "TENANT_CONTACT_EMAIL_ASC" "TENANT_CONTACT_EMAIL_DESC" "TENANT_CONTACT_FULL_NAME_ASC" "TENANT_CONTACT_FULL_NAME_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the Tenant Account

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider

    -
    infrastructureProviderOrg
    string

    Organization name of the Infrastructure Provider

    -
    tenantId
    string or null <uuid>

    ID of the Tenant

    -
    tenantOrg
    string or null

    Org of the Tenant

    -
    object (User)

    Contact user for the Tenant

    -
    id
    string <uuid>

    Unique identifier for the given user.

    -
    email
    string or null <email>

    Email used by the user to register with NGC

    -
    firstName
    string or null

    First name of the user

    -
    lastName
    string or null

    Surname of the user

    -
    created
    string <date-time>

    The date that the user was created.

    -
    updated
    string <date-time>

    Date/time when the user was last updated in NICo

    -
    allocationCount
    integer

    Number of Allocations for the Tenant Account

    -
    status
    string (TenantAccountStatus)
    Enum: "Pending" "Invited" "Ready" "Error"

    Status of the Tenant Account

    -
    Array of objects (StatusDetail)

    Chronological status history for the Tenant Account

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    -
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    -
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    -
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    -
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    -
    notice
    string

    Message describing the deprecation

    -
    created
    string <date-time>

    Date/time when the Tenant Account was created

    -
    updated
    string <date-time>

    Date/time when the Tenant Account was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create Tenant Account

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    infrastructureProviderId
    string <uuid>
    Deprecated

    Filter Tenant Accounts by Infrastructure Provider ID. Deprecated: Infrastructure Provider is now inferred from the org's membership.

    +
    tenantId
    string <uuid>

    Filter Tenant Accounts by Tenant ID

    +
    query
    string

    Search string to filter Tenant Accounts by account number, tenant org, or tenant org display name

    +
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant"

    Related entity to expand

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC" "ACCOUNT_NUMBER_ASC" "ACCOUNT_NUMBER_DESC" "TENANT_ORG_NAME_ASC" "TENANT_ORG_NAME_DESC" "TENANT_ORG_DISPLAY_NAME_ASC" "TENANT_ORG_DISPLAY_NAME_DESC" "TENANT_CONTACT_EMAIL_ASC" "TENANT_CONTACT_EMAIL_DESC" "TENANT_CONTACT_FULL_NAME_ASC" "TENANT_CONTACT_FULL_NAME_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the Tenant Account

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider

    +
    infrastructureProviderOrg
    string

    Organization name of the Infrastructure Provider

    +
    tenantId
    string or null <uuid>

    ID of the Tenant

    +
    tenantOrg
    string or null

    Org of the Tenant

    +
    object (User)

    Contact user for the Tenant

    +
    id
    string <uuid>

    Unique identifier for the given user.

    +
    email
    string or null <email>

    Email used by the user to register with NGC

    +
    firstName
    string or null

    First name of the user

    +
    lastName
    string or null

    Surname of the user

    +
    created
    string <date-time>

    The date that the user was created.

    +
    updated
    string <date-time>

    Date/time when the user was last updated in NICo

    +
    allocationCount
    integer

    Number of Allocations for the Tenant Account

    +
    status
    string (TenantAccountStatus)
    Enum: "Pending" "Invited" "Ready" "Error"

    Status of the Tenant Account

    +
    Array of objects (StatusDetail)

    Chronological status history for the Tenant Account

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    +
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    +
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    +
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    +
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    +
    notice
    string

    Message describing the deprecation

    +
    created
    string <date-time>

    Date/time when the Tenant Account was created

    +
    updated
    string <date-time>

    Date/time when the Tenant Account was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create Tenant Account

    Create a Tenant Account.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create a Tenant Account.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix. The Infrastructure Provider is inferred from the caller's org; the deprecated infrastructureProviderId request body field is optional and, when provided, must match the org's Infrastructure Provider.

    Infrastructure Provider can create a Tenant Account by specifying the Tenant's UUID or Tenant's org name. This sets the Tenant Account status to "Invited". The Tenant can then view the account information and accept the account by updating the Tenant Account.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    infrastructureProviderId
    string <uuid>
    Deprecated
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    infrastructureProviderId
    string <uuid>
    Deprecated

    Deprecated; inferred from the caller's org Infrastructure Provider +" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    Deprecated; inferred from the caller's org Infrastructure Provider when omitted. When provided, the value must match the org's Infrastructure Provider — mismatched values are rejected with 400.

    -
    tenantOrg
    required
    string non-empty ^[A-Za-z0-9_-]+$

    Must be a valid Org name

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Tenant Account

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider

    -
    infrastructureProviderOrg
    string

    Organization name of the Infrastructure Provider

    -
    tenantId
    string or null <uuid>

    ID of the Tenant

    -
    tenantOrg
    string or null

    Org of the Tenant

    -
    object (User)

    Contact user for the Tenant

    -
    id
    string <uuid>

    Unique identifier for the given user.

    -
    email
    string or null <email>

    Email used by the user to register with NGC

    -
    firstName
    string or null

    First name of the user

    -
    lastName
    string or null

    Surname of the user

    -
    created
    string <date-time>

    The date that the user was created.

    -
    updated
    string <date-time>

    Date/time when the user was last updated in NICo

    -
    allocationCount
    integer

    Number of Allocations for the Tenant Account

    -
    status
    string (TenantAccountStatus)
    Enum: "Pending" "Invited" "Ready" "Error"

    Status of the Tenant Account

    -
    Array of objects (StatusDetail)

    Chronological status history for the Tenant Account

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    -
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    -
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    -
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    -
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    -
    notice
    string

    Message describing the deprecation

    -
    created
    string <date-time>

    Date/time when the Tenant Account was created

    -
    updated
    string <date-time>

    Date/time when the Tenant Account was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "tenantOrg": "rf43bbtnb9c5"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "infrastructureProviderOrg": "xskkpgqpeakn",
    • "tenantId": null,
    • "tenantOrg": "rf43bbtnb9c5",
    • "tenantContact": {
      },
    • "allocationCount": 0,
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve Tenant Account

    		tenantOrg
    required
    string non-empty ^[A-Za-z0-9_-]+$

    Must be a valid Org name

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Tenant Account

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider

    +
    infrastructureProviderOrg
    string

    Organization name of the Infrastructure Provider

    +
    tenantId
    string or null <uuid>

    ID of the Tenant

    +
    tenantOrg
    string or null

    Org of the Tenant

    +
    object (User)

    Contact user for the Tenant

    +
    id
    string <uuid>

    Unique identifier for the given user.

    +
    email
    string or null <email>

    Email used by the user to register with NGC

    +
    firstName
    string or null

    First name of the user

    +
    lastName
    string or null

    Surname of the user

    +
    created
    string <date-time>

    The date that the user was created.

    +
    updated
    string <date-time>

    Date/time when the user was last updated in NICo

    +
    allocationCount
    integer

    Number of Allocations for the Tenant Account

    +
    status
    string (TenantAccountStatus)
    Enum: "Pending" "Invited" "Ready" "Error"

    Status of the Tenant Account

    +
    Array of objects (StatusDetail)

    Chronological status history for the Tenant Account

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    +
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    +
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    +
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    +
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    +
    notice
    string

    Message describing the deprecation

    +
    created
    string <date-time>

    Date/time when the Tenant Account was created

    +
    updated
    string <date-time>

    Date/time when the Tenant Account was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "tenantOrg": "rf43bbtnb9c5"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "infrastructureProviderOrg": "xskkpgqpeakn",
    • "tenantId": null,
    • "tenantOrg": "rf43bbtnb9c5",
    • "tenantContact": {
      },
    • "allocationCount": 0,
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve Tenant Account

    Retrieve a Tenant Account by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a Tenant Account by ID.

    The Infrastructure Provider and Tenant are inferred from the org's membership. User must have authorization role with PROVIDER_ADMIN, PROVIDER_VIEWER, or TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    accountId
    required
    string <uuid>

    ID of the Tenant Account

    -
    query Parameters
    infrastructureProviderId
    string <uuid>
    Deprecated

    Filter Tenant Accounts by Infrastructure Provider ID. Deprecated: Infrastructure Provider is now inferred from the org's membership.

    -
    tenantId
    string <uuid>
    Deprecated

    Filter Tenant Accounts by Tenant ID. Deprecated: Tenant is now inferred from the org's membership.

    -
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant"

    Related entity to expand

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Tenant Account

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider

    -
    infrastructureProviderOrg
    string

    Organization name of the Infrastructure Provider

    -
    tenantId
    string or null <uuid>

    ID of the Tenant

    -
    tenantOrg
    string or null

    Org of the Tenant

    -
    object (User)

    Contact user for the Tenant

    -
    id
    string <uuid>

    Unique identifier for the given user.

    -
    email
    string or null <email>

    Email used by the user to register with NGC

    -
    firstName
    string or null

    First name of the user

    -
    lastName
    string or null

    Surname of the user

    -
    created
    string <date-time>

    The date that the user was created.

    -
    updated
    string <date-time>

    Date/time when the user was last updated in NICo

    -
    allocationCount
    integer

    Number of Allocations for the Tenant Account

    -
    status
    string (TenantAccountStatus)
    Enum: "Pending" "Invited" "Ready" "Error"

    Status of the Tenant Account

    -
    Array of objects (StatusDetail)

    Chronological status history for the Tenant Account

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    -
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    -
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    -
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    -
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    -
    notice
    string

    Message describing the deprecation

    -
    created
    string <date-time>

    Date/time when the Tenant Account was created

    -
    updated
    string <date-time>

    Date/time when the Tenant Account was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "infrastructureProviderOrg": "xskkpgqpeakn",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "tenantOrg": "rf43bbtnb9c5",
    • "tenantContact": {
      },
    • "allocationCount": 2,
    • "status": "Ready",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Tenant Account

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    accountId
    required
    string <uuid>

    ID of the Tenant Account

    +
    query Parameters
    infrastructureProviderId
    string <uuid>
    Deprecated

    Filter Tenant Accounts by Infrastructure Provider ID. Deprecated: Infrastructure Provider is now inferred from the org's membership.

    +
    tenantId
    string <uuid>
    Deprecated

    Filter Tenant Accounts by Tenant ID. Deprecated: Tenant is now inferred from the org's membership.

    +
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant"

    Related entity to expand

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Tenant Account

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider

    +
    infrastructureProviderOrg
    string

    Organization name of the Infrastructure Provider

    +
    tenantId
    string or null <uuid>

    ID of the Tenant

    +
    tenantOrg
    string or null

    Org of the Tenant

    +
    object (User)

    Contact user for the Tenant

    +
    id
    string <uuid>

    Unique identifier for the given user.

    +
    email
    string or null <email>

    Email used by the user to register with NGC

    +
    firstName
    string or null

    First name of the user

    +
    lastName
    string or null

    Surname of the user

    +
    created
    string <date-time>

    The date that the user was created.

    +
    updated
    string <date-time>

    Date/time when the user was last updated in NICo

    +
    allocationCount
    integer

    Number of Allocations for the Tenant Account

    +
    status
    string (TenantAccountStatus)
    Enum: "Pending" "Invited" "Ready" "Error"

    Status of the Tenant Account

    +
    Array of objects (StatusDetail)

    Chronological status history for the Tenant Account

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    +
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    +
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    +
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    +
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    +
    notice
    string

    Message describing the deprecation

    +
    created
    string <date-time>

    Date/time when the Tenant Account was created

    +
    updated
    string <date-time>

    Date/time when the Tenant Account was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "infrastructureProviderOrg": "xskkpgqpeakn",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "tenantOrg": "rf43bbtnb9c5",
    • "tenantContact": {
      },
    • "allocationCount": 2,
    • "status": "Ready",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Tenant Account

    Update a Tenant Account.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update a Tenant Account.

    Can be used to accept an invitation sent by an Infrastructure Provider.

    Org must have a Tenant entity whose ID matches the tenantId of the Tenant Account object. User must have authorization role with TENANT_ADMIN suffix. Can only update a Tenant Account that has Invited status.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    accountId
    required
    string <uuid>

    ID of the Tenant Account

    -
    Request Body schema: application/json

    No parameters are required; an empty request body is sufficient.

    -
    object (TenantAccountUpdateRequest)
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    accountId
    required
    string <uuid>

    ID of the Tenant Account

    +
    Request Body schema: application/json

    No parameters are required; an empty request body is sufficient.

    +
    object (TenantAccountUpdateRequest)

    Request data to update a TenantAccount.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    Request data to update a TenantAccount.

    No params needed, an empty request will suffice.

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Tenant Account

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider

    -
    infrastructureProviderOrg
    string

    Organization name of the Infrastructure Provider

    -
    tenantId
    string or null <uuid>

    ID of the Tenant

    -
    tenantOrg
    string or null

    Org of the Tenant

    -
    object (User)

    Contact user for the Tenant

    -
    id
    string <uuid>

    Unique identifier for the given user.

    -
    email
    string or null <email>

    Email used by the user to register with NGC

    -
    firstName
    string or null

    First name of the user

    -
    lastName
    string or null

    Surname of the user

    -
    created
    string <date-time>

    The date that the user was created.

    -
    updated
    string <date-time>

    Date/time when the user was last updated in NICo

    -
    allocationCount
    integer

    Number of Allocations for the Tenant Account

    -
    status
    string (TenantAccountStatus)
    Enum: "Pending" "Invited" "Ready" "Error"

    Status of the Tenant Account

    -
    Array of objects (StatusDetail)

    Chronological status history for the Tenant Account

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    -
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    -
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    -
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    -
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    -
    notice
    string

    Message describing the deprecation

    -
    created
    string <date-time>

    Date/time when the Tenant Account was created

    -
    updated
    string <date-time>

    Date/time when the Tenant Account was last updated

    -

    Request samples

    Content type
    application/json
    { }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "infrastructureProviderOrg": "xskkpgqpeakn",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "tenantOrg": "rf43bbtnb9c5",
    • "tenantContact": {
      },
    • "allocationCount": 0,
    • "status": "Ready",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Tenant Account

    Responses
    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Tenant Account

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider

    +
    infrastructureProviderOrg
    string

    Organization name of the Infrastructure Provider

    +
    tenantId
    string or null <uuid>

    ID of the Tenant

    +
    tenantOrg
    string or null

    Org of the Tenant

    +
    object (User)

    Contact user for the Tenant

    +
    id
    string <uuid>

    Unique identifier for the given user.

    +
    email
    string or null <email>

    Email used by the user to register with NGC

    +
    firstName
    string or null

    First name of the user

    +
    lastName
    string or null

    Surname of the user

    +
    created
    string <date-time>

    The date that the user was created.

    +
    updated
    string <date-time>

    Date/time when the user was last updated in NICo

    +
    allocationCount
    integer

    Number of Allocations for the Tenant Account

    +
    status
    string (TenantAccountStatus)
    Enum: "Pending" "Invited" "Ready" "Error"

    Status of the Tenant Account

    +
    Array of objects (StatusDetail)

    Chronological status history for the Tenant Account

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    +
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    +
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    +
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    +
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    +
    notice
    string

    Message describing the deprecation

    +
    created
    string <date-time>

    Date/time when the Tenant Account was created

    +
    updated
    string <date-time>

    Date/time when the Tenant Account was last updated

    +

    Request samples

    Content type
    application/json
    { }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "infrastructureProviderOrg": "xskkpgqpeakn",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "tenantOrg": "rf43bbtnb9c5",
    • "tenantContact": {
      },
    • "allocationCount": 0,
    • "status": "Ready",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Tenant Account

    Delete a Tenant Account by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete a Tenant Account by ID.

    Org must have an Infrastructure Provider entity, and the specified Tenant Account must have been created by that Provider. Requesting user must have PROVIDER_ADMIN role.

    Tenant cannot delete a Tenant Account.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    accountId
    required
    string <uuid>

    ID of the Tenant Account

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Site

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    accountId
    required
    string <uuid>

    ID of the Tenant Account

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Site

    Typical API Call Flow for Tenant
  • rackLevelAdministration capability attribute was deprecated in favor of flow and was removed on May 13th, 2026 0:00 UTC. Please use flow instead.
  • isRackLevelAdministrationEnabled query parameter was deprecated in favor of isFlowEnabled and was removed on May 13th, 2026 0:00 UTC. Please use isFlowEnabled instead.
    • -

    Retrieve all Sites

    Retrieve all Sites

    Retrieve all Sites for org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all Sites for org.

    User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix. infrastructureProviderId or tenantId query parameter may be required for older API versions.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    infrastructureProviderId
    string <uuid>

    Filter Sites by Infrastructure Provider ID

    -
    tenantId
    string <uuid>

    Filter Sites by Tenant ID

    -
    status
    string

    Filter Sites by Status. Can be specified multiple times to filter on more than one status

    -
    isNativeNetworkingEnabled
    boolean

    Filter Sites by native networking enabled flag. Requires Provider Admin role.

    -
    isNetworkSecurityGroupEnabled
    boolean

    Filter Sites by network security group enabled flag. Requires Provider Admin role.

    -
    isNVLinkPartitionEnabled
    boolean

    Filter Sites by NVLink partitioning enabled flag. Requires Provider Admin role.

    -
    isFlowEnabled
    boolean

    Filter Sites by NICo Flow enabled flag. Requires Provider Admin role.

    -
    includeMachineStats
    boolean

    Include a breakdown of Machine counts by lifecycle status and health. Requires Provider Admin role.

    -
    query
    string

    Search for matches across all Sites. Input will be matched against name, description, location, contact, and status fields

    -
    includeRelation
    string
    Value: "InfrastructureProvider"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC" "DESCRIPTION_ASC" "DESCRIPTION_DESC" "LOCATION_ASC" "LOCATION_DESC" "CONTACT_ASC" "CONTACT_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the Site in NICo Cloud

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    -
    description
    string or null

    Optional description for the Site

    -
    org
    string

    NGC organization ID of the Infrastructure Provider that owns the Site

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    -
    siteControllerVersion
    string or null

    Version of the Site Controller software

    -
    siteAgentVersion
    string or null

    Version of the Site Agent software

    -
    registrationToken
    string or null

    Token that can be used to register a Site. Value only exposed to Provider

    -
    registrationTokenExpiration
    string or null <date-time>

    Date/time when registration token expires. Value only exposed to Provider

    -
    serialConsoleHostname
    string or null <hostname>

    Serial console hostname of the site controller

    -
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    -
    serialConsoleIdleTimeout
    integer or null

    Maximum idle time in seconds before Serial Console is disconnected

    -
    serialConsoleMaxSessionLength
    integer or null

    Maximum length of Serial Console session in seconds

    -
    isSerialConsoleSSHKeysEnabled
    boolean

    Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

    -
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    -
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    -
    Array of objects (StatusDetail)

    Chronological status history for the Site

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the Site was created

    -
    updated
    string <date-time>

    Date/time when the Site was last updated

    -
    object (SiteLocation)

    Site location information

    -
    city
    string

    City where the site is located

    -
    state
    string

    State where the site is located

    -
    country
    string

    Country where the site is located

    -
    object (SiteContact)

    Site contact information

    -
    email
    string

    Email address of the Site contact

    -
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    -
    nativeNetworking
    boolean

    Whether the Site supports native networking

    -
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    -
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    -
    flow
    boolean

    Whether the Site supports Flow-based operations

    -
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    -
    object (SiteMachineStats)

    Machine counts by status for the Site

    -
    total
    integer

    Total number of Machines at the Site

    -
    object (SiteMachineStatsByStatus)

    Machine counts grouped by Machine status

    -
    object (SiteMachineStatsByHealth)

    Machine counts grouped by health state

    -
    object (SiteMachineStatsByStatusAndHealth)

    Machine health counts grouped by Machine status

    -
    object (SiteMachineStatsByAllocation)

    Machine counts grouped by allocation and usage state

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create Site

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    infrastructureProviderId
    string <uuid>

    Filter Sites by Infrastructure Provider ID

    +
    tenantId
    string <uuid>

    Filter Sites by Tenant ID

    +
    status
    string

    Filter Sites by Status. Can be specified multiple times to filter on more than one status

    +
    isNativeNetworkingEnabled
    boolean

    Filter Sites by native networking enabled flag. Requires Provider Admin role.

    +
    isNetworkSecurityGroupEnabled
    boolean

    Filter Sites by network security group enabled flag. Requires Provider Admin role.

    +
    isNVLinkPartitionEnabled
    boolean

    Filter Sites by NVLink partitioning enabled flag. Requires Provider Admin role.

    +
    isFlowEnabled
    boolean

    Filter Sites by NICo Flow enabled flag. Requires Provider Admin role.

    +
    includeMachineStats
    boolean

    Include a breakdown of Machine counts by lifecycle status and health. Requires Provider Admin role.

    +
    query
    string

    Search for matches across all Sites. Input will be matched against name, description, location, contact, and status fields

    +
    includeRelation
    string
    Value: "InfrastructureProvider"

    Related entity to expand

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC" "DESCRIPTION_ASC" "DESCRIPTION_DESC" "LOCATION_ASC" "LOCATION_DESC" "CONTACT_ASC" "CONTACT_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the Site in NICo Cloud

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    +
    description
    string or null

    Optional description for the Site

    +
    org
    string

    NGC organization ID of the Infrastructure Provider that owns the Site

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    +
    siteControllerVersion
    string or null

    Version of the Site Controller software

    +
    siteAgentVersion
    string or null

    Version of the Site Agent software

    +
    registrationToken
    string or null

    Token that can be used to register a Site. Value only exposed to Provider

    +
    registrationTokenExpiration
    string or null <date-time>

    Date/time when registration token expires. Value only exposed to Provider

    +
    serialConsoleHostname
    string or null <hostname>

    Serial console hostname of the site controller

    +
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    +
    serialConsoleIdleTimeout
    integer or null

    Maximum idle time in seconds before Serial Console is disconnected

    +
    serialConsoleMaxSessionLength
    integer or null

    Maximum length of Serial Console session in seconds

    +
    isSerialConsoleSSHKeysEnabled
    boolean

    Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

    +
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    +
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    +
    Array of objects (StatusDetail)

    Chronological status history for the Site

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the Site was created

    +
    updated
    string <date-time>

    Date/time when the Site was last updated

    +
    object (SiteLocation)

    Site location information

    +
    city
    string

    City where the site is located

    +
    state
    string

    State where the site is located

    +
    country
    string

    Country where the site is located

    +
    object (SiteContact)

    Site contact information

    +
    email
    string

    Email address of the Site contact

    +
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    +
    nativeNetworking
    boolean

    Whether the Site supports native networking

    +
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    +
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    +
    flow
    boolean

    Whether the Site supports Flow-based operations

    +
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    +
    object (SiteMachineStats)

    Machine counts by status for the Site

    +
    total
    integer

    Total number of Machines at the Site

    +
    object (SiteMachineStatsByStatus)

    Machine counts grouped by Machine status

    +
    object (SiteMachineStatsByHealth)

    Machine counts grouped by health state

    +
    object (SiteMachineStatsByStatusAndHealth)

    Machine health counts grouped by Machine status

    +
    object (SiteMachineStatsByAllocation)

    Machine counts grouped by allocation and usage state

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create Site

    Create a Site for the org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create a Site for the org.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Tenants cannot create Sites.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name for the Site

    -
    description
    string or null

    Description for the Site

    -
    serialConsoleHostname
    string or null <hostname>

    Hostname to reach Serial Console for the Site

    -
    object (SiteLocation)

    Site location information

    -
    city
    string

    City where the site is located

    -
    state
    string

    State where the site is located

    -
    country
    string

    Country where the site is located

    -
    object (SiteContact)

    Site contact information

    -
    email
    string

    Email address of the Site contact

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Site in NICo Cloud

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    -
    description
    string or null

    Optional description for the Site

    -
    org
    string

    NGC organization ID of the Infrastructure Provider that owns the Site

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    -
    siteControllerVersion
    string or null

    Version of the Site Controller software

    -
    siteAgentVersion
    string or null

    Version of the Site Agent software

    -
    registrationToken
    string or null

    Token that can be used to register a Site. Value only exposed to Provider

    -
    registrationTokenExpiration
    string or null <date-time>

    Date/time when registration token expires. Value only exposed to Provider

    -
    serialConsoleHostname
    string or null <hostname>

    Serial console hostname of the site controller

    -
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    -
    serialConsoleIdleTimeout
    integer or null

    Maximum idle time in seconds before Serial Console is disconnected

    -
    serialConsoleMaxSessionLength
    integer or null

    Maximum length of Serial Console session in seconds

    -
    isSerialConsoleSSHKeysEnabled
    boolean

    Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

    -
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    -
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    -
    Array of objects (StatusDetail)

    Chronological status history for the Site

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the Site was created

    -
    updated
    string <date-time>

    Date/time when the Site was last updated

    -
    object (SiteLocation)

    Site location information

    -
    city
    string

    City where the site is located

    -
    state
    string

    State where the site is located

    -
    country
    string

    Country where the site is located

    -
    object (SiteContact)

    Site contact information

    -
    email
    string

    Email address of the Site contact

    -
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    -
    nativeNetworking
    boolean

    Whether the Site supports native networking

    -
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    -
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    -
    flow
    boolean

    Whether the Site supports Flow-based operations

    -
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    -
    object (SiteMachineStats)

    Machine counts by status for the Site

    -
    total
    integer

    Total number of Machines at the Site

    -
    object (SiteMachineStatsByStatus)

    Machine counts grouped by Machine status

    -
    Decommissioned
    integer

    Number of Machines in Decommissioned status

    -
    Error
    integer

    Number of Machines in Error status

    -
    Initializing
    integer

    Number of Machines in Initializing status

    -
    InUse
    integer

    Number of Machines in InUse status

    -
    Maintenance
    integer

    Number of Machines in Maintenance status

    -
    Ready
    integer

    Number of Machines in Ready status

    -
    Reset
    integer

    Number of Machines in Reset status

    -
    Unknown
    integer

    Number of Machines in Unknown status

    -
    object (SiteMachineStatsByHealth)

    Machine counts grouped by health state

    -
    healthy
    integer

    Number of healthy Machines

    -
    unhealthy
    integer

    Number of unhealthy Machines

    -
    object (SiteMachineStatsByStatusAndHealth)

    Machine health counts grouped by Machine status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Decommissioned status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Error status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Initializing status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in InUse status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Maintenance status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Ready status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Reset status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Unknown status

    -
    object (SiteMachineStatsByAllocation)

    Machine counts grouped by allocation and usage state

    -
    allocatedInUse
    integer

    Number of allocated Machines currently in use

    -
    allocatedNotInUse
    integer

    Number of allocated Machines not currently in use

    -
    unallocated
    integer

    Number of Machines not currently allocated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "San Jose Central 4",
    • "description": "Datacenter serving San Jose central region",
    • "location": {
      },
    • "contact": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "San Jose Central 4",
    • "description": "Datacenter serving the San Jose central region",
    • "org": "qygdmg8oqik8",
    • "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
    • "siteControllerVersion": "0.1",
    • "siteAgentVersion": "0.1",
    • "registrationToken": "J7KO-89RR-Y7WQ-AD90",
    • "registrationTokenExpiration": "2019-08-25T12:00:00Z",
    • "serialConsoleHostname": "sjc.nico.acme.com",
    • "isSerialConsoleEnabled": true,
    • "serialConsoleIdleTimeout": 60,
    • "serialConsoleMaxSessionLength": 3600,
    • "isSerialConsoleSSHKeysEnabled": true,
    • "machineStats": {
      },
    • "capabilities": {
      },
    • "isOnline": false,
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "location": {
      },
    • "contact": {
      }
    }

    Retrieve Site

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name for the Site

    +
    description
    string or null

    Description for the Site

    +
    serialConsoleHostname
    string or null <hostname>

    Hostname to reach Serial Console for the Site

    +
    object (SiteLocation)

    Site location information

    +
    city
    string

    City where the site is located

    +
    state
    string

    State where the site is located

    +
    country
    string

    Country where the site is located

    +
    object (SiteContact)

    Site contact information

    +
    email
    string

    Email address of the Site contact

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Site in NICo Cloud

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    +
    description
    string or null

    Optional description for the Site

    +
    org
    string

    NGC organization ID of the Infrastructure Provider that owns the Site

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    +
    siteControllerVersion
    string or null

    Version of the Site Controller software

    +
    siteAgentVersion
    string or null

    Version of the Site Agent software

    +
    registrationToken
    string or null

    Token that can be used to register a Site. Value only exposed to Provider

    +
    registrationTokenExpiration
    string or null <date-time>

    Date/time when registration token expires. Value only exposed to Provider

    +
    serialConsoleHostname
    string or null <hostname>

    Serial console hostname of the site controller

    +
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    +
    serialConsoleIdleTimeout
    integer or null

    Maximum idle time in seconds before Serial Console is disconnected

    +
    serialConsoleMaxSessionLength
    integer or null

    Maximum length of Serial Console session in seconds

    +
    isSerialConsoleSSHKeysEnabled
    boolean

    Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

    +
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    +
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    +
    Array of objects (StatusDetail)

    Chronological status history for the Site

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the Site was created

    +
    updated
    string <date-time>

    Date/time when the Site was last updated

    +
    object (SiteLocation)

    Site location information

    +
    city
    string

    City where the site is located

    +
    state
    string

    State where the site is located

    +
    country
    string

    Country where the site is located

    +
    object (SiteContact)

    Site contact information

    +
    email
    string

    Email address of the Site contact

    +
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    +
    nativeNetworking
    boolean

    Whether the Site supports native networking

    +
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    +
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    +
    flow
    boolean

    Whether the Site supports Flow-based operations

    +
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    +
    object (SiteMachineStats)

    Machine counts by status for the Site

    +
    total
    integer

    Total number of Machines at the Site

    +
    object (SiteMachineStatsByStatus)

    Machine counts grouped by Machine status

    +
    Decommissioned
    integer

    Number of Machines in Decommissioned status

    +
    Error
    integer

    Number of Machines in Error status

    +
    Initializing
    integer

    Number of Machines in Initializing status

    +
    InUse
    integer

    Number of Machines in InUse status

    +
    Maintenance
    integer

    Number of Machines in Maintenance status

    +
    Ready
    integer

    Number of Machines in Ready status

    +
    Reset
    integer

    Number of Machines in Reset status

    +
    Unknown
    integer

    Number of Machines in Unknown status

    +
    object (SiteMachineStatsByHealth)

    Machine counts grouped by health state

    +
    healthy
    integer

    Number of healthy Machines

    +
    unhealthy
    integer

    Number of unhealthy Machines

    +
    object (SiteMachineStatsByStatusAndHealth)

    Machine health counts grouped by Machine status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Decommissioned status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Error status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Initializing status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in InUse status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Maintenance status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Ready status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Reset status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Unknown status

    +
    object (SiteMachineStatsByAllocation)

    Machine counts grouped by allocation and usage state

    +
    allocatedInUse
    integer

    Number of allocated Machines currently in use

    +
    allocatedNotInUse
    integer

    Number of allocated Machines not currently in use

    +
    unallocated
    integer

    Number of Machines not currently allocated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "San Jose Central 4",
    • "description": "Datacenter serving San Jose central region",
    • "location": {
      },
    • "contact": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "San Jose Central 4",
    • "description": "Datacenter serving the San Jose central region",
    • "org": "qygdmg8oqik8",
    • "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
    • "siteControllerVersion": "0.1",
    • "siteAgentVersion": "0.1",
    • "registrationToken": "J7KO-89RR-Y7WQ-AD90",
    • "registrationTokenExpiration": "2019-08-25T12:00:00Z",
    • "serialConsoleHostname": "sjc.nico.acme.com",
    • "isSerialConsoleEnabled": true,
    • "serialConsoleIdleTimeout": 60,
    • "serialConsoleMaxSessionLength": 3600,
    • "isSerialConsoleSSHKeysEnabled": true,
    • "machineStats": {
      },
    • "capabilities": {
      },
    • "isOnline": false,
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "location": {
      },
    • "contact": {
      }
    }

    Retrieve Site

    Typical API Call Flow for Tenant <li>The org&#39;s Tenant has an Allocation for Site</li> <li>The org&#39;s Tenant is privileged and has Account with Site&#39;s Provider</li> </ul> -" class="sc-iKGpAq sc-cCYyou dXXcln dHaogz">

    Retrieve a specific Site by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific Site by ID.

    User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix.

    Access is granted if:

      @@ -1564,341 +1564,341 @@

      Typical API Call Flow for Tenant

    • The org's Tenant has an Allocation for Site
    • The org's Tenant is privileged and has Account with Site's Provider
    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    siteId
    required
    string <uuid>

    ID of the Site

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Site in NICo Cloud

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    -
    description
    string or null

    Optional description for the Site

    -
    org
    string

    NGC organization ID of the Infrastructure Provider that owns the Site

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    -
    siteControllerVersion
    string or null

    Version of the Site Controller software

    -
    siteAgentVersion
    string or null

    Version of the Site Agent software

    -
    registrationToken
    string or null

    Token that can be used to register a Site. Value only exposed to Provider

    -
    registrationTokenExpiration
    string or null <date-time>

    Date/time when registration token expires. Value only exposed to Provider

    -
    serialConsoleHostname
    string or null <hostname>

    Serial console hostname of the site controller

    -
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    -
    serialConsoleIdleTimeout
    integer or null

    Maximum idle time in seconds before Serial Console is disconnected

    -
    serialConsoleMaxSessionLength
    integer or null

    Maximum length of Serial Console session in seconds

    -
    isSerialConsoleSSHKeysEnabled
    boolean

    Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

    -
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    -
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    -
    Array of objects (StatusDetail)

    Chronological status history for the Site

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the Site was created

    -
    updated
    string <date-time>

    Date/time when the Site was last updated

    -
    object (SiteLocation)

    Site location information

    -
    city
    string

    City where the site is located

    -
    state
    string

    State where the site is located

    -
    country
    string

    Country where the site is located

    -
    object (SiteContact)

    Site contact information

    -
    email
    string

    Email address of the Site contact

    -
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    -
    nativeNetworking
    boolean

    Whether the Site supports native networking

    -
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    -
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    -
    flow
    boolean

    Whether the Site supports Flow-based operations

    -
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    -
    object (SiteMachineStats)

    Machine counts by status for the Site

    -
    total
    integer

    Total number of Machines at the Site

    -
    object (SiteMachineStatsByStatus)

    Machine counts grouped by Machine status

    -
    Decommissioned
    integer

    Number of Machines in Decommissioned status

    -
    Error
    integer

    Number of Machines in Error status

    -
    Initializing
    integer

    Number of Machines in Initializing status

    -
    InUse
    integer

    Number of Machines in InUse status

    -
    Maintenance
    integer

    Number of Machines in Maintenance status

    -
    Ready
    integer

    Number of Machines in Ready status

    -
    Reset
    integer

    Number of Machines in Reset status

    -
    Unknown
    integer

    Number of Machines in Unknown status

    -
    object (SiteMachineStatsByHealth)

    Machine counts grouped by health state

    -
    healthy
    integer

    Number of healthy Machines

    -
    unhealthy
    integer

    Number of unhealthy Machines

    -
    object (SiteMachineStatsByStatusAndHealth)

    Machine health counts grouped by Machine status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Decommissioned status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Error status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Initializing status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in InUse status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Maintenance status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Ready status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Reset status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Unknown status

    -
    object (SiteMachineStatsByAllocation)

    Machine counts grouped by allocation and usage state

    -
    allocatedInUse
    integer

    Number of allocated Machines currently in use

    -
    allocatedNotInUse
    integer

    Number of allocated Machines not currently in use

    -
    unallocated
    integer

    Number of Machines not currently allocated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "San Jose Central 4",
    • "description": "Datacenter serving the San Jose central region",
    • "org": "qygdmg8oqik8",
    • "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
    • "siteControllerVersion": "0.1",
    • "siteAgentVersion": "0.1",
    • "registrationToken": "J7KO-89RR-Y7WQ-AD90",
    • "registrationTokenExpiration": "2019-08-25T12:00:00Z",
    • "serialConsoleHostname": "sjc.nico.acme.com",
    • "isSerialConsoleEnabled": true,
    • "serialConsoleIdleTimeout": 60,
    • "serialConsoleMaxSessionLength": 3600,
    • "isSerialConsoleSSHKeysEnabled": true,
    • "machineStats": {
      },
    • "capabilities": {
      },
    • "isOnline": false,
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "location": {
      },
    • "contact": {
      }
    }

    Update Site

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    siteId
    required
    string <uuid>

    ID of the Site

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Site in NICo Cloud

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    +
    description
    string or null

    Optional description for the Site

    +
    org
    string

    NGC organization ID of the Infrastructure Provider that owns the Site

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    +
    siteControllerVersion
    string or null

    Version of the Site Controller software

    +
    siteAgentVersion
    string or null

    Version of the Site Agent software

    +
    registrationToken
    string or null

    Token that can be used to register a Site. Value only exposed to Provider

    +
    registrationTokenExpiration
    string or null <date-time>

    Date/time when registration token expires. Value only exposed to Provider

    +
    serialConsoleHostname
    string or null <hostname>

    Serial console hostname of the site controller

    +
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    +
    serialConsoleIdleTimeout
    integer or null

    Maximum idle time in seconds before Serial Console is disconnected

    +
    serialConsoleMaxSessionLength
    integer or null

    Maximum length of Serial Console session in seconds

    +
    isSerialConsoleSSHKeysEnabled
    boolean

    Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

    +
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    +
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    +
    Array of objects (StatusDetail)

    Chronological status history for the Site

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the Site was created

    +
    updated
    string <date-time>

    Date/time when the Site was last updated

    +
    object (SiteLocation)

    Site location information

    +
    city
    string

    City where the site is located

    +
    state
    string

    State where the site is located

    +
    country
    string

    Country where the site is located

    +
    object (SiteContact)

    Site contact information

    +
    email
    string

    Email address of the Site contact

    +
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    +
    nativeNetworking
    boolean

    Whether the Site supports native networking

    +
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    +
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    +
    flow
    boolean

    Whether the Site supports Flow-based operations

    +
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    +
    object (SiteMachineStats)

    Machine counts by status for the Site

    +
    total
    integer

    Total number of Machines at the Site

    +
    object (SiteMachineStatsByStatus)

    Machine counts grouped by Machine status

    +
    Decommissioned
    integer

    Number of Machines in Decommissioned status

    +
    Error
    integer

    Number of Machines in Error status

    +
    Initializing
    integer

    Number of Machines in Initializing status

    +
    InUse
    integer

    Number of Machines in InUse status

    +
    Maintenance
    integer

    Number of Machines in Maintenance status

    +
    Ready
    integer

    Number of Machines in Ready status

    +
    Reset
    integer

    Number of Machines in Reset status

    +
    Unknown
    integer

    Number of Machines in Unknown status

    +
    object (SiteMachineStatsByHealth)

    Machine counts grouped by health state

    +
    healthy
    integer

    Number of healthy Machines

    +
    unhealthy
    integer

    Number of unhealthy Machines

    +
    object (SiteMachineStatsByStatusAndHealth)

    Machine health counts grouped by Machine status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Decommissioned status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Error status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Initializing status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in InUse status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Maintenance status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Ready status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Reset status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Unknown status

    +
    object (SiteMachineStatsByAllocation)

    Machine counts grouped by allocation and usage state

    +
    allocatedInUse
    integer

    Number of allocated Machines currently in use

    +
    allocatedNotInUse
    integer

    Number of allocated Machines not currently in use

    +
    unallocated
    integer

    Number of Machines not currently allocated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "San Jose Central 4",
    • "description": "Datacenter serving the San Jose central region",
    • "org": "qygdmg8oqik8",
    • "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
    • "siteControllerVersion": "0.1",
    • "siteAgentVersion": "0.1",
    • "registrationToken": "J7KO-89RR-Y7WQ-AD90",
    • "registrationTokenExpiration": "2019-08-25T12:00:00Z",
    • "serialConsoleHostname": "sjc.nico.acme.com",
    • "isSerialConsoleEnabled": true,
    • "serialConsoleIdleTimeout": 60,
    • "serialConsoleMaxSessionLength": 3600,
    • "isSerialConsoleSSHKeysEnabled": true,
    • "machineStats": {
      },
    • "capabilities": {
      },
    • "isOnline": false,
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "location": {
      },
    • "contact": {
      }
    }

    Update Site

    Update a specific Site

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update a specific Site

    User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider updating the Site must be the owner of the Site. At present, there are no other Site-specific configurations modifiable by Tenant.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    siteId
    required
    string <uuid>

    ID of the Site

    -
    Request Body schema: application/json
    name
    string or null

    Update name of the Site. Can only be updated by Provider

    -
    description
    string or null

    Update description for the Site. Can only be updated by Provider

    -
    renewRegistrationToken
    boolean

    Set to true to issue a new registration token. Can only be updated by Provider

    -
    serialConsoleHostname
    string or null <hostname>

    Hostname to reach Serial Console for the Site. Can only be updated by Provider

    -
    isSerialConsoleEnabled
    boolean
    Deprecated

    Enable/disable Serial Console. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

    -
    serialConsoleIdleTimeout
    integer
    Deprecated

    Maximum idle time in seconds before Serial Console is disconnected. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

    -
    serialConsoleMaxSessionLength
    integer
    Deprecated

    Maximum length of Serial Console session in seconds. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

    -
    isSerialConsoleSSHKeysEnabled
    boolean
    Deprecated

    Enable/disable Serial Console access using SSH Keys. Previously updateable only by Tenants, modifying this value is no longer supported, update SSH Key Groups to remove Site instead.

    -
    object (SiteLocation)

    Updated Site location information

    -
    city
    string

    City where the site is located

    -
    state
    string

    State where the site is located

    -
    country
    string

    Country where the site is located

    -
    object (SiteContact)

    Updated Site contact information

    -
    email
    string

    Email address of the Site contact

    -
    object (SiteCapabilitiesUpdateRequest)

    Modify Site capabilities. Can only be updated by Provider. Partial update allowed, only specify capabilities that should be updated.

    -
    nativeNetworking
    boolean or null

    Enable or disable native networking for the Site

    -
    networkSecurityGroup
    boolean or null

    Enable or disable network security groups for the Site

    -
    nvLinkPartition
    boolean or null

    Enable or disable NVLink partition support for the Site

    -
    flow
    boolean or null

    Enable or disable NICo Flow for the Site

    -
    imageBasedOperatingSystem
    boolean or null

    Enable or disable image-based operating system support for the Site

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Site in NICo Cloud

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    -
    description
    string or null

    Optional description for the Site

    -
    org
    string

    NGC organization ID of the Infrastructure Provider that owns the Site

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    -
    siteControllerVersion
    string or null

    Version of the Site Controller software

    -
    siteAgentVersion
    string or null

    Version of the Site Agent software

    -
    registrationToken
    string or null

    Token that can be used to register a Site. Value only exposed to Provider

    -
    registrationTokenExpiration
    string or null <date-time>

    Date/time when registration token expires. Value only exposed to Provider

    -
    serialConsoleHostname
    string or null <hostname>

    Serial console hostname of the site controller

    -
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    -
    serialConsoleIdleTimeout
    integer or null

    Maximum idle time in seconds before Serial Console is disconnected

    -
    serialConsoleMaxSessionLength
    integer or null

    Maximum length of Serial Console session in seconds

    -
    isSerialConsoleSSHKeysEnabled
    boolean

    Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

    -
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    -
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    -
    Array of objects (StatusDetail)

    Chronological status history for the Site

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the Site was created

    -
    updated
    string <date-time>

    Date/time when the Site was last updated

    -
    object (SiteLocation)

    Site location information

    -
    city
    string

    City where the site is located

    -
    state
    string

    State where the site is located

    -
    country
    string

    Country where the site is located

    -
    object (SiteContact)

    Site contact information

    -
    email
    string

    Email address of the Site contact

    -
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    -
    nativeNetworking
    boolean

    Whether the Site supports native networking

    -
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    -
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    -
    flow
    boolean

    Whether the Site supports Flow-based operations

    -
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    -
    object (SiteMachineStats)

    Machine counts by status for the Site

    -
    total
    integer

    Total number of Machines at the Site

    -
    object (SiteMachineStatsByStatus)

    Machine counts grouped by Machine status

    -
    Decommissioned
    integer

    Number of Machines in Decommissioned status

    -
    Error
    integer

    Number of Machines in Error status

    -
    Initializing
    integer

    Number of Machines in Initializing status

    -
    InUse
    integer

    Number of Machines in InUse status

    -
    Maintenance
    integer

    Number of Machines in Maintenance status

    -
    Ready
    integer

    Number of Machines in Ready status

    -
    Reset
    integer

    Number of Machines in Reset status

    -
    Unknown
    integer

    Number of Machines in Unknown status

    -
    object (SiteMachineStatsByHealth)

    Machine counts grouped by health state

    -
    healthy
    integer

    Number of healthy Machines

    -
    unhealthy
    integer

    Number of unhealthy Machines

    -
    object (SiteMachineStatsByStatusAndHealth)

    Machine health counts grouped by Machine status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Decommissioned status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Error status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Initializing status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in InUse status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Maintenance status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Ready status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Reset status

    -
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Unknown status

    -
    object (SiteMachineStatsByAllocation)

    Machine counts grouped by allocation and usage state

    -
    allocatedInUse
    integer

    Number of allocated Machines currently in use

    -
    allocatedNotInUse
    integer

    Number of allocated Machines not currently in use

    -
    unallocated
    integer

    Number of Machines not currently allocated

    -

    Request samples

    Content type
    application/json
    Example
    {
    • "name": "San Jose Central No.4",
    • "description": "Datacenter 4 serving central San Jose",
    • "renewRegistrationToken": true,
    • "serialConsoleHostname": "sol.nico.acme.com",
    • "location": {
      },
    • "contact": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "San Jose Central 4",
    • "description": "Datacenter serving the San Jose central region",
    • "org": "qygdmg8oqik8",
    • "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
    • "siteControllerVersion": "0.1",
    • "siteAgentVersion": "0.1",
    • "registrationToken": "J7KO-89RR-Y7WQ-AD90",
    • "registrationTokenExpiration": "2019-08-25T12:00:00Z",
    • "serialConsoleHostname": "sjc.nico.acme.com",
    • "isSerialConsoleEnabled": true,
    • "serialConsoleIdleTimeout": 60,
    • "serialConsoleMaxSessionLength": 3600,
    • "isSerialConsoleSSHKeysEnabled": true,
    • "machineStats": {
      },
    • "capabilities": {
      },
    • "isOnline": false,
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "location": {
      },
    • "contact": {
      }
    }

    Delete Site

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    siteId
    required
    string <uuid>

    ID of the Site

    +
    Request Body schema: application/json
    name
    string or null

    Update name of the Site. Can only be updated by Provider

    +
    description
    string or null

    Update description for the Site. Can only be updated by Provider

    +
    renewRegistrationToken
    boolean

    Set to true to issue a new registration token. Can only be updated by Provider

    +
    serialConsoleHostname
    string or null <hostname>

    Hostname to reach Serial Console for the Site. Can only be updated by Provider

    +
    isSerialConsoleEnabled
    boolean
    Deprecated

    Enable/disable Serial Console. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

    +
    serialConsoleIdleTimeout
    integer
    Deprecated

    Maximum idle time in seconds before Serial Console is disconnected. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

    +
    serialConsoleMaxSessionLength
    integer
    Deprecated

    Maximum length of Serial Console session in seconds. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

    +
    isSerialConsoleSSHKeysEnabled
    boolean
    Deprecated

    Enable/disable Serial Console access using SSH Keys. Previously updateable only by Tenants, modifying this value is no longer supported, update SSH Key Groups to remove Site instead.

    +
    object (SiteLocation)

    Updated Site location information

    +
    city
    string

    City where the site is located

    +
    state
    string

    State where the site is located

    +
    country
    string

    Country where the site is located

    +
    object (SiteContact)

    Updated Site contact information

    +
    email
    string

    Email address of the Site contact

    +
    object (SiteCapabilitiesUpdateRequest)

    Modify Site capabilities. Can only be updated by Provider. Partial update allowed, only specify capabilities that should be updated.

    +
    nativeNetworking
    boolean or null

    Enable or disable native networking for the Site

    +
    networkSecurityGroup
    boolean or null

    Enable or disable network security groups for the Site

    +
    nvLinkPartition
    boolean or null

    Enable or disable NVLink partition support for the Site

    +
    flow
    boolean or null

    Enable or disable NICo Flow for the Site

    +
    imageBasedOperatingSystem
    boolean or null

    Enable or disable image-based operating system support for the Site

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Site in NICo Cloud

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    +
    description
    string or null

    Optional description for the Site

    +
    org
    string

    NGC organization ID of the Infrastructure Provider that owns the Site

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    +
    siteControllerVersion
    string or null

    Version of the Site Controller software

    +
    siteAgentVersion
    string or null

    Version of the Site Agent software

    +
    registrationToken
    string or null

    Token that can be used to register a Site. Value only exposed to Provider

    +
    registrationTokenExpiration
    string or null <date-time>

    Date/time when registration token expires. Value only exposed to Provider

    +
    serialConsoleHostname
    string or null <hostname>

    Serial console hostname of the site controller

    +
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    +
    serialConsoleIdleTimeout
    integer or null

    Maximum idle time in seconds before Serial Console is disconnected

    +
    serialConsoleMaxSessionLength
    integer or null

    Maximum length of Serial Console session in seconds

    +
    isSerialConsoleSSHKeysEnabled
    boolean

    Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

    +
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    +
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    +
    Array of objects (StatusDetail)

    Chronological status history for the Site

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the Site was created

    +
    updated
    string <date-time>

    Date/time when the Site was last updated

    +
    object (SiteLocation)

    Site location information

    +
    city
    string

    City where the site is located

    +
    state
    string

    State where the site is located

    +
    country
    string

    Country where the site is located

    +
    object (SiteContact)

    Site contact information

    +
    email
    string

    Email address of the Site contact

    +
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    +
    nativeNetworking
    boolean

    Whether the Site supports native networking

    +
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    +
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    +
    flow
    boolean

    Whether the Site supports Flow-based operations

    +
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    +
    object (SiteMachineStats)

    Machine counts by status for the Site

    +
    total
    integer

    Total number of Machines at the Site

    +
    object (SiteMachineStatsByStatus)

    Machine counts grouped by Machine status

    +
    Decommissioned
    integer

    Number of Machines in Decommissioned status

    +
    Error
    integer

    Number of Machines in Error status

    +
    Initializing
    integer

    Number of Machines in Initializing status

    +
    InUse
    integer

    Number of Machines in InUse status

    +
    Maintenance
    integer

    Number of Machines in Maintenance status

    +
    Ready
    integer

    Number of Machines in Ready status

    +
    Reset
    integer

    Number of Machines in Reset status

    +
    Unknown
    integer

    Number of Machines in Unknown status

    +
    object (SiteMachineStatsByHealth)

    Machine counts grouped by health state

    +
    healthy
    integer

    Number of healthy Machines

    +
    unhealthy
    integer

    Number of unhealthy Machines

    +
    object (SiteMachineStatsByStatusAndHealth)

    Machine health counts grouped by Machine status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Decommissioned status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Error status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Initializing status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in InUse status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Maintenance status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Ready status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Reset status

    +
    object (SiteMachineStatsByHealth)

    Health breakdown for Machines in Unknown status

    +
    object (SiteMachineStatsByAllocation)

    Machine counts grouped by allocation and usage state

    +
    allocatedInUse
    integer

    Number of allocated Machines currently in use

    +
    allocatedNotInUse
    integer

    Number of allocated Machines not currently in use

    +
    unallocated
    integer

    Number of Machines not currently allocated

    +

    Request samples

    Content type
    application/json
    Example
    {
    • "name": "San Jose Central No.4",
    • "description": "Datacenter 4 serving central San Jose",
    • "renewRegistrationToken": true,
    • "serialConsoleHostname": "sol.nico.acme.com",
    • "location": {
      },
    • "contact": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "San Jose Central 4",
    • "description": "Datacenter serving the San Jose central region",
    • "org": "qygdmg8oqik8",
    • "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
    • "siteControllerVersion": "0.1",
    • "siteAgentVersion": "0.1",
    • "registrationToken": "J7KO-89RR-Y7WQ-AD90",
    • "registrationTokenExpiration": "2019-08-25T12:00:00Z",
    • "serialConsoleHostname": "sjc.nico.acme.com",
    • "isSerialConsoleEnabled": true,
    • "serialConsoleIdleTimeout": 60,
    • "serialConsoleMaxSessionLength": 3600,
    • "isSerialConsoleSSHKeysEnabled": true,
    • "machineStats": {
      },
    • "capabilities": {
      },
    • "isOnline": false,
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "location": {
      },
    • "contact": {
      }
    }

    Delete Site

    Delete a specific Site

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete a specific Site

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Site can only be deleted if all Allocations have been deleted.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    siteId
    required
    string <uuid>

    ID of the Site

    -
    query Parameters
    purgeMachines
    boolean

    Scrub all Machine data associated with this Site to re-pair

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Retrieve Site status history

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    siteId
    required
    string <uuid>

    ID of the Site

    +
    query Parameters
    purgeMachines
    boolean

    Scrub all Machine data associated with this Site to re-pair

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Retrieve Site status history

    Typical API Call Flow for Tenant <li>The org&#39;s Tenant has an Allocation for Site</li> <li>The org&#39;s Tenant is privileged and has Account with Site&#39;s Provider</li> </ul> -" class="sc-iKGpAq sc-cCYyou dXXcln dHaogz">

    Retrieve a specific Site status history

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific Site status history

    User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix.

    Access is granted if:

      @@ -1914,59 +1914,59 @@

      Typical API Call Flow for Tenant

    • The org's Tenant has an Allocation for Site
    • The org's Tenant is privileged and has Account with Site's Provider
    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    siteId
    required
    string <uuid>

    ID of the Site

    -
    query Parameters
    pageNumber
    integer

    Page number for pagination query

    -
    pageSize
    integer

    Page size for pagination query

    -
    orderBy
    string

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    BMC Credential

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    siteId
    required
    string <uuid>

    ID of the Site

    +
    query Parameters
    pageNumber
    integer

    Page number for pagination query

    +
    pageSize
    integer

    Page size for pagination query

    +
    orderBy
    string

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    BMC Credential

    BMC Credential endpoints allow creating and updating BMC credentials across all Machines of a Site

    -

    Create Or Update BMC Credential

    Create Or Update BMC Credential

    Create or update a site-wide or per-BMC root credential. Equivalent +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create or update a site-wide or per-BMC root credential. Equivalent to carbide-admin-cli credential add-bmc.

    User must have authorization role with PROVIDER_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    required
    siteId
    required
    string <uuid>

    ID of the Site where the credential is stored.

    -
    kind
    required
    string
    Enum: "SiteWideRoot" "BMCRoot"

    Which BMC credential to store.

    -
    password
    required
    string non-empty

    Credential password.

    -
    username
    string

    Optional username; Core defaults to "root" for BMCRoot when omitted.

    -
    macAddress
    string

    BMC MAC address. Required for kind BMCRoot, ignored for SiteWideRoot.

    -

    Responses

    Request samples

    Content type
    application/json
    {
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "kind": "SiteWideRoot",
    • "password": "string",
    • "username": "string",
    • "macAddress": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "kind": "SiteWideRoot",
    • "username": "string",
    • "macAddress": "string"
    }

    Allocation

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    required
    siteId
    required
    string <uuid>

    ID of the Site where the credential is stored.

    +
    kind
    required
    string
    Enum: "SiteWideRoot" "BMCRoot"

    Which BMC credential to store.

    +
    password
    required
    string non-empty

    Credential password.

    +
    username
    string

    Optional username; Core defaults to "root" for BMCRoot when omitted.

    +
    macAddress
    string

    BMC MAC address. Required for kind BMCRoot, ignored for SiteWideRoot.

    +

    Responses

    Request samples

    Content type
    application/json
    {
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "kind": "SiteWideRoot",
    • "password": "string",
    • "username": "string",
    • "macAddress": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "kind": "SiteWideRoot",
    • "username": "string",
    • "macAddress": "string"
    }

    Allocation

    Typical API Call Flow for Tenant
    • ResourceTypeID attribute on Allocation Constraint was deprecated in favor of resourceTypeId and will be removed on July 9th, 2026 0:00 UTC. Please use resourceTypeId instead.
    -

    Retrieve all Allocations

    Retrieve all Allocations

    Retrieve all Allocations for the org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all Allocations for the org.

    The Infrastructure Provider and Tenant are inferred from the org's membership. User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix.

    Results are returned from both Provider and Tenant perspectives when the org has both roles.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    infrastructureProviderId
    string <uuid>
    Deprecated

    Filter Allocations by Infrastructure Provider ID.

    -
    tenantId
    string <uuid>

    Filter Allocations by Tenant ID.

    -
    siteId
    string <uuid>

    Filter Allocations by Site ID. Can be specified multiple times to filter on more than one Site ID.

    -
    id
    string

    Filter Allocations by ID. Can be specified multiple times to filter on more than one ID.

    -
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Filter Allocations by Constraint Resource Type. Can be specified multiple times to filter on more than one Constraint Resource Type.

    -
    status
    string

    Filter Allocations by Status. Can be specified multiple times to filter on more than one Status.

    -
    resourceTypeId
    string

    Filter Allocations by Constraint Resource Type ID. Can be specified multiple times to filter on more than one Constraint Resource Type ID.

    -
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Filter Allocations by Constraint Type. Can be specified multiple times to filter on more than one Constraint Type.

    -
    constraintValue
    integer

    Filter Allocations by Constraint Value. Can be specified multiple times to filter on more than one Constraint Value.

    -
    query
    string

    Search for matches across all Allocations. Input will be matched against name, description, and status fields

    -
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant" "Site"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC" "SITE_NAME_ASC" "SITE_NAME_DESC" "TENANT_ORG_DISPLAY_NAME_ASC" "TENANT_ORG_DISPLAY_NAME_DESC" "INSTANCE_TYPE_NAME_ASC" "INSTANCE_TYPE_NAME_DESC" "IP_BLOCK_NAME_ASC" "IP_BLOCK_NAME_DESC" "CONSTRAINT_VALUE_ASC" "CONSTRAINT_VALUE_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    ID of the Allocation

    -
    name
    string [ 2 .. 256 ] characters

    Concise and descriptive name of the Allocation

    -
    description
    string or null

    Detailed description of the Allocation

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that created the Allocation

    -
    tenantId
    string <uuid>

    ID of the Tenant that received the Allocation

    -
    siteId
    string <uuid>

    ID of the Site where resources are allocated

    -
    status
    string (AllocationStatus)
    Enum: "Pending" "Registered" "Deleting" "Error"

    Status of the Allocation

    -
    Array of objects (StatusDetail)

    Chronological status history for the Allocation

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    Array of objects (AllocationConstraint)

    List of Allocation Constraints for the Allocation

    -
    Array
    id
    string <uuid>

    ID of the Allocation Constraint

    -
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    -
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    -
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    -
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    -
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    -
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    -
    object (InstanceTypeSummary)

    Summary of the Instance Type

    -
    object (IpBlockSummary)

    Summary of the IP Block

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    -
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    -
    created
    string <date-time>

    Date/time when the Allocation was created

    -
    updated
    string <date-time>

    Date/time when the Allocation was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create Allocation

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    infrastructureProviderId
    string <uuid>
    Deprecated

    Filter Allocations by Infrastructure Provider ID.

    +
    tenantId
    string <uuid>

    Filter Allocations by Tenant ID.

    +
    siteId
    string <uuid>

    Filter Allocations by Site ID. Can be specified multiple times to filter on more than one Site ID.

    +
    id
    string

    Filter Allocations by ID. Can be specified multiple times to filter on more than one ID.

    +
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Filter Allocations by Constraint Resource Type. Can be specified multiple times to filter on more than one Constraint Resource Type.

    +
    status
    string

    Filter Allocations by Status. Can be specified multiple times to filter on more than one Status.

    +
    resourceTypeId
    string

    Filter Allocations by Constraint Resource Type ID. Can be specified multiple times to filter on more than one Constraint Resource Type ID.

    +
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Filter Allocations by Constraint Type. Can be specified multiple times to filter on more than one Constraint Type.

    +
    constraintValue
    integer

    Filter Allocations by Constraint Value. Can be specified multiple times to filter on more than one Constraint Value.

    +
    query
    string

    Search for matches across all Allocations. Input will be matched against name, description, and status fields

    +
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant" "Site"

    Related entity to expand

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC" "SITE_NAME_ASC" "SITE_NAME_DESC" "TENANT_ORG_DISPLAY_NAME_ASC" "TENANT_ORG_DISPLAY_NAME_DESC" "INSTANCE_TYPE_NAME_ASC" "INSTANCE_TYPE_NAME_DESC" "IP_BLOCK_NAME_ASC" "IP_BLOCK_NAME_DESC" "CONSTRAINT_VALUE_ASC" "CONSTRAINT_VALUE_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    ID of the Allocation

    +
    name
    string [ 2 .. 256 ] characters

    Concise and descriptive name of the Allocation

    +
    description
    string or null

    Detailed description of the Allocation

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that created the Allocation

    +
    tenantId
    string <uuid>

    ID of the Tenant that received the Allocation

    +
    siteId
    string <uuid>

    ID of the Site where resources are allocated

    +
    status
    string (AllocationStatus)
    Enum: "Pending" "Registered" "Deleting" "Error"

    Status of the Allocation

    +
    Array of objects (StatusDetail)

    Chronological status history for the Allocation

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    Array of objects (AllocationConstraint)

    List of Allocation Constraints for the Allocation

    +
    Array
    id
    string <uuid>

    ID of the Allocation Constraint

    +
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    +
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    +
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    +
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    +
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    +
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    +
    object (InstanceTypeSummary)

    Summary of the Instance Type

    +
    object (IpBlockSummary)

    Summary of the IP Block

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    +
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    +
    created
    string <date-time>

    Date/time when the Allocation was created

    +
    updated
    string <date-time>

    Date/time when the Allocation was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create Allocation

    Create an Allocation for the org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create an Allocation for the org.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    To successfully create a compute Allocation, there must be enough unallocated Machines associated with the Instance Type to satisfy the constraint value. For network Allocation, the source site-level IP Block must have an available prefix with length equal to the constraint value.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Concise and descriptive name for the Allocation

    -
    description
    string or null

    Detailed description for the Allocation

    -
    tenantId
    required
    string <uuid>

    ID of the Tenant that should receive the Allocation

    -
    siteId
    required
    string <uuid>

    ID of the Site where resources should be allocated

    -
    Array of objects (AllocationConstraintCreateRequest)

    List of Allocation Constraint objects

    -
    Array
    resourceType
    required
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    -
    resourceTypeId
    required
    string <uuid>

    ID of the Resource Type that the Allocation Constraint applies to. For InstanceType, this is the ID of the Instance Type. For IPBlock, this is the ID of the IP Block.

    -
    constraintType
    required
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Please note that OnDemand and Preemptible are not supported by current implementation.

    -
    constraintValue
    required
    integer

    Value of the Allocation Constraint. For InstanceType, this value represents number of Machines allocated for Tenant. For IPBlock, this value represents the prefix Length of the IP Block.

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the Allocation

    -
    name
    string [ 2 .. 256 ] characters

    Concise and descriptive name of the Allocation

    -
    description
    string or null

    Detailed description of the Allocation

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that created the Allocation

    -
    tenantId
    string <uuid>

    ID of the Tenant that received the Allocation

    -
    siteId
    string <uuid>

    ID of the Site where resources are allocated

    -
    status
    string (AllocationStatus)
    Enum: "Pending" "Registered" "Deleting" "Error"

    Status of the Allocation

    -
    Array of objects (StatusDetail)

    Chronological status history for the Allocation

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    Array of objects (AllocationConstraint)

    List of Allocation Constraints for the Allocation

    -
    Array
    id
    string <uuid>

    ID of the Allocation Constraint

    -
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    -
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    -
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    -
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    -
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    -
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    -
    object (InstanceTypeSummary)

    Summary of the Instance Type

    -
    object (IpBlockSummary)

    Summary of the IP Block

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    -
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    -
    created
    string <date-time>

    Date/time when the Allocation was created

    -
    updated
    string <date-time>

    Date/time when the Allocation was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "Echo Studios",
    • "description": "Echo Studios resource allocation in SJC4",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "allocationConstraints": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "Echo Studios",
    • "description": "Echo Studios resource allocation in SJC4",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "allocationConstraints": [
      ]
    }

    Retrieve Allocation

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Concise and descriptive name for the Allocation

    +
    description
    string or null

    Detailed description for the Allocation

    +
    tenantId
    required
    string <uuid>

    ID of the Tenant that should receive the Allocation

    +
    siteId
    required
    string <uuid>

    ID of the Site where resources should be allocated

    +
    Array of objects (AllocationConstraintCreateRequest)

    List of Allocation Constraint objects

    +
    Array
    resourceType
    required
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    +
    resourceTypeId
    required
    string <uuid>

    ID of the Resource Type that the Allocation Constraint applies to. For InstanceType, this is the ID of the Instance Type. For IPBlock, this is the ID of the IP Block.

    +
    constraintType
    required
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Please note that OnDemand and Preemptible are not supported by current implementation.

    +
    constraintValue
    required
    integer

    Value of the Allocation Constraint. For InstanceType, this value represents number of Machines allocated for Tenant. For IPBlock, this value represents the prefix Length of the IP Block.

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the Allocation

    +
    name
    string [ 2 .. 256 ] characters

    Concise and descriptive name of the Allocation

    +
    description
    string or null

    Detailed description of the Allocation

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that created the Allocation

    +
    tenantId
    string <uuid>

    ID of the Tenant that received the Allocation

    +
    siteId
    string <uuid>

    ID of the Site where resources are allocated

    +
    status
    string (AllocationStatus)
    Enum: "Pending" "Registered" "Deleting" "Error"

    Status of the Allocation

    +
    Array of objects (StatusDetail)

    Chronological status history for the Allocation

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    Array of objects (AllocationConstraint)

    List of Allocation Constraints for the Allocation

    +
    Array
    id
    string <uuid>

    ID of the Allocation Constraint

    +
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    +
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    +
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    +
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    +
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    +
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    +
    object (InstanceTypeSummary)

    Summary of the Instance Type

    +
    object (IpBlockSummary)

    Summary of the IP Block

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    +
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    +
    created
    string <date-time>

    Date/time when the Allocation was created

    +
    updated
    string <date-time>

    Date/time when the Allocation was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "Echo Studios",
    • "description": "Echo Studios resource allocation in SJC4",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "allocationConstraints": [
      ]
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "Echo Studios",
    • "description": "Echo Studios resource allocation in SJC4",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "allocationConstraints": [
      ]
    }

    Retrieve Allocation

    Retrieve Allocation by ID

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve Allocation by ID

    The Infrastructure Provider and Tenant are inferred from the org's membership. Allocation must belong to the Provider or Tenant associated with the org.

    User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    allocationId
    required
    string <uuid>

    ID of the Allocation

    -
    query Parameters
    infrastructureProviderId
    string <uuid>
    Deprecated

    Filter Allocations by Infrastructure Provider ID.

    -
    tenantId
    string <uuid>
    Deprecated

    Filter Allocations by Tenant ID.

    -
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant" "Site"

    Related entity to expand

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the Allocation

    -
    name
    string [ 2 .. 256 ] characters

    Concise and descriptive name of the Allocation

    -
    description
    string or null

    Detailed description of the Allocation

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that created the Allocation

    -
    tenantId
    string <uuid>

    ID of the Tenant that received the Allocation

    -
    siteId
    string <uuid>

    ID of the Site where resources are allocated

    -
    status
    string (AllocationStatus)
    Enum: "Pending" "Registered" "Deleting" "Error"

    Status of the Allocation

    -
    Array of objects (StatusDetail)

    Chronological status history for the Allocation

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    Array of objects (AllocationConstraint)

    List of Allocation Constraints for the Allocation

    -
    Array
    id
    string <uuid>

    ID of the Allocation Constraint

    -
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    -
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    -
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    -
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    -
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    -
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    -
    object (InstanceTypeSummary)

    Summary of the Instance Type

    -
    object (IpBlockSummary)

    Summary of the IP Block

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    -
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    -
    created
    string <date-time>

    Date/time when the Allocation was created

    -
    updated
    string <date-time>

    Date/time when the Allocation was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "Echo Studios",
    • "description": "Echo Studios resource allocation in SJC4",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "allocationConstraints": [
      ]
    }

    Delete Allocation

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    allocationId
    required
    string <uuid>

    ID of the Allocation

    +
    query Parameters
    infrastructureProviderId
    string <uuid>
    Deprecated

    Filter Allocations by Infrastructure Provider ID.

    +
    tenantId
    string <uuid>
    Deprecated

    Filter Allocations by Tenant ID.

    +
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant" "Site"

    Related entity to expand

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the Allocation

    +
    name
    string [ 2 .. 256 ] characters

    Concise and descriptive name of the Allocation

    +
    description
    string or null

    Detailed description of the Allocation

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that created the Allocation

    +
    tenantId
    string <uuid>

    ID of the Tenant that received the Allocation

    +
    siteId
    string <uuid>

    ID of the Site where resources are allocated

    +
    status
    string (AllocationStatus)
    Enum: "Pending" "Registered" "Deleting" "Error"

    Status of the Allocation

    +
    Array of objects (StatusDetail)

    Chronological status history for the Allocation

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    Array of objects (AllocationConstraint)

    List of Allocation Constraints for the Allocation

    +
    Array
    id
    string <uuid>

    ID of the Allocation Constraint

    +
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    +
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    +
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    +
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    +
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    +
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    +
    object (InstanceTypeSummary)

    Summary of the Instance Type

    +
    object (IpBlockSummary)

    Summary of the IP Block

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    +
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    +
    created
    string <date-time>

    Date/time when the Allocation was created

    +
    updated
    string <date-time>

    Date/time when the Allocation was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "Echo Studios",
    • "description": "Echo Studios resource allocation in SJC4",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "allocationConstraints": [
      ]
    }

    Delete Allocation

    Delete an Allocation by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete an Allocation by ID.

    Org must have an Infrastructure Provider entity, and the specified Allocation must have been created by that Provider. Requesting user must have PROVIDER_ADMIN role.

    Tenant management of Allocation is not supported in MVP.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    allocationId
    required
    string <uuid>

    ID of the Allocation

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Update Allocation

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    allocationId
    required
    string <uuid>

    ID of the Allocation

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Update Allocation

    Update an existing Allocation

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing Allocation

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix. Provider must own the Allocation.

    Tenant management of Allocation is not supported in MVP.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    allocationId
    required
    string <uuid>

    ID of the Allocation

    -
    Request Body schema: application/json
    name
    string or null [ 2 .. 256 ] characters

    Update name of the Allocation

    -
    description
    string or null

    Update description of the Allocation

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the Allocation

    -
    name
    string [ 2 .. 256 ] characters

    Concise and descriptive name of the Allocation

    -
    description
    string or null

    Detailed description of the Allocation

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that created the Allocation

    -
    tenantId
    string <uuid>

    ID of the Tenant that received the Allocation

    -
    siteId
    string <uuid>

    ID of the Site where resources are allocated

    -
    status
    string (AllocationStatus)
    Enum: "Pending" "Registered" "Deleting" "Error"

    Status of the Allocation

    -
    Array of objects (StatusDetail)

    Chronological status history for the Allocation

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    Array of objects (AllocationConstraint)

    List of Allocation Constraints for the Allocation

    -
    Array
    id
    string <uuid>

    ID of the Allocation Constraint

    -
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    -
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    -
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    -
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    -
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    -
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    -
    object (InstanceTypeSummary)

    Summary of the Instance Type

    -
    object (IpBlockSummary)

    Summary of the IP Block

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    -
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    -
    created
    string <date-time>

    Date/time when the Allocation was created

    -
    updated
    string <date-time>

    Date/time when the Allocation was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "Echo Studios Compute",
    • "description": "Echo Studios compute resource allocation in SJC4"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "Echo Studios Compute",
    • "description": "Echo Studios compute resource allocation in SJC4",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "allocationConstraints": [
      ]
    }

    Update Allocation Constraint

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    allocationId
    required
    string <uuid>

    ID of the Allocation

    +
    Request Body schema: application/json
    name
    string or null [ 2 .. 256 ] characters

    Update name of the Allocation

    +
    description
    string or null

    Update description of the Allocation

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the Allocation

    +
    name
    string [ 2 .. 256 ] characters

    Concise and descriptive name of the Allocation

    +
    description
    string or null

    Detailed description of the Allocation

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that created the Allocation

    +
    tenantId
    string <uuid>

    ID of the Tenant that received the Allocation

    +
    siteId
    string <uuid>

    ID of the Site where resources are allocated

    +
    status
    string (AllocationStatus)
    Enum: "Pending" "Registered" "Deleting" "Error"

    Status of the Allocation

    +
    Array of objects (StatusDetail)

    Chronological status history for the Allocation

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    Array of objects (AllocationConstraint)

    List of Allocation Constraints for the Allocation

    +
    Array
    id
    string <uuid>

    ID of the Allocation Constraint

    +
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    +
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    +
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    +
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    +
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    +
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    +
    object (InstanceTypeSummary)

    Summary of the Instance Type

    +
    object (IpBlockSummary)

    Summary of the IP Block

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    +
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    +
    created
    string <date-time>

    Date/time when the Allocation was created

    +
    updated
    string <date-time>

    Date/time when the Allocation was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "Echo Studios Compute",
    • "description": "Echo Studios compute resource allocation in SJC4"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "Echo Studios Compute",
    • "description": "Echo Studios compute resource allocation in SJC4",
    • "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z",
    • "allocationConstraints": [
      ]
    }

    Update Allocation Constraint

    Update an existing Allocation Constraint by ID

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing Allocation Constraint by ID

    Org must have an Infrastructure Provider. Specified Allocation must have been created by the Provider and requesting user must have PROVIDER_ADMIN role.

    Modifying allocations may not be possible if Tenant has started utilizing resources from this allocation.

    For an InstanceType resource, constraintValue can be incremented at any time, but not decremented if doing so requires decommissioning Tenant resources.

    For an IPBlock resource, constraintValue cannot be modified if Tenant resources, e.g., Subnets or VPC Prefixes, reference the block.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    allocationId
    required
    string

    ID of the Allocation

    -
    allocationConstraintId
    required
    string <uuid>

    ID of the Allocation Constraint

    -
    Request Body schema: application/json
    constraintValue
    required
    integer

    Value of the Allocation Constraint. For InstanceType, this value represents number of Machines allocated for Tenant. For IPBlock, this value represents the prefix Length of the IP Block.

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the Allocation Constraint

    -
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    -
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    -
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    -
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    -
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    -
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    -
    object (InstanceTypeSummary)

    Summary of the Instance Type

    -
    id
    string <uuid>

    ID of the Instance Type

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Instance Type, only lowercase characters, digits, hyphens and cannot begin/end with hyphen

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Instance Type

    -
    siteId
    string <uuid>

    ID of the Site that owns the Instance Type

    -
    status
    string (InstanceTypeStatus)
    Enum: "Pending" "Registering" "Ready" "Deleting" "Error"

    Status of the Instance Type

    -
    object (IpBlockSummary)

    Summary of the IP Block

    -
    id
    string <uuid>

    ID of the IP Block

    -
    name
    string [ 2 .. 256 ] characters

    Name of the IP Block, only lowercase characters, digits, hyphens and cannot begin/end with hyphen

    -
    routingType
    string
    Enum: "Public" "DatacenterOnly"

    RoutingType of the IP Block

    -
    prefix
    string

    Either IPv4 or IPv6 address

    -
    prefixLength
    integer

    Min: 1, Max: 32 for ipv4, 128 for ipv6

    -
    status
    string (IpBlockStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the IP Block

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    -
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    -
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    -
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    -
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    -
    notice
    string

    Message describing the deprecation

    -
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    -
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "constraintValue": 20
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "allocationId": "9ec871ce-3363-4de2-8f79-062881067628",
    • "resourceType": "InstanceType",
    • "resourceTypeId": "a59ee688-b5e5-4606-9891-f4a605edacd3",
    • "constraintType": "Reserved",
    • "constraintValue": 20,
    • "derivedResourceId": null,
    • "instanceType": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    VPC

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    allocationId
    required
    string

    ID of the Allocation

    +
    allocationConstraintId
    required
    string <uuid>

    ID of the Allocation Constraint

    +
    Request Body schema: application/json
    constraintValue
    required
    integer

    Value of the Allocation Constraint. For InstanceType, this value represents number of Machines allocated for Tenant. For IPBlock, this value represents the prefix Length of the IP Block.

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the Allocation Constraint

    +
    allocationId
    string <uuid>

    ID of the Allocation that contains the Allocation Constraint

    +
    resourceType
    string
    Enum: "InstanceType" "IPBlock"

    Type of the Resource that the Allocation Constraint applies to

    +
    resourceTypeId
    string <uuid>

    ID of the resource that acts as the source of the Allocation. For resource type InstanceType, this is the ID of the Instance Type whose associated Machines are allocated to the Tenant. For resource type IPBlock, this is the ID of the Site-level IP Block from which a prefix is allocated to the Tenant.

    +
    constraintType
    string
    Enum: "Reserved" "OnDemand" "Preemptible"

    Type of the Allocation Constraint. Reserved is the only constraint type supported by current implementation.

    +
    constraintValue
    integer

    Value of the Allocation Constraint. For resource type: InstanceType, this value represents number of Machines associated with the Instance Type that is allocated to the Tenant. For resource type IPBlock, this value represents the prefix length of the IP Block allocated to the Tenant.

    +
    derivedResourceId
    string or null

    ID of the allocated Tenant IP Block when resource type is IPBlock

    +
    object (InstanceTypeSummary)

    Summary of the Instance Type

    +
    id
    string <uuid>

    ID of the Instance Type

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Instance Type, only lowercase characters, digits, hyphens and cannot begin/end with hyphen

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Instance Type

    +
    siteId
    string <uuid>

    ID of the Site that owns the Instance Type

    +
    status
    string (InstanceTypeStatus)
    Enum: "Pending" "Registering" "Ready" "Deleting" "Error"

    Status of the Instance Type

    +
    object (IpBlockSummary)

    Summary of the IP Block

    +
    id
    string <uuid>

    ID of the IP Block

    +
    name
    string [ 2 .. 256 ] characters

    Name of the IP Block, only lowercase characters, digits, hyphens and cannot begin/end with hyphen

    +
    routingType
    string
    Enum: "Public" "DatacenterOnly"

    RoutingType of the IP Block

    +
    prefix
    string

    Either IPv4 or IPv6 address

    +
    prefixLength
    integer

    Min: 1, Max: 32 for ipv4, 128 for ipv6

    +
    status
    string (IpBlockStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the IP Block

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    +
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    +
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    +
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    +
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    +
    notice
    string

    Message describing the deprecation

    +
    created
    string <date-time>

    Date/time when the Allocation Constraint was created

    +
    updated
    string <date-time>

    Date/time when the Allocation Constraint was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "constraintValue": 20
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "allocationId": "9ec871ce-3363-4de2-8f79-062881067628",
    • "resourceType": "InstanceType",
    • "resourceTypeId": "a59ee688-b5e5-4606-9891-f4a605edacd3",
    • "constraintType": "Reserved",
    • "constraintValue": 20,
    • "derivedResourceId": null,
    • "instanceType": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    VPC

    VPC defines the networking isolation boundary for Tenant's Instances.

    -

    Retrieve all VPCs

    Retrieve all VPCs

    Retrieve all VPCs for the org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all VPCs for the org.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string <uuid>

    Filter VPCs by Site ID. Can be specified multiple times to filter on more than one Site.

    -
    status
    string

    Filter VPCs by Status. Can be specified multiple times to filter on more than one Status.

    -
    networkSecurityGroupId
    string

    Filter VPCs by Network Security Group ID. Can be specified multiple times to filter on more than one Network Security Group.

    -
    nvLinkLogicalPartitionId
    string <uuid>

    Filter VPCs by NVLink Logical Partition ID. Can be specified multiple times to filter on more than one NVLink Logical Partition.

    -
    query
    string

    Search for matches across all VPCs. Input will be matched against name, description, labels, and status fields

    -
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant" "Site" "NetworkSecurityGroup"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    description
    string or null

    Description of the VPC, can be empty

    -
    org
    string

    Organization the VPC belongs to

    -
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    -
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    -
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    -
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    -
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    -
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI assigned to the VPC

    -
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    -
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    -
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    -
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    -
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    -
    details
    string or null

    Additional details for the status

    -
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    -
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    -
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    -
    property name*
    additional property
    string
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    Array of objects (StatusDetail)

    History of status changes for the VPC

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when VPC was created

    -
    updated
    string <date-time>

    Date/time when VPC was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create VPC

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    string <uuid>

    Filter VPCs by Site ID. Can be specified multiple times to filter on more than one Site.

    +
    status
    string

    Filter VPCs by Status. Can be specified multiple times to filter on more than one Status.

    +
    networkSecurityGroupId
    string

    Filter VPCs by Network Security Group ID. Can be specified multiple times to filter on more than one Network Security Group.

    +
    nvLinkLogicalPartitionId
    string <uuid>

    Filter VPCs by NVLink Logical Partition ID. Can be specified multiple times to filter on more than one NVLink Logical Partition.

    +
    query
    string

    Search for matches across all VPCs. Input will be matched against name, description, labels, and status fields

    +
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant" "Site" "NetworkSecurityGroup"

    Related entity to expand

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC, can be empty

    +
    org
    string

    Organization the VPC belongs to

    +
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    +
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    +
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    +
    networkVirtualizationType
    string or null
    Deprecated
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Deprecated: use config.networkVirtualizationType. Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    +
    routingProfile
    string or null [ 3 .. 64 ] characters
    Deprecated

    Deprecated: use config.routingProfile. Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    +
    requestedVni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use config.requestedVni. Explicitly requested VNI for the VPC if one was requested at creation time

    +
    vni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use runtimeStatus.vni. Active VNI assigned to the VPC

    +
    networkSecurityGroupId
    string or null
    Deprecated

    Deprecated: use config.networkSecurityGroupId. ID of the Network Security Group attached to the VPC

    +
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    +
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    +
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    +
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    +
    details
    string or null

    Additional details for the status

    +
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    +
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    nvLinkLogicalPartitionId
    string or null <uuid>
    Deprecated

    Deprecated: use config.nvLinkLogicalPartitionId. ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    property name*
    additional property
    string
    object (VpcConfig)

    Desired configuration for the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC

    +
    siteId
    string or null <uuid>

    ID of the Site the VPC belongs to

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC

    +
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    +
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    +
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    object (VpcRuntimeStatus)

    Observed runtime status for the VPC

    +
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI allocated to the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    Array of objects (StatusDetail)

    History of status changes for the VPC

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when VPC was created

    +
    updated
    string <date-time>

    Date/time when VPC was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create VPC

    Create a VPC for the org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create a VPC for the org.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    id
    string <uuid>

    Optional user-specified UUID for the VPC

    -
    name
    required
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    description
    string or null

    Optional description for the VPC

    -
    siteId
    required
    string <uuid>

    ID of the Site where the VPC should be created

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC. If no value is specified, then defaults to FNN if Site has native networking enabled, or ETHERNET_VIRTUALIZER if native networking is disabled. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode) and are never auto-selected -- FLAT must be specified explicitly.

    -
    routingProfile
    string or null [ 3 .. 64 ] characters

    Specify routing profile for the VPC. Only supported when networkVirtualizationType is set to FNN, or when networkVirtualizationType is omitted and Site has Native Networking enabled. Requires Tenant to have elevated privilege. Current accepted values are privileged-internal, internal, and external.

    -
    networkSecurityGroupId
    string or null

    ID of the Network Security Group to attach to the VPC

    -
    vni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC

    -
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    -
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels. Up to 10 key-value pairs can be specified

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    description
    string or null

    Description of the VPC, can be empty

    -
    org
    string

    Organization the VPC belongs to

    -
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    -
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    -
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    -
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    -
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    -
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI assigned to the VPC

    -
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    -
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    -
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    -
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    -
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    -
    details
    string or null

    Additional details for the status

    -
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    -
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    -
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    -
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    -
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    -
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    -
    notice
    string

    Message describing the deprecation

    -
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    -
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    -
    property name*
    additional property
    string
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    Array of objects (StatusDetail)

    History of status changes for the VPC

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when VPC was created

    -
    updated
    string <date-time>

    Date/time when VPC was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc",
    • "description": "Virtual network for machines executing Spark jobs",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc",
    • "description": "Virtual network for machines executing Spark jobs",
    • "org": "xskkpgqpeakn",
    • "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
    • "requestedVni": 12001,
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve a VPC

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    id
    string <uuid>

    Optional user-specified UUID for the VPC

    +
    name
    required
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Optional description for the VPC

    +
    siteId
    required
    string <uuid>

    ID of the Site where the VPC should be created

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC. If no value is specified, then defaults to FNN if Site has native networking enabled, or ETHERNET_VIRTUALIZER if native networking is disabled. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode) and are never auto-selected -- FLAT must be specified explicitly.

    +
    routingProfile
    string or null [ 3 .. 64 ] characters

    Specify routing profile for the VPC. Only supported when networkVirtualizationType is set to FNN, or when networkVirtualizationType is omitted and Site has Native Networking enabled. Requires Tenant to have elevated privilege. Current accepted values are privileged-internal, internal, and external.

    +
    networkSecurityGroupId
    string or null

    ID of the Network Security Group to attach to the VPC

    +
    vni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC

    +
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels. Up to 10 key-value pairs can be specified

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC, can be empty

    +
    org
    string

    Organization the VPC belongs to

    +
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    +
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    +
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    +
    networkVirtualizationType
    string or null
    Deprecated
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Deprecated: use config.networkVirtualizationType. Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    +
    routingProfile
    string or null [ 3 .. 64 ] characters
    Deprecated

    Deprecated: use config.routingProfile. Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    +
    requestedVni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use config.requestedVni. Explicitly requested VNI for the VPC if one was requested at creation time

    +
    vni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use runtimeStatus.vni. Active VNI assigned to the VPC

    +
    networkSecurityGroupId
    string or null
    Deprecated

    Deprecated: use config.networkSecurityGroupId. ID of the Network Security Group attached to the VPC

    +
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    +
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    +
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    +
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    +
    details
    string or null

    Additional details for the status

    +
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    +
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    +
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    +
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    +
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    +
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    +
    notice
    string

    Message describing the deprecation

    +
    nvLinkLogicalPartitionId
    string or null <uuid>
    Deprecated

    Deprecated: use config.nvLinkLogicalPartitionId. ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    property name*
    additional property
    string
    object (VpcConfig)

    Desired configuration for the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC

    +
    siteId
    string or null <uuid>

    ID of the Site the VPC belongs to

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC

    +
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    +
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    +
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    property name*
    additional property
    string
    object (VpcRuntimeStatus)

    Observed runtime status for the VPC

    +
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI allocated to the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    Array of objects (StatusDetail)

    History of status changes for the VPC

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when VPC was created

    +
    updated
    string <date-time>

    Date/time when VPC was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc",
    • "description": "Virtual network for machines executing Spark jobs",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc",
    • "description": "Virtual network for machines executing Spark jobs",
    • "org": "xskkpgqpeakn",
    • "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
    • "requestedVni": 12001,
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve a VPC

    Retrieve a specific VPC by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific VPC by ID.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    vpcId
    required
    string <uuid>

    ID of the VPC

    -
    query Parameters
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant" "Site" "NetworkSecurityGroup"

    Related entity to expand

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    description
    string or null

    Description of the VPC, can be empty

    -
    org
    string

    Organization the VPC belongs to

    -
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    -
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    -
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    -
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    -
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    -
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI assigned to the VPC

    -
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    -
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    -
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    -
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    -
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    -
    details
    string or null

    Additional details for the status

    -
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    -
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    -
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    -
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    -
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    -
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    -
    notice
    string

    Message describing the deprecation

    -
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    -
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    -
    property name*
    additional property
    string
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    Array of objects (StatusDetail)

    History of status changes for the VPC

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when VPC was created

    -
    updated
    string <date-time>

    Date/time when VPC was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc",
    • "description": "Virtual network for machines executing Spark jobs",
    • "org": "xskkpgqpeakn",
    • "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
    • "requestedVni": 12001,
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      },
    • "status": "Ready",
    • "networkSecurityGroupId": "c602eb90-3039-11f0-997a-b38d4fc8389e",
    • "networkSecurityGroupPropagationDetails": {
      },
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete a VPC

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    vpcId
    required
    string <uuid>

    ID of the VPC

    +
    query Parameters
    includeRelation
    string
    Enum: "InfrastructureProvider" "Tenant" "Site" "NetworkSecurityGroup"

    Related entity to expand

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC, can be empty

    +
    org
    string

    Organization the VPC belongs to

    +
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    +
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    +
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    +
    networkVirtualizationType
    string or null
    Deprecated
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Deprecated: use config.networkVirtualizationType. Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    +
    routingProfile
    string or null [ 3 .. 64 ] characters
    Deprecated

    Deprecated: use config.routingProfile. Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    +
    requestedVni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use config.requestedVni. Explicitly requested VNI for the VPC if one was requested at creation time

    +
    vni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use runtimeStatus.vni. Active VNI assigned to the VPC

    +
    networkSecurityGroupId
    string or null
    Deprecated

    Deprecated: use config.networkSecurityGroupId. ID of the Network Security Group attached to the VPC

    +
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    +
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    +
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    +
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    +
    details
    string or null

    Additional details for the status

    +
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    +
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    +
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    +
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    +
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    +
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    +
    notice
    string

    Message describing the deprecation

    +
    nvLinkLogicalPartitionId
    string or null <uuid>
    Deprecated

    Deprecated: use config.nvLinkLogicalPartitionId. ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    property name*
    additional property
    string
    object (VpcConfig)

    Desired configuration for the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC

    +
    siteId
    string or null <uuid>

    ID of the Site the VPC belongs to

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC

    +
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    +
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    +
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    property name*
    additional property
    string
    object (VpcRuntimeStatus)

    Observed runtime status for the VPC

    +
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI allocated to the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    Array of objects (StatusDetail)

    History of status changes for the VPC

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when VPC was created

    +
    updated
    string <date-time>

    Date/time when VPC was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc",
    • "description": "Virtual network for machines executing Spark jobs",
    • "org": "xskkpgqpeakn",
    • "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
    • "requestedVni": 12001,
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      },
    • "status": "Ready",
    • "networkSecurityGroupId": "c602eb90-3039-11f0-997a-b38d4fc8389e",
    • "networkSecurityGroupPropagationDetails": {
      },
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete a VPC

    Delete a specific VPC by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete a specific VPC by ID.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    vpcId
    required
    string <uuid>

    ID of the VPC

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Update VPC

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    vpcId
    required
    string <uuid>

    ID of the VPC

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Update VPC

    Update an existing VPC

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing VPC

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    vpcId
    required
    string <uuid>

    ID of the VPC

    -
    Request Body schema: application/json
    name
    string or null [ 2 .. 256 ] characters

    Updated name of the VPC

    -
    description
    string or null

    Updated description of the VPC

    -
    networkSecurityGroupId
    string or null

    ID of the Network Security Group to attach to the VPC

    -
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to. Can only be updated if VPC currently has no active Instances

    -
    object (Labels) <= 10 properties

    Update labels of the VPC. Up to 10 key-value pairs can be specified. The labels will be replaced with the labels sent in the request. Any labels not included in the request will be removed. To retain existing labels, fetch them first and include them in this request.

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    description
    string or null

    Description of the VPC, can be empty

    -
    org
    string

    Organization the VPC belongs to

    -
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    -
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    -
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    -
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    -
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    -
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI assigned to the VPC

    -
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    -
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    -
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    -
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    -
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    -
    details
    string or null

    Additional details for the status

    -
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    -
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    -
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    -
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    -
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    -
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    -
    notice
    string

    Message describing the deprecation

    -
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    -
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    -
    property name*
    additional property
    string
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    Array of objects (StatusDetail)

    History of status changes for the VPC

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when VPC was created

    -
    updated
    string <date-time>

    Date/time when VPC was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "spark-vpc-v1",
    • "description": "Virtual network for machines executing Spark jobs v1",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc-v1",
    • "description": "Virtual network for machines executing Spark jobs v1",
    • "org": "xskkpgqpeakn",
    • "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
    • "requestedVni": 12001,
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update VPC Virtualization

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    vpcId
    required
    string <uuid>

    ID of the VPC

    +
    Request Body schema: application/json
    name
    string or null [ 2 .. 256 ] characters

    Updated name of the VPC

    +
    description
    string or null

    Updated description of the VPC

    +
    networkSecurityGroupId
    string or null

    ID of the Network Security Group to attach to the VPC

    +
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to. Can only be updated if VPC currently has no active Instances

    +
    object (Labels) <= 10 properties

    Update labels of the VPC. Up to 10 key-value pairs can be specified. The labels will be replaced with the labels sent in the request. Any labels not included in the request will be removed. To retain existing labels, fetch them first and include them in this request.

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC, can be empty

    +
    org
    string

    Organization the VPC belongs to

    +
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    +
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    +
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    +
    networkVirtualizationType
    string or null
    Deprecated
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Deprecated: use config.networkVirtualizationType. Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    +
    routingProfile
    string or null [ 3 .. 64 ] characters
    Deprecated

    Deprecated: use config.routingProfile. Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    +
    requestedVni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use config.requestedVni. Explicitly requested VNI for the VPC if one was requested at creation time

    +
    vni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use runtimeStatus.vni. Active VNI assigned to the VPC

    +
    networkSecurityGroupId
    string or null
    Deprecated

    Deprecated: use config.networkSecurityGroupId. ID of the Network Security Group attached to the VPC

    +
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    +
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    +
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    +
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    +
    details
    string or null

    Additional details for the status

    +
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    +
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    +
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    +
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    +
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    +
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    +
    notice
    string

    Message describing the deprecation

    +
    nvLinkLogicalPartitionId
    string or null <uuid>
    Deprecated

    Deprecated: use config.nvLinkLogicalPartitionId. ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    property name*
    additional property
    string
    object (VpcConfig)

    Desired configuration for the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC

    +
    siteId
    string or null <uuid>

    ID of the Site the VPC belongs to

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC

    +
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    +
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    +
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    property name*
    additional property
    string
    object (VpcRuntimeStatus)

    Observed runtime status for the VPC

    +
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI allocated to the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    Array of objects (StatusDetail)

    History of status changes for the VPC

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when VPC was created

    +
    updated
    string <date-time>

    Date/time when VPC was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "spark-vpc-v1",
    • "description": "Virtual network for machines executing Spark jobs v1",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc-v1",
    • "description": "Virtual network for machines executing Spark jobs v1",
    • "org": "xskkpgqpeakn",
    • "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "networkVirtualizationType": "ETHERNET_VIRTUALIZER",
    • "requestedVni": 12001,
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update VPC Virtualization

    Update network virtualization type for a VPC

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update network virtualization type for a VPC

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix

    Tenant must own the VPC Request is rejected if the VPC already has Subnets or Instances.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    vpcId
    required
    string <uuid>

    ID of the VPC

    -
    Request Body schema: application/json
    networkVirtualizationType
    string
    Value: "FNN"

    Network virtualization type of the VPC. Can only be updated to FNN

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    description
    string or null

    Description of the VPC, can be empty

    -
    org
    string

    Organization the VPC belongs to

    -
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    -
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    -
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    -
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    -
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    -
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI assigned to the VPC

    -
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    -
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    -
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    -
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    -
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    -
    details
    string or null

    Additional details for the status

    -
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    -
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    -
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    -
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    -
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    -
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    -
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    -
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    -
    notice
    string

    Message describing the deprecation

    -
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    -
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    -
    property name*
    additional property
    string
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    Array of objects (StatusDetail)

    History of status changes for the VPC

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when VPC was created

    -
    updated
    string <date-time>

    Date/time when VPC was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "networkVirtualizationType": "FNN"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc-v1",
    • "description": "Virtual network for machines executing Spark jobs v1",
    • "org": "xskkpgqpeakn",
    • "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "networkVirtualizationType": "FNN",
    • "requestedVni": 12001,
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    VPC Peering

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    vpcId
    required
    string <uuid>

    ID of the VPC

    +
    Request Body schema: application/json
    networkVirtualizationType
    string
    Value: "FNN"

    Network virtualization type of the VPC. Can only be updated to FNN

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC, can be empty

    +
    org
    string

    Organization the VPC belongs to

    +
    tenantId
    string <uuid>

    ID of the Tenant the VPC belongs to

    +
    siteId
    string <uuid>

    ID of the Site the VPC belongs to

    +
    controllerVpcId
    string or null <uuid>

    Legacy attribute, contains the same value as ID

    +
    networkVirtualizationType
    string or null
    Deprecated
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Deprecated: use config.networkVirtualizationType. Network virtualization type of the VPC. Flat VPCs hold instances on zero-DPU hosts (or hosts with their DPU in NIC mode); their interfaces are bound to underlay (HostInband) network segments and NICo does not drive their data plane.

    +
    routingProfile
    string or null [ 3 .. 64 ] characters
    Deprecated

    Deprecated: use config.routingProfile. Routing profile type for the VPC. Populated when Site has Native Networking enabled and network virtualization type is FNN.

    +
    requestedVni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use config.requestedVni. Explicitly requested VNI for the VPC if one was requested at creation time

    +
    vni
    integer or null [ 1 .. 65535 ]
    Deprecated

    Deprecated: use runtimeStatus.vni. Active VNI assigned to the VPC

    +
    networkSecurityGroupId
    string or null
    Deprecated

    Deprecated: use config.networkSecurityGroupId. ID of the Network Security Group attached to the VPC

    +
    object (NetworkSecurityGroupPropagationDetails)

    Propagation details for the attached Network Security Group

    +
    objectId
    string <uuid>

    The ID of the object (VPC/Instance etc.)

    +
    detailedStatus
    string
    Enum: "None" "Partial" "Full" "Unknown" "Error"

    The detailed propagation status that was actually returned from NICo

    +
    status
    string (NetworkSecurityGroupPropagationStatus)
    Enum: "Synchronizing" "Synchronized" "Error"

    The simplified propagation status that reduces the actual status to just a few values

    +
    details
    string or null

    Additional details for the status

    +
    unpropagatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of Instances associated with the object that have not yet updated their Network Security Group rules

    +
    relatedInstanceIds
    Array of strings <uuid> [ items <uuid > ]

    IDs of the instances involved in determining the propagation status

    +
    Array of objects (Deprecation)

    Deprecations active for this resource. Returned only if there are active deprecations.

    +
    Array
    attribute
    string or null

    Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.

    +
    queryParam
    string or null

    Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.

    +
    endpoint
    string or null

    API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.

    +
    replacedBy
    string or null

    Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.

    +
    takeActionBy
    string <date-time>

    Date/time by which clients should migrate away from the deprecated API surface

    +
    notice
    string

    Message describing the deprecation

    +
    nvLinkLogicalPartitionId
    string or null <uuid>
    Deprecated

    Deprecated: use config.nvLinkLogicalPartitionId. ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    property name*
    additional property
    string
    object (VpcConfig)

    Desired configuration for the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    description
    string or null

    Description of the VPC

    +
    siteId
    string or null <uuid>

    ID of the Site the VPC belongs to

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    routingProfile
    string or null [ 3 .. 64 ] characters

    Routing profile type for the VPC

    +
    requestedVni
    integer or null [ 1 .. 65535 ]

    Explicitly requested VNI for the VPC if one was requested at creation time

    +
    networkSecurityGroupId
    string or null

    ID of the Network Security Group attached to the VPC

    +
    nvLinkLogicalPartitionId
    string or null <uuid>

    ID of the default NVLink Logical Partition that GPUs for all Instances in the VPC will attach to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing VPC labels

    +
    property name*
    additional property
    string
    object (VpcRuntimeStatus)

    Observed runtime status for the VPC

    +
    vni
    integer or null [ 1 .. 65535 ]

    Active VNI allocated to the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    Array of objects (StatusDetail)

    History of status changes for the VPC

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when VPC was created

    +
    updated
    string <date-time>

    Date/time when VPC was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "networkVirtualizationType": "FNN"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-vpc-v1",
    • "description": "Virtual network for machines executing Spark jobs v1",
    • "org": "xskkpgqpeakn",
    • "tenantId": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
    • "controllerVpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "networkVirtualizationType": "FNN",
    • "requestedVni": 12001,
    • "vni": 12001,
    • "nvLinkLogicalPartitionId": "dd887330-dbd3-45ce-b400-c42fc8e47315",
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    VPC Peering

    VPC Peering allows Instances in one VPC to communicate with Instances in another VPC on the same Site.

    -

    Retrieve all VPC peerings

    Retrieve all VPC peerings

    Get all VPC peerings. +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Get all VPC peerings. Tenant Admin can get all peerings where the tenant owns at least one VPC. Provider Admin can get all peerings in a site. User must have authorization role with TENANT_ADMIN or PROVIDER_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string <uuid>

    Optional Site ID filter. If provided, caller must have access to the specified Site.

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string

    Ordering for pagination query

    -
    isMultiTenant
    boolean

    Optional filter by peering tenancy type (single-tenant or multi-tenant).

    -
    status
    string
    Enum: "Pending" "Configuring" "Requested" "Ready" "Deleting" "Error"

    Optional filter by peering status. Repeat the parameter to match multiple statuses.

    -
    vpcId
    string <uuid>

    Optional filter by VPC ID involved in the peering as either vpc1 or vpc2. Repeat the parameter to match multiple VPCs.

    -
    peerTenantId
    string <uuid>

    Optional filter by tenant ID of a VPC involved in the peering. Repeat the parameter to match multiple tenants.

    -
    includeRelation
    string
    Enum: "Vpc1" "Vpc2" "Site" "Tenant"

    Related entity to expand

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier of the VPC peering

    -
    vpc1Id
    string <uuid>

    ID of the first VPC in the peering

    -
    object (VpcPeeringVpcSummary)

    Summary of the first VPC in the peering.

    -
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    tenantId
    string <uuid>

    ID of the tenant

    -
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    -
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    vpc2Id
    string <uuid>

    ID of the second VPC in the peering

    -
    object (VpcPeeringVpcSummary)

    Summary of the second VPC in the peering.

    -
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    tenantId
    string <uuid>

    ID of the tenant

    -
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    -
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    siteId
    string <uuid>

    ID of the Site where the peering exists

    -
    object (SiteSummary)

    Summary of the Site where the peering exists.

    -
    id
    string <uuid>

    Unique UUID v4 identifier for the Site

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    -
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    -
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    -
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    -
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    -
    tenantId
    string <uuid>

    ID of the tenant that created the VPC peering.

    -
    object (TenantSummary)

    Summary of the tenant that created the VPC peering.

    -
    org
    string

    Name of the org this tenant belongs to

    -
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    -
    object (TenantCapabilities)

    Features that are enabled/disabled for Tenant

    -
    isMultiTenant
    boolean

    Indicates if this is a multi-tenant peering (VPCs from different tenants)

    -
    status
    string (VpcPeeringStatus)
    Enum: "Pending" "Configuring" "Requested" "Ready" "Deleting" "Error"

    Status of the VPC peering

    -
    created
    string <date-time>

    Date and time when the VPC peering was created

    -
    updated
    string <date-time>

    Date and time when the VPC peering was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create VPC peering

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    string <uuid>

    Optional Site ID filter. If provided, caller must have access to the specified Site.

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string

    Ordering for pagination query

    +
    isMultiTenant
    boolean

    Optional filter by peering tenancy type (single-tenant or multi-tenant).

    +
    status
    string
    Enum: "Pending" "Configuring" "Requested" "Ready" "Deleting" "Error"

    Optional filter by peering status. Repeat the parameter to match multiple statuses.

    +
    vpcId
    string <uuid>

    Optional filter by VPC ID involved in the peering as either vpc1 or vpc2. Repeat the parameter to match multiple VPCs.

    +
    peerTenantId
    string <uuid>

    Optional filter by tenant ID of a VPC involved in the peering. Repeat the parameter to match multiple tenants.

    +
    includeRelation
    string
    Enum: "Vpc1" "Vpc2" "Site" "Tenant"

    Related entity to expand

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier of the VPC peering

    +
    vpc1Id
    string <uuid>

    ID of the first VPC in the peering

    +
    object (VpcPeeringVpcSummary)

    Summary of the first VPC in the peering.

    +
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    tenantId
    string <uuid>

    ID of the tenant

    +
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    vpc2Id
    string <uuid>

    ID of the second VPC in the peering

    +
    object (VpcPeeringVpcSummary)

    Summary of the second VPC in the peering.

    +
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    tenantId
    string <uuid>

    ID of the tenant

    +
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    siteId
    string <uuid>

    ID of the Site where the peering exists

    +
    object (SiteSummary)

    Summary of the Site where the peering exists.

    +
    id
    string <uuid>

    Unique UUID v4 identifier for the Site

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    +
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    +
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    +
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    +
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    +
    tenantId
    string <uuid>

    ID of the tenant that created the VPC peering.

    +
    object (TenantSummary)

    Summary of the tenant that created the VPC peering.

    +
    org
    string

    Name of the org this tenant belongs to

    +
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    +
    object (TenantCapabilities)

    Features that are enabled/disabled for Tenant

    +
    isMultiTenant
    boolean

    Indicates if this is a multi-tenant peering (VPCs from different tenants)

    +
    status
    string (VpcPeeringStatus)
    Enum: "Pending" "Configuring" "Requested" "Ready" "Deleting" "Error"

    Status of the VPC peering

    +
    created
    string <date-time>

    Date and time when the VPC peering was created

    +
    updated
    string <date-time>

    Date and time when the VPC peering was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create VPC peering

    Create a VPC peering between two VPCs on the same site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create a VPC peering between two VPCs on the same site.

    Tenant Admin can create single-tenant peerings (both VPCs belong to their tenant). Provider Admin can create multi-tenant peerings (VPCs from different tenants).

    User must have authorization role with TENANT_ADMIN or PROVIDER_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    required
    vpc1Id
    required
    string <uuid>

    ID of the first VPC in the peering

    -
    vpc2Id
    required
    string <uuid>

    ID of the second VPC to peer with

    -
    siteId
    required
    string <uuid>

    ID of the Site where the peering exists

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier of the VPC peering

    -
    vpc1Id
    string <uuid>

    ID of the first VPC in the peering

    -
    object (VpcPeeringVpcSummary)

    Summary of the first VPC in the peering.

    -
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    tenantId
    string <uuid>

    ID of the tenant

    -
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    -
    id
    string <uuid>

    ID of the Tenant

    -
    org
    string

    Name of the org this tenant belongs to

    -
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    -
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    vpc2Id
    string <uuid>

    ID of the second VPC in the peering

    -
    object (VpcPeeringVpcSummary)

    Summary of the second VPC in the peering.

    -
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    tenantId
    string <uuid>

    ID of the tenant

    -
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    -
    id
    string <uuid>

    ID of the Tenant

    -
    org
    string

    Name of the org this tenant belongs to

    -
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    -
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    siteId
    string <uuid>

    ID of the Site where the peering exists

    -
    object (SiteSummary)

    Summary of the Site where the peering exists.

    -
    id
    string <uuid>

    Unique UUID v4 identifier for the Site

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    -
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    -
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    -
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    -
    nativeNetworking
    boolean

    Whether the Site supports native networking

    -
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    -
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    -
    flow
    boolean

    Whether the Site supports Flow-based operations

    -
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    -
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    -
    tenantId
    string <uuid>

    ID of the tenant that created the VPC peering.

    -
    object (TenantSummary)

    Summary of the tenant that created the VPC peering.

    -
    org
    string

    Name of the org this tenant belongs to

    -
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    -
    object (TenantCapabilities)

    Features that are enabled/disabled for Tenant

    -
    targetedInstanceCreation
    boolean <uuid>

    Indicates whether Tenant can create Instances by specifying Machine ID

    -
    isMultiTenant
    boolean

    Indicates if this is a multi-tenant peering (VPCs from different tenants)

    -
    status
    string (VpcPeeringStatus)
    Enum: "Pending" "Configuring" "Requested" "Ready" "Deleting" "Error"

    Status of the VPC peering

    -
    created
    string <date-time>

    Date and time when the VPC peering was created

    -
    updated
    string <date-time>

    Date and time when the VPC peering was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "vpc1Id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "vpc2Id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "vpc1Id": "bafbaf4c-c730-48ae-8f5d-d7d251f3315a",
    • "vpc1": {
      },
    • "vpc2Id": "a7cd678e-fe62-4184-9f75-66ac903ae1c3",
    • "vpc2": {
      },
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "site": {
      },
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "tenant": {
      },
    • "isMultiTenant": true,
    • "status": "Pending",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve a VPC peering

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    required
    vpc1Id
    required
    string <uuid>

    ID of the first VPC in the peering

    +
    vpc2Id
    required
    string <uuid>

    ID of the second VPC to peer with

    +
    siteId
    required
    string <uuid>

    ID of the Site where the peering exists

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier of the VPC peering

    +
    vpc1Id
    string <uuid>

    ID of the first VPC in the peering

    +
    object (VpcPeeringVpcSummary)

    Summary of the first VPC in the peering.

    +
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    tenantId
    string <uuid>

    ID of the tenant

    +
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    +
    id
    string <uuid>

    ID of the Tenant

    +
    org
    string

    Name of the org this tenant belongs to

    +
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    vpc2Id
    string <uuid>

    ID of the second VPC in the peering

    +
    object (VpcPeeringVpcSummary)

    Summary of the second VPC in the peering.

    +
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    tenantId
    string <uuid>

    ID of the tenant

    +
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    +
    id
    string <uuid>

    ID of the Tenant

    +
    org
    string

    Name of the org this tenant belongs to

    +
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    siteId
    string <uuid>

    ID of the Site where the peering exists

    +
    object (SiteSummary)

    Summary of the Site where the peering exists.

    +
    id
    string <uuid>

    Unique UUID v4 identifier for the Site

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    +
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    +
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    +
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    +
    nativeNetworking
    boolean

    Whether the Site supports native networking

    +
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    +
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    +
    flow
    boolean

    Whether the Site supports Flow-based operations

    +
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    +
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    +
    tenantId
    string <uuid>

    ID of the tenant that created the VPC peering.

    +
    object (TenantSummary)

    Summary of the tenant that created the VPC peering.

    +
    org
    string

    Name of the org this tenant belongs to

    +
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    +
    object (TenantCapabilities)

    Features that are enabled/disabled for Tenant

    +
    targetedInstanceCreation
    boolean <uuid>

    Indicates whether Tenant can create Instances by specifying Machine ID

    +
    isMultiTenant
    boolean

    Indicates if this is a multi-tenant peering (VPCs from different tenants)

    +
    status
    string (VpcPeeringStatus)
    Enum: "Pending" "Configuring" "Requested" "Ready" "Deleting" "Error"

    Status of the VPC peering

    +
    created
    string <date-time>

    Date and time when the VPC peering was created

    +
    updated
    string <date-time>

    Date and time when the VPC peering was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "vpc1Id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "vpc2Id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    • "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "vpc1Id": "bafbaf4c-c730-48ae-8f5d-d7d251f3315a",
    • "vpc1": {
      },
    • "vpc2Id": "a7cd678e-fe62-4184-9f75-66ac903ae1c3",
    • "vpc2": {
      },
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "site": {
      },
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "tenant": {
      },
    • "isMultiTenant": true,
    • "status": "Pending",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve a VPC peering

    Get details of a VPC peering by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Get details of a VPC peering by ID.

    Tenant Admin can get a peering if at least one VPC belongs to their tenant. Provider Admin can get a peering if it is in a site provided by their org.

    User must have authorization role with TENANT_ADMIN or PROVIDER_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    id
    required
    string <uuid>

    VPC Peering ID

    -
    query Parameters
    includeRelation
    string
    Enum: "Vpc1" "Vpc2" "Site" "Tenant"

    Related entity to expand

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier of the VPC peering

    -
    vpc1Id
    string <uuid>

    ID of the first VPC in the peering

    -
    object (VpcPeeringVpcSummary)

    Summary of the first VPC in the peering.

    -
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    tenantId
    string <uuid>

    ID of the tenant

    -
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    -
    id
    string <uuid>

    ID of the Tenant

    -
    org
    string

    Name of the org this tenant belongs to

    -
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    -
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    vpc2Id
    string <uuid>

    ID of the second VPC in the peering

    -
    object (VpcPeeringVpcSummary)

    Summary of the second VPC in the peering.

    -
    id
    string <uuid>

    ID of the VPC

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    -
    tenantId
    string <uuid>

    ID of the tenant

    -
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    -
    id
    string <uuid>

    ID of the Tenant

    -
    org
    string

    Name of the org this tenant belongs to

    -
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    -
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    -
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    -
    siteId
    string <uuid>

    ID of the Site where the peering exists

    -
    object (SiteSummary)

    Summary of the Site where the peering exists.

    -
    id
    string <uuid>

    Unique UUID v4 identifier for the Site

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    -
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    -
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    -
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    -
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    -
    nativeNetworking
    boolean

    Whether the Site supports native networking

    -
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    -
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    -
    flow
    boolean

    Whether the Site supports Flow-based operations

    -
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    -
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    -
    tenantId
    string <uuid>

    ID of the tenant that created the VPC peering.

    -
    object (TenantSummary)

    Summary of the tenant that created the VPC peering.

    -
    org
    string

    Name of the org this tenant belongs to

    -
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    -
    object (TenantCapabilities)

    Features that are enabled/disabled for Tenant

    -
    targetedInstanceCreation
    boolean <uuid>

    Indicates whether Tenant can create Instances by specifying Machine ID

    -
    isMultiTenant
    boolean

    Indicates if this is a multi-tenant peering (VPCs from different tenants)

    -
    status
    string (VpcPeeringStatus)
    Enum: "Pending" "Configuring" "Requested" "Ready" "Deleting" "Error"

    Status of the VPC peering

    -
    created
    string <date-time>

    Date and time when the VPC peering was created

    -
    updated
    string <date-time>

    Date and time when the VPC peering was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "vpc1Id": "bafbaf4c-c730-48ae-8f5d-d7d251f3315a",
    • "vpc1": {
      },
    • "vpc2Id": "a7cd678e-fe62-4184-9f75-66ac903ae1c3",
    • "vpc2": {
      },
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "site": {
      },
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "tenant": {
      },
    • "isMultiTenant": true,
    • "status": "Pending",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete a VPC peering

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    id
    required
    string <uuid>

    VPC Peering ID

    +
    query Parameters
    includeRelation
    string
    Enum: "Vpc1" "Vpc2" "Site" "Tenant"

    Related entity to expand

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier of the VPC peering

    +
    vpc1Id
    string <uuid>

    ID of the first VPC in the peering

    +
    object (VpcPeeringVpcSummary)

    Summary of the first VPC in the peering.

    +
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    tenantId
    string <uuid>

    ID of the tenant

    +
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    +
    id
    string <uuid>

    ID of the Tenant

    +
    org
    string

    Name of the org this tenant belongs to

    +
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    vpc2Id
    string <uuid>

    ID of the second VPC in the peering

    +
    object (VpcPeeringVpcSummary)

    Summary of the second VPC in the peering.

    +
    id
    string <uuid>

    ID of the VPC

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC

    +
    tenantId
    string <uuid>

    ID of the tenant

    +
    object (VpcPeeringTenantSummary)

    Summary of the tenant

    +
    id
    string <uuid>

    ID of the Tenant

    +
    org
    string

    Name of the org this tenant belongs to

    +
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    +
    networkVirtualizationType
    string or null
    Enum: "ETHERNET_VIRTUALIZER" "FNN" "FLAT"

    Network virtualization type of the VPC

    +
    status
    string (VpcStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the VPC

    +
    siteId
    string <uuid>

    ID of the Site where the peering exists

    +
    object (SiteSummary)

    Summary of the Site where the peering exists.

    +
    id
    string <uuid>

    Unique UUID v4 identifier for the Site

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Site

    +
    infrastructureProviderId
    string <uuid>

    ID of the Infrastructure Provider that owns the Site

    +
    isSerialConsoleEnabled
    boolean

    Indicates if Serial Console is enabled for the Site by the Provider

    +
    isOnline
    boolean

    Indicates if the Site is currently reachable from Cloud

    +
    object (SiteCapabilities)

    Site capabilities used for feature availability and configuration

    +
    nativeNetworking
    boolean

    Whether the Site supports native networking

    +
    networkSecurityGroup
    boolean

    Whether the Site supports Network Security Groups

    +
    nvLinkPartition
    boolean

    Whether the Site supports NVLink partitioning

    +
    flow
    boolean

    Whether the Site supports Flow-based operations

    +
    imageBasedOperatingSystem
    boolean

    Whether the Site supports image-based operating system provisioning

    +
    status
    string (SiteStatus)
    Enum: "Pending" "Registered" "Error"

    Status of the Site

    +
    tenantId
    string <uuid>

    ID of the tenant that created the VPC peering.

    +
    object (TenantSummary)

    Summary of the tenant that created the VPC peering.

    +
    org
    string

    Name of the org this tenant belongs to

    +
    orgDisplayName
    string or null

    Display name of the org the Tenant belongs to

    +
    object (TenantCapabilities)

    Features that are enabled/disabled for Tenant

    +
    targetedInstanceCreation
    boolean <uuid>

    Indicates whether Tenant can create Instances by specifying Machine ID

    +
    isMultiTenant
    boolean

    Indicates if this is a multi-tenant peering (VPCs from different tenants)

    +
    status
    string (VpcPeeringStatus)
    Enum: "Pending" "Configuring" "Requested" "Ready" "Deleting" "Error"

    Status of the VPC peering

    +
    created
    string <date-time>

    Date and time when the VPC peering was created

    +
    updated
    string <date-time>

    Date and time when the VPC peering was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "vpc1Id": "bafbaf4c-c730-48ae-8f5d-d7d251f3315a",
    • "vpc1": {
      },
    • "vpc2Id": "a7cd678e-fe62-4184-9f75-66ac903ae1c3",
    • "vpc2": {
      },
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "site": {
      },
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "tenant": {
      },
    • "isMultiTenant": true,
    • "status": "Pending",
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete a VPC peering

    Delete a VPC peering by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete a VPC peering by ID.

    Tenant Admin can delete only peerings where both VPCs belong to their tenant. Provider Admin can delete only multi-tenant peerings in sites they provide.

    User must have authorization role with TENANT_ADMIN or PROVIDER_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    id
    required
    string <uuid>

    VPC Peering ID

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    VPC Prefix

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    id
    required
    string <uuid>

    VPC Peering ID

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    VPC Prefix

    VPC Prefix is a network prefix belonging to an IP Block allocated to a Tenant. Tenant can use VPC Prefixes to enable network connectivity between their Instances.

    Only Sites that support Native Networking (FNN) offer VPC Prefix management.

    -

    Retrieve all VPC Prefixes

    Retrieve all VPC Prefixes

    Retrieve all VPC Prefixes for the org

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all VPC Prefixes for the org

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string <uuid>

    Filter VPC Prefixes by Site, required if the vpcId query parameter is not specified

    -
    vpcId
    string <uuid>

    Filter VPC Prefixes by VPC

    -
    status
    string

    Filter VPC Prefixes by Status

    -
    query
    string

    Search for matches across all VPC Prefixes. Input will be matched against name and status fields

    -
    includeRelation
    string
    Enum: "VPC" "Tenant" "IPBlock"

    Related entity to expand

    -
    includeUsageStats
    boolean

    When true, each VPC Prefix object includes usage statistics using the same structure as IP Block usage. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the VPCPrefix

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC Prefix

    -
    siteId
    string <uuid>

    ID of the Site the VPC Prefix belongs to

    -
    vpcId
    string <uuid>

    ID of the VPC the VPC Prefix belongs to

    -
    ipBlockId
    string or null <uuid>

    ID of the IP Block that contains the prefix of the VPC Prefix

    -
    prefix
    string or null

    The network prefix including prefix length in CIDR notation

    -
    prefixLength
    integer [ 8 .. 31 ]

    Length of the prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    -
    status
    string (VpcPrefixStatus)
    Enum: "Provisioning" "Ready" "Deleting" "Deleted" "Error"

    Status of the VPC Prefix

    -
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    -
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    -
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    -
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    -
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    -
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    -
    Array of objects (StatusDetail)

    Details of 20 most recent status changes

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date and time when the VPC Prefix was created

    -
    updated
    string <date-time>

    Date and time when the VPC Prefix was updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create VPC Prefix

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    string <uuid>

    Filter VPC Prefixes by Site, required if the vpcId query parameter is not specified

    +
    vpcId
    string <uuid>

    Filter VPC Prefixes by VPC

    +
    status
    string

    Filter VPC Prefixes by Status

    +
    query
    string

    Search for matches across all VPC Prefixes. Input will be matched against name and status fields

    +
    includeRelation
    string
    Enum: "VPC" "Tenant" "IPBlock"

    Related entity to expand

    +
    includeUsageStats
    boolean

    When true, each VPC Prefix object includes usage statistics using the same structure as IP Block usage. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the VPCPrefix

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC Prefix

    +
    siteId
    string <uuid>

    ID of the Site the VPC Prefix belongs to

    +
    vpcId
    string <uuid>

    ID of the VPC the VPC Prefix belongs to

    +
    ipBlockId
    string or null <uuid>

    ID of the IP Block that contains the prefix of the VPC Prefix

    +
    prefix
    string or null

    The network prefix including prefix length in CIDR notation

    +
    prefixLength
    integer [ 8 .. 31 ]

    Length of the prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    +
    status
    string (VpcPrefixStatus)
    Enum: "Provisioning" "Ready" "Deleting" "Deleted" "Error"

    Status of the VPC Prefix

    +
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    +
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    +
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    +
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    +
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    +
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    +
    Array of objects (StatusDetail)

    Details of 20 most recent status changes

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date and time when the VPC Prefix was created

    +
    updated
    string <date-time>

    Date and time when the VPC Prefix was updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create VPC Prefix

    Create a VPC Prefix for the org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create a VPC Prefix for the org.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Human readable name for the VPC Prefix

    -
    vpcId
    required
    string <uuid>

    ID of the VPC

    -
    ipBlockId
    required
    string <uuid>

    ID of the IP Block to allocate the VPC Prefix from

    -
    prefixLength
    required
    integer [ 8 .. 31 ]

    Prefix length for the VPC Prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the VPCPrefix

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC Prefix

    -
    siteId
    string <uuid>

    ID of the Site the VPC Prefix belongs to

    -
    vpcId
    string <uuid>

    ID of the VPC the VPC Prefix belongs to

    -
    ipBlockId
    string or null <uuid>

    ID of the IP Block that contains the prefix of the VPC Prefix

    -
    prefix
    string or null

    The network prefix including prefix length in CIDR notation

    -
    prefixLength
    integer [ 8 .. 31 ]

    Length of the prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    -
    status
    string (VpcPrefixStatus)
    Enum: "Provisioning" "Ready" "Deleting" "Deleted" "Error"

    Status of the VPC Prefix

    -
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    -
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    -
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    -
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    -
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    -
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    -
    Array of objects (StatusDetail)

    Details of 20 most recent status changes

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date and time when the VPC Prefix was created

    -
    updated
    string <date-time>

    Date and time when the VPC Prefix was updated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "east-vpc-traffic-net",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 20
    }

    Response samples

    Content type
    application/json
    {
    • "id": "0c03ba01-d86b-4a57-a41e-cc359b380a6f",
    • "name": "east-vpc-traffic-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "prefix": "192.168.1.0/24",
    • "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 24,
    • "status": "Ready",
    • "usageStats": {
      },
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve VPC Prefix

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Human readable name for the VPC Prefix

    +
    vpcId
    required
    string <uuid>

    ID of the VPC

    +
    ipBlockId
    required
    string <uuid>

    ID of the IP Block to allocate the VPC Prefix from

    +
    prefixLength
    required
    integer [ 8 .. 31 ]

    Prefix length for the VPC Prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the VPCPrefix

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC Prefix

    +
    siteId
    string <uuid>

    ID of the Site the VPC Prefix belongs to

    +
    vpcId
    string <uuid>

    ID of the VPC the VPC Prefix belongs to

    +
    ipBlockId
    string or null <uuid>

    ID of the IP Block that contains the prefix of the VPC Prefix

    +
    prefix
    string or null

    The network prefix including prefix length in CIDR notation

    +
    prefixLength
    integer [ 8 .. 31 ]

    Length of the prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    +
    status
    string (VpcPrefixStatus)
    Enum: "Provisioning" "Ready" "Deleting" "Deleted" "Error"

    Status of the VPC Prefix

    +
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    +
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    +
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    +
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    +
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    +
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    +
    Array of objects (StatusDetail)

    Details of 20 most recent status changes

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date and time when the VPC Prefix was created

    +
    updated
    string <date-time>

    Date and time when the VPC Prefix was updated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "east-vpc-traffic-net",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 20
    }

    Response samples

    Content type
    application/json
    {
    • "id": "0c03ba01-d86b-4a57-a41e-cc359b380a6f",
    • "name": "east-vpc-traffic-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "prefix": "192.168.1.0/24",
    • "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 24,
    • "status": "Ready",
    • "usageStats": {
      },
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve VPC Prefix

    Retrieve a specific VPC Prefix

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific VPC Prefix

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    vpcPrefixId
    required
    string <uuid>

    ID of the VPC Prefix

    -
    query Parameters
    includeRelation
    string
    Enum: "VPC" "Tenant" "IPBlock"

    Related entity to expand

    -
    includeUsageStats
    boolean
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    vpcPrefixId
    required
    string <uuid>

    ID of the VPC Prefix

    +
    query Parameters
    includeRelation
    string
    Enum: "VPC" "Tenant" "IPBlock"

    Related entity to expand

    +
    includeUsageStats
    boolean

    When true, each VPC Prefix object includes usage statistics using the same structure as IP Block usage. +" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    When true, each VPC Prefix object includes usage statistics using the same structure as IP Block usage. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the VPCPrefix

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC Prefix

    -
    siteId
    string <uuid>

    ID of the Site the VPC Prefix belongs to

    -
    vpcId
    string <uuid>

    ID of the VPC the VPC Prefix belongs to

    -
    ipBlockId
    string or null <uuid>

    ID of the IP Block that contains the prefix of the VPC Prefix

    -
    prefix
    string or null

    The network prefix including prefix length in CIDR notation

    -
    prefixLength
    integer [ 8 .. 31 ]

    Length of the prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    -
    status
    string (VpcPrefixStatus)
    Enum: "Provisioning" "Ready" "Deleting" "Deleted" "Error"

    Status of the VPC Prefix

    -
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    -
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    -
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    -
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    -
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    -
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    -
    Array of objects (StatusDetail)

    Details of 20 most recent status changes

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date and time when the VPC Prefix was created

    -
    updated
    string <date-time>

    Date and time when the VPC Prefix was updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "0c03ba01-d86b-4a57-a41e-cc359b380a6f",
    • "name": "east-vpc-traffic-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "prefix": "192.168.1.0/24",
    • "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 24,
    • "status": "Ready",
    • "usageStats": {
      },
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete VPC Prefix

    Responses
    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the VPCPrefix

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC Prefix

    +
    siteId
    string <uuid>

    ID of the Site the VPC Prefix belongs to

    +
    vpcId
    string <uuid>

    ID of the VPC the VPC Prefix belongs to

    +
    ipBlockId
    string or null <uuid>

    ID of the IP Block that contains the prefix of the VPC Prefix

    +
    prefix
    string or null

    The network prefix including prefix length in CIDR notation

    +
    prefixLength
    integer [ 8 .. 31 ]

    Length of the prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    +
    status
    string (VpcPrefixStatus)
    Enum: "Provisioning" "Ready" "Deleting" "Deleted" "Error"

    Status of the VPC Prefix

    +
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    +
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    +
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    +
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    +
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    +
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    +
    Array of objects (StatusDetail)

    Details of 20 most recent status changes

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date and time when the VPC Prefix was created

    +
    updated
    string <date-time>

    Date and time when the VPC Prefix was updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "0c03ba01-d86b-4a57-a41e-cc359b380a6f",
    • "name": "east-vpc-traffic-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "prefix": "192.168.1.0/24",
    • "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 24,
    • "status": "Ready",
    • "usageStats": {
      },
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete VPC Prefix

    Delete a specific VPC Prefix by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete a specific VPC Prefix by ID.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    vpcPrefixId
    required
    string <uuid>

    ID of the VPC Prefix

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "User is not allowed to perform this action",
    • "data": null
    }

    Update VPC Prefix

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    vpcPrefixId
    required
    string <uuid>

    ID of the VPC Prefix

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "User is not allowed to perform this action",
    • "data": null
    }

    Update VPC Prefix

    Update an existing VPC Prefix

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing VPC Prefix

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    vpcPrefixId
    required
    string <uuid>

    ID of the VPC Prefix

    -
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the VPCPrefix

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the VPCPrefix

    -
    name
    string [ 2 .. 256 ] characters

    Name of the VPC Prefix

    -
    siteId
    string <uuid>

    ID of the Site the VPC Prefix belongs to

    -
    vpcId
    string <uuid>

    ID of the VPC the VPC Prefix belongs to

    -
    ipBlockId
    string or null <uuid>

    ID of the IP Block that contains the prefix of the VPC Prefix

    -
    prefix
    string or null

    The network prefix including prefix length in CIDR notation

    -
    prefixLength
    integer [ 8 .. 31 ]

    Length of the prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    -
    status
    string (VpcPrefixStatus)
    Enum: "Provisioning" "Ready" "Deleting" "Deleted" "Error"

    Status of the VPC Prefix

    -
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    -
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    -
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    -
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    -
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    -
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    -
    Array of objects (StatusDetail)

    Details of 20 most recent status changes

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date and time when the VPC Prefix was created

    -
    updated
    string <date-time>

    Date and time when the VPC Prefix was updated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "east-vpc-traffic-net"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "0c03ba01-d86b-4a57-a41e-cc359b380a6f",
    • "name": "east-vpc-traffic-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "prefix": "192.168.1.0/24",
    • "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 24,
    • "status": "Ready",
    • "usageStats": {
      },
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Subnet

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    vpcPrefixId
    required
    string <uuid>

    ID of the VPC Prefix

    +
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the VPCPrefix

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the VPCPrefix

    +
    name
    string [ 2 .. 256 ] characters

    Name of the VPC Prefix

    +
    siteId
    string <uuid>

    ID of the Site the VPC Prefix belongs to

    +
    vpcId
    string <uuid>

    ID of the VPC the VPC Prefix belongs to

    +
    ipBlockId
    string or null <uuid>

    ID of the IP Block that contains the prefix of the VPC Prefix

    +
    prefix
    string or null

    The network prefix including prefix length in CIDR notation

    +
    prefixLength
    integer [ 8 .. 31 ]

    Length of the prefix. Valid range is 8 to 31, and max usable value depends on prefix length of parent IP Block.

    +
    status
    string (VpcPrefixStatus)
    Enum: "Provisioning" "Ready" "Deleting" "Deleted" "Error"

    Status of the VPC Prefix

    +
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a VPC Prefix consumes a /31 prefix.

    +
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    +
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    +
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    +
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    +
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    +
    Array of objects (StatusDetail)

    Details of 20 most recent status changes

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date and time when the VPC Prefix was created

    +
    updated
    string <date-time>

    Date and time when the VPC Prefix was updated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "east-vpc-traffic-net"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "0c03ba01-d86b-4a57-a41e-cc359b380a6f",
    • "name": "east-vpc-traffic-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "prefix": "192.168.1.0/24",
    • "ipBlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 24,
    • "status": "Ready",
    • "usageStats": {
      },
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Subnet

    Subnet is a network prefix belonging to an IP Block allocated to a Tenant. Tenant can use Subnets to enable network connectivity between their Instances.

    Subnets are used on Sites that do not support Native Networking (FNN).

    -

    Retrieve all Subnets

    Retrieve all Subnets

    Retrieve all Subnets for the org

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all Subnets for the org

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string <uuid>

    Filter subnets by Site, required if the vpcId query parameter is not specified

    -
    vpcId
    string <uuid>

    Filter subnets by VPC

    -
    status
    string

    Filter Subnets by Status

    -
    query
    string

    Search for matches across all Subnets. Input will be matched against name, description, and status fields

    -
    includeRelation
    string
    Enum: "VPC" "Tenant" "IPv4Block" "IPv6Block"

    Related entity to expand

    -
    includeUsageStats
    boolean
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    string <uuid>

    Filter subnets by Site, required if the vpcId query parameter is not specified

    +
    vpcId
    string <uuid>

    Filter subnets by VPC

    +
    status
    string

    Filter Subnets by Status

    +
    query
    string

    Search for matches across all Subnets. Input will be matched against name, description, and status fields

    +
    includeRelation
    string
    Enum: "VPC" "Tenant" "IPv4Block" "IPv6Block"

    Related entity to expand

    +
    includeUsageStats
    boolean

    When true, each Subnet object includes usage statistics using the same structure as IP Block usage. +" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    When true, each Subnet object includes usage statistics using the same structure as IP Block usage. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the Subnet

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Subnet

    -
    description
    string or null

    Description of the Subnet

    -
    siteId
    string <uuid>

    ID of the Site containing the Subnet

    -
    vpcId
    string <uuid>

    ID of the VPC containing the Subnet

    -
    controllerNetworkSegmentId
    string or null <uuid>

    ID of the Site Controller network segment corresponding to the Subnet

    -
    ipv4Prefix
    string or null <ipv4>

    The prefix that gets assigned to the subnet if ipv4 block is chosen

    -
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    -
    ipv4Gateway
    string or null <ipv4>

    Address of the IPv4 gateway in the Subnet

    -
    ipv6Prefix
    string or null <ipv6>

    Prefix of the network in CIDR notation

    -
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    -
    ipv6Gateway
    string or null <ipv6>

    Address of the IPv6 gateway in the Subnet

    -
    mtu
    integer

    Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

    -
    prefixLength
    integer

    Max value depends on prefix length of parent IP Block

    -
    routingType
    string or null
    Enum: "Public" "DatacenterOnly"

    Routing type of the Subnet

    -
    status
    string (SubnetStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the Subnet

    -
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    -
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    -
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    -
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    -
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    -
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    -
    Array of objects (StatusDetail)

    Chronological status history for the Subnet

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the Subnet was created

    -
    updated
    string <date-time>

    Date/time when the Subnet was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create Subnet

    		pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the Subnet

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Subnet

    +
    description
    string or null

    Description of the Subnet

    +
    siteId
    string <uuid>

    ID of the Site containing the Subnet

    +
    vpcId
    string <uuid>

    ID of the VPC containing the Subnet

    +
    controllerNetworkSegmentId
    string or null <uuid>

    ID of the Site Controller network segment corresponding to the Subnet

    +
    ipv4Prefix
    string or null <ipv4>

    The prefix that gets assigned to the subnet if ipv4 block is chosen

    +
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    +
    ipv4Gateway
    string or null <ipv4>

    Address of the IPv4 gateway in the Subnet

    +
    ipv6Prefix
    string or null <ipv6>

    Prefix of the network in CIDR notation

    +
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    +
    ipv6Gateway
    string or null <ipv6>

    Address of the IPv6 gateway in the Subnet

    +
    mtu
    integer

    Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

    +
    prefixLength
    integer

    Max value depends on prefix length of parent IP Block

    +
    routingType
    string or null
    Enum: "Public" "DatacenterOnly"

    Routing type of the Subnet

    +
    status
    string (SubnetStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the Subnet

    +
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    +
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    +
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    +
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    +
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    +
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    +
    Array of objects (StatusDetail)

    Chronological status history for the Subnet

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the Subnet was created

    +
    updated
    string <date-time>

    Date/time when the Subnet was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create Subnet

    Create a Subnet for the org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create a Subnet for the org.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    At least one IPv4 IP block or one IPv6 IP block must be specified.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the Subnet

    -
    description
    string or null

    Description of the Subnet

    -
    vpcId
    required
    string <uuid>

    ID of the VPC containing the Subnet

    -
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    -
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    -
    prefixLength
    required
    integer

    Length of the prefix

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Subnet

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Subnet

    -
    description
    string or null

    Description of the Subnet

    -
    siteId
    string <uuid>

    ID of the Site containing the Subnet

    -
    vpcId
    string <uuid>

    ID of the VPC containing the Subnet

    -
    controllerNetworkSegmentId
    string or null <uuid>

    ID of the Site Controller network segment corresponding to the Subnet

    -
    ipv4Prefix
    string or null <ipv4>

    The prefix that gets assigned to the subnet if ipv4 block is chosen

    -
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    -
    ipv4Gateway
    string or null <ipv4>

    Address of the IPv4 gateway in the Subnet

    -
    ipv6Prefix
    string or null <ipv6>

    Prefix of the network in CIDR notation

    -
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    -
    ipv6Gateway
    string or null <ipv6>

    Address of the IPv6 gateway in the Subnet

    -
    mtu
    integer

    Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

    -
    prefixLength
    integer

    Max value depends on prefix length of parent IP Block

    -
    routingType
    string or null
    Enum: "Public" "DatacenterOnly"

    Routing type of the Subnet

    -
    status
    string (SubnetStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the Subnet

    -
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    -
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    -
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    -
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    -
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    -
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    -
    Array of objects (StatusDetail)

    Chronological status history for the Subnet

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the Subnet was created

    -
    updated
    string <date-time>

    Date/time when the Subnet was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "spark-gpu-net",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 20
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-gpu-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "controllerNetworkSegmentId": null,
    • "ipv4Prefix": "202.168.16.0",
    • "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "ipv4Gateway": "202.168.0.1",
    • "ipv6Prefix": null,
    • "ipv6BlockId": null,
    • "ipv6Gateway": null,
    • "prefixLength": 20,
    • "routingType": "Public",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve Subnet

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the Subnet

    +
    description
    string or null

    Description of the Subnet

    +
    vpcId
    required
    string <uuid>

    ID of the VPC containing the Subnet

    +
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    +
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    +
    prefixLength
    required
    integer

    Length of the prefix

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Subnet

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Subnet

    +
    description
    string or null

    Description of the Subnet

    +
    siteId
    string <uuid>

    ID of the Site containing the Subnet

    +
    vpcId
    string <uuid>

    ID of the VPC containing the Subnet

    +
    controllerNetworkSegmentId
    string or null <uuid>

    ID of the Site Controller network segment corresponding to the Subnet

    +
    ipv4Prefix
    string or null <ipv4>

    The prefix that gets assigned to the subnet if ipv4 block is chosen

    +
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    +
    ipv4Gateway
    string or null <ipv4>

    Address of the IPv4 gateway in the Subnet

    +
    ipv6Prefix
    string or null <ipv6>

    Prefix of the network in CIDR notation

    +
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    +
    ipv6Gateway
    string or null <ipv6>

    Address of the IPv6 gateway in the Subnet

    +
    mtu
    integer

    Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

    +
    prefixLength
    integer

    Max value depends on prefix length of parent IP Block

    +
    routingType
    string or null
    Enum: "Public" "DatacenterOnly"

    Routing type of the Subnet

    +
    status
    string (SubnetStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the Subnet

    +
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    +
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    +
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    +
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    +
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    +
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    +
    Array of objects (StatusDetail)

    Chronological status history for the Subnet

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the Subnet was created

    +
    updated
    string <date-time>

    Date/time when the Subnet was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "spark-gpu-net",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "prefixLength": 20
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-gpu-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "controllerNetworkSegmentId": null,
    • "ipv4Prefix": "202.168.16.0",
    • "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "ipv4Gateway": "202.168.0.1",
    • "ipv6Prefix": null,
    • "ipv6BlockId": null,
    • "ipv6Gateway": null,
    • "prefixLength": 20,
    • "routingType": "Public",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve Subnet

    Retrieve a specific Subnet

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific Subnet

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    subnetId
    required
    string <uuid>

    ID of the Subnet

    -
    query Parameters
    includeRelation
    string
    Enum: "VPC" "Tenant" "IPv4Block" "IPv6Block"

    Related entity to expand

    -
    includeUsageStats
    boolean
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    subnetId
    required
    string <uuid>

    ID of the Subnet

    +
    query Parameters
    includeRelation
    string
    Enum: "VPC" "Tenant" "IPv4Block" "IPv6Block"

    Related entity to expand

    +
    includeUsageStats
    boolean

    When true, each Subnet object includes usage statistics using the same structure as IP Block usage. +" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    When true, each Subnet object includes usage statistics using the same structure as IP Block usage. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Subnet

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Subnet

    -
    description
    string or null

    Description of the Subnet

    -
    siteId
    string <uuid>

    ID of the Site containing the Subnet

    -
    vpcId
    string <uuid>

    ID of the VPC containing the Subnet

    -
    controllerNetworkSegmentId
    string or null <uuid>

    ID of the Site Controller network segment corresponding to the Subnet

    -
    ipv4Prefix
    string or null <ipv4>

    The prefix that gets assigned to the subnet if ipv4 block is chosen

    -
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    -
    ipv4Gateway
    string or null <ipv4>

    Address of the IPv4 gateway in the Subnet

    -
    ipv6Prefix
    string or null <ipv6>

    Prefix of the network in CIDR notation

    -
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    -
    ipv6Gateway
    string or null <ipv6>

    Address of the IPv6 gateway in the Subnet

    -
    mtu
    integer

    Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

    -
    prefixLength
    integer

    Max value depends on prefix length of parent IP Block

    -
    routingType
    string or null
    Enum: "Public" "DatacenterOnly"

    Routing type of the Subnet

    -
    status
    string (SubnetStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the Subnet

    -
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    -
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    -
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    -
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    -
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    -
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    -
    Array of objects (StatusDetail)

    Chronological status history for the Subnet

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the Subnet was created

    -
    updated
    string <date-time>

    Date/time when the Subnet was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-gpu-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "controllerNetworkSegmentId": "abe7b0e8-67db-4e89-903e-fc4f2bd7f034",
    • "ipv4Prefix": "202.168.16.0",
    • "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "ipv4Gateway": "202.168.0.1",
    • "ipv6Prefix": null,
    • "ipv6BlockId": null,
    • "ipv6Gateway": null,
    • "prefixLength": 20,
    • "routingType": "Public",
    • "status": "Ready",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Subnet

    Responses
    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Subnet

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Subnet

    +
    description
    string or null

    Description of the Subnet

    +
    siteId
    string <uuid>

    ID of the Site containing the Subnet

    +
    vpcId
    string <uuid>

    ID of the VPC containing the Subnet

    +
    controllerNetworkSegmentId
    string or null <uuid>

    ID of the Site Controller network segment corresponding to the Subnet

    +
    ipv4Prefix
    string or null <ipv4>

    The prefix that gets assigned to the subnet if ipv4 block is chosen

    +
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    +
    ipv4Gateway
    string or null <ipv4>

    Address of the IPv4 gateway in the Subnet

    +
    ipv6Prefix
    string or null <ipv6>

    Prefix of the network in CIDR notation

    +
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    +
    ipv6Gateway
    string or null <ipv6>

    Address of the IPv6 gateway in the Subnet

    +
    mtu
    integer

    Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

    +
    prefixLength
    integer

    Max value depends on prefix length of parent IP Block

    +
    routingType
    string or null
    Enum: "Public" "DatacenterOnly"

    Routing type of the Subnet

    +
    status
    string (SubnetStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the Subnet

    +
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    +
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    +
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    +
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    +
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    +
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    +
    Array of objects (StatusDetail)

    Chronological status history for the Subnet

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the Subnet was created

    +
    updated
    string <date-time>

    Date/time when the Subnet was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-gpu-net",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "controllerNetworkSegmentId": "abe7b0e8-67db-4e89-903e-fc4f2bd7f034",
    • "ipv4Prefix": "202.168.16.0",
    • "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "ipv4Gateway": "202.168.0.1",
    • "ipv6Prefix": null,
    • "ipv6BlockId": null,
    • "ipv6Gateway": null,
    • "prefixLength": 20,
    • "routingType": "Public",
    • "status": "Ready",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Subnet

    Delete a specific Subnet by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete a specific Subnet by ID.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    subnetId
    required
    string <uuid>

    ID of the Subnet

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "User is not allowed to perform this action",
    • "data": null
    }

    Update Subnet

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    subnetId
    required
    string <uuid>

    ID of the Subnet

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "User is not allowed to perform this action",
    • "data": null
    }

    Update Subnet

    Update an existing Subnet

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing Subnet

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    subnetId
    required
    string <uuid>

    ID of the Subnet

    -
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the Subnet

    -
    description
    string or null

    Description of the Subnet

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Subnet

    -
    name
    string [ 2 .. 256 ] characters

    Name of the Subnet

    -
    description
    string or null

    Description of the Subnet

    -
    siteId
    string <uuid>

    ID of the Site containing the Subnet

    -
    vpcId
    string <uuid>

    ID of the VPC containing the Subnet

    -
    controllerNetworkSegmentId
    string or null <uuid>

    ID of the Site Controller network segment corresponding to the Subnet

    -
    ipv4Prefix
    string or null <ipv4>

    The prefix that gets assigned to the subnet if ipv4 block is chosen

    -
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    -
    ipv4Gateway
    string or null <ipv4>

    Address of the IPv4 gateway in the Subnet

    -
    ipv6Prefix
    string or null <ipv6>

    Prefix of the network in CIDR notation

    -
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    -
    ipv6Gateway
    string or null <ipv6>

    Address of the IPv6 gateway in the Subnet

    -
    mtu
    integer

    Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

    -
    prefixLength
    integer

    Max value depends on prefix length of parent IP Block

    -
    routingType
    string or null
    Enum: "Public" "DatacenterOnly"

    Routing type of the Subnet

    -
    status
    string (SubnetStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the Subnet

    -
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    -
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    -
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    -
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    -
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    -
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    -
    Array of objects (StatusDetail)

    Chronological status history for the Subnet

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the Subnet was created

    -
    updated
    string <date-time>

    Date/time when the Subnet was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "spark-gpu-subnet",
    • "description": "Subnet for dedicated GPU nodes"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-gpu-subnet",
    • "description": "Subnet for dedicated GPU nodes",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "controllerNetworkSegmentId": null,
    • "ipv4Prefix": "212.168.0.250",
    • "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "ipv4Gateway": "202.168.0.1",
    • "ipv6Prefix": null,
    • "ipv6BlockId": null,
    • "ipv6Gateway": null,
    • "prefixLength": 20,
    • "routingType": "Public",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Expected Machine

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    subnetId
    required
    string <uuid>

    ID of the Subnet

    +
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the Subnet

    +
    description
    string or null

    Description of the Subnet

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the Subnet

    +
    name
    string [ 2 .. 256 ] characters

    Name of the Subnet

    +
    description
    string or null

    Description of the Subnet

    +
    siteId
    string <uuid>

    ID of the Site containing the Subnet

    +
    vpcId
    string <uuid>

    ID of the VPC containing the Subnet

    +
    controllerNetworkSegmentId
    string or null <uuid>

    ID of the Site Controller network segment corresponding to the Subnet

    +
    ipv4Prefix
    string or null <ipv4>

    The prefix that gets assigned to the subnet if ipv4 block is chosen

    +
    ipv4BlockId
    string or null <uuid>

    ID of the derived Tenant IPv4 Block from an Allocation

    +
    ipv4Gateway
    string or null <ipv4>

    Address of the IPv4 gateway in the Subnet

    +
    ipv6Prefix
    string or null <ipv6>

    Prefix of the network in CIDR notation

    +
    ipv6BlockId
    string or null <uuid>

    ID of the derived Tenant IPv6 Block from an Allocation

    +
    ipv6Gateway
    string or null <ipv6>

    Address of the IPv6 gateway in the Subnet

    +
    mtu
    integer

    Maximum Transmission Unit size in bytes. This property is system-determined and read-only.

    +
    prefixLength
    integer

    Max value depends on prefix length of parent IP Block

    +
    routingType
    string or null
    Enum: "Public" "DatacenterOnly"

    Routing type of the Subnet

    +
    status
    string (SubnetStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the Subnet

    +
    object (IpBlockUsageStats)

    Present when query parameter includeUsageStats=true. Prefix and IP usage data is derived by evaluating associated Ethernet interfaces. Each Interface associated with a Subnet consumes a single IP. In addition, one gateway and one broadcast IP address are reserved per Subnet.

    +
    availableIPs
    integer <int64>

    Total number of IP addresses in the block (acquired and unused)

    +
    acquiredIPs
    integer <int64>

    Number of individual IP addresses acquired from the block

    +
    availablePrefixes
    Array of strings

    Example prefixes available to acquire

    +
    availableSmallestPrefixes
    integer <int64>

    Total number of /30 prefixes that can still be acquired from this block (only reduced if prefixes are acquired, not reduced by acquired IPs)

    +
    acquiredPrefixes
    integer <int64>

    Total number of prefixes (of any size) acquired from this block

    +
    Array of objects (StatusDetail)

    Chronological status history for the Subnet

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the Subnet was created

    +
    updated
    string <date-time>

    Date/time when the Subnet was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "spark-gpu-subnet",
    • "description": "Subnet for dedicated GPU nodes"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "spark-gpu-subnet",
    • "description": "Subnet for dedicated GPU nodes",
    • "siteId": "ea144def-d68f-44c3-9485-4b103fa2686f",
    • "vpcId": "5e28ad7c-5fb7-46d6-a28a-fc0ba6fdc4a3",
    • "controllerNetworkSegmentId": null,
    • "ipv4Prefix": "212.168.0.250",
    • "ipv4BlockId": "8c1d1a06-90a2-4863-8ee1-6029265b9f0a",
    • "ipv4Gateway": "202.168.0.1",
    • "ipv6Prefix": null,
    • "ipv6BlockId": null,
    • "ipv6Gateway": null,
    • "prefixLength": 20,
    • "routingType": "Public",
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Expected Machine

    Expected Machine identifies a Machine that is expected to be discovered at a Site. Infrastructure Providers can pre-register Expected Machines using BMC credentials and serial numbers to help with Machine discovery and ingestion.

    -

    Create Expected Machine

    Create Expected Machine

    Create an Expected Machine to pre-register Machines expected to be discovered at a Site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create an Expected Machine to pre-register Machines expected to be discovered at a Site.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also create Expected Machines if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    required

    Expected Machine creation request

    -
    siteId
    required
    string <uuid>

    ID of the site the Expected Machine belongs to

    -
    bmcMacAddress
    required
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    defaultBmcUsername
    string or null <= 20 characters

    Username for accessing the Expected Machine's BMC

    -
    defaultBmcPassword
    string or null <= 50 characters

    Password for accessing the Expected Machine's BMC

    -
    chassisSerialNumber
    required
    string [ 1 .. 100 ] characters

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings or null

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU to associate with this Expected Machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean or null

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Machine

    -
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    -
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    -
    id
    string

    Unique identifier for the SKU

    -
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    -
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    -
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    -
    object (SkuComponents)

    Hardware components of this SKU

    -
    Array of objects (SkuCpu)

    CPU components

    -
    Array of objects (SkuGpu)

    GPU components

    -
    Array of objects (SkuMemory)

    Memory components

    -
    Array of objects (SkuStorage)

    Storage components

    -
    object (SkuChassis)

    Chassis component

    -
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    -
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    -
    Array of objects (SkuTpm)

    TPM components

    -
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    -
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    -
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    -
    id
    string

    Unique ID of Machine

    -
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    -
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    -
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    -
    vendor
    string or null

    Name of the vendor of the Machine

    -
    productName
    string or null

    Product name of the Machine

    -
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    -
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "defaultBmcUsername": "admin",
    • "defaultBmcPassword": "password123",
    • "chassisSerialNumber": "CHASSIS-12345",
    • "fallbackDPUSerialNumbers": [
      ],
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "chassisSerialNumber": "CHASSIS-12345",
    • "fallbackDPUSerialNumbers": [
      ],
    • "skuId": "lenovo.sr650v2.cpu.1",
    • "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
    • "rackId": "rack-01",
    • "isDpfEnabled": true,
    • "manufacturer": "Lenovo",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all Expected Machines

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    required

    Expected Machine creation request

    +
    siteId
    required
    string <uuid>

    ID of the site the Expected Machine belongs to

    +
    bmcMacAddress
    required
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    defaultBmcUsername
    string or null <= 20 characters

    Username for accessing the Expected Machine's BMC

    +
    defaultBmcPassword
    string or null <= 50 characters

    Password for accessing the Expected Machine's BMC

    +
    chassisSerialNumber
    required
    string [ 1 .. 100 ] characters

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings or null

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU to associate with this Expected Machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean or null

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Machine

    +
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    +
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    +
    id
    string

    Unique identifier for the SKU

    +
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    +
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    +
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    +
    object (SkuComponents)

    Hardware components of this SKU

    +
    Array of objects (SkuCpu)

    CPU components

    +
    Array of objects (SkuGpu)

    GPU components

    +
    Array of objects (SkuMemory)

    Memory components

    +
    Array of objects (SkuStorage)

    Storage components

    +
    object (SkuChassis)

    Chassis component

    +
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    +
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    +
    Array of objects (SkuTpm)

    TPM components

    +
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    +
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    +
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    +
    id
    string

    Unique ID of Machine

    +
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    +
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    +
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    +
    vendor
    string or null

    Name of the vendor of the Machine

    +
    productName
    string or null

    Product name of the Machine

    +
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    +
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "defaultBmcUsername": "admin",
    • "defaultBmcPassword": "password123",
    • "chassisSerialNumber": "CHASSIS-12345",
    • "fallbackDPUSerialNumbers": [
      ],
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "chassisSerialNumber": "CHASSIS-12345",
    • "fallbackDPUSerialNumbers": [
      ],
    • "skuId": "lenovo.sr650v2.cpu.1",
    • "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
    • "rackId": "rack-01",
    • "isDpfEnabled": true,
    • "manufacturer": "Lenovo",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all Expected Machines

    Retrieve all Expected Machines.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all Expected Machines.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Machines if they have an account with the Site's Infrastructure Provider (siteId query parameter is required for Tenants).

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string <uuid>

    ID of the Site to filter Expected Machines by

    -
    includeRelation
    string
    Enum: "Site" "Sku"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "BMC_MAC_ADDRESS_ASC" "BMC_MAC_ADDRESS_DESC" "CHASSIS_SERIAL_NUMBER_ASC" "CHASSIS_SERIAL_NUMBER_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Machine

    -
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    -
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    -
    id
    string

    Unique identifier for the SKU

    -
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    -
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    -
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    -
    object (SkuComponents)

    Hardware components of this SKU

    -
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    -
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    -
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    -
    id
    string

    Unique ID of Machine

    -
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    -
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    -
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    -
    vendor
    string or null

    Name of the vendor of the Machine

    -
    productName
    string or null

    Product name of the Machine

    -
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    -
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieve Expected Machine

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    string <uuid>

    ID of the Site to filter Expected Machines by

    +
    includeRelation
    string
    Enum: "Site" "Sku"

    Related entity to expand

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "BMC_MAC_ADDRESS_ASC" "BMC_MAC_ADDRESS_DESC" "CHASSIS_SERIAL_NUMBER_ASC" "CHASSIS_SERIAL_NUMBER_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Machine

    +
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    +
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    +
    id
    string

    Unique identifier for the SKU

    +
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    +
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    +
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    +
    object (SkuComponents)

    Hardware components of this SKU

    +
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    +
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    +
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    +
    id
    string

    Unique ID of Machine

    +
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    +
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    +
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    +
    vendor
    string or null

    Name of the vendor of the Machine

    +
    productName
    string or null

    Product name of the Machine

    +
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    +
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieve Expected Machine

    Retrieve a specific Expected Machine by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific Expected Machine by ID.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Machines if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    expectedMachineId
    required
    string

    ID of the Expected Machine

    -
    query Parameters
    includeRelation
    string
    Enum: "Site" "Sku"

    Related entity to expand

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Machine

    -
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    -
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    -
    id
    string

    Unique identifier for the SKU

    -
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    -
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    -
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    -
    object (SkuComponents)

    Hardware components of this SKU

    -
    Array of objects (SkuCpu)

    CPU components

    -
    Array of objects (SkuGpu)

    GPU components

    -
    Array of objects (SkuMemory)

    Memory components

    -
    Array of objects (SkuStorage)

    Storage components

    -
    object (SkuChassis)

    Chassis component

    -
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    -
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    -
    Array of objects (SkuTpm)

    TPM components

    -
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    -
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    -
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    -
    id
    string

    Unique ID of Machine

    -
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    -
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    -
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    -
    vendor
    string or null

    Name of the vendor of the Machine

    -
    productName
    string or null

    Product name of the Machine

    -
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    -
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "chassisSerialNumber": "CHASSIS-12345",
    • "fallbackDPUSerialNumbers": [
      ],
    • "skuId": "lenovo.sr650v2.cpu.1",
    • "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
    • "rackId": "rack-01",
    • "isDpfEnabled": true,
    • "manufacturer": "Lenovo",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Expected Machine

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    expectedMachineId
    required
    string

    ID of the Expected Machine

    +
    query Parameters
    includeRelation
    string
    Enum: "Site" "Sku"

    Related entity to expand

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Machine

    +
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    +
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    +
    id
    string

    Unique identifier for the SKU

    +
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    +
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    +
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    +
    object (SkuComponents)

    Hardware components of this SKU

    +
    Array of objects (SkuCpu)

    CPU components

    +
    Array of objects (SkuGpu)

    GPU components

    +
    Array of objects (SkuMemory)

    Memory components

    +
    Array of objects (SkuStorage)

    Storage components

    +
    object (SkuChassis)

    Chassis component

    +
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    +
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    +
    Array of objects (SkuTpm)

    TPM components

    +
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    +
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    +
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    +
    id
    string

    Unique ID of Machine

    +
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    +
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    +
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    +
    vendor
    string or null

    Name of the vendor of the Machine

    +
    productName
    string or null

    Product name of the Machine

    +
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    +
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "chassisSerialNumber": "CHASSIS-12345",
    • "fallbackDPUSerialNumbers": [
      ],
    • "skuId": "lenovo.sr650v2.cpu.1",
    • "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
    • "rackId": "rack-01",
    • "isDpfEnabled": true,
    • "manufacturer": "Lenovo",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Expected Machine

    Update an existing Expected Machine by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing Expected Machine by ID.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Machine.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also update Expected Machines if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    expectedMachineId
    required
    string

    ID of the Expected Machine

    -
    Request Body schema: application/json
    required

    Expected Machine update request

    -
    id
    string or null <uuid>
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    expectedMachineId
    required
    string

    ID of the Expected Machine

    +
    Request Body schema: application/json
    required

    Expected Machine update request

    +
    id
    string or null <uuid>

    ID of the Expected Machine to update.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    ID of the Expected Machine to update.

    Optional for individual Expected Machine update (ignored if provided, ID from URL path is used).

    Required for batch update operations.

    -
    bmcMacAddress
    string or null^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    defaultBmcUsername
    string or null <= 20 characters

    Username for accessing the Expected Machine's BMC

    -
    defaultBmcPassword
    string or null <= 50 characters

    Password for accessing the Expected Machine's BMC

    -
    chassisSerialNumber
    string or null [ 1 .. 100 ] characters

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings or null

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU to associate with this Expected Machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean or null

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Machine

    -
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    -
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    -
    id
    string

    Unique identifier for the SKU

    -
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    -
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    -
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    -
    object (SkuComponents)

    Hardware components of this SKU

    -
    Array of objects (SkuCpu)

    CPU components

    -
    Array of objects (SkuGpu)

    GPU components

    -
    Array of objects (SkuMemory)

    Memory components

    -
    Array of objects (SkuStorage)

    Storage components

    -
    object (SkuChassis)

    Chassis component

    -
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    -
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    -
    Array of objects (SkuTpm)

    TPM components

    -
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    -
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    -
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    -
    id
    string

    Unique ID of Machine

    -
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    -
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    -
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    -
    vendor
    string or null

    Name of the vendor of the Machine

    -
    productName
    string or null

    Product name of the Machine

    -
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    -
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "defaultBmcUsername": "newadmin",
    • "defaultBmcPassword": "newpassword123",
    • "chassisSerialNumber": "CHASSIS-54321",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "chassisSerialNumber": "CHASSIS-12345",
    • "fallbackDPUSerialNumbers": [
      ],
    • "skuId": "lenovo.sr650v2.cpu.1",
    • "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
    • "rackId": "rack-01",
    • "isDpfEnabled": true,
    • "manufacturer": "Lenovo",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Expected Machine

    		bmcMacAddress
    string or null^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    defaultBmcUsername
    string or null <= 20 characters

    Username for accessing the Expected Machine's BMC

    +
    defaultBmcPassword
    string or null <= 50 characters

    Password for accessing the Expected Machine's BMC

    +
    chassisSerialNumber
    string or null [ 1 .. 100 ] characters

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings or null

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU to associate with this Expected Machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean or null

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Machine

    +
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    +
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    +
    id
    string

    Unique identifier for the SKU

    +
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    +
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    +
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    +
    object (SkuComponents)

    Hardware components of this SKU

    +
    Array of objects (SkuCpu)

    CPU components

    +
    Array of objects (SkuGpu)

    GPU components

    +
    Array of objects (SkuMemory)

    Memory components

    +
    Array of objects (SkuStorage)

    Storage components

    +
    object (SkuChassis)

    Chassis component

    +
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    +
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    +
    Array of objects (SkuTpm)

    TPM components

    +
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    +
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    +
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    +
    id
    string

    Unique ID of Machine

    +
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    +
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    +
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    +
    vendor
    string or null

    Name of the vendor of the Machine

    +
    productName
    string or null

    Product name of the Machine

    +
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    +
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "defaultBmcUsername": "newadmin",
    • "defaultBmcPassword": "newpassword123",
    • "chassisSerialNumber": "CHASSIS-54321",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "chassisSerialNumber": "CHASSIS-12345",
    • "fallbackDPUSerialNumbers": [
      ],
    • "skuId": "lenovo.sr650v2.cpu.1",
    • "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
    • "rackId": "rack-01",
    • "isDpfEnabled": true,
    • "manufacturer": "Lenovo",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Expected Machine

    Delete an existing Expected Machine by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete an existing Expected Machine by ID.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Machine.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also delete Expected Machines if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    expectedMachineId
    required
    string

    ID of the Expected Machine

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    Batch Create Expected Machines

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    expectedMachineId
    required
    string

    ID of the Expected Machine

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    Batch Create Expected Machines

    Create multiple Expected Machines in a single request. All machines must belong to the same site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create multiple Expected Machines in a single request. All machines must belong to the same site.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also create Expected Machines if they have an account with the Site's Infrastructure Provider.

    Maximum batch size: 100 Expected Machines per request.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    required

    Array of Expected Machine creation requests

    -
    Array ([ 1 .. 100 ] items)
    siteId
    required
    string <uuid>

    ID of the site the Expected Machine belongs to

    -
    bmcMacAddress
    required
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    defaultBmcUsername
    string or null <= 20 characters

    Username for accessing the Expected Machine's BMC

    -
    defaultBmcPassword
    string or null <= 50 characters

    Password for accessing the Expected Machine's BMC

    -
    chassisSerialNumber
    required
    string [ 1 .. 100 ] characters

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings or null

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU to associate with this Expected Machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean or null

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -

    Responses

    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Machine

    -
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    -
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    -
    id
    string

    Unique identifier for the SKU

    -
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    -
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    -
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    -
    object (SkuComponents)

    Hardware components of this SKU

    -
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    -
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    -
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    -
    id
    string

    Unique ID of Machine

    -
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    -
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    -
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    -
    vendor
    string or null

    Name of the vendor of the Machine

    -
    productName
    string or null

    Product name of the Machine

    -
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    -
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    -

    Request samples

    Content type
    application/json
    [
    • {
      },
    • {
      }
    ]

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Batch Update Expected Machines

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    required

    Array of Expected Machine creation requests

    +
    Array ([ 1 .. 100 ] items)
    siteId
    required
    string <uuid>

    ID of the site the Expected Machine belongs to

    +
    bmcMacAddress
    required
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    defaultBmcUsername
    string or null <= 20 characters

    Username for accessing the Expected Machine's BMC

    +
    defaultBmcPassword
    string or null <= 50 characters

    Password for accessing the Expected Machine's BMC

    +
    chassisSerialNumber
    required
    string [ 1 .. 100 ] characters

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings or null

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU to associate with this Expected Machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean or null

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +

    Responses

    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Machine

    +
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    +
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    +
    id
    string

    Unique identifier for the SKU

    +
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    +
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    +
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    +
    object (SkuComponents)

    Hardware components of this SKU

    +
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    +
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    +
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    +
    id
    string

    Unique ID of Machine

    +
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    +
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    +
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    +
    vendor
    string or null

    Name of the vendor of the Machine

    +
    productName
    string or null

    Product name of the Machine

    +
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    +
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    +

    Request samples

    Content type
    application/json
    [
    • {
      },
    • {
      }
    ]

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Batch Update Expected Machines

    Update multiple Expected Machines in a single request. All machines must belong to the same site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update multiple Expected Machines in a single request. All machines must belong to the same site.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Machines.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also update Expected Machines if they have an account with the Site's Infrastructure Provider.

    Maximum batch size: 100 Expected Machines per request.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    required

    Array of Expected Machine update requests

    -
    Array ([ 1 .. 100 ] items)
    id
    string or null <uuid>
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    required

    Array of Expected Machine update requests

    +
    Array ([ 1 .. 100 ] items)
    id
    string or null <uuid>

    ID of the Expected Machine to update.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH bAoMjv">

    ID of the Expected Machine to update.

    Optional for individual Expected Machine update (ignored if provided, ID from URL path is used).

    Required for batch update operations.

    -
    bmcMacAddress
    string or null^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    defaultBmcUsername
    string or null <= 20 characters

    Username for accessing the Expected Machine's BMC

    -
    defaultBmcPassword
    string or null <= 50 characters

    Password for accessing the Expected Machine's BMC

    -
    chassisSerialNumber
    string or null [ 1 .. 100 ] characters

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings or null

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU to associate with this Expected Machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean or null

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -

    Responses

    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Machine

    -
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    -
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    -
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    -
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    -
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    -
    id
    string

    Unique identifier for the SKU

    -
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    -
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    -
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    -
    object (SkuComponents)

    Hardware components of this SKU

    -
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    -
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    -
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    -
    id
    string

    Unique ID of Machine

    -
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    -
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    -
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    -
    vendor
    string or null

    Name of the vendor of the Machine

    -
    productName
    string or null

    Product name of the Machine

    -
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    -
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    -
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    -
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    -
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    -

    Request samples

    Content type
    application/json
    [
    • {
      },
    • {
      }
    ]

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Expected Power Shelf

    		bmcMacAddress
    string or null^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    defaultBmcUsername
    string or null <= 20 characters

    Username for accessing the Expected Machine's BMC

    +
    defaultBmcPassword
    string or null <= 50 characters

    Password for accessing the Expected Machine's BMC

    +
    chassisSerialNumber
    string or null [ 1 .. 100 ] characters

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings or null

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU to associate with this Expected Machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean or null

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +

    Responses

    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Machine

    +
    siteId
    string <uuid>

    ID of the site the Expected Machine belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Machine's BMC (Baseboard Management Controller)

    +
    chassisSerialNumber
    string

    Serial number of the Expected Machine's chassis

    +
    fallbackDPUSerialNumbers
    Array of strings

    Serial numbers of the Expected Machine's fallback DPUs (Data Processing Units)

    +
    skuId
    string or null

    Optional ID of the SKU associated with this Expected Machine

    +
    object (Sku)

    SKU information for this Expected Machine (populated when includeRelation=Sku is specified)

    +
    id
    string

    Unique identifier for the SKU

    +
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    +
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    +
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    +
    object (SkuComponents)

    Hardware components of this SKU

    +
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    +
    machineId
    string or null

    Optional ID of the Machine associated with this Expected Machine

    +
    object (MachineSummary)

    Machine information for this Expected Machine (populated when includeRelation=Machine is specified)

    +
    id
    string

    Unique ID of Machine

    +
    controllerMachineId
    string

    ID of the Machine at Site, now same as the primary ID

    +
    controllerMachineType
    string or null

    Denotes architecture (x86 vs ARM) of the Machine

    +
    hwSkuDeviceType
    string or null

    SKU derived device type of the machine, e.g. cpu, gpu, cache, storage, etc.

    +
    vendor
    string or null

    Name of the vendor of the Machine

    +
    productName
    string or null

    Product name of the Machine

    +
    maintenanceMessage
    string or null

    If the Machine is in maintenance mode, this message will typically describe the reason and how long it is expected to be in maintenance

    +
    status
    string (MachineStatus)
    Enum: "Initializing" "Ready" "Reset" "Maintenance" "InUse" "Error" "Decommissioned" "Unknown"

    Status represents the status of the machine

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    isDpfEnabled
    boolean

    When true, this host is eligible for DPF-based provisioning.

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Machines

    +
    property name*
    additional property
    string
    object (HostLifecycleProfile)

    Optional per-host lifecycle profile

    +
    disableLockdown
    boolean or null

    When true, the server is not locked down during host lifecycle management. When omitted, the existing value is preserved.

    +
    created
    string <date-time>

    ISO 8601 datetime when the Expected Machine was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Machine was last updated

    +

    Request samples

    Content type
    application/json
    [
    • {
      },
    • {
      }
    ]

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Expected Power Shelf

    Expected Power Shelf identifies a Power Shelf that is expected to be discovered at a Site. Infrastructure Providers can pre-register Expected Power Shelves using BMC credentials and serial numbers to help with Power Shelf discovery and ingestion.

    -

    Create Expected Power Shelf

    Create Expected Power Shelf

    Create an Expected Power Shelf to pre-register power shelves expected to be discovered at a Site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create an Expected Power Shelf to pre-register power shelves expected to be discovered at a Site.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also create Expected Power Shelves if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    required

    Expected Power Shelf creation request

    -
    siteId
    required
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    -
    bmcMacAddress
    required
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    -
    defaultBmcUsername
    string or null <= 16 characters

    Username for accessing the Expected Power Shelf's BMC

    -
    defaultBmcPassword
    string or null <= 20 characters

    Password for accessing the Expected Power Shelf's BMC

    -
    shelfSerialNumber
    required
    string [ 1 .. 32 ] characters

    Serial number of the Expected Power Shelf

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Power Shelf

    -
    siteId
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    -
    shelfSerialNumber
    string

    Serial number of the Expected Power Shelf

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "defaultBmcUsername": "admin",
    • "defaultBmcPassword": "password123",
    • "shelfSerialNumber": "SHELF-12345",
    • "bmcIpAddress": "192.168.1.100",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "shelfSerialNumber": "SHELF-12345",
    • "bmcIpAddress": "192.168.1.100",
    • "rackId": "rack-01",
    • "manufacturer": "Delta",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all Expected Power Shelves

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    required

    Expected Power Shelf creation request

    +
    siteId
    required
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    +
    bmcMacAddress
    required
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    +
    defaultBmcUsername
    string or null <= 16 characters

    Username for accessing the Expected Power Shelf's BMC

    +
    defaultBmcPassword
    string or null <= 20 characters

    Password for accessing the Expected Power Shelf's BMC

    +
    shelfSerialNumber
    required
    string [ 1 .. 32 ] characters

    Serial number of the Expected Power Shelf

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Power Shelf

    +
    siteId
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    +
    shelfSerialNumber
    string

    Serial number of the Expected Power Shelf

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "defaultBmcUsername": "admin",
    • "defaultBmcPassword": "password123",
    • "shelfSerialNumber": "SHELF-12345",
    • "bmcIpAddress": "192.168.1.100",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "shelfSerialNumber": "SHELF-12345",
    • "bmcIpAddress": "192.168.1.100",
    • "rackId": "rack-01",
    • "manufacturer": "Delta",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all Expected Power Shelves

    Retrieve all Expected Power Shelves.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all Expected Power Shelves.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Power Shelves if they have an account with the Site's Infrastructure Provider (siteId query parameter is required for Tenants).

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string <uuid>

    ID of the Site to filter Expected Power Shelves by

    -
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "BMC_MAC_ADDRESS_ASC" "BMC_MAC_ADDRESS_DESC" "SHELF_SERIAL_NUMBER_ASC" "SHELF_SERIAL_NUMBER_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Power Shelf

    -
    siteId
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    -
    shelfSerialNumber
    string

    Serial number of the Expected Power Shelf

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieve Expected Power Shelf

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    string <uuid>

    ID of the Site to filter Expected Power Shelves by

    +
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "BMC_MAC_ADDRESS_ASC" "BMC_MAC_ADDRESS_DESC" "SHELF_SERIAL_NUMBER_ASC" "SHELF_SERIAL_NUMBER_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Power Shelf

    +
    siteId
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    +
    shelfSerialNumber
    string

    Serial number of the Expected Power Shelf

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieve Expected Power Shelf

    Retrieve a specific Expected Power Shelf by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific Expected Power Shelf by ID.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Power Shelves if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    expectedPowerShelfId
    required
    string

    ID of the Expected Power Shelf

    -
    query Parameters
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Power Shelf

    -
    siteId
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    -
    shelfSerialNumber
    string

    Serial number of the Expected Power Shelf

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "shelfSerialNumber": "SHELF-12345",
    • "bmcIpAddress": "192.168.1.100",
    • "rackId": "rack-01",
    • "manufacturer": "Delta",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Expected Power Shelf

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    expectedPowerShelfId
    required
    string

    ID of the Expected Power Shelf

    +
    query Parameters
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Power Shelf

    +
    siteId
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    +
    shelfSerialNumber
    string

    Serial number of the Expected Power Shelf

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "shelfSerialNumber": "SHELF-12345",
    • "bmcIpAddress": "192.168.1.100",
    • "rackId": "rack-01",
    • "manufacturer": "Delta",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Expected Power Shelf

    Update an existing Expected Power Shelf by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing Expected Power Shelf by ID.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Power Shelf.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also update Expected Power Shelves if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    expectedPowerShelfId
    required
    string

    ID of the Expected Power Shelf

    -
    Request Body schema: application/json
    required

    Expected Power Shelf update request

    -
    id
    string or null <uuid>

    ID of the Expected Power Shelf to update (ignored for single update, used for identification in batch operations).

    -
    bmcMacAddress
    string or null^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    -
    defaultBmcUsername
    string or null <= 16 characters

    Username for accessing the Expected Power Shelf's BMC

    -
    defaultBmcPassword
    string or null <= 20 characters

    Password for accessing the Expected Power Shelf's BMC

    -
    shelfSerialNumber
    string or null [ 1 .. 32 ] characters

    Serial number of the Expected Power Shelf

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Power Shelf

    -
    siteId
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    -
    shelfSerialNumber
    string

    Serial number of the Expected Power Shelf

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "defaultBmcUsername": "newadmin",
    • "defaultBmcPassword": "newpassword123",
    • "shelfSerialNumber": "SHELF-54321",
    • "bmcIpAddress": "192.168.1.200",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "shelfSerialNumber": "SHELF-12345",
    • "bmcIpAddress": "192.168.1.100",
    • "rackId": "rack-01",
    • "manufacturer": "Delta",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Expected Power Shelf

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    expectedPowerShelfId
    required
    string

    ID of the Expected Power Shelf

    +
    Request Body schema: application/json
    required

    Expected Power Shelf update request

    +
    id
    string or null <uuid>

    ID of the Expected Power Shelf to update (ignored for single update, used for identification in batch operations).

    +
    bmcMacAddress
    string or null^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    +
    defaultBmcUsername
    string or null <= 16 characters

    Username for accessing the Expected Power Shelf's BMC

    +
    defaultBmcPassword
    string or null <= 20 characters

    Password for accessing the Expected Power Shelf's BMC

    +
    shelfSerialNumber
    string or null [ 1 .. 32 ] characters

    Serial number of the Expected Power Shelf

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Power Shelf

    +
    siteId
    string <uuid>

    ID of the site the Expected Power Shelf belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Power Shelf's BMC (Baseboard Management Controller)

    +
    shelfSerialNumber
    string

    Serial number of the Expected Power Shelf

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Power Shelves

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Power Shelf was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "defaultBmcUsername": "newadmin",
    • "defaultBmcPassword": "newpassword123",
    • "shelfSerialNumber": "SHELF-54321",
    • "bmcIpAddress": "192.168.1.200",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "shelfSerialNumber": "SHELF-12345",
    • "bmcIpAddress": "192.168.1.100",
    • "rackId": "rack-01",
    • "manufacturer": "Delta",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Expected Power Shelf

    Delete an existing Expected Power Shelf by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete an existing Expected Power Shelf by ID.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Power Shelf.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also delete Expected Power Shelves if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    expectedPowerShelfId
    required
    string

    ID of the Expected Power Shelf

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    Expected Rack

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    expectedPowerShelfId
    required
    string

    ID of the Expected Power Shelf

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    Expected Rack

    Expected Rack identifies a Rack that is expected to be discovered at a Site. Infrastructure Providers can pre-register Expected Racks with an operator-supplied rack identifier and a Rack Profile reference to help with Rack discovery and ingestion. Chassis identity and physical location information are conveyed via well-known label keys (chassis.manufacturer, chassis.serial-number, chassis.model, location.region, location.datacenter, location.room, location.position).

    -

    Create Expected Rack

    Create Expected Rack

    Typical API Call Flow for Tenant <li><code>chassis.manufacturer</code>, <code>chassis.serial-number</code>, <code>chassis.model</code></li> <li><code>location.region</code>, <code>location.datacenter</code>, <code>location.room</code>, <code>location.position</code></li> </ul> -" class="sc-iKGpAq sc-cCYyou dXXcln dHaogz">

    Create an Expected Rack to pre-register a rack expected to be discovered at a Site. The rackId is an operator-supplied string identifier (not a UUID) that uniquely identifies the rack within the Site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create an Expected Rack to pre-register a rack expected to be discovered at a Site. The rackId is an operator-supplied string identifier (not a UUID) that uniquely identifies the rack within the Site.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also create Expected Racks if they have an account with the Site's Infrastructure Provider.

    Chassis identity and physical location information are conveyed via well-known label keys in labels:

    @@ -5084,1111 +5204,1111 @@

    Typical API Call Flow for Tenant

  • chassis.manufacturer, chassis.serial-number, chassis.model
  • location.region, location.datacenter, location.room, location.position
    • -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    required

    Expected Rack creation request

    -
    siteId
    required
    string <uuid>

    ID of the Site the Expected Rack belongs to

    -
    rackId
    required
    string non-empty

    Operator-supplied identifier for the rack (string, not UUID). Must be non-empty and unique within the Site.

    -
    rackProfileId
    required
    string non-empty

    Identifier of the Rack Profile this rack conforms to. Must be non-empty.

    -
    name
    string or null non-empty

    Human-readable name of the Expected Rack

    -
    description
    string or null non-empty

    Human-readable description of the Expected Rack

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    -
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    -
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    -
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    -
    name
    string

    Human-readable name of the Expected Rack

    -
    description
    string

    Human-readable description of the Expected Rack

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "rackId": "rack-01",
    • "rackProfileId": "rp-standard-42u",
    • "name": "Rack 01",
    • "description": "Production rack in row A",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "rackId": "rack-01",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "rackProfileId": "rp-standard-42u",
    • "name": "Rack 01",
    • "description": "Production rack in row A",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all Expected Racks

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    required

    Expected Rack creation request

    +
    siteId
    required
    string <uuid>

    ID of the Site the Expected Rack belongs to

    +
    rackId
    required
    string non-empty

    Operator-supplied identifier for the rack (string, not UUID). Must be non-empty and unique within the Site.

    +
    rackProfileId
    required
    string non-empty

    Identifier of the Rack Profile this rack conforms to. Must be non-empty.

    +
    name
    string or null non-empty

    Human-readable name of the Expected Rack

    +
    description
    string or null non-empty

    Human-readable description of the Expected Rack

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    +
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    +
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    +
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    +
    name
    string

    Human-readable name of the Expected Rack

    +
    description
    string

    Human-readable description of the Expected Rack

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "rackId": "rack-01",
    • "rackProfileId": "rp-standard-42u",
    • "name": "Rack 01",
    • "description": "Production rack in row A",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "rackId": "rack-01",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "rackProfileId": "rp-standard-42u",
    • "name": "Rack 01",
    • "description": "Production rack in row A",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all Expected Racks

    Retrieve all Expected Racks.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all Expected Racks.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Racks if they have an account with the Site's Infrastructure Provider (siteId query parameter is required for Tenants).

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string <uuid>

    ID of the Site to filter Expected Racks by

    -
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "RACK_ID_ASC" "RACK_ID_DESC" "RACK_PROFILE_ID_ASC" "RACK_PROFILE_ID_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    -
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    -
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    -
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    -
    name
    string

    Human-readable name of the Expected Rack

    -
    description
    string

    Human-readable description of the Expected Rack

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Replace all Expected Racks

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    string <uuid>

    ID of the Site to filter Expected Racks by

    +
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "RACK_ID_ASC" "RACK_ID_DESC" "RACK_PROFILE_ID_ASC" "RACK_PROFILE_ID_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    +
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    +
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    +
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    +
    name
    string

    Human-readable name of the Expected Rack

    +
    description
    string

    Human-readable description of the Expected Rack

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Replace all Expected Racks

    Replace the full set of Expected Racks for a Site with the provided list. All existing Expected Racks for the Site that are not in the request body will be deleted, and any new Expected Racks in the request will be created. Existing Expected Racks with matching rackId values will be updated.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Replace the full set of Expected Racks for a Site with the provided list. All existing Expected Racks for the Site that are not in the request body will be deleted, and any new Expected Racks in the request will be created. Existing Expected Racks with matching rackId values will be updated.

    Every entry in expectedRacks must reference the same siteId as the top-level siteId. rackId values must be unique within the request. The expectedRacks array may be empty to clear all Expected Racks for the Site.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also replace Expected Racks if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    required

    Replace-all Expected Racks request

    -
    siteId
    required
    string <uuid>

    ID of the Site whose Expected Racks should be replaced

    -
    required
    Array of objects (ExpectedRackCreateRequest)

    The full desired set of Expected Racks for the Site. Every entry must reference the same siteId as the top-level field, and rackId values must be unique within the request. May be empty to clear all Expected Racks for the Site.

    -
    Array
    siteId
    required
    string <uuid>

    ID of the Site the Expected Rack belongs to

    -
    rackId
    required
    string non-empty

    Operator-supplied identifier for the rack (string, not UUID). Must be non-empty and unique within the Site.

    -
    rackProfileId
    required
    string non-empty

    Identifier of the Rack Profile this rack conforms to. Must be non-empty.

    -
    name
    string or null non-empty

    Human-readable name of the Expected Rack

    -
    description
    string or null non-empty

    Human-readable description of the Expected Rack

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    -

    Responses

    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    -
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    -
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    -
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    -
    name
    string

    Human-readable name of the Expected Rack

    -
    description
    string

    Human-readable description of the Expected Rack

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "expectedRacks": [
      ]
    }

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Delete all Expected Racks

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    required

    Replace-all Expected Racks request

    +
    siteId
    required
    string <uuid>

    ID of the Site whose Expected Racks should be replaced

    +
    required
    Array of objects (ExpectedRackCreateRequest)

    The full desired set of Expected Racks for the Site. Every entry must reference the same siteId as the top-level field, and rackId values must be unique within the request. May be empty to clear all Expected Racks for the Site.

    +
    Array
    siteId
    required
    string <uuid>

    ID of the Site the Expected Rack belongs to

    +
    rackId
    required
    string non-empty

    Operator-supplied identifier for the rack (string, not UUID). Must be non-empty and unique within the Site.

    +
    rackProfileId
    required
    string non-empty

    Identifier of the Rack Profile this rack conforms to. Must be non-empty.

    +
    name
    string or null non-empty

    Human-readable name of the Expected Rack

    +
    description
    string or null non-empty

    Human-readable description of the Expected Rack

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    +

    Responses

    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    +
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    +
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    +
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    +
    name
    string

    Human-readable name of the Expected Rack

    +
    description
    string

    Human-readable description of the Expected Rack

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "expectedRacks": [
      ]
    }

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Delete all Expected Racks

    Delete all Expected Racks for a Site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete all Expected Racks for a Site.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Racks.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also delete Expected Racks if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    required
    string <uuid>

    ID of the Site whose Expected Racks should be deleted

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    Retrieve Expected Rack

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    required
    string <uuid>

    ID of the Site whose Expected Racks should be deleted

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    Retrieve Expected Rack

    Retrieve a specific Expected Rack by its id.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific Expected Rack by its id.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Racks if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    id
    required
    string <uuid>

    ID of the Expected Rack

    -
    query Parameters
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    -
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    -
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    -
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    -
    name
    string

    Human-readable name of the Expected Rack

    -
    description
    string

    Human-readable description of the Expected Rack

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "rackId": "rack-01",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "rackProfileId": "rp-standard-42u",
    • "name": "Rack 01",
    • "description": "Production rack in row A",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Expected Rack

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    id
    required
    string <uuid>

    ID of the Expected Rack

    +
    query Parameters
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    +
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    +
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    +
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    +
    name
    string

    Human-readable name of the Expected Rack

    +
    description
    string

    Human-readable description of the Expected Rack

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "rackId": "rack-01",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "rackProfileId": "rp-standard-42u",
    • "name": "Rack 01",
    • "description": "Production rack in row A",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Expected Rack

    Update an existing Expected Rack identified by its id.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing Expected Rack identified by its id.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Rack.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also update Expected Racks if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    id
    required
    string <uuid>

    ID of the Expected Rack

    -
    Request Body schema: application/json
    required

    Expected Rack update request

    -
    id
    string or null <uuid>

    Unique identifier (UUID) of the Expected Rack to update. Optional for single Expected Rack update (must be empty or match the id from the URL path).

    -
    rackId
    string or null non-empty

    Optional new operator-supplied rack identifier. If provided, must be non-empty and unique within the Site.

    -
    rackProfileId
    string or null non-empty

    Optional new Rack Profile identifier. If provided, must be non-empty.

    -
    name
    string or null non-empty

    Human-readable name of the Expected Rack

    -
    description
    string or null non-empty

    Human-readable description of the Expected Rack

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    -
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    -
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    -
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    -
    name
    string

    Human-readable name of the Expected Rack

    -
    description
    string

    Human-readable description of the Expected Rack

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "rackProfileId": "rp-standard-48u",
    • "name": "Rack 01 (updated)",
    • "description": "Production rack in row A, upgraded chassis",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "rackId": "rack-01",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "rackProfileId": "rp-standard-42u",
    • "name": "Rack 01",
    • "description": "Production rack in row A",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Expected Rack

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    id
    required
    string <uuid>

    ID of the Expected Rack

    +
    Request Body schema: application/json
    required

    Expected Rack update request

    +
    id
    string or null <uuid>

    Unique identifier (UUID) of the Expected Rack to update. Optional for single Expected Rack update (must be empty or match the id from the URL path).

    +
    rackId
    string or null non-empty

    Optional new operator-supplied rack identifier. If provided, must be non-empty and unique within the Site.

    +
    rackProfileId
    string or null non-empty

    Optional new Rack Profile identifier. If provided, must be non-empty.

    +
    name
    string or null non-empty

    Human-readable name of the Expected Rack

    +
    description
    string or null non-empty

    Human-readable description of the Expected Rack

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier (UUID) for the Expected Rack

    +
    rackId
    string

    Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

    +
    siteId
    string <uuid>

    ID of the Site the Expected Rack belongs to

    +
    rackProfileId
    string

    Identifier of the Rack Profile this rack conforms to

    +
    name
    string

    Human-readable name of the Expected Rack

    +
    description
    string

    Human-readable description of the Expected Rack

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Racks. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Rack was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Rack was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "rackProfileId": "rp-standard-48u",
    • "name": "Rack 01 (updated)",
    • "description": "Production rack in row A, upgraded chassis",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "rackId": "rack-01",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "rackProfileId": "rp-standard-42u",
    • "name": "Rack 01",
    • "description": "Production rack in row A",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Expected Rack

    Delete an existing Expected Rack identified by its id.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete an existing Expected Rack identified by its id.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Rack.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also delete Expected Racks if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    id
    required
    string <uuid>

    ID of the Expected Rack

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    Expected Switch

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    id
    required
    string <uuid>

    ID of the Expected Rack

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    Expected Switch

    Expected Switch identifies an NVLink Switch that is expected to be discovered at a Site. Infrastructure Providers can pre-register Expected Switches using BMC, NVOS credentials and serial numbers to help with NVLink Switch discovery and ingestion.

    -

    Create Expected Switch

    Create Expected Switch

    Create an Expected Switch to pre-register network switches expected to be discovered at a Site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create an Expected Switch to pre-register network switches expected to be discovered at a Site.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also create Expected Switches if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    required

    Expected Switch creation request

    -
    siteId
    required
    string <uuid>

    ID of the site the Expected Switch belongs to

    -
    bmcMacAddress
    required
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    -
    defaultBmcUsername
    string or null <= 16 characters

    Username for accessing the Expected Switch's BMC

    -
    defaultBmcPassword
    string or null <= 20 characters

    Password for accessing the Expected Switch's BMC

    -
    switchSerialNumber
    required
    string [ 1 .. 32 ] characters

    Serial number of the Expected Switch

    -
    nvOsUsername
    string or null

    NvOS username for the Expected Switch

    -
    nvOsPassword
    string or null

    NvOS password for the Expected Switch

    -
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Switch

    -
    siteId
    string <uuid>

    ID of the site the Expected Switch belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    -
    switchSerialNumber
    string

    Serial number of the Expected Switch

    -
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Switch was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Switch was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "defaultBmcUsername": "admin",
    • "defaultBmcPassword": "password123",
    • "switchSerialNumber": "SWITCH-12345",
    • "nvOsUsername": "nvadmin",
    • "nvOsPassword": "nvpassword123",
    • "nvosMacAddresses": [
      ],
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "switchSerialNumber": "SWITCH-12345",
    • "nvosMacAddresses": [
      ],
    • "rackId": "rack-01",
    • "manufacturer": "NVIDIA",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all Expected Switches

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    required

    Expected Switch creation request

    +
    siteId
    required
    string <uuid>

    ID of the site the Expected Switch belongs to

    +
    bmcMacAddress
    required
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    +
    defaultBmcUsername
    string or null <= 16 characters

    Username for accessing the Expected Switch's BMC

    +
    defaultBmcPassword
    string or null <= 20 characters

    Password for accessing the Expected Switch's BMC

    +
    switchSerialNumber
    required
    string [ 1 .. 32 ] characters

    Serial number of the Expected Switch

    +
    nvOsUsername
    string or null

    NvOS username for the Expected Switch

    +
    nvOsPassword
    string or null

    NvOS password for the Expected Switch

    +
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Switch

    +
    siteId
    string <uuid>

    ID of the site the Expected Switch belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    +
    switchSerialNumber
    string

    Serial number of the Expected Switch

    +
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Switch was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Switch was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "defaultBmcUsername": "admin",
    • "defaultBmcPassword": "password123",
    • "switchSerialNumber": "SWITCH-12345",
    • "nvOsUsername": "nvadmin",
    • "nvOsPassword": "nvpassword123",
    • "nvosMacAddresses": [
      ],
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "switchSerialNumber": "SWITCH-12345",
    • "nvosMacAddresses": [
      ],
    • "rackId": "rack-01",
    • "manufacturer": "NVIDIA",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all Expected Switches

    Retrieve all Expected Switches.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all Expected Switches.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Switches if they have an account with the Site's Infrastructure Provider (siteId query parameter is required for Tenants).

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string <uuid>

    ID of the Site to filter Expected Switches by

    -
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "BMC_MAC_ADDRESS_ASC" "BMC_MAC_ADDRESS_DESC" "SWITCH_SERIAL_NUMBER_ASC" "SWITCH_SERIAL_NUMBER_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Switch

    -
    siteId
    string <uuid>

    ID of the site the Expected Switch belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    -
    switchSerialNumber
    string

    Serial number of the Expected Switch

    -
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Switch was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Switch was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieve Expected Switch

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    string <uuid>

    ID of the Site to filter Expected Switches by

    +
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "BMC_MAC_ADDRESS_ASC" "BMC_MAC_ADDRESS_DESC" "SWITCH_SERIAL_NUMBER_ASC" "SWITCH_SERIAL_NUMBER_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique identifier for the Expected Switch

    +
    siteId
    string <uuid>

    ID of the site the Expected Switch belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    +
    switchSerialNumber
    string

    Serial number of the Expected Switch

    +
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Switch was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Switch was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieve Expected Switch

    Retrieve a specific Expected Switch by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific Expected Switch by ID.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Switches if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    expectedSwitchId
    required
    string

    ID of the Expected Switch

    -
    query Parameters
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Switch

    -
    siteId
    string <uuid>

    ID of the site the Expected Switch belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    -
    switchSerialNumber
    string

    Serial number of the Expected Switch

    -
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Switch was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Switch was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "switchSerialNumber": "SWITCH-12345",
    • "nvosMacAddresses": [
      ],
    • "rackId": "rack-01",
    • "manufacturer": "NVIDIA",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Expected Switch

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    expectedSwitchId
    required
    string

    ID of the Expected Switch

    +
    query Parameters
    includeRelation
    string
    Value: "Site"

    Related entity to expand

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Switch

    +
    siteId
    string <uuid>

    ID of the site the Expected Switch belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    +
    switchSerialNumber
    string

    Serial number of the Expected Switch

    +
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Switch was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Switch was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "switchSerialNumber": "SWITCH-12345",
    • "nvosMacAddresses": [
      ],
    • "rackId": "rack-01",
    • "manufacturer": "NVIDIA",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Update Expected Switch

    Update an existing Expected Switch by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing Expected Switch by ID.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Switch.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also update Expected Switches if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    expectedSwitchId
    required
    string

    ID of the Expected Switch

    -
    Request Body schema: application/json
    required

    Expected Switch update request

    -
    id
    string or null <uuid>

    ID of the Expected Switch to update (ignored for single update, used for identification in batch operations).

    -
    bmcMacAddress
    string or null^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    -
    defaultBmcUsername
    string or null <= 16 characters

    Username for accessing the Expected Switch's BMC

    -
    defaultBmcPassword
    string or null <= 20 characters

    Password for accessing the Expected Switch's BMC

    -
    switchSerialNumber
    string or null [ 1 .. 32 ] characters

    Serial number of the Expected Switch

    -
    nvOsUsername
    string or null

    NvOS username for the Expected Switch

    -
    nvOsPassword
    string or null

    NvOS password for the Expected Switch

    -
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Switch

    -
    siteId
    string <uuid>

    ID of the site the Expected Switch belongs to

    -
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    -
    switchSerialNumber
    string

    Serial number of the Expected Switch

    -
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    -
    rackId
    string or null

    Optional rack identifier for this component

    -
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    -
    name
    string or null

    Display name for this component

    -
    manufacturer
    string or null

    Manufacturer of this component

    -
    model
    string or null

    Model of this component

    -
    description
    string or null

    Description of this component

    -
    slotId
    integer or null <int32>

    Slot ID within the rack

    -
    trayIdx
    integer or null <int32>

    Tray index within the rack

    -
    hostId
    integer or null <int32>

    Host ID within the tray

    -
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    -
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Switch was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Switch was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "defaultBmcUsername": "newadmin",
    • "defaultBmcPassword": "newpassword123",
    • "switchSerialNumber": "SWITCH-54321",
    • "nvOsUsername": "newnvadmin",
    • "nvOsPassword": "newnvpassword123",
    • "nvosMacAddresses": [
      ],
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "switchSerialNumber": "SWITCH-12345",
    • "nvosMacAddresses": [
      ],
    • "rackId": "rack-01",
    • "manufacturer": "NVIDIA",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Expected Switch

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    expectedSwitchId
    required
    string

    ID of the Expected Switch

    +
    Request Body schema: application/json
    required

    Expected Switch update request

    +
    id
    string or null <uuid>

    ID of the Expected Switch to update (ignored for single update, used for identification in batch operations).

    +
    bmcMacAddress
    string or null^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    +
    defaultBmcUsername
    string or null <= 16 characters

    Username for accessing the Expected Switch's BMC

    +
    defaultBmcPassword
    string or null <= 20 characters

    Password for accessing the Expected Switch's BMC

    +
    switchSerialNumber
    string or null [ 1 .. 32 ] characters

    Serial number of the Expected Switch

    +
    nvOsUsername
    string or null

    NvOS username for the Expected Switch

    +
    nvOsPassword
    string or null

    NvOS password for the Expected Switch

    +
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique identifier for the Expected Switch

    +
    siteId
    string <uuid>

    ID of the site the Expected Switch belongs to

    +
    bmcMacAddress
    string^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

    MAC address of the Expected Switch's BMC (Baseboard Management Controller)

    +
    switchSerialNumber
    string

    Serial number of the Expected Switch

    +
    nvosMacAddresses
    Array of strings unique [ items^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ ]

    MAC addresses of the Expected Switch's NvOS management interfaces

    +
    rackId
    string or null

    Optional rack identifier for this component

    +
    bmcIpAddress
    string or null

    Optional BMC IP address (IPv4 or IPv6). When set, pre-allocates a reserved IP for the BMC.

    +
    name
    string or null

    Display name for this component

    +
    manufacturer
    string or null

    Manufacturer of this component

    +
    model
    string or null

    Model of this component

    +
    description
    string or null

    Description of this component

    +
    slotId
    integer or null <int32>

    Slot ID within the rack

    +
    trayIdx
    integer or null <int32>

    Tray index within the rack

    +
    hostId
    integer or null <int32>

    Host ID within the tray

    +
    object (Labels) <= 10 properties

    User-defined key-value pairs for organizing and categorizing Expected Switches

    +
    property name*
    additional property
    string
    created
    string <date-time>

    ISO 8601 datetime when the Expected Switch was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the Expected Switch was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "defaultBmcUsername": "newadmin",
    • "defaultBmcPassword": "newpassword123",
    • "switchSerialNumber": "SWITCH-54321",
    • "nvOsUsername": "newnvadmin",
    • "nvOsPassword": "newnvpassword123",
    • "nvosMacAddresses": [
      ],
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "bmcMacAddress": "00:1A:2B:3C:4D:5E",
    • "bmcIpAddress": "192.168.1.100",
    • "switchSerialNumber": "SWITCH-12345",
    • "nvosMacAddresses": [
      ],
    • "rackId": "rack-01",
    • "manufacturer": "NVIDIA",
    • "labels": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete Expected Switch

    Delete an existing Expected Switch by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete an existing Expected Switch by ID.

    Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

    Infrastructure Provider must own the Expected Switch.

    Alternatively, Tenant Admins with TargetedInstanceCreation capability can also delete Expected Switches if they have an account with the Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    expectedSwitchId
    required
    string

    ID of the Expected Switch

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    SKU

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    expectedSwitchId
    required
    string

    ID of the Expected Switch

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "source": "nico",
    • "message": "Error validating request data",
    • "data": {
      }
    }

    SKU

    SKU (Stock Keeping Unit) defines one or more hardware configurations or Machine Bill of Materials (BOM).

    SKUs are automatically derived from machine hardware characteristics and used to group similar machines. SKUs are read-only and managed by the system.

    -

    Retrieve all SKUs

    Retrieve all SKUs

    Retrieve all SKUs (Stock Keeping Units) for a Site.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all SKUs (Stock Keeping Units) for a Site.

    SKUs represent unique hardware configurations discovered at sites. They are automatically derived from machine characteristics.

    A siteId query parameter is required for all requests.

    For Infrastructure Providers: Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with PROVIDER_ADMIN suffix.

    For Tenants: Org must have a Tenant with TargetedInstanceCreation capability enabled and Tenant Account with Machine's Provider. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    required
    string <uuid>

    ID of the Site to retrieve SKUs from

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC" "ID_ASC" "ID_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string

    Unique identifier for the SKU

    -
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    -
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    -
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    -
    object (SkuComponents)

    Hardware components of this SKU

    -
    Array of objects (SkuCpu)

    CPU components

    -
    Array of objects (SkuGpu)

    GPU components

    -
    Array of objects (SkuMemory)

    Memory components

    -
    Array of objects (SkuStorage)

    Storage components

    -
    object (SkuChassis)

    Chassis component

    -
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    -
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    -
    Array of objects (SkuTpm)

    TPM components

    -
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieve SKU

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    required
    string <uuid>

    ID of the Site to retrieve SKUs from

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC" "ID_ASC" "ID_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string

    Unique identifier for the SKU

    +
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    +
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    +
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    +
    object (SkuComponents)

    Hardware components of this SKU

    +
    Array of objects (SkuCpu)

    CPU components

    +
    Array of objects (SkuGpu)

    GPU components

    +
    Array of objects (SkuMemory)

    Memory components

    +
    Array of objects (SkuStorage)

    Storage components

    +
    object (SkuChassis)

    Chassis component

    +
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    +
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    +
    Array of objects (SkuTpm)

    TPM components

    +
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Retrieve SKU

    Retrieve a specific SKU (Stock Keeping Unit) by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific SKU (Stock Keeping Unit) by ID.

    SKUs represent unique hardware configurations discovered at sites. They are automatically derived from machine characteristics.

    For Infrastructure Providers: Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

    For Tenants: Org must have a Tenant with TargetedInstanceCreation capability enabled. User must have authorization role with TENANT_ADMIN suffix. The Tenant must have an account with the SKU's Site's Infrastructure Provider.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    skuId
    required
    string

    ID of the SKU

    -

    Responses

    Response Schema: application/json
    id
    string

    Unique identifier for the SKU

    -
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    -
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    -
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    -
    object (SkuComponents)

    Hardware components of this SKU

    -
    Array of objects (SkuCpu)

    CPU components

    -
    Array
    vendor
    string

    Vendor of the CPU

    -
    model
    string

    Model of the CPU

    -
    threadCount
    integer <uint32>

    Number of threads for the CPU

    -
    count
    integer <uint32>

    Number of CPUs present

    -
    Array of objects (SkuGpu)

    GPU components

    -
    Array
    vendor
    string

    Vendor of the GPU

    -
    model
    string

    Model of the GPU

    -
    totalMemory
    string

    Total memory of the GPU (e.g. "80GB HBM3")

    -
    count
    integer <uint32>

    Number of GPUs present

    -
    Array of objects (SkuMemory)

    Memory components

    -
    Array
    capacityMb
    integer <uint32>

    Capacity in megabytes

    -
    memoryType
    string

    Type of memory (e.g. "DDR4", "DDR5")

    -
    count
    integer <uint32>

    Number of memory modules present

    -
    Array of objects (SkuStorage)

    Storage components

    -
    Array
    vendor
    string

    Vendor of the storage device

    -
    model
    string

    Model of the storage device

    -
    capacityMb
    integer <uint32>

    Capacity in megabytes

    -
    count
    integer <uint32>

    Number of storage devices present

    -
    object (SkuChassis)

    Chassis component

    -
    vendor
    string

    Vendor of the chassis

    -
    model
    string

    Model of the chassis

    -
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    -
    Array
    vendor
    string

    Vendor of the ethernet device

    -
    model
    string

    Model of the ethernet device

    -
    count
    integer <uint32>

    Number of ethernet devices present

    -
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    -
    Array
    vendor
    string

    Vendor of the infiniband device

    -
    model
    string

    Model of the infiniband device

    -
    count
    integer <uint32>

    Number of infiniband devices present

    -
    Array of objects (SkuTpm)

    TPM components

    -
    Array
    vendor
    string

    Vendor of the TPM

    -
    version
    string

    Version of the TPM

    -
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    -
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "lenovo.sr650v2.cpu.1",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "deviceType": "gpu",
    • "associatedMachineIds": [
      ],
    • "components": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    InfiniBand Partition

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    skuId
    required
    string

    ID of the SKU

    +

    Responses

    Response Schema: application/json
    id
    string

    Unique identifier for the SKU

    +
    siteId
    string <uuid>

    ID of the Site this SKU belongs to

    +
    deviceType
    string or null

    Optional device type identifier (e.g. "gpu", "cpu", "storage")

    +
    associatedMachineIds
    Array of strings

    List of machine IDs associated with this SKU

    +
    object (SkuComponents)

    Hardware components of this SKU

    +
    Array of objects (SkuCpu)

    CPU components

    +
    Array
    vendor
    string

    Vendor of the CPU

    +
    model
    string

    Model of the CPU

    +
    threadCount
    integer <uint32>

    Number of threads for the CPU

    +
    count
    integer <uint32>

    Number of CPUs present

    +
    Array of objects (SkuGpu)

    GPU components

    +
    Array
    vendor
    string

    Vendor of the GPU

    +
    model
    string

    Model of the GPU

    +
    totalMemory
    string

    Total memory of the GPU (e.g. "80GB HBM3")

    +
    count
    integer <uint32>

    Number of GPUs present

    +
    Array of objects (SkuMemory)

    Memory components

    +
    Array
    capacityMb
    integer <uint32>

    Capacity in megabytes

    +
    memoryType
    string

    Type of memory (e.g. "DDR4", "DDR5")

    +
    count
    integer <uint32>

    Number of memory modules present

    +
    Array of objects (SkuStorage)

    Storage components

    +
    Array
    vendor
    string

    Vendor of the storage device

    +
    model
    string

    Model of the storage device

    +
    capacityMb
    integer <uint32>

    Capacity in megabytes

    +
    count
    integer <uint32>

    Number of storage devices present

    +
    object (SkuChassis)

    Chassis component

    +
    vendor
    string

    Vendor of the chassis

    +
    model
    string

    Model of the chassis

    +
    Array of objects (SkuEthernetDevice)

    Ethernet device components

    +
    Array
    vendor
    string

    Vendor of the ethernet device

    +
    model
    string

    Model of the ethernet device

    +
    count
    integer <uint32>

    Number of ethernet devices present

    +
    Array of objects (SkuInfinibandDevice)

    Infiniband device components

    +
    Array
    vendor
    string

    Vendor of the infiniband device

    +
    model
    string

    Model of the infiniband device

    +
    count
    integer <uint32>

    Number of infiniband devices present

    +
    Array of objects (SkuTpm)

    TPM components

    +
    Array
    vendor
    string

    Vendor of the TPM

    +
    version
    string

    Version of the TPM

    +
    created
    string <date-time>

    ISO 8601 datetime when the SKU was created

    +
    updated
    string <date-time>

    ISO 8601 datetime when the SKU was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "lenovo.sr650v2.cpu.1",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "deviceType": "gpu",
    • "associatedMachineIds": [
      ],
    • "components": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    InfiniBand Partition

    InfiniBand (IB) is a high-performance, low-latency networking standard designed for interconnecting servers and storage in HPC (High-Performance Computing) and AI systems, utilizing RDMA (Remote Direct Memory Access) to reduce CPU overhead. InfiniBand Partitions are used to group Machines into logical partitions for network isolation and load distribution.

    -

    Retrieve all InfiniBand Partitions

    Retrieve all InfiniBand Partitions

    Retrieve all InfiniBand Partitions for the org

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve all InfiniBand Partitions for the org

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string <uuid>

    Filter Partitions by Site

    -
    status
    string

    Filter Partitions by Status

    -
    query
    string

    Search for matches across all InfiniBand Partitions. Input will be matched against name, description, and status fields

    -
    includeRelation
    string
    Enum: "Site" "VPC" "Tenant"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the InfiniBand Partition

    -
    name
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    -
    description
    string or null

    Description of the InfiniBand Partition

    -
    siteId
    string <uuid>

    ID of the Site

    -
    tenantId
    string <uuid>

    ID of the Tenant

    -
    controllerIBPartitionId
    string or null <uuid>

    ID of the Site Controller InfiniBand partition corresponding to this InfiniBand Partition

    -
    partitionKey
    string or null

    Partition key assigned to the InfiniBand Partition

    -
    partitionName
    string or null

    Partition name assigned to the InfiniBand Partition

    -
    serviceLevel
    integer or null [ 0 .. 15 ]

    Service level configured for the InfiniBand Partition

    -
    rateLimit
    number or null
    Enum: 2 5 10 14 20 25 30 40 56 60 80 100 112 120 168 200 300

    Rate limit configured for the InfiniBand Partition

    -
    mtu
    integer or null
    Enum: 4000 8000

    MTU configured for the InfiniBand Partition

    -
    enableSharp
    boolean

    Whether SHARP is enabled for the InfiniBand Partition

    -
    object (Labels) <= 10 properties

    String key-value pairs describing InfiniBand Partition labels. Up to 10 key-value pairs can be specified

    -
    property name*
    additional property
    string
    status
    string (InfiniBandPartitionStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the InfiniBand Partition

    -
    Array of objects (StatusDetail)

    Chronological status history for the InfiniBand Partition

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the InfiniBand Partition was created

    -
    updated
    string <date-time>

    Date/time when the InfiniBand Partition was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create InfiniBand Partition

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    query Parameters
    siteId
    string <uuid>

    Filter Partitions by Site

    +
    status
    string

    Filter Partitions by Status

    +
    query
    string

    Search for matches across all InfiniBand Partitions. Input will be matched against name, description, and status fields

    +
    includeRelation
    string
    Enum: "Site" "VPC" "Tenant"

    Related entity to expand

    +
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    +
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    +
    orderBy
    string
    Enum: "NAME_ASC" "NAME_DESC" "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    +

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    +
    Response Schema: application/json
    Array
    id
    string <uuid>

    Unique UUID v4 identifier for the InfiniBand Partition

    +
    name
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    +
    description
    string or null

    Description of the InfiniBand Partition

    +
    siteId
    string <uuid>

    ID of the Site

    +
    tenantId
    string <uuid>

    ID of the Tenant

    +
    controllerIBPartitionId
    string or null <uuid>

    ID of the Site Controller InfiniBand partition corresponding to this InfiniBand Partition

    +
    partitionKey
    string or null

    Partition key assigned to the InfiniBand Partition

    +
    partitionName
    string or null

    Partition name assigned to the InfiniBand Partition

    +
    serviceLevel
    integer or null [ 0 .. 15 ]

    Service level configured for the InfiniBand Partition

    +
    rateLimit
    number or null
    Enum: 2 5 10 14 20 25 30 40 56 60 80 100 112 120 168 200 300

    Rate limit configured for the InfiniBand Partition

    +
    mtu
    integer or null
    Enum: 4000 8000

    MTU configured for the InfiniBand Partition

    +
    enableSharp
    boolean

    Whether SHARP is enabled for the InfiniBand Partition

    +
    object (Labels) <= 10 properties

    String key-value pairs describing InfiniBand Partition labels. Up to 10 key-value pairs can be specified

    +
    property name*
    additional property
    string
    status
    string (InfiniBandPartitionStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the InfiniBand Partition

    +
    Array of objects (StatusDetail)

    Chronological status history for the InfiniBand Partition

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the InfiniBand Partition was created

    +
    updated
    string <date-time>

    Date/time when the InfiniBand Partition was last updated

    +

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create InfiniBand Partition

    Create an InfiniBand Partition for the org.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Create an InfiniBand Partition for the org.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the Partition to create

    -
    description
    string or null

    Optional description of the Partition

    -
    siteId
    required
    string <uuid>

    ID of the Site the Partition should belong to

    -
    object (Labels) <= 10 properties

    String key-value pairs describing Partition labels. Up to 10 key-value pairs can be specified

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the InfiniBand Partition

    -
    name
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    -
    description
    string or null

    Description of the InfiniBand Partition

    -
    siteId
    string <uuid>

    ID of the Site

    -
    tenantId
    string <uuid>

    ID of the Tenant

    -
    controllerIBPartitionId
    string or null <uuid>

    ID of the Site Controller InfiniBand partition corresponding to this InfiniBand Partition

    -
    partitionKey
    string or null

    Partition key assigned to the InfiniBand Partition

    -
    partitionName
    string or null

    Partition name assigned to the InfiniBand Partition

    -
    serviceLevel
    integer or null [ 0 .. 15 ]

    Service level configured for the InfiniBand Partition

    -
    rateLimit
    number or null
    Enum: 2 5 10 14 20 25 30 40 56 60 80 100 112 120 168 200 300

    Rate limit configured for the InfiniBand Partition

    -
    mtu
    integer or null
    Enum: 4000 8000

    MTU configured for the InfiniBand Partition

    -
    enableSharp
    boolean

    Whether SHARP is enabled for the InfiniBand Partition

    -
    object (Labels) <= 10 properties

    String key-value pairs describing InfiniBand Partition labels. Up to 10 key-value pairs can be specified

    -
    property name*
    additional property
    string
    status
    string (InfiniBandPartitionStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the InfiniBand Partition

    -
    Array of objects (StatusDetail)

    Chronological status history for the InfiniBand Partition

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the InfiniBand Partition was created

    -
    updated
    string <date-time>

    Date/time when the InfiniBand Partition was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "turbo-net",
    • "siteId": "69dae3c8-3554-4a1f-b391-858c6dc47fff",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "turbo-net",
    • "description": "InfiniBand Partition for model training Instances",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "controllerIBPartitionId": "0e60d064-3d38-4812-84d9-c3353bd96eaf",
    • "partitionKey": "0x1",
    • "partitionName": "turbo-net",
    • "serviceLevel": 5,
    • "rateLimit": 40,
    • "mtu": 4000,
    • "enableSharp": true,
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve InfiniBand Partition

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the Partition to create

    +
    description
    string or null

    Optional description of the Partition

    +
    siteId
    required
    string <uuid>

    ID of the Site the Partition should belong to

    +
    object (Labels) <= 10 properties

    String key-value pairs describing Partition labels. Up to 10 key-value pairs can be specified

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the InfiniBand Partition

    +
    name
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    +
    description
    string or null

    Description of the InfiniBand Partition

    +
    siteId
    string <uuid>

    ID of the Site

    +
    tenantId
    string <uuid>

    ID of the Tenant

    +
    controllerIBPartitionId
    string or null <uuid>

    ID of the Site Controller InfiniBand partition corresponding to this InfiniBand Partition

    +
    partitionKey
    string or null

    Partition key assigned to the InfiniBand Partition

    +
    partitionName
    string or null

    Partition name assigned to the InfiniBand Partition

    +
    serviceLevel
    integer or null [ 0 .. 15 ]

    Service level configured for the InfiniBand Partition

    +
    rateLimit
    number or null
    Enum: 2 5 10 14 20 25 30 40 56 60 80 100 112 120 168 200 300

    Rate limit configured for the InfiniBand Partition

    +
    mtu
    integer or null
    Enum: 4000 8000

    MTU configured for the InfiniBand Partition

    +
    enableSharp
    boolean

    Whether SHARP is enabled for the InfiniBand Partition

    +
    object (Labels) <= 10 properties

    String key-value pairs describing InfiniBand Partition labels. Up to 10 key-value pairs can be specified

    +
    property name*
    additional property
    string
    status
    string (InfiniBandPartitionStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the InfiniBand Partition

    +
    Array of objects (StatusDetail)

    Chronological status history for the InfiniBand Partition

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the InfiniBand Partition was created

    +
    updated
    string <date-time>

    Date/time when the InfiniBand Partition was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "turbo-net",
    • "siteId": "69dae3c8-3554-4a1f-b391-858c6dc47fff",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "turbo-net",
    • "description": "InfiniBand Partition for model training Instances",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "controllerIBPartitionId": "0e60d064-3d38-4812-84d9-c3353bd96eaf",
    • "partitionKey": "0x1",
    • "partitionName": "turbo-net",
    • "serviceLevel": 5,
    • "rateLimit": 40,
    • "mtu": 4000,
    • "enableSharp": true,
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve InfiniBand Partition

    Retrieve a specific InfiniBand Partition

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Retrieve a specific InfiniBand Partition

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    Tenant must own the Partition.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    infiniBandPartitionId
    required
    string

    ID of the InfiniBand Partition

    -
    query Parameters
    includeRelation
    string
    Enum: "Site" "VPC" "Tenant"

    Related entity to expand

    -

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the InfiniBand Partition

    -
    name
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    -
    description
    string or null

    Description of the InfiniBand Partition

    -
    siteId
    string <uuid>

    ID of the Site

    -
    tenantId
    string <uuid>

    ID of the Tenant

    -
    controllerIBPartitionId
    string or null <uuid>

    ID of the Site Controller InfiniBand partition corresponding to this InfiniBand Partition

    -
    partitionKey
    string or null

    Partition key assigned to the InfiniBand Partition

    -
    partitionName
    string or null

    Partition name assigned to the InfiniBand Partition

    -
    serviceLevel
    integer or null [ 0 .. 15 ]

    Service level configured for the InfiniBand Partition

    -
    rateLimit
    number or null
    Enum: 2 5 10 14 20 25 30 40 56 60 80 100 112 120 168 200 300

    Rate limit configured for the InfiniBand Partition

    -
    mtu
    integer or null
    Enum: 4000 8000

    MTU configured for the InfiniBand Partition

    -
    enableSharp
    boolean

    Whether SHARP is enabled for the InfiniBand Partition

    -
    object (Labels) <= 10 properties

    String key-value pairs describing InfiniBand Partition labels. Up to 10 key-value pairs can be specified

    -
    property name*
    additional property
    string
    status
    string (InfiniBandPartitionStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the InfiniBand Partition

    -
    Array of objects (StatusDetail)

    Chronological status history for the InfiniBand Partition

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the InfiniBand Partition was created

    -
    updated
    string <date-time>

    Date/time when the InfiniBand Partition was last updated

    -

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "turbo-net",
    • "description": "InfiniBand Partition for model training Instances",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "controllerIBPartitionId": "0e60d064-3d38-4812-84d9-c3353bd96eaf",
    • "partitionKey": "0x1",
    • "partitionName": "turbo-net",
    • "serviceLevel": 5,
    • "rateLimit": 40,
    • "mtu": 4000,
    • "enableSharp": true,
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete InfiniBand Partition

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    infiniBandPartitionId
    required
    string

    ID of the InfiniBand Partition

    +
    query Parameters
    includeRelation
    string
    Enum: "Site" "VPC" "Tenant"

    Related entity to expand

    +

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the InfiniBand Partition

    +
    name
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    +
    description
    string or null

    Description of the InfiniBand Partition

    +
    siteId
    string <uuid>

    ID of the Site

    +
    tenantId
    string <uuid>

    ID of the Tenant

    +
    controllerIBPartitionId
    string or null <uuid>

    ID of the Site Controller InfiniBand partition corresponding to this InfiniBand Partition

    +
    partitionKey
    string or null

    Partition key assigned to the InfiniBand Partition

    +
    partitionName
    string or null

    Partition name assigned to the InfiniBand Partition

    +
    serviceLevel
    integer or null [ 0 .. 15 ]

    Service level configured for the InfiniBand Partition

    +
    rateLimit
    number or null
    Enum: 2 5 10 14 20 25 30 40 56 60 80 100 112 120 168 200 300

    Rate limit configured for the InfiniBand Partition

    +
    mtu
    integer or null
    Enum: 4000 8000

    MTU configured for the InfiniBand Partition

    +
    enableSharp
    boolean

    Whether SHARP is enabled for the InfiniBand Partition

    +
    object (Labels) <= 10 properties

    String key-value pairs describing InfiniBand Partition labels. Up to 10 key-value pairs can be specified

    +
    property name*
    additional property
    string
    status
    string (InfiniBandPartitionStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the InfiniBand Partition

    +
    Array of objects (StatusDetail)

    Chronological status history for the InfiniBand Partition

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the InfiniBand Partition was created

    +
    updated
    string <date-time>

    Date/time when the InfiniBand Partition was last updated

    +

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "turbo-net",
    • "description": "InfiniBand Partition for model training Instances",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "controllerIBPartitionId": "0e60d064-3d38-4812-84d9-c3353bd96eaf",
    • "partitionKey": "0x1",
    • "partitionName": "turbo-net",
    • "serviceLevel": 5,
    • "rateLimit": 40,
    • "mtu": 4000,
    • "enableSharp": true,
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Delete InfiniBand Partition

    Delete a specific InfiniBand Partition by ID.

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Delete a specific InfiniBand Partition by ID.

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    Tenant must own the Partition.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    infiniBandPartitionId
    required
    string

    ID of the InfiniBand Partition

    -

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Update InfiniBand Partition

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    infiniBandPartitionId
    required
    string

    ID of the InfiniBand Partition

    +

    Responses

    Response samples

    Content type
    application/json
    {
    • "message": "Deletion request was accepted"
    }

    Update InfiniBand Partition

    Update an existing InfiniBand Partition

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Update an existing InfiniBand Partition

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    Tenant must own the Partition.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    infiniBandPartitionId
    required
    string

    ID of the InfiniBand Partition

    -
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    -
    description
    string or null

    Description of the InfiniBand Partition

    -
    object (Labels) <= 10 properties

    String key-value pairs describing Partition labels. Up to 10 key-value pairs can be specified

    -
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the InfiniBand Partition

    -
    name
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    -
    description
    string or null

    Description of the InfiniBand Partition

    -
    siteId
    string <uuid>

    ID of the Site

    -
    tenantId
    string <uuid>

    ID of the Tenant

    -
    controllerIBPartitionId
    string or null <uuid>

    ID of the Site Controller InfiniBand partition corresponding to this InfiniBand Partition

    -
    partitionKey
    string or null

    Partition key assigned to the InfiniBand Partition

    -
    partitionName
    string or null

    Partition name assigned to the InfiniBand Partition

    -
    serviceLevel
    integer or null [ 0 .. 15 ]

    Service level configured for the InfiniBand Partition

    -
    rateLimit
    number or null
    Enum: 2 5 10 14 20 25 30 40 56 60 80 100 112 120 168 200 300

    Rate limit configured for the InfiniBand Partition

    -
    mtu
    integer or null
    Enum: 4000 8000

    MTU configured for the InfiniBand Partition

    -
    enableSharp
    boolean

    Whether SHARP is enabled for the InfiniBand Partition

    -
    object (Labels) <= 10 properties

    String key-value pairs describing InfiniBand Partition labels. Up to 10 key-value pairs can be specified

    -
    property name*
    additional property
    string
    status
    string (InfiniBandPartitionStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the InfiniBand Partition

    -
    Array of objects (StatusDetail)

    Chronological status history for the InfiniBand Partition

    -
    Array
    status
    string

    State of the associated entity at a particular time

    -
    message
    string or null

    Description of the state and cause/remedy in case of error

    -
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    -
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    -
    created
    string <date-time>

    Date/time when the InfiniBand Partition was created

    -
    updated
    string <date-time>

    Date/time when the InfiniBand Partition was last updated

    -

    Request samples

    Content type
    application/json
    {
    • "name": "turbo-net-v2",
    • "description": "Second version of the model training network",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "turbo-net-v2",
    • "description": "Second version of the model training network",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "controllerIBPartitionId": "0e60d064-3d38-4812-84d9-c3353bd96eaf",
    • "partitionKey": "0x1",
    • "partitionName": "turbo-net",
    • "serviceLevel": 5,
    • "rateLimit": 40,
    • "mtu": 4000,
    • "enableSharp": true,
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all InfiniBand Interfaces

    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    +
    infiniBandPartitionId
    required
    string

    ID of the InfiniBand Partition

    +
    Request Body schema: application/json
    name
    required
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    +
    description
    string or null

    Description of the InfiniBand Partition

    +
    object (Labels) <= 10 properties

    String key-value pairs describing Partition labels. Up to 10 key-value pairs can be specified

    +
    property name*
    additional property
    string

    Responses

    Response Schema: application/json
    id
    string <uuid>

    Unique UUID v4 identifier for the InfiniBand Partition

    +
    name
    string [ 2 .. 256 ] characters

    Name of the InfiniBand Partition

    +
    description
    string or null

    Description of the InfiniBand Partition

    +
    siteId
    string <uuid>

    ID of the Site

    +
    tenantId
    string <uuid>

    ID of the Tenant

    +
    controllerIBPartitionId
    string or null <uuid>

    ID of the Site Controller InfiniBand partition corresponding to this InfiniBand Partition

    +
    partitionKey
    string or null

    Partition key assigned to the InfiniBand Partition

    +
    partitionName
    string or null

    Partition name assigned to the InfiniBand Partition

    +
    serviceLevel
    integer or null [ 0 .. 15 ]

    Service level configured for the InfiniBand Partition

    +
    rateLimit
    number or null
    Enum: 2 5 10 14 20 25 30 40 56 60 80 100 112 120 168 200 300

    Rate limit configured for the InfiniBand Partition

    +
    mtu
    integer or null
    Enum: 4000 8000

    MTU configured for the InfiniBand Partition

    +
    enableSharp
    boolean

    Whether SHARP is enabled for the InfiniBand Partition

    +
    object (Labels) <= 10 properties

    String key-value pairs describing InfiniBand Partition labels. Up to 10 key-value pairs can be specified

    +
    property name*
    additional property
    string
    status
    string (InfiniBandPartitionStatus)
    Enum: "Pending" "Provisioning" "Ready" "Configuring" "Deleting" "Error"

    Status of the InfiniBand Partition

    +
    Array of objects (StatusDetail)

    Chronological status history for the InfiniBand Partition

    +
    Array
    status
    string

    State of the associated entity at a particular time

    +
    message
    string or null

    Description of the state and cause/remedy in case of error

    +
    created
    string <date-time>

    Date/time when the associated entity assumed the status

    +
    updated
    string <date-time>

    Date/time when the associated entity was last observed with this status

    +
    created
    string <date-time>

    Date/time when the InfiniBand Partition was created

    +
    updated
    string <date-time>

    Date/time when the InfiniBand Partition was last updated

    +

    Request samples

    Content type
    application/json
    {
    • "name": "turbo-net-v2",
    • "description": "Second version of the model training network",
    • "labels": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "turbo-net-v2",
    • "description": "Second version of the model training network",
    • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    • "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    • "controllerIBPartitionId": "0e60d064-3d38-4812-84d9-c3353bd96eaf",
    • "partitionKey": "0x1",
    • "partitionName": "turbo-net",
    • "serviceLevel": 5,
    • "rateLimit": 40,
    • "mtu": 4000,
    • "enableSharp": true,
    • "labels": {
      },
    • "status": "Pending",
    • "statusHistory": [
      ],
    • "created": "2019-08-24T14:15:22Z",
    • "updated": "2019-08-24T14:15:22Z"
    }

    Retrieve all InfiniBand Interfaces

    Get all InfiniBand Interfaces

    +" class="sc-iJSMbW sc-cBEgGa fiNpIH ewCFMV">

    Get all InfiniBand Interfaces

    Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

    -
    Authorizations:
    JWTBearerToken
    path Parameters
    org
    required
    string

    Name of the Org

    -
    query Parameters
    siteId
    string

    Filter InfiniBand Interfaces by Site ID. Can be specified multiple times to filter on more than one ID.

    -
    instanceId
    string

    Filter InfiniBand Interfaces by Instance ID. Can be specified multiple times to filter on more than one ID.

    -
    infinibandPartitionId
    string

    Filter InfiniBand Interfaces by InfiniBand Partition ID. Can be specified multiple times to filter on more than one ID.

    -
    status
    string

    Filter InfiniBand Interfaces by Status. Can be specified multiple times to filter on more than one status.

    -
    includeRelation
    string
    Enum: "Instance" "InfiniBandPartition" "Site"

    Related entity to expand

    -
    pageNumber
    integer >= 1
    Default: 1
    Example: pageNumber=1

    Page number for pagination query

    -
    pageSize
    integer [ 1 .. 100 ]
    Example: pageSize=20

    Page size for pagination query

    -
    orderBy
    string
    Enum: "STATUS_ASC" "STATUS_DESC" "CREATED_ASC" "CREATED_DESC" "UPDATED_ASC" "UPDATED_DESC"

    Ordering for pagination query

    -

    Responses

    Response Headers
    X-Pagination
    string
    Example: "{\"pageNumber\":1,\"pageSize\":20,\"total\":30,\"orderBy\": \"CREATED_DESC\"}"

    Pagination result in JSON format

    -
    Response Schema: application/json
    Array
    id
    string <uuid> non-empty

    Unique UUID v4 identifier for the InfiniBandInterface

    -
    instanceId
    string <uuid>

    ID of the associated Instance

    -
    partitionId
    string <uuid>

    ID of the InfiniBand Partition associated with this interface

    -
    device
    string

    Name of the InfiniBand device associated with this interface

    -
    vendor
    string or null

    Name of the InfiniBand device vendor associated with this interface

    -
    deviceInstance
    integer

    Index of the device where partition attach to

    -
    isPhysical
    boolean

    Indicates whether this is a physical interface

    -
    virtualFunctionId
    integer or null

    Must be specified if isPhysical is false

    -
    guid
    string or null

    Must be specified if isPhysical is false

    -
    status
    string (InfiniBandInterfaceStatus)
    Enum: "Pending" "Provisioning" "Ready" "Deleting" "Error"

    Status of the InfiniBandInterface

    -
    created
    string <date-time>

    Date/time when the InfiniBandInterface was created

    -
    updated
    string <date-time>

    Date/time when the InfiniBandInterface was last updated

    -

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]