Create Allocation

POST

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/allocation

POST

/v2/org/:org/nico/allocation

$ curl -X POST https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/allocation \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Echo Studios",
>   "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
>   "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
>   "description": "Echo Studios resource allocation in SJC4",
>   "allocationConstraints": [
>     {
>       "resourceType": "InstanceType",
>       "resourceTypeId": "bd5a0240-eb62-4bff-91f7-335e6bb86459",
>       "constraintType": "Reserved",
>       "constraintValue": 10
>     }
>   ]
> }'

1 {
2   "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
3   "name": "Echo Studios",
4   "description": "Echo Studios resource allocation in SJC4",
5   "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
6   "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
7   "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
8   "status": "Pending",
9   "statusHistory": [
10     {
11       "status": "Pending",
12       "message": "Request received, pending processing",
13       "created": "2019-08-24T14:15:22Z",
14       "updated": "2019-08-24T14:15:22Z"
15     }
16   ],
17   "allocationConstraints": [
18     {
19       "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
20       "allocationId": "9ec871ce-3363-4de2-8f79-062881067628",
21       "resourceType": "InstanceType",
22       "resourceTypeId": "bd5a0240-eb62-4bff-91f7-335e6bb86459",
23       "constraintType": "Reserved",
24       "constraintValue": 10,
25       "derivedResourceId": null,
26       "created": "2019-08-24T14:15:22Z",
27       "updated": "2019-08-24T14:15:22Z"
28     }
29   ],
30   "created": "2019-08-24T14:15:22Z",
31   "updated": "2019-08-24T14:15:22Z"
32 }

Create an Allocation for the org.

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

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

Create an Allocation for the org. Org must have an Infrastructure Provider entity. User must have authorization role with `PROVIDER_ADMIN` suffix. To successfully create a compute Allocation, there must be enough unallocated Machines associated with the Instance Type to satisfy the constraint value. For network Allocation, the source site-level IP Block must have an available prefix with length equal to the constraint value.

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

Request

This endpoint expects an object.

namestringRequired2-256 characters

Concise and descriptive name for the Allocation

tenantIdstringRequiredformat: "uuid"

ID of the Tenant that should receive the Allocation

siteIdstringRequiredformat: "uuid"

ID of the Site where resources should be allocated

descriptionstring or nullOptional

Detailed description for the Allocation

allocationConstraintslist of objectsOptional

List of Allocation Constraint objects

Response

Created

idstringRead-onlyformat: "uuid"

ID of the Allocation

namestring2-256 characters

Concise and descriptive name of the Allocation

descriptionstring or null

Detailed description of the Allocation

infrastructureProviderIdstringformat: "uuid"

ID of the Infrastructure Provider that created the Allocation

tenantIdstringformat: "uuid"

ID of the Tenant that received the Allocation

siteIdstringformat: "uuid"

ID of the Site where resources are allocated

statusenum

Status of the Allocation

statusHistorylist of objectsRead-only

Chronological status history for the Allocation

allocationConstraintslist of objects

List of Allocation Constraints for the Allocation

createddatetimeRead-only

Date/time when the Allocation was created

updateddatetimeRead-only

Date/time when the Allocation was last updated

Errors

400

Bad Request Error

403

Forbidden Error