NVIDIA Infra Controller REST API is the centralized RESTful gateway to access NVIDIA Infra Controller service
-
NVIDIA Infra Controller REST API allows users to create and manage resources e.g. VPC, Subnets, Instances across all connected NVIDIA Infra Controller datacenters, also referred to as Sites.
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
This section provides a quick overview of the API and how to get started.
In both cases, these calls initialize Provider and Tenant entities for the organization. All resources created are anchored to either the Provider or Tenant entity.
Once the Provider and the Tenant are initialized, the user can create resources by making calls to the appropriate endpoints.
-
Creating Site Level IP Blocks
-
To utilize a NICo Site, the Provider or Service Account holder must create IP Blocks for each network overlay defined in the Site configuration toml file.
+
Creating Site-Level IP Blocks
+
To use a NICo Site, the Provider or Service Account holder must create IP Blocks for each network overlay defined in the Site configuration TOML file.
Note: From this point onwards, a brief outline is provided for the typical API call flows for various use cases.
@@ -589,36 +589,36 @@
Typical API Call Flow for Ser
Retrieve available Sites using the Retrieve All Sites endpoint and choose a Site to create resources in. For Disconnected NICo installations where NICo
REST is deployed alongside NICo Core, typically there will be a single Site available.
-
For each Site IP Block, create a Network Allocation for the Tenant entity using the Create Allocation endpoint using the full prefix length.
+
For each Site IP Block, create a Network Allocation for the Tenant entity with the full prefix length using the Create Allocation endpoint.
This will create a Tenant IP Block for each Site IP Block.
Creating an Allocation will create the Tenant in NICo Core.
Retrieve available Site IP Blocks using the Retrieve All IP Blocks endpoint. Any IP Block for which the Tenant has received
a Network Allocation from the Provider will be returned.
-
Create a VPC Prefix or Subnet referencing the VPC and a Tenant IP Block
Retrieve available Instance Types using the Retrieve All Instance Types endpoint. Any Instance Type for which
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
+
Create an Instance specifying the VPC, VPC Prefix or Subnet, Operating System, and Instance Type.
-
Service Account
Service Account
When 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
+">
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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Name of the Org
Responses
Response Schema: application/json
id
string <uuid>
org
string
orgDisplayName
string or null
created
string <date-time>
updated
string <date-time>
Kubernetes Cluster
@@ -714,13 +724,51 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Name of the Org
Responses
Response Schema: application/json
object (MachineCountByStatus)
Describes count of Machines in various statuses
-
total
integer
initializing
integer
reset
integer
assigned
integer
ready
integer
error
integer
decommissioned
integer
unknown
integer
object (IpBlockCountByStatus)
Describes counts of IP Blocks in various statuses
-
total
integer
pending
integer
provisioning
integer
ready
integer
deleting
integer
error
integer
object (TenantAccountCountByStatus)
Describes counts of Tenant Accounts in various statuses
Tenant Account connects a Tenant with an Infrastructure Provider. It represents/contains any information pertaining to their relationship.
+
Deprecation history:
+
+
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.
-
Either infrastructureProviderId or tenantId query param must be specified.
-
If infrastructureProviderId query param is provided, then org must have an Infrastructure Provider entity and its ID should match the query param value. User must have authorization role with PROVIDER_ADMIN suffix.
-
If tenantId query param is provided, then org must have a Tenant entity and its ID should match the query param value. User must have authorization role with TENANT_ADMIN suffix.
+
Either infrastructureProviderId or tenantId query parameter must be specified.
+
If the infrastructureProviderId query parameter is provided, then org must have an Infrastructure Provider entity and its ID should match the query parameter value. User must have authorization role with PROVIDER_ADMIN suffix.
+
If the tenantId query parameter is provided, then org must have a Tenant entity and its ID should match the query parameter value. User must have authorization role with TENANT_ADMIN suffix.
Authorizations:
JWTBearerToken
path Parameters
org
required
string
Name of the Org
-
query Parameters
infrastructureProviderId
string <uuid>
Filter TenantAccounts by Infrastructure Provider ID
-
tenantId
string <uuid>
Filter TenantAccounts by Tenant ID
+
query Parameters
infrastructureProviderId
string <uuid>
Filter Tenant Accounts by Infrastructure Provider ID
+
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"
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB sc-cittYi iNuSsz eBjiEo hynizp">
Org must have an Infrastructure Provider entity and its ID must match the Infrastructure Provider ID in request data. User must have authorization role with PROVIDER_ADMIN suffix
-
Infrastructure Provider can create a Tenant Account by specifying the Tenant's UUID or Tenant's org name. This will set the status of the Tenant Account to "Invited". Then the Tenant can view this account information and are able to confirm/accept the account by updating the Tenant Account.
+
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
required
string <uuid>
tenantOrg
required
string non-empty ^[A-Za-z0-9-_]+$
Request Body schema: application/json
infrastructureProviderId
required
string <uuid>
ID of the Infrastructure Provider in the organization
+
tenantOrg
required
string non-empty ^[A-Za-z0-9-_]+$
Must be a valid Org name
Responses
Response Schema: application/json
id
string <uuid>
infrastructureProviderId
string <uuid>
infrastructureProviderOrg
string
tenantId
string or null <uuid>
tenantOrg
string or null
object (User)
Details of the user collected from authentication tokens
+
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>
firstName
string or null
lastName
string or null
created
string <date-time>
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>
allocationCount
integer
status
string (TenantAccountStatus)
Enum:"Pending""Invited""Ready""Error"
Status values for Tenant Account objects
-
Array of objects (StatusDetail)
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
updated
string <date-time>
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
+
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
Either infrastructureProviderId or tenantId query param must be specified.
-
If infrastructureProviderId query param is provided, then org must have an Infrastructure Provider entity and its ID should match the query param value. User must have authorization role with PROVIDER_ADMIN suffix.
-
If tenantId query param is provided, then org must have a Tenant entity and its ID should match the query param value. User must have authorization role with TENANT_ADMIN suffix.
+
Either infrastructureProviderId or tenantId query parameter must be specified.
+
If the infrastructureProviderId query parameter is provided, then org must have an Infrastructure Provider entity and its ID should match the query parameter value. User must have authorization role with PROVIDER_ADMIN suffix.
+
If the tenantId query parameter is provided, then org must have a Tenant entity and its ID should match the query parameter value. User must have authorization role with TENANT_ADMIN suffix.
Authorizations:
JWTBearerToken
path Parameters
org
required
string
Name of the Org
accountId
required
string <uuid>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Related entity to expand
Responses
Response Schema: application/json
id
string <uuid>
infrastructureProviderId
string <uuid>
infrastructureProviderOrg
string
tenantId
string or null <uuid>
tenantOrg
string or null
object (User)
Details of the user collected from authentication tokens
+
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>
firstName
string or null
lastName
string or null
created
string <date-time>
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>
allocationCount
integer
status
string (TenantAccountStatus)
Enum:"Pending""Invited""Ready""Error"
Status values for Tenant Account objects
-
Array of objects (StatusDetail)
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
updated
string <date-time>
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
+
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
Can be used to accept an invitation sent by 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 TenantAccount that has Invited status.
+
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 params needed, an empty request body will suffice.
+
Request Body schema: application/json
No parameters are required; an empty request body is sufficient.
object (TenantAccountUpdateRequest)
Request data to update a TenantAccount.
No params needed, an empty request will suffice.
Responses
Response Schema: application/json
id
string <uuid>
infrastructureProviderId
string <uuid>
infrastructureProviderOrg
string
tenantId
string or null <uuid>
tenantOrg
string or null
object (User)
Details of the user collected from authentication tokens
+
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>
firstName
string or null
lastName
string or null
created
string <date-time>
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>
allocationCount
integer
status
string (TenantAccountStatus)
Enum:"Pending""Invited""Ready""Error"
Status values for Tenant Account objects
-
Array of objects (StatusDetail)
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
updated
string <date-time>
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
+
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
Org must have an Infrastructure Provider entity, specified Tenant Account must be created by said Provider. Requesting user must have PROVIDER_ADMIN role.
+
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
@@ -953,9 +1207,9 @@
Typical API Call Flow for Tenant
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 for org.
-
User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix. infrastructureProviderId or tenantId query param may be required for older API versions.
+
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>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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.
+
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>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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)
Location of the Site
+
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)
Contact for the Site
+
object (SiteContact)
Updated Site contact information
email
string
Email address of the Site contact
object (SiteCapabilitiesUpdateRequest)
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Enable or disable image-based operating system support for the Site
Responses
Response Schema: application/json
id
string <uuid>
name
string [ 2 .. 256 ] characters
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
infrastructureProviderId
string <uuid>
siteControllerVersion
string or null
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
@@ -1292,7 +1706,9 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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>
isSerialConsoleEnabled
boolean
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
@@ -1302,49 +1718,101 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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 values for Site objects
-
Array of objects (StatusDetail)
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
updated
string <date-time>
object (SiteLocation)
Location of the Site
+
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)
Contact for the Site
+
object (SiteContact)
Site contact information
email
string
Email address of the Site contact
-
object (SiteCapabilities)
Boolean flags to indicate features supported by a Site
Allocations are the mechanism by which Provider can delegate Network and Compute resources to Tenant.
+
Deprecation history:
+
+
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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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 Sites. Input will be matched against name, description and status fields
+
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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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 values for Allocation objects
-
Array of objects (StatusDetail)
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
Array of objects (AllocationConstraint)
Array
id
string <uuid>
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 Type 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 where a prefix is allocated to the Tenant.
+
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)
Describes a subset of core attributes of an Instance Type
-
object (IpBlockSummary)
Describes a subset of core attributes of an IP block
+
object (InstanceTypeSummary)
Summary of the Instance Type
+
object (IpBlockSummary)
Summary of the IP Block
created
string <date-time>
Date/time when the Allocation Constraint was created
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 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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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)
Array
resourceType
required
string
Enum:"InstanceType""IPBlock"
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.
@@ -1528,26 +2026,38 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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 values for Allocation objects
-
Array of objects (StatusDetail)
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
Array of objects (AllocationConstraint)
Array
id
string <uuid>
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 Type 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 where a prefix is allocated to the Tenant.
+
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)
Describes a subset of core attributes of an Instance Type
-
object (IpBlockSummary)
Describes a subset of core attributes of an IP block
+
object (InstanceTypeSummary)
Summary of the Instance Type
+
object (IpBlockSummary)
Summary of the IP Block
created
string <date-time>
Date/time when the Allocation Constraint was created
updated
string <date-time>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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 values for Allocation objects
-
Array of objects (StatusDetail)
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
Array of objects (AllocationConstraint)
Array
id
string <uuid>
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 Type 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 where a prefix is allocated to the Tenant.
+
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)
Describes a subset of core attributes of an Instance Type
-
object (IpBlockSummary)
Describes a subset of core attributes of an IP block
+
object (InstanceTypeSummary)
Summary of the Instance Type
+
object (IpBlockSummary)
Summary of the IP Block
created
string <date-time>
Date/time when the Allocation Constraint was created
Org must have an Infrastructure Provider entity, specified Allocation must be created by said Provider. Requesting user must have PROVIDER_ADMIN role.
+
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
@@ -1668,26 +2190,38 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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 values for Allocation objects
-
Array of objects (StatusDetail)
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
Array of objects (AllocationConstraint)
Array
id
string <uuid>
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 Type 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 where a prefix is allocated to the Tenant.
+
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)
Describes a subset of core attributes of an Instance Type
-
object (IpBlockSummary)
Describes a subset of core attributes of an IP block
+
object (InstanceTypeSummary)
Summary of the Instance Type
+
object (IpBlockSummary)
Summary of the IP Block
created
string <date-time>
Date/time when the Allocation Constraint was created
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.
-
In case of InstanceType resource, constraintValue can be incremented anytime, but not decremented if it requires decommissioning Tenant resources.
-
In case of IPBlock resource, constraintValue can not be modified if Tenant resources are using IPs from the block.
+
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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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 Type 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 where a prefix is allocated to the Tenant.
+
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)
Describes a subset of core attributes of an Instance Type
Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.
@@ -1998,8 +2624,8 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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 entirely replaced by those sent in the request. Any labels not included in the request will be removed. To retain existing labels, first fetch them and include them along with this request.
+
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>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
ID of the Network Security Group attached to the VPC
object (NetworkSecurityGroupPropagationDetails)
Propagation details for the attached Network Security Group
-
id
string <uuid>
The VPC or Instance ID
-
detailedStatus
string
Enum:"None""Partial""Full""Unknown""Error"
status
string (NetworkSecurityGroupPropagationStatus)
Enum:"Synchronizing""Synchronized""Error"
Status values for Network Security Group propagation
-
details
string or null
unpropagatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
relatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
nvLinkLogicalPartitionId
string or null <uuid>
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)
Deprecation notices for fields returned by this propagation detail
+
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
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
@@ -2278,18 +2964,18 @@
Typical API Call Flow for Tenant
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 vpcId query param is not specified
+
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 Sites. Input will be matched against name and status fields
+
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 statistic 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.
+
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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB sc-cittYi iNuSsz eBjiEo hynizp">
ID of the IP Block that contains the prefix of the VPC Prefix
prefix
string or null
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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:"Ready""Deleting""Error"
Status of the VPC Prefix
-
object (IpBlockUsageStats)
Present when query param 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.
+
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>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
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
Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.
@@ -2354,14 +3048,14 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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>
name
string [ 2 .. 256 ] characters
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
-
tenantId
string <uuid>
ID of the Tenant 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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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:"Ready""Deleting""Error"
Status of the VPC Prefix
-
object (IpBlockUsageStats)
Present when query param 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.
+
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>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
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
Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.
@@ -2404,20 +3106,20 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
ID of the VPC Prefix
query Parameters
includeRelation
string
Enum:"VPC""Tenant""IPBlock"
Related entity to expand
-
includeUsageStats
boolean
includeUsageStats
boolean
When true, each VPC Prefix object includes usage statistic using the same structure as IP Block usage.
+" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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>
name
string [ 2 .. 256 ] characters
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
-
tenantId
string <uuid>
ID of the Tenant 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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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:"Ready""Deleting""Error"
Status of the VPC Prefix
-
object (IpBlockUsageStats)
Present when query param 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.
+
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>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
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
Expected Switch identifies a 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 Switch discovery and ingestion.
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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
TPM components
Array
vendor
string
Vendor of the TPM
-
model
string
Model of the TPM
-
count
integer <uint32>
Number of TPMs present
+
version
string
Version of the TPM
created
string <date-time>
ISO 8601 datetime when the SKU was created
updated
string <date-time>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Filter Partitions by Site
status
string
Filter Partitions by Status
-
query
string
Search for matches across all Sites. Input will be matched against name, description and status fields
+
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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB sc-cittYi iNuSsz eBjiEo hynizp">
NVLink Logical Partitions are used to group GPUs into logical partitions for shared memory and low-latency direct communication between GPUs.
+
Deprecation history:
+
+
nvLinklogicalPartitionId attribute on NVLink Interface was deprecated in favor of nvLinkLogicalPartitionId and will be removed on July 9th, 2026 0:00 UTC. Please use nvLinkLogicalPartitionId instead.
+
Retrieve all NVLink Logical Partitions
Retrieve all NVLink Logical Partitions for the org
@@ -4836,8 +5854,8 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Filter NVLink Logical Partitions by Site
status
string
Filter NVLink Logical Partitions by Status
-
query
string
Search for matches across all Sites. Input will be matched against name, description and status fields
+
query
string
Search for matches across all NVLink Logical Partitions. Input will be matched against name, description, and status fields
includeInterfaces
boolean
Include NVLink Interfaces in response.
includeStats
boolean
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Status of the NVLink Logical Partition
Array of objects (StatusDetail)
Details of status changes for the NVLink Logical Partition over time
-
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
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
+
object (NVLinkLogicalPartitionStats)
GPU and Instance usage counts for the NVLink Logical Partition. Returned if the includeStats query parameter is set to true in retrieval endpoints
+
totalGpus
integer
Total number of GPUs associated with the NVLink Logical Partition
+
totalDistinctInstances
integer
Total number of distinct Instances associated with the NVLink Logical Partition
+
created
string <date-time>
Date and time the NVLink Logical Partition was created
updated
string <date-time>
Date and time the NVLink Logical Partition was last updated
@@ -4906,7 +5938,21 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Status of the NVLink Logical Partition
Array of objects (StatusDetail)
Details of status changes for the NVLink Logical Partition over time
-
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
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
+
object (NVLinkLogicalPartitionStats)
GPU and Instance usage counts for the NVLink Logical Partition. Returned if the includeStats query parameter is set to true in retrieval endpoints
+
totalGpus
integer
Total number of GPUs associated with the NVLink Logical Partition
+
totalDistinctInstances
integer
Total number of distinct Instances associated with the NVLink Logical Partition
+
created
string <date-time>
Date and time the NVLink Logical Partition was created
updated
string <date-time>
Date and time the NVLink Logical Partition was last updated
@@ -4948,7 +5994,21 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Status of the NVLink Logical Partition
Array of objects (StatusDetail)
Details of status changes for the NVLink Logical Partition over time
-
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
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
+
object (NVLinkLogicalPartitionStats)
GPU and Instance usage counts for the NVLink Logical Partition. Returned if the includeStats query parameter is set to true in retrieval endpoints
+
totalGpus
integer
Total number of GPUs associated with the NVLink Logical Partition
+
totalDistinctInstances
integer
Total number of distinct Instances associated with the NVLink Logical Partition
+
created
string <date-time>
Date and time the NVLink Logical Partition was created
updated
string <date-time>
Date and time the NVLink Logical Partition was last updated
@@ -4984,7 +6044,21 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Status of the NVLink Logical Partition
Array of objects (StatusDetail)
Details of status changes for the NVLink Logical Partition over time
-
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
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
+
object (NVLinkLogicalPartitionStats)
GPU and Instance usage counts for the NVLink Logical Partition. Returned if the includeStats query parameter is set to true in retrieval endpoints
+
totalGpus
integer
Total number of GPUs associated with the NVLink Logical Partition
+
totalDistinctInstances
integer
Total number of distinct Instances associated with the NVLink Logical Partition
+
created
string <date-time>
Date and time the NVLink Logical Partition was created
updated
string <date-time>
Date and time the NVLink Logical Partition was last updated
"message": "received Operating System creation request, syncing",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
],
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
]
Create Operating System
Create an Operating System for the org.
Either infrastructureProviderId or tenantId must be provided in request data. Both cannot be provided at the same time.
-
If infrastructureProviderId is provided in request data, then org must have an Infrastructure Provider entity and its ID should match the query param value. User must have authorization role with PROVIDER_ADMIN suffix.
-
If tenantId is provided in request data, then org must have a Tenant entity and its ID should match the query param value. User must have authorization role with TENANT_ADMIN suffix.
+
If infrastructureProviderId is provided in request data, then org must have an Infrastructure Provider entity and its ID should match the query parameter value. User must have authorization role with PROVIDER_ADMIN suffix.
+
If tenantId is provided in request data, then org must have a Tenant entity and its ID should match the query parameter value. User must have authorization role with TENANT_ADMIN suffix.
Only Tenants are allowed to create Operating System for MVP.
Authorizations:
JWTBearerToken
path Parameters
org
required
string
Name of the Org
@@ -5160,30 +6268,30 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Deprecated: Infrastructure Provider is now inferred from org membership.
tenantId
string or null <uuid>
Deprecated
Deprecated: Tenant is now inferred from org membership.
-
siteIds
Array of strings <uuid> [ items <uuid > ]
Specified only one Site if an Operating System is Image based, more than one Site is not supported"
-
ipxeScript
string or null
iPXE script or URL, only applicable for iPXE based OS. Cannot be specified if imageUrl is specified
-
imageUrl
string or null <uri>
Original URL from where the Operating System image can be retreived from, required for image based OS. Cannot be specified if ipxeScript is specified
-
imageSha
string or null
SHA hash of the image file, required for image based OS
-
imageAuthType
string or null
Authentication type for image URL if needed e.g. basic/bearer/token, required is imageAuthToken is specified
+
siteIds
Array of strings <uuid> [ items <uuid > ]
Specify only one Site if an Operating System is image-based; more than one Site is not supported.
+
ipxeScript
string or null
iPXE script or URL, only applicable for iPXE-based OS. Cannot be specified if imageUrl is specified
+
imageUrl
string or null <uri>
Original URL from which the Operating System image can be retrieved; required for image-based OS. Cannot be specified if ipxeScript is specified
+
imageSha
string or null
SHA hash of the image file, required for image-based OS
+
imageAuthType
string or null
Authentication type for image URL, if needed, e.g., basic/bearer/token; required if imageAuthToken is specified
imageAuthToken
string or null
Auth token to retrieve the image from image URL, required if imageAuthType is specified
imageDisk
string or null
Disk path where the image should be mounted, optional
-
rootFsId
string or null
Root filesystem UUID, this or rootFsLabel required for image based OS
-
rootFsLabel
string or null
Root filesystem label, this or rootFsId required for image based OS
+
rootFsId
string or null
Root filesystem UUID; this or rootFsLabel is required for image-based OS
+
rootFsLabel
string or null
Root filesystem label; this or rootFsId is required for image-based OS
phoneHomeEnabled
boolean or null
Indicates whether the Phone Home service should be enabled or disabled for Operating System
userData
string or null
User data for the Operating System
-
isCloudInit
boolean
Specified when the Operating System is Cloud Init based
+
isCloudInit
boolean
Specified when the Operating System is cloud-init based
allowOverride
boolean
Indicates if the user data can be overridden at Instance creation time
Responses
type
string or null
Enum:"iPXE""Image"
Type of the Operating System
-
imageUrl
string or null <uri>
Original URL from where the Operating System image can be retrieved
-
imageSha
string or null
SHA hash of the image file, only present for image based OS
-
imageAuthType
string or null
Authentication type for image URL e.g. 'Basic' or 'Bearer'
+
imageUrl
string or null <uri>
Original URL from which the Operating System image can be retrieved
+
imageSha
string or null
SHA hash of the image file, only present for image-based OS
+
imageAuthType
string or null
Authentication type for image URL, e.g., 'Basic' or 'Bearer'
imageAuthToken
string or null
Auth token to retrieve the image from image URL
-
imageDisk
string or null
Disk path where the image should be monuted
-
rootFsId
string or null
Root filesystem UUID, only applicable for image based Operating System
-
rootFsLabel
string or null
Root filesystem label, only applicable for image based Operating System
-
ipxeScript
string or null
iPXE script or URL, only applicable for iPXE based Operating System
+
imageDisk
string or null
Disk path where the image should be mounted
+
rootFsId
string or null
Root filesystem UUID, only applicable for image-based Operating System
+
rootFsLabel
string or null
Root filesystem label, only applicable for image-based Operating System
+
ipxeScript
string or null
iPXE script or URL, only applicable for iPXE-based Operating System
userData
string or null
User data for the Operating System
-
isCloudInit
boolean
Specified when the Operating System is Cloud Init based
+
isCloudInit
boolean
Specified when the Operating System is cloud-init based
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for Operating System
isActive
boolean
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Indicates if the user data can be overridden at Instance creation time
Array of objects (OperatingSystemSiteAssociation)
Sites the Operating System is synced to
-
Array
object (SiteSummary)
SiteSummary contains a subset of data for Site object, used when nesting in other objects
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
ID of the Infrastructure Provider that owns the Site where the Instance is located
siteId
string <uuid>
ID of the Site where the Instance is located
-
instanceTypeId
string or null <uuid>
vpcId
string <uuid>
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
instanceTypeId
string or null <uuid>
ID of the Instance Type
+
vpcId
string <uuid>
ID of the VPC
+
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
IDs of VPCs attached to the Instance through non-primary interfaces
-
machineId
string or null
operatingSystemId
string or null <uuid>
networkSecurityGroupId
string or null
object (NetworkSecurityGroupPropagationDetails)
machineId
string or null
ID of the Machine
+
operatingSystemId
string or null <uuid>
ID of the Operating System
+
networkSecurityGroupId
string or null
ID of the attached Network Security Group, if any
+
object (NetworkSecurityGroupPropagationDetails)
Propagation details for the attached Network Security Group
-
id
string <uuid>
The VPC or Instance ID
-
detailedStatus
string
Enum:"None""Partial""Full""Unknown""Error"
status
string (NetworkSecurityGroupPropagationStatus)
Enum:"Synchronizing""Synchronized""Error"
Status values for Network Security Group propagation
-
details
string or null
unpropagatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
relatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
networkSecurityGroupInherited
boolean
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)
Deprecation notices for fields returned by this propagation detail
+
networkSecurityGroupInherited
boolean
Indicates if the Network Security Group is inherited from VPC
-
controllerInstanceId
string or null <uuid>
ipxeScript
string or null
alwaysBootWithCustomIpxe
boolean
controllerInstanceId
string or null <uuid>
ID of the Instance in Site Controller
+
ipxeScript
string or null
Attribute which is inherited from Operating System
+
alwaysBootWithCustomIpxe
boolean
Indicates whether the Instance should always execute custom iPXE script when rebooting
-
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for Instance
-
userData
string or null
object (Labels) <= 10 properties
property name*
additional property
string
isUpdatePending
boolean
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for the Instance
+
userData
string or null
UserData is inherited from Operating System or specified by user if allowed
+
object (Labels) <= 10 properties
User-specified Instance labels
+
property name*
additional property
string
isUpdatePending
boolean
Indicates whether an update is available for the Instance. Updates can be applied on reboot
serialConsoleUrl
string or null
Serial Console URL for the Instance. Format: ssh://@siteSerialConsoleHostname
autoNetwork
boolean
True when this Instance uses NICo auto-resolved networking from the host's underlay (HostInband) network segments. When true, the caller's request interfaces list was empty, this interfaces field remains empty on readback, and the resolved per-interface details surface under status.network.interfaces.
-
Array of objects (Interface)
Array
id
string <uuid> non-empty
instanceId
string <uuid>
subnetId
string or null <uuid>
vpcPrefixId
string or null <uuid>
isPhysical
boolean
device
string or null
Array of objects (Interface)
Interfaces are list of the subnet associated with the Instance
+
Array
id
string <uuid> non-empty
Unique UUID v4 identifier for the Interface
+
instanceId
string <uuid>
ID of the associated Instance
+
subnetId
string or null <uuid>
ID of the associated Subnet
+
vpcPrefixId
string or null <uuid>
ID of the associated VPCPrefix
+
isPhysical
boolean
IsPhysical indicates whether the Subnet is bound on a physical Interface
+
device
string or null
Name of the device to use
deviceInstance
integer or null
Index of the device, used to identify which interface card to attache the Partition to
virtualFunctionId
integer or null
Must be specified if isPhysical is false
-
macAddress
string or null
ipAddresses
Array of strings
macAddress
string or null
MAC address of the Interface
+
ipAddresses
Array of strings
A list of IPv4 or IPv6 addresses
requestedIpAddress
string or null
Explicitly requested IP address for the interface. This is only used for VPC Prefix-based interfaces and is not valid for Subnet-based interfaces. The least-significant host bit must be 1.
InterfaceInlineRoutingProfile (object) or null
Inline interface-local routing profile options. Only valid for VPC Prefix-based interfaces.
"message": "The Instance successfully completed boot",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
],
"deprecations": [
{
"attribute": "sshkeygroups",
"replacedBy": "sshKeyGroups",
"takeActionBy": "2025-09-04T00:00:00Z",
"notice": "'sshkeygroups' is being deprecated in favor of 'sshKeyGroups'. Please take action prior to the specified date."
}
],
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
]
Create an Instance
Create an Instance for Tenant.
Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.
@@ -6076,15 +7532,23 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Can only be specified if allowOverride is set to true in Operating System
operatingSystemId
string or null <uuid>
Must be specified if iPXE Script field is empty
-
networkSecurityGroupId
string or null
ipxeScript
string or null
networkSecurityGroupId
string or null
ID of the desired Network Security Group to attach to the Instance
+
ipxeScript
string or null
Override iPXE script specified in OS, must be specified if Operating System is not specified
alwaysBootWithCustomIpxe
boolean
When set to true, the iPXE script specified by OS or overridden here will always be run when rebooting the Instance. OS must be of iPXE type.
phoneHomeEnabled
boolean
When set to true, the Instance will be enabled with the Phone Home service.
-
object (Labels) <= 10 properties
property name*
additional property
string
Array of objects (InterfaceCreateRequest)
object (Labels) <= 10 properties
User-defined key-value labels
+
property name*
additional property
string
Array of objects (InterfaceCreateRequest)
At least one interface must be specified unless autoNetwork is true. Either Subnet or VPC Prefix interfaces allowed. Only one of the Subnets or VPC Prefixes can be attached over Physical interface. If only one Subnet is specified, then it will be attached over physical interface regardless of the value of isPhysical. In case of VPC Prefix, isPhysical will always be true. Mutually exclusive with autoNetwork: when autoNetwork is true this list MUST be empty.
-
Array
subnetId
string <uuid>
vpcPrefixId
string <uuid>
ipAddress
string or null
Array
subnetId
string <uuid>
ID of the Subnet to attach to the Interface
+
vpcPrefixId
string <uuid>
ID of the VPC Prefix to attach to the Interface
+
ipAddress
string or null
Explicitly requested IP address for the interface. It cannot be specified for Subnet-based interfaces. The least-significant host bit must be 1.
InterfaceInlineRoutingProfile (object) or null
Inline interface-local routing profile options. It cannot be specified for Subnet-based interfaces.
@@ -6120,7 +7584,7 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Version of the DPU Extension Service to deploy
Array of objects (NVLinkInterfaceCreateOrUpdateRequest)
Define Interfaces to associate Instance GPUs with NVLink Logical Partitions. A subset of GPUs may be specified (it is not required to include all GPUs). Each item references one GPU index (deviceInstance) and one NVLink Logical Partition. Different interfaces may reference different NVLink Logical Partitions.
-
Array
nvLinklogicalPartitionId
string <uuid>
Array
nvLinkLogicalPartitionId
string <uuid>
ID of the NVLink Logical Partition the Interface should attach to
deviceInstance
integer >= 0
GPU index for this NVLink interface. Must be non-negative, unique within the request, and within the GPU count exposed by the selected Machine or Instance Type.
@@ -6142,49 +7606,131 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
ID of the Infrastructure Provider that owns the Site where the Instance is located
siteId
string <uuid>
ID of the Site where the Instance is located
-
instanceTypeId
string or null <uuid>
vpcId
string <uuid>
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
instanceTypeId
string or null <uuid>
ID of the Instance Type
+
vpcId
string <uuid>
ID of the VPC
+
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
IDs of VPCs attached to the Instance through non-primary interfaces
-
machineId
string or null
operatingSystemId
string or null <uuid>
networkSecurityGroupId
string or null
object (NetworkSecurityGroupPropagationDetails)
machineId
string or null
ID of the Machine
+
operatingSystemId
string or null <uuid>
ID of the Operating System
+
networkSecurityGroupId
string or null
ID of the attached Network Security Group, if any
+
object (NetworkSecurityGroupPropagationDetails)
Propagation details for the attached Network Security Group
-
id
string <uuid>
The VPC or Instance ID
-
detailedStatus
string
Enum:"None""Partial""Full""Unknown""Error"
status
string (NetworkSecurityGroupPropagationStatus)
Enum:"Synchronizing""Synchronized""Error"
Status values for Network Security Group propagation
-
details
string or null
unpropagatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
relatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
networkSecurityGroupInherited
boolean
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)
Deprecation notices for fields returned by this propagation detail
+
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
+
networkSecurityGroupInherited
boolean
Indicates if the Network Security Group is inherited from VPC
-
controllerInstanceId
string or null <uuid>
ipxeScript
string or null
alwaysBootWithCustomIpxe
boolean
controllerInstanceId
string or null <uuid>
ID of the Instance in Site Controller
+
ipxeScript
string or null
Attribute which is inherited from Operating System
+
alwaysBootWithCustomIpxe
boolean
Indicates whether the Instance should always execute custom iPXE script when rebooting
-
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for Instance
-
userData
string or null
object (Labels) <= 10 properties
property name*
additional property
string
isUpdatePending
boolean
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for the Instance
+
userData
string or null
UserData is inherited from Operating System or specified by user if allowed
+
object (Labels) <= 10 properties
User-specified Instance labels
+
property name*
additional property
string
isUpdatePending
boolean
Indicates whether an update is available for the Instance. Updates can be applied on reboot
serialConsoleUrl
string or null
Serial Console URL for the Instance. Format: ssh://@siteSerialConsoleHostname
autoNetwork
boolean
True when this Instance uses NICo auto-resolved networking from the host's underlay (HostInband) network segments. When true, the caller's request interfaces list was empty, this interfaces field remains empty on readback, and the resolved per-interface details surface under status.network.interfaces.
-
Array of objects (Interface)
Array
id
string <uuid> non-empty
instanceId
string <uuid>
subnetId
string or null <uuid>
vpcPrefixId
string or null <uuid>
isPhysical
boolean
device
string or null
Array of objects (Interface)
Interfaces are list of the subnet associated with the Instance
+
Array
id
string <uuid> non-empty
Unique UUID v4 identifier for the Interface
+
instanceId
string <uuid>
ID of the associated Instance
+
subnetId
string or null <uuid>
ID of the associated Subnet
+
vpcPrefixId
string or null <uuid>
ID of the associated VPCPrefix
+
isPhysical
boolean
IsPhysical indicates whether the Subnet is bound on a physical Interface
+
device
string or null
Name of the device to use
deviceInstance
integer or null
Index of the device, used to identify which interface card to attache the Partition to
virtualFunctionId
integer or null
Must be specified if isPhysical is false
-
macAddress
string or null
ipAddresses
Array of strings
macAddress
string or null
MAC address of the Interface
+
ipAddresses
Array of strings
A list of IPv4 or IPv6 addresses
requestedIpAddress
string or null
Explicitly requested IP address for the interface. This is only used for VPC Prefix-based interfaces and is not valid for Subnet-based interfaces. The least-significant host bit must be 1.
InterfaceInlineRoutingProfile (object) or null
Inline interface-local routing profile options. Only valid for VPC Prefix-based interfaces.
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)
Deprecation notices for fields returned by this resource
+
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.
@@ -6248,11 +7812,15 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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>
ISO datetime string for when the deprecated field will no longer be accepted or available in the API
+
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>
updated
string <date-time>
created
string <date-time>
Date/time when the Instance was created
+
updated
string <date-time>
Date/time when the Instance was last updated
+
phoneHomeEnabled
boolean
When set to true, the Instances will be enabled with the Phone Home service.
-
object (Labels) <= 10 properties
property name*
additional property
string
Array of objects (InterfaceCreateRequest)
object (Labels) <= 10 properties
Key-value objects to be applied to all instances (shared across all instances)
+
property name*
additional property
string
Array of objects (InterfaceCreateRequest)
Interface configuration shared across all instances. At least one interface must be specified unless autoNetwork is true. Either Subnet or VPC Prefix interfaces allowed, only one of the Subnets or VPC Prefixes can be attached over Physical interface. Interface ipAddress is not supported for batch instance creation requests. Mutually exclusive with autoNetwork: when autoNetwork is true this list MUST be empty.
-
Array
subnetId
string <uuid>
vpcPrefixId
string <uuid>
ipAddress
string or null
Array
subnetId
string <uuid>
ID of the Subnet to attach to the Interface
+
vpcPrefixId
string <uuid>
ID of the VPC Prefix to attach to the Interface
+
ipAddress
string or null
Explicitly requested IP address for the interface. It cannot be specified for Subnet-based interfaces. The least-significant host bit must be 1.
InterfaceInlineRoutingProfile (object) or null
Inline interface-local routing profile options. It cannot be specified for Subnet-based interfaces.
@@ -6336,7 +7910,7 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Version of the DPU Extension Service to deploy
Array of objects (NVLinkInterfaceCreateOrUpdateRequest)
NVLink interface configuration shared across all instances. A subset of GPUs may be specified. Each item references one GPU index (deviceInstance) and one NVLink Logical Partition. Different interfaces may reference different NVLink Logical Partitions.
-
Array
nvLinklogicalPartitionId
string <uuid>
Array
nvLinkLogicalPartitionId
string <uuid>
ID of the NVLink Logical Partition the Interface should attach to
deviceInstance
integer >= 0
GPU index for this NVLink interface. Must be non-negative, unique within the request, and within the GPU count exposed by the selected Machine or Instance Type.
@@ -6358,49 +7932,119 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
ID of the Infrastructure Provider that owns the Site where the Instance is located
siteId
string <uuid>
ID of the Site where the Instance is located
-
instanceTypeId
string or null <uuid>
vpcId
string <uuid>
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
instanceTypeId
string or null <uuid>
ID of the Instance Type
+
vpcId
string <uuid>
ID of the VPC
+
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
IDs of VPCs attached to the Instance through non-primary interfaces
-
machineId
string or null
operatingSystemId
string or null <uuid>
networkSecurityGroupId
string or null
object (NetworkSecurityGroupPropagationDetails)
machineId
string or null
ID of the Machine
+
operatingSystemId
string or null <uuid>
ID of the Operating System
+
networkSecurityGroupId
string or null
ID of the attached Network Security Group, if any
+
object (NetworkSecurityGroupPropagationDetails)
Propagation details for the attached Network Security Group
-
id
string <uuid>
The VPC or Instance ID
-
detailedStatus
string
Enum:"None""Partial""Full""Unknown""Error"
status
string (NetworkSecurityGroupPropagationStatus)
Enum:"Synchronizing""Synchronized""Error"
Status values for Network Security Group propagation
-
details
string or null
unpropagatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
relatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
networkSecurityGroupInherited
boolean
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)
Deprecation notices for fields returned by this propagation detail
+
networkSecurityGroupInherited
boolean
Indicates if the Network Security Group is inherited from VPC
-
controllerInstanceId
string or null <uuid>
ipxeScript
string or null
alwaysBootWithCustomIpxe
boolean
controllerInstanceId
string or null <uuid>
ID of the Instance in Site Controller
+
ipxeScript
string or null
Attribute which is inherited from Operating System
+
alwaysBootWithCustomIpxe
boolean
Indicates whether the Instance should always execute custom iPXE script when rebooting
-
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for Instance
-
userData
string or null
object (Labels) <= 10 properties
property name*
additional property
string
isUpdatePending
boolean
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for the Instance
+
userData
string or null
UserData is inherited from Operating System or specified by user if allowed
+
object (Labels) <= 10 properties
User-specified Instance labels
+
property name*
additional property
string
isUpdatePending
boolean
Indicates whether an update is available for the Instance. Updates can be applied on reboot
serialConsoleUrl
string or null
Serial Console URL for the Instance. Format: ssh://@siteSerialConsoleHostname
autoNetwork
boolean
True when this Instance uses NICo auto-resolved networking from the host's underlay (HostInband) network segments. When true, the caller's request interfaces list was empty, this interfaces field remains empty on readback, and the resolved per-interface details surface under status.network.interfaces.
-
Array of objects (Interface)
Array
id
string <uuid> non-empty
instanceId
string <uuid>
subnetId
string or null <uuid>
vpcPrefixId
string or null <uuid>
isPhysical
boolean
device
string or null
Array of objects (Interface)
Interfaces are list of the subnet associated with the Instance
+
Array
id
string <uuid> non-empty
Unique UUID v4 identifier for the Interface
+
instanceId
string <uuid>
ID of the associated Instance
+
subnetId
string or null <uuid>
ID of the associated Subnet
+
vpcPrefixId
string or null <uuid>
ID of the associated VPCPrefix
+
isPhysical
boolean
IsPhysical indicates whether the Subnet is bound on a physical Interface
+
device
string or null
Name of the device to use
deviceInstance
integer or null
Index of the device, used to identify which interface card to attache the Partition to
virtualFunctionId
integer or null
Must be specified if isPhysical is false
-
macAddress
string or null
ipAddresses
Array of strings
macAddress
string or null
MAC address of the Interface
+
ipAddresses
Array of strings
A list of IPv4 or IPv6 addresses
requestedIpAddress
string or null
Explicitly requested IP address for the interface. This is only used for VPC Prefix-based interfaces and is not valid for Subnet-based interfaces. The least-significant host bit must be 1.
InterfaceInlineRoutingProfile (object) or null
Inline interface-local routing profile options. Only valid for VPC Prefix-based interfaces.
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)
Deprecation notices for fields returned by this resource
+
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.
@@ -6464,11 +8126,15 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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>
ISO datetime string for when the deprecated field will no longer be accepted or available in the API
+
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>
updated
string <date-time>
created
string <date-time>
Date/time when the Instance was created
+
updated
string <date-time>
Date/time when the Instance was last updated
+
siteId
string <uuid>
ID of the Site where the Instance is located
-
instanceTypeId
string or null <uuid>
vpcId
string <uuid>
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
instanceTypeId
string or null <uuid>
ID of the Instance Type
+
vpcId
string <uuid>
ID of the VPC
+
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
IDs of VPCs attached to the Instance through non-primary interfaces
-
machineId
string or null
operatingSystemId
string or null <uuid>
networkSecurityGroupId
string or null
object (NetworkSecurityGroupPropagationDetails)
machineId
string or null
ID of the Machine
+
operatingSystemId
string or null <uuid>
ID of the Operating System
+
networkSecurityGroupId
string or null
ID of the attached Network Security Group, if any
+
object (NetworkSecurityGroupPropagationDetails)
Propagation details for the attached Network Security Group
-
id
string <uuid>
The VPC or Instance ID
-
detailedStatus
string
Enum:"None""Partial""Full""Unknown""Error"
status
string (NetworkSecurityGroupPropagationStatus)
Enum:"Synchronizing""Synchronized""Error"
Status values for Network Security Group propagation
-
details
string or null
unpropagatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
relatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
networkSecurityGroupInherited
boolean
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)
Deprecation notices for fields returned by this propagation detail
+
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
+
networkSecurityGroupInherited
boolean
Indicates if the Network Security Group is inherited from VPC
-
controllerInstanceId
string or null <uuid>
ipxeScript
string or null
alwaysBootWithCustomIpxe
boolean
controllerInstanceId
string or null <uuid>
ID of the Instance in Site Controller
+
ipxeScript
string or null
Attribute which is inherited from Operating System
+
alwaysBootWithCustomIpxe
boolean
Indicates whether the Instance should always execute custom iPXE script when rebooting
-
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for Instance
-
userData
string or null
object (Labels) <= 10 properties
property name*
additional property
string
isUpdatePending
boolean
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for the Instance
+
userData
string or null
UserData is inherited from Operating System or specified by user if allowed
+
object (Labels) <= 10 properties
User-specified Instance labels
+
property name*
additional property
string
isUpdatePending
boolean
Indicates whether an update is available for the Instance. Updates can be applied on reboot
serialConsoleUrl
string or null
Serial Console URL for the Instance. Format: ssh://@siteSerialConsoleHostname
autoNetwork
boolean
True when this Instance uses NICo auto-resolved networking from the host's underlay (HostInband) network segments. When true, the caller's request interfaces list was empty, this interfaces field remains empty on readback, and the resolved per-interface details surface under status.network.interfaces.
-
Array of objects (Interface)
Array
id
string <uuid> non-empty
instanceId
string <uuid>
subnetId
string or null <uuid>
vpcPrefixId
string or null <uuid>
isPhysical
boolean
device
string or null
Array of objects (Interface)
Interfaces are list of the subnet associated with the Instance
+
Array
id
string <uuid> non-empty
Unique UUID v4 identifier for the Interface
+
instanceId
string <uuid>
ID of the associated Instance
+
subnetId
string or null <uuid>
ID of the associated Subnet
+
vpcPrefixId
string or null <uuid>
ID of the associated VPCPrefix
+
isPhysical
boolean
IsPhysical indicates whether the Subnet is bound on a physical Interface
+
device
string or null
Name of the device to use
deviceInstance
integer or null
Index of the device, used to identify which interface card to attache the Partition to
virtualFunctionId
integer or null
Must be specified if isPhysical is false
-
macAddress
string or null
ipAddresses
Array of strings
macAddress
string or null
MAC address of the Interface
+
ipAddresses
Array of strings
A list of IPv4 or IPv6 addresses
requestedIpAddress
string or null
Explicitly requested IP address for the interface. This is only used for VPC Prefix-based interfaces and is not valid for Subnet-based interfaces. The least-significant host bit must be 1.
InterfaceInlineRoutingProfile (object) or null
Inline interface-local routing profile options. Only valid for VPC Prefix-based interfaces.
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)
Deprecation notices for fields returned by this resource
+
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.
@@ -6604,11 +8370,15 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
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>
ISO datetime string for when the deprecated field will no longer be accepted or available in the API
+
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>
updated
string <date-time>
created
string <date-time>
Date/time when the Instance was created
+
updated
string <date-time>
Date/time when the Instance was last updated
+
Kubernetes Cluster
@@ -6654,27 +8424,33 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Trigger power cycle for Instance
rebootWithCustomIpxe
boolean or null
When specified along with triggerReboot, the Instance will boot using the custom iPXE specified by OS. If Instance has alwaysBootWithCustomIpxe flag set then this value will be ignored.
-
applyUpdatesOnReboot
boolean or null
When specified, any updates pending for the Instance e.g. DPU reprovisioning, will be applied on reboot
+
applyUpdatesOnReboot
boolean or null
When specified, pending Instance updates such as DPU reprovisioning are applied on reboot
operatingSystemId
string or null
The UUID of the desired operating system.
ipxeScript
string or null
The iPXE script content to be used for booting.
sshKeyGroupIds
Array of strings <uuid> [ items <uuid > ]
Specify a new list of SSH Key Group IDs that will provide Serial over LAN and SSH access. This will overwrite an existing list.
-
networkSecurityGroupId
string or null
userData
string or null
networkSecurityGroupId
string or null
ID of the Network Security Group to attach to the Instance
+
userData
string or null
Any user-data to be sent to the booting OS. For example, cloud-init data.
alwaysBootWithCustomIpxe
boolean or null
Whether the custom iPXE data should be used for every boot.
-
phoneHomeEnabled
boolean or null
Indicates whether the Phone Home service should be enabled or disabled for Instance
-
object (Labels) <= 10 properties
Update labels of the Instance. The labels will be entirely replaced by those sent in the request. Any labels not included in the request will be removed. To retain existing labels, first fetch them and include them along with this request.
+
phoneHomeEnabled
boolean or null
Indicates whether the Phone Home service should be enabled or disabled for the Instance
+
object (Labels) <= 10 properties
Update labels of the Instance. 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
secondaryVpcIds
Array of strings <uuid> unique [ items <uuid > ]
IDs of additional VPCs the Instance should attach to through non-primary interfaces. This field may only be specified when every entry in interfaces uses vpcPrefixId. IDs must be unique, must be valid UUIDs, and must not include the primary vpcId.
Array of objects (InterfaceCreateRequest)
Update Interfaces of the Instance. Mutually exclusive with autoNetwork: when autoNetwork is true this list MUST be empty.
-
Array
subnetId
string <uuid>
vpcPrefixId
string <uuid>
ipAddress
string or null
Array
subnetId
string <uuid>
ID of the Subnet to attach to the Interface
+
vpcPrefixId
string <uuid>
ID of the VPC Prefix to attach to the Interface
+
ipAddress
string or null
Explicitly requested IP address for the interface. It cannot be specified for Subnet-based interfaces. The least-significant host bit must be 1.
InterfaceInlineRoutingProfile (object) or null
Inline interface-local routing profile options. It cannot be specified for Subnet-based interfaces.
@@ -6702,9 +8478,9 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Specifies whether this Partition should be attached to the Instance over physical interface
virtualFunctionId
integer or null
Must be specified if isPhysical is false
-
Array of objects (NVLinkInterfaceCreateOrUpdateRequest)
Update NVLink Interfaces of the Instance. A subset of GPUs may be specified. Each item references a GPU index (deviceInstance) and an NVLink Logical Partition. Different interfaces may reference different NVLink Logical Partitions. Partial updates are not allowed, specified interfaces will delete or replace existing Interfaces. Updating is not allowed if Instance's VPC has nvLinkLogicalPartitionId attribute set.
-
Array
nvLinklogicalPartitionId
string <uuid>
Array of objects (NVLinkInterfaceCreateOrUpdateRequest)
Update NVLink Interfaces of the Instance. A subset of GPUs may be specified. Each item references a GPU index (deviceInstance) and an NVLink Logical Partition. Different interfaces may reference different NVLink Logical Partitions. Partial updates are not allowed; specified interfaces will delete or replace existing Interfaces. Updating is not allowed if the Instance's VPC has the nvLinkLogicalPartitionId attribute set.
+
Array
nvLinkLogicalPartitionId
string <uuid>
ID of the NVLink Logical Partition the Interface should attach to
deviceInstance
integer >= 0
GPU index for this NVLink interface. Must be non-negative, unique within the request, and within the GPU count exposed by the selected Machine or Instance Type.
@@ -6728,49 +8504,131 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
ID of the Infrastructure Provider that owns the Site where the Instance is located
siteId
string <uuid>
ID of the Site where the Instance is located
-
instanceTypeId
string or null <uuid>
vpcId
string <uuid>
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
instanceTypeId
string or null <uuid>
ID of the Instance Type
+
vpcId
string <uuid>
ID of the VPC
+
secondaryVpcIds
Array of strings <uuid> [ items <uuid > ]
IDs of VPCs attached to the Instance through non-primary interfaces
-
machineId
string or null
operatingSystemId
string or null <uuid>
networkSecurityGroupId
string or null
object (NetworkSecurityGroupPropagationDetails)
machineId
string or null
ID of the Machine
+
operatingSystemId
string or null <uuid>
ID of the Operating System
+
networkSecurityGroupId
string or null
ID of the attached Network Security Group, if any
+
object (NetworkSecurityGroupPropagationDetails)
Propagation details for the attached Network Security Group
-
id
string <uuid>
The VPC or Instance ID
-
detailedStatus
string
Enum:"None""Partial""Full""Unknown""Error"
status
string (NetworkSecurityGroupPropagationStatus)
Enum:"Synchronizing""Synchronized""Error"
Status values for Network Security Group propagation
-
details
string or null
unpropagatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
relatedInstanceIds
Array of strings <uuid> [ items <uuid > ]
networkSecurityGroupInherited
boolean
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)
Deprecation notices for fields returned by this propagation detail
+
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
+
networkSecurityGroupInherited
boolean
Indicates if the Network Security Group is inherited from VPC
-
controllerInstanceId
string or null <uuid>
ipxeScript
string or null
alwaysBootWithCustomIpxe
boolean
controllerInstanceId
string or null <uuid>
ID of the Instance in Site Controller
+
ipxeScript
string or null
Attribute which is inherited from Operating System
+
alwaysBootWithCustomIpxe
boolean
Indicates whether the Instance should always execute custom iPXE script when rebooting
-
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for Instance
-
userData
string or null
object (Labels) <= 10 properties
property name*
additional property
string
isUpdatePending
boolean
phoneHomeEnabled
boolean
Indicates whether the Phone Home service should be enabled or disabled for the Instance
+
userData
string or null
UserData is inherited from Operating System or specified by user if allowed
+
object (Labels) <= 10 properties
User-specified Instance labels
+
property name*
additional property
string
isUpdatePending
boolean
Indicates whether an update is available for the Instance. Updates can be applied on reboot
serialConsoleUrl
string or null
Serial Console URL for the Instance. Format: ssh://@siteSerialConsoleHostname
autoNetwork
boolean
True when this Instance uses NICo auto-resolved networking from the host's underlay (HostInband) network segments. When true, the caller's request interfaces list was empty, this interfaces field remains empty on readback, and the resolved per-interface details surface under status.network.interfaces.
-
Array of objects (Interface)
Array
id
string <uuid> non-empty
instanceId
string <uuid>
subnetId
string or null <uuid>
vpcPrefixId
string or null <uuid>
isPhysical
boolean
device
string or null
Array of objects (Interface)
Interfaces are list of the subnet associated with the Instance
+
Array
id
string <uuid> non-empty
Unique UUID v4 identifier for the Interface
+
instanceId
string <uuid>
ID of the associated Instance
+
subnetId
string or null <uuid>
ID of the associated Subnet
+
vpcPrefixId
string or null <uuid>
ID of the associated VPCPrefix
+
isPhysical
boolean
IsPhysical indicates whether the Subnet is bound on a physical Interface
+
device
string or null
Name of the device to use
deviceInstance
integer or null
Index of the device, used to identify which interface card to attache the Partition to
virtualFunctionId
integer or null
Must be specified if isPhysical is false
-
macAddress
string or null
ipAddresses
Array of strings
macAddress
string or null
MAC address of the Interface
+
ipAddresses
Array of strings
A list of IPv4 or IPv6 addresses
requestedIpAddress
string or null
Explicitly requested IP address for the interface. This is only used for VPC Prefix-based interfaces and is not valid for Subnet-based interfaces. The least-significant host bit must be 1.
InterfaceInlineRoutingProfile (object) or null
Inline interface-local routing profile options. Only valid for VPC Prefix-based interfaces.
IsPhysical indicates whether the Subnet is bound on a physical Interface
+
device
string or null
Name of the device to use
deviceInstance
integer or null
Index of the device, used to identify which interface card to attache the Partition to
virtualFunctionId
integer or null
Must be specified if isPhysical is false
-
macAddress
string or null
ipAddresses
Array of strings
macAddress
string or null
MAC address of the Interface
+
ipAddresses
Array of strings
A list of IPv4 or IPv6 addresses
requestedIpAddress
string or null
Explicitly requested IP address for the interface. This is only used for VPC Prefix-based interfaces and is not valid for Subnet-based interfaces. The least-significant host bit must be 1.
@@ -6902,9 +8802,13 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Inline interface-local routing profile options. Only valid for VPC Prefix-based interfaces.
One of
allowedAnycastPrefixes
Array of strings
Default: []
CIDR prefixes this interface is allowed to announce as anycast routes.
Indicates whether the machine is usable by or currently in use by a tenant.
-
Array of objects (StatusDetail)
Array
status
string
message
string or null
created
string <date-time>
updated
string <date-time>
created
string <date-time>
updated
string <date-time>
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 Machine was created
+
updated
string <date-time>
Date/time when the Machine was last updated
+
Kubernetes Cluster
@@ -7220,17 +9332,19 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Optional message describing the reason for moving Machine into maintenance mode. Can be updated by Provider or Privileged Tenant.
object (Labels) <= 10 properties
Machine labels will be overwritten, include existing labels to preserve them. Can be updated by Provider or Privileged Tenant.
-
property name*
additional property
string
object (MachineOnlineRepair)
Enable or disable online repair of a Machine. Online repair facilitates repairing a Machine without the Tenant having to release the Machine by deleting the Instance. When enabled is true, policy and acknowledgments are required inside this object,
-and healthIssue is required at the top level of the MachineUpdateRequest. When enabled is false, none of those fields may be set.
+
property name*
additional property
string
object (MachineOnlineRepair)
Request to enter/exit online repair
enabled
required
boolean
When true, initiates the online repair process by sending a merge-mode health override with source: request-online-repair and sets the associated Instance status to Repairing.
When false, exits online repair by clearing the merge-mode health override and returns the Instance to Ready status. Cannot be combined with instance type, maintenance, or label updates in the same request.
-
object (MachineOnlineRepairPolicy)
allowAutoInstanceDeletionOnFailure
required
boolean
object (MachineOnlineRepairPolicy)
Online repair policy to apply to the Machine
+
allowAutoInstanceDeletionOnFailure
required
boolean
When true, escalation to offline breakfix (permanent delete / deallocate) is allowed if online repair cannot be completed.
-
object (MachineOnlineRepairAcknowledgments)
acceptDataCorruptionRisk
required
boolean
Value:true
object (MachineOnlineRepairAcknowledgments)
Acknowledgments required before online repair can proceed
+
acceptDataCorruptionRisk
required
boolean
Value:true
Tenant confirms data may be corrupted during repair.
acceptRepairTeamAccess
required
boolean
Value:true
Tenant confirms the dedicated repair team will have access to the instance.
@@ -7270,7 +9384,9 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Product name of the Machine
serialNumber
string or null
Serial number of the Machine, only visible to Provider
Machines that have been assigned to an instance type
-
total
integer
initializing
integer
ready
integer
inUse
integer
error
integer
maintenance
integer
unknown
integer
object (MachineStatusBreakdown)
total
integer
Total number of machines in this group
+
initializing
integer
Number of machines being initialized
+
ready
integer
Number of machines in ready state
+
inUse
integer
Number of machines currently in use
+
error
integer
Number of machines in error state
+
maintenance
integer
Number of machines in maintenance state
+
unknown
integer
Number of machines in unknown state
+
object (MachineStatusBreakdown)
Machines that have not been assigned to any instance type
-
total
integer
initializing
integer
ready
integer
inUse
integer
error
integer
maintenance
integer
unknown
integer
Kubernetes Cluster
@@ -7432,17 +9702,57 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Unique identifier for the InstanceType
name
string
Name of the InstanceType
-
object (MachineStatusBreakdown)
Machine counts broken down by status
-
total
integer
initializing
integer
ready
integer
inUse
integer
error
integer
maintenance
integer
unknown
integer
allocated
integer
object (MachineStatusBreakdown)
AssignedMachineStats captures the status of all Machines assigned to this Instance Type
+
total
integer
Total number of machines in this group
+
initializing
integer
Number of machines being initialized
+
ready
integer
Number of machines in ready state
+
inUse
integer
Number of machines currently in use
+
error
integer
Number of machines in error state
+
maintenance
integer
Number of machines in maintenance state
+
unknown
integer
Number of machines in unknown state
+
allocated
integer
Number of Machines of this Instance Type allocated to Tenants
maxAllocatable
integer
Number of Ready Machines of this Instance Type available for additional allocation to Tenants
-
object (MachineStatusBreakdown)
Machine counts broken down by status
-
total
integer
initializing
integer
ready
integer
inUse
integer
error
integer
maintenance
integer
unknown
integer
Array of objects (InstanceTypeStats)
Array
id
string <uuid>
name
string
allocated
integer
object (MachineStatusBreakdown)
Machine counts broken down by status
-
maxAllocatable
integer
Array of objects (AllocationStats)
total
integer
Total number of machines in this group
+
initializing
integer
Number of machines being initialized
+
ready
integer
Number of machines in ready state
+
inUse
integer
Number of machines currently in use
+
error
integer
Number of machines in error state
+
maintenance
integer
Number of machines in maintenance state
+
unknown
integer
Number of machines in unknown state
+
Array of objects (InstanceTypeStats)
Per-tenant breakdown for this instance type
+
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
+
Kubernetes Cluster
@@ -7466,8 +9776,8 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Filter Capabilities by Capacity value
vendor
string
Filter Capabilities by Vendor
-
inactiveDevices
string
Filter Capabilities by Inactive Devices value. Since the value is an array, multiple query params should be specified in correct order in order to filter. For example, to filter for [1, 3], specify inactiveDevices=1&inactiveDevices=3
+
inactiveDevices
string
Filter Capabilities by Inactive Devices value. Since the value is an array, multiple query parameters should be specified in the correct order. For example, to filter for [1, 3], specify inactiveDevices=1&inactiveDevices=3
count
string
Filter Capabilities by Count
pageNumber
integer >= 1
Default: 1
Example: pageNumber=1
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Capacity of the Capability component, if applicable
vendor
string or null
Vendor of the Capability component, if available
+
hardwareRevision
string or null
Hardware revision of the Capability component, if available
inactiveDevices
Array of integers
A list of inactive devices
count
integer or null
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Serial number of the Rack
description
string
Description of the Rack
-
object (RackLocation)
Physical location of a Rack
+
object (RackLocation)
Physical or logical location of the Rack
region
string
Region where the rack is located
datacenter
string
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Serial number of the Rack
description
string
Description of the Rack
-
object (RackLocation)
Physical location of a Rack
+
object (RackLocation)
Physical or logical location of the Rack
region
string
Region where the rack is located
datacenter
string
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Flow internal component UUID
componentId
string
Component ID assigned by the component manager service
-
object (RackComponent)
A component within a Rack (e.g. compute node, switch, PDU)
-
object (RackComponent)
A component within a Rack (e.g. compute node, switch, PDU)
+
object (RackComponent)
Expected component value
+
object (RackComponent)
Actual component value reported by the system
Array of objects (FieldDiff)
List of field differences (populated when type is Mismatch)
totalDiffs
integer
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Flow internal component UUID
componentId
string
Component ID assigned by the component manager service
-
object (RackComponent)
A component within a Rack (e.g. compute node, switch, PDU)
-
object (RackComponent)
A component within a Rack (e.g. compute node, switch, PDU)
+
object (RackComponent)
Expected component value
+
object (RackComponent)
Actual component value reported by the system
Array of objects (FieldDiff)
List of field differences (populated when type is Mismatch)
totalDiffs
integer
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Name of the Org
Request Body schema: application/json
required
siteId
required
string <uuid>
ID of the Site
-
object (RackFilter)
Filter criteria for selecting racks in batch operations. If omitted or empty, all racks in the site are targeted.
+
object (RackFilter)
Filter that selects Racks whose power state should be updated
names
Array of strings
Filter racks by name
state
required
string
Enum:"on""off""cycle""forceoff""forcecycle"
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Name of the Org
Request Body schema: application/json
required
siteId
required
string <uuid>
ID of the Site
-
object (RackFilter)
Filter criteria for selecting racks in batch operations. If omitted or empty, all racks in the site are targeted.
+
object (RackFilter)
Filter that selects Racks targeted for firmware update
names
Array of strings
Filter racks by name
version
string or null
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Name of the Org
Request Body schema: application/json
required
siteId
required
string <uuid>
ID of the Site
-
object (RackFilter)
Filter criteria for selecting racks in batch operations. If omitted or empty, all racks in the site are targeted.
+
object (RackFilter)
Filter that selects Racks targeted for bring-up
names
Array of strings
Filter racks by name
description
string
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Firmware version of the tray
powerState
string
Current power state of the tray
-
object (TrayPosition)
Position of a tray within a rack
+
object (TrayPosition)
Position of the Tray within the Rack
slotId
integer
Slot number of the tray in the rack
trayIdx
integer
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Firmware version of the tray
powerState
string
Current power state of the tray
-
object (TrayPosition)
Position of a tray within a rack
+
object (TrayPosition)
Position of the Tray within the Rack
slotId
integer
Slot number of the tray in the rack
trayIdx
integer
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Flow internal component UUID
componentId
string
Component ID assigned by the component manager service
-
object (RackComponent)
A component within a Rack (e.g. compute node, switch, PDU)
-
object (RackComponent)
A component within a Rack (e.g. compute node, switch, PDU)
+
object (RackComponent)
Expected component value
+
object (RackComponent)
Actual component value reported by the system
Array of objects (FieldDiff)
List of field differences (populated when type is Mismatch)
totalDiffs
integer
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Flow internal component UUID
componentId
string
Component ID assigned by the component manager service
-
object (RackComponent)
A component within a Rack (e.g. compute node, switch, PDU)
-
object (RackComponent)
A component within a Rack (e.g. compute node, switch, PDU)
+
object (RackComponent)
Expected component value
+
object (RackComponent)
Actual component value reported by the system
Array of objects (FieldDiff)
List of field differences (populated when type is Mismatch)
totalDiffs
integer
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Name of the Org
Request Body schema: application/json
required
siteId
required
string <uuid>
ID of the Site
-
object (TrayFilter)
Filter criteria for selecting trays in batch operations. If omitted or empty, all trays in the site are targeted.
-
Constraints: rackId and rackName are mutually exclusive. rackId/rackName cannot be combined with ids/componentIds. componentIds requires type. slotId requires rackId or rackName, must be >= 0, and composes with the rest of the filter via AND.
+
object (TrayFilter)
Filter that selects Trays whose power state should be updated
rackId
string <uuid>
Filter by Rack ID
rackName
string
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Name of the Org
Request Body schema: application/json
required
siteId
required
string <uuid>
ID of the Site
-
object (TrayFilter)
Filter criteria for selecting trays in batch operations. If omitted or empty, all trays in the site are targeted.
-
Constraints: rackId and rackName are mutually exclusive. rackId/rackName cannot be combined with ids/componentIds. componentIds requires type. slotId requires rackId or rackName, must be >= 0, and composes with the rest of the filter via AND.
+
object (TrayFilter)
Filter that selects Trays targeted for firmware update
Network Security Group is a security policy that controls the traffic flowing between Instances.
+
Deprecation history:
+
+
object_id attribute on Network Security Group propagation details was deprecated in favor of objectId and will be removed on July 9th, 2026 0:00 UTC. Please use objectId instead.
+
Retrieve all Network Security Groups
Get all Network Security Groups for Tenant
@@ -9164,8 +11480,8 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Filter By Site ID
status
string
Filter Network Security Groups by Status
-
query
string
Search for matches across all Sites. Input will be matched against name, description and status fields
+
query
string
Search for matches across all Network Security Groups. Input will be matched against name, description, and status fields
includeRelation
string
Enum:"Tenant""Site"
Related entity to expand
pageNumber
integer >= 1
Default: 1
Example: pageNumber=1
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB sc-cittYi iNuSsz eBjiEo hynizp">
Egress rules with protocol and destination ports defined but without source ports defined should automatically be made stateful.
-
Array of objects (NetworkSecurityGroupRule)
Update rules of the NetworkSecurityGroup. The rules will be entirely replaced by those sent in the request. Any rules not included in the request will be removed. To retain existing rules, first fetch them and include them.
-
Array
name
string or null
direction
required
string
Enum:"INGRESS""EGRESS"
sourcePortRange
string or null
destinationPortRange
string or null
protocol
required
string
Enum:"TCP""UDP""ICMP""ANY"
action
required
string
Enum:"PERMIT""DENY"
priority
integer
sourcePrefix
required
string
destinationPrefix
required
string
object (Labels) <= 10 properties
property name*
additional property
string
Responses
Array
name
string or null
Name of the Network Security Group rule
+
direction
required
string
Enum:"INGRESS""EGRESS"
Traffic direction the rule applies to
+
sourcePortRange
string or null
Source port or port range matched by the rule
+
destinationPortRange
string or null
Destination port or port range matched by the rule
+
protocol
required
string
Enum:"TCP""UDP""ICMP""ICMP6""ANY"
Network protocol matched by the rule
+
action
required
string
Enum:"PERMIT""DENY"
Action applied when traffic matches the rule
+
priority
integer
Rule priority used to order evaluation
+
sourcePrefix
required
string
Source CIDR prefix matched by the rule
+
destinationPrefix
required
string
Destination CIDR prefix matched by the rule
+
object (Labels) <= 10 properties
User-defined key-value labels for the Network Security Group
User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix. infrastructureProviderId or tenantId query param may be required for older API versions.
+
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>
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Filter IP Blocks by Status
includeUsageStats
boolean
Include IP Block usage stats in response
-
query
string
Search for matches across all Sites. Input will be matched against name, description and status fields
+
query
string
Search for matches across all IP Blocks. 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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB sc-cittYi iNuSsz eBjiEo hynizp">
Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix. Only root IP Blocks can be deleted if there are no allocations associated with it.
+
Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix. Only root IP Blocks can be deleted if there are no allocations associated with them.
Tenant IP Blocks are managed via Allocation.
Authorizations:
JWTBearerToken
path Parameters
org
required
string
Name of the Org
@@ -9500,14 +12172,34 @@
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Name of the Org
ipBlockId
required
string
ID of the IP Block
-
Request Body schema: application/json
name
string or null [ 2 .. 256 ] characters
description
string or null
Responses
query Parameters
status
string
Filter IP Blocks by Status
-
query
string
Search for matches across all Sites. Input will be matched against name, description and status fields
+
query
string
Search for matches across all derived IP Blocks. 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
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB sc-cittYi iNuSsz eBjiEo hynizp">
Metadata describes various system-level attributes of the API service.
Retrieve metadata about the API server
Retrieve system metadata providing information about the API server
Authorizations:
JWTBearerToken
path Parameters
org
required
string
Typical API Call Flow for Tenant
keypair and arm a JWKS overlap window.
Responses
Response Schema: application/json
org
string
enabled
boolean
issuer
string
defaultAudience
string
allowedAudiences
Array of strings
Response Schema: application/json
org
string
Organization that owns the Tenant identity configuration
+
enabled
boolean
Whether Tenant identity token delegation is enabled
+
issuer
string
Issuer URL for Tenant identity tokens
+
defaultAudience
string
Default audience used for Tenant identity tokens
+
allowedAudiences
Array of strings
Typical API Call Flow for Tenant
PUT supplied an empty list, the Core gRPC API substituted
[defaultAudience] before persisting. Issuance rejects audiences
outside this list.
-
tokenTtlSeconds
integer
subjectPrefix
string
tokenTtlSeconds
integer
Lifetime of issued Tenant identity tokens, in seconds
+
subjectPrefix
string
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Set on the inactive (previous) key during the JWKS overlap
window; the Core gRPC API deletes the inactive slot once
now >= expireAt. Null on the current signer.
-
created
string <date-time>
updated
string <date-time>
created
string <date-time>
Date/time when the Tenant identity configuration was created
+
updated
string <date-time>
Date/time when the Tenant identity configuration was last updated
+
Response Schema: application/json
org
string
enabled
boolean
issuer
string
defaultAudience
string
allowedAudiences
Array of strings
Response Schema: application/json
org
string
Organization that owns the Tenant identity configuration
+
enabled
boolean
Whether Tenant identity token delegation is enabled
+
issuer
string
Issuer URL for Tenant identity tokens
+
defaultAudience
string
Default audience used for Tenant identity tokens
+
allowedAudiences
Array of strings
Typical API Call Flow for Tenant
PUT supplied an empty list, the Core gRPC API substituted
[defaultAudience] before persisting. Issuance rejects audiences
outside this list.
-
tokenTtlSeconds
integer
subjectPrefix
string
tokenTtlSeconds
integer
Lifetime of issued Tenant identity tokens, in seconds
+
subjectPrefix
string
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Set on the inactive (previous) key during the JWKS overlap
window; the Core gRPC API deletes the inactive slot once
now >= expireAt. Null on the current signer.
-
created
string <date-time>
updated
string <date-time>
created
string <date-time>
Date/time when the Tenant identity configuration was created
+
updated
string <date-time>
Date/time when the Tenant identity configuration was last updated
+
Responses
Response Schema: application/json
org
string
enabled
boolean
issuer
string
defaultAudience
string
allowedAudiences
Array of strings
Response Schema: application/json
org
string
Organization that owns the Tenant identity configuration
+
enabled
boolean
Whether Tenant identity token delegation is enabled
+
issuer
string
Issuer URL for Tenant identity tokens
+
defaultAudience
string
Default audience used for Tenant identity tokens
+
allowedAudiences
Array of strings
Typical API Call Flow for Tenant
PUT supplied an empty list, the Core gRPC API substituted
[defaultAudience] before persisting. Issuance rejects audiences
outside this list.
-
tokenTtlSeconds
integer
subjectPrefix
string
tokenTtlSeconds
integer
Lifetime of issued Tenant identity tokens, in seconds
+
subjectPrefix
string
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Set on the inactive (previous) key during the JWKS overlap
window; the Core gRPC API deletes the inactive slot once
now >= expireAt. Null on the current signer.
-
created
string <date-time>
updated
string <date-time>
created
string <date-time>
Date/time when the Tenant identity configuration was created
+
updated
string <date-time>
Date/time when the Tenant identity configuration was last updated
+
object (TenantIdentityBasicClientSecretRequest)
Raw OAuth2 client_secret_basic credentials. clientSecret is accepted on input but never returned in responses.
-
clientId
required
string
clientSecret
required
string
object (TenantIdentityBasicClientSecretRequest)
Client-secret basic authentication settings for token delegation
+
clientId
required
string
Client identifier used for basic client-secret authentication
+
clientSecret
required
string
Typical API Call Flow for Tenant
" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">
Audience value placed on the intermediate JWT-SVID posted to the exchange endpoint.
Responses
Response Schema: application/json
tokenEndpoint
string <uri>
object (TenantIdentityBasicClientSecretResponse)
Public half of client_secret_basic credentials. Only the SHA-256 hash of the secret is returned.
-
clientId
string
clientSecretHash
string
Response Schema: application/json
tokenEndpoint
string <uri>
Token endpoint used to exchange delegated Tenant identity tokens
+
object (TenantIdentityBasicClientSecretResponse)
Client-secret basic authentication settings for token delegation
+
clientId
string
Client identifier used for basic client-secret authentication
+
clientSecretHash
string
SHA-256 hash of the raw secret.
-
subjectTokenAudience
string
created
string <date-time>
updated
string <date-time>
created
string <date-time>
Date/time when the token delegation configuration was created
+
updated
string <date-time>
Date/time when the token delegation configuration was last updated
+
Response Schema: application/json
tokenEndpoint
string <uri>
object (TenantIdentityBasicClientSecretResponse)
Public half of client_secret_basic credentials. Only the SHA-256 hash of the secret is returned.
-
clientId
string
clientSecretHash
string
Response Schema: application/json
tokenEndpoint
string <uri>
Token endpoint used to exchange delegated Tenant identity tokens
+
object (TenantIdentityBasicClientSecretResponse)
Client-secret basic authentication settings for token delegation
+
clientId
string
Client identifier used for basic client-secret authentication
+
clientSecretHash
string
SHA-256 hash of the raw secret.
-
subjectTokenAudience
string
created
string <date-time>
updated
string <date-time>
created
string <date-time>
Date/time when the token delegation configuration was created
+
updated
string <date-time>
Date/time when the token delegation configuration was last updated
+
Responses
Response Schema: application/json
tokenEndpoint
string <uri>
object (TenantIdentityBasicClientSecretResponse)
Public half of client_secret_basic credentials. Only the SHA-256 hash of the secret is returned.
-
clientId
string
clientSecretHash
string
Response Schema: application/json
tokenEndpoint
string <uri>
Token endpoint used to exchange delegated Tenant identity tokens
+
object (TenantIdentityBasicClientSecretResponse)
Client-secret basic authentication settings for token delegation
+
clientId
string
Client identifier used for basic client-secret authentication
+
clientSecretHash
string
SHA-256 hash of the raw secret.
-
subjectTokenAudience
string
created
string <date-time>
updated
string <date-time>
created
string <date-time>
Date/time when the token delegation configuration was created
+
updated
string <date-time>
Date/time when the token delegation configuration was last updated