Deprecations

NICo REST API maintains backward compatibility with the previous versions. Any breaking changes are announced using deprecation API objects.

Deprecation API Object

A deprecation API object is a JSON object that contains the details of a particular deprecation in the API. It is used to announce deprecations to clients of the API.

Attribute Deprecation

When an attribute of an API object is being deprecated:

• Each API object that contains the deprecated attribute will include a deprecations attribute containing an array of deprecation API objects
• When an attribute is being deprecated, only the attribute field will be included in the deprecation API object

1
{
2
    "id": "123e4567-e89b-12d3-a456-426614174000",
3
    "org": "example-org",
4
    "displayName": "Example Org", // Deprecated in favor of orgDisplayName
5
    "orgDisplayName": "Example Org",
6
    "status": "Pending",
7
    "deprecations": [
8
        {
9
            "attribute": "displayName",
10
            "replacedBy": "orgDisplayName",
11
            "takeActionBy": "2026-06-08T00:00:00Z",
12
            "notice": "`displayName` has been deprecated in favor of `orgDisplayName`. Please take action prior to the specified date"
13
        }
14
    ]
15
}

Endpoint Deprecation

When an API endpoint is being deprecated:

• Each API endpoint will include a deprecations attribute containing an array of deprecation API objects
• When an endpoint is being deprecated, only the endpoint field will be included in the deprecation API object

1
{
2
    "id": "123e4567-e89b-12d3-a456-426614174000",
3
    "name": "example-endpoint-resource",
4
    "description": "Example endpoint resource",
5
    "status": "Pending",
6
    "deprecations": [
7
        {
8
            "endpoint": "POST /org/:orgName/nico/resource/example",
9
            "takeActionBy": "2026-06-08T00:00:00Z",
10
            "notice": "`POST /org/:orgName/nico/resource/example` has been deprecated. Please take action prior to the specified date"
11
        }
12
    ]
13
}

If a deprecated attribute/endpoint or query param has no replacement, the replacedBy field will be omitted from the response.

Query Param Deprecation

When a query param is being deprecated:

• Each API endpoint that accepts the query param will include a deprecations attribute containing an array of deprecation API objects
• When a query param is being deprecated, only the queryParam field will be included in the deprecation API object

1
{
2
    "id": "123e4567-e89b-12d3-a456-426614174000",
3
    "name": "example-endpoint-resource",
4
    "description": "Example endpoint resource",
5
    "status": "Pending",
6
    "deprecations": [
7
        {
8
            "queryParam": "includeUsageStats",
9
            "replacedBy": "includeUsage",
10
            "takeActionBy": "2026-06-08T00:00:00Z",
11
            "notice": "`includeUsageStats` has been deprecated in favor of `includeUsage`. Please take action prior to the specified date"
12
        }
13
    ]
14
}

Guidance for Users

If the deprecated item is an attribute that belongs to a request object used for create/update API endpoints:

• If a new attribute is introduced, either the new or deprecated attribute can be specified in request until expiry date
• If both new and deprecated attributes are specified in request data at the same time, an HTTP 400 response is returned informing preference for the new attribute
• Once the take action by date has passed and the deprecated attribute is included in create/update request, an HTTP 400 response is returned informing that the attribute has been deprecated

Deprecation notices continue to be returned for one more release cycle after the take action by date.

Active Deprecations

Endpoints that have deprecations will be grouped here. Following deprecations are in effect:

Operating System

• isCloudInit on create and update requests is deprecated and ignored. The value returned in API responses is derived from whether userData is non-empty.

Tenant Account

• accountNumber, subscriptionId, and subscriptionTier attributes were deprecated and will be removed on September 10th, 2026 0:00 UTC. Please update your usage accordingly.

Allocation

• ResourceTypeID attribute on Allocation Constraint was deprecated in favor of resourceTypeId and will be removed on September 10th, 2026 0:00 UTC. Please use resourceTypeId instead.

Instance Type

• id attribute on Machine Instance Type association was deprecated in favor of machineId and will be removed on September 10th, 2026 0:00 UTC. Please use machineId instead.

NVLink Logical Partition

• nvLinklogicalPartitionId attribute on NVLink Interface was deprecated in favor of nvLinkLogicalPartitionId and will be removed on September 10th, 2026 0:00 UTC. Please use nvLinkLogicalPartitionId instead.

Network Security Group

• object_id attribute on Network Security Group propagation details was deprecated in favor of objectId and will be removed on September 10th, 2026 0:00 UTC. Please use objectId instead.

Instance

• infrastructureProviderId query parameter on the list Instances endpoint was deprecated and will be removed on October 10th, 2026 0:00 UTC. Instances will no longer be filtered by Infrastructure Provider; results are scoped to the org’s Tenant. Use the siteId parameter to scope results to a specific Infrastructure Provider’s Sites.

Recent Deprecations

Following deprecations were removed from the API in the recent past:

Site

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