Retrieve all Allocations

GET

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

GET

/v2/org/:org/nico/allocation

$ curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/allocation \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
4     "name": "Echo Studios",
5     "description": "Echo Studios resource allocation in SJC4",
6     "infrastructureProviderId": "e94bcfda-f6cb-42e4-80ec-516811e5abbf",
7     "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
8     "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
9     "status": "Pending",
10     "statusHistory": [
11       {
12         "status": "Pending",
13         "message": "Request received, pending processing",
14         "created": "2019-08-24T14:15:22Z",
15         "updated": "2019-08-24T14:15:22Z"
16       }
17     ],
18     "allocationConstraints": [
19       {
20         "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
21         "allocationId": "9ec871ce-3363-4de2-8f79-062881067628",
22         "resourceType": "InstanceType",
23         "resourceTypeId": "a59ee688-b5e5-4606-9891-f4a605edacd3",
24         "constraintType": "Reserved",
25         "constraintValue": 10,
26         "derivedResourceId": null,
27         "instanceType": {
28           "name": "x3.large",
29           "infrastructureProviderId": "63c29416-8833-4eaf-9e1c-7c0173cc3150",
30           "siteId": "c9f4f276-6f7a-4209-953c-2b9870ce7cc1",
31           "status": "Ready"
32         },
33         "created": "2019-08-24T14:15:22Z",
34         "updated": "2019-08-24T14:15:22Z"
35       }
36     ],
37     "created": "2019-08-24T14:15:22Z",
38     "updated": "2019-08-24T14:15:22Z"
39   }
40 ]

Retrieve all Allocations for the org.

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

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

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

Query parameters

infrastructureProviderIdstringOptionalformat: "uuid"Deprecated

Filter Allocations by Infrastructure Provider ID.

tenantIdstringOptionalformat: "uuid"

Filter Allocations by Tenant ID.

siteIdstringOptionalformat: "uuid"

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

idstringOptional

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

resourceTypeenumOptional

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

Allowed values:

statusstringOptional

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

resourceTypeIdstringOptional

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

constraintTypeenumOptional

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

Allowed values:

constraintValueintegerOptional

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

querystringOptional

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

includeRelationenumOptional

Related entity to expand

Allowed values:

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

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

403

Forbidden Error