Create a Machine/Instance Type association

POST

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/instance/type/:instanceTypeId/machine

POST

/v2/org/:org/nico/instance/type/:instanceTypeId/machine

$ curl -X POST https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/instance/type/instanceTypeId/machine \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "machineIds": [
>     "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
>     "fm100htrh18t1lrjg2pqagkh3sfigr9m65dejvkq168ako07sc0uibpp5q0",
>     "fm100ht68sf2m52idrpslcjkpdj5r3tb3j5o0bkfubhoglbq47u18nknfog"
>   ]
> }'

1 [
2   {
3     "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
4     "instanceTypeId": "41e36058-8403-4086-a9b8-39cb5bc9cb98",
5     "created": "2019-08-24T14:15:22Z",
6     "updated": "2019-08-24T14:15:22Z",
7     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
8   },
9   {
10     "machineId": "fm100ht68sf2m52idrpslcjkpdj5r3tb3j5o0bkfubhoglbq47u18nknfog",
11     "instanceTypeId": "41e36058-8403-4086-a9b8-39cb5bc9cb98",
12     "created": "2019-08-24T14:15:22Z",
13     "updated": "2019-08-24T14:15:22Z",
14     "id": "f690ffcd-06b7-430c-9c2a-b9afd18d77c3"
15   },
16   {
17     "machineId": "fm100htrh18t1lrjg2pqagkh3sfigr9m65dejvkq168ako07sc0uibpp5q0",
18     "instanceTypeId": "41e36058-8403-4086-a9b8-39cb5bc9cb98",
19     "created": "2019-08-24T14:15:22Z",
20     "updated": "2019-08-24T14:15:22Z",
21     "id": "f690ffcd-06b7-430c-9c2a-b9afd18d77c3"
22   }
23 ]

Associate a Machine to an Instance Type

Org must have an Infrastructure Provider entity that owns the Instance Type and the Machine. User must have authorization role with PROVIDER_ADMIN suffix.

The Machine’s capabilities must be a superset of the Instance Type’s required capabilities for the association to succeed.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

instanceTypeIdstringRequiredformat: "uuid"

ID of the Instance Type

Request

This endpoint expects an object.

machineIdslist of stringsRequired

ID of the Machine

Response

Created

machineIdstring

ID of the associated Machine

instanceTypeIdstringformat: "uuid"

ID of the associated Instance Type

deprecationslist of objects

Deprecation notices for fields returned by this resource

createddatetimeRead-only

Date and time the Machine Instance Type was created

updateddatetime

Date and time the Machine Instance Type was last updated

idstringRead-onlyformat: "uuid"Deprecated

Deprecated: Use machineId when identifying a Machine/Instance Type association. This field will be removed on July 9th, 2026 0:00 UTC.

Errors

400

Bad Request Error

403

Forbidden Error