Retrieve SpectrumX Partition

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/spectrumx-partition/:spectrumXPartitionId

GET

/v2/org/:org/nico/spectrumx-partition/:spectrumXPartitionId

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

{
  "id": "8e6f2a1c-9b3d-4e5f-a6b7-c8d9e0f1a2b3",
  "name": "east-west-net",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "status": "Ready",
  "description": "SpectrumX Partition for east-west training traffic",
  "vni": 10200,
  "labels": {
    "environment": "production",
    "team": "devops"
  },
  "statusHistory": [
    {
      "status": "Ready",
      "message": "SpectrumX Partition is ready for use",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Retrieve a specific SpectrumX Partition

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

Tenant must own the Partition.

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

spectrumXPartitionIdstringRequired

ID of the SpectrumX Partition

Query parameters

includeRelationenumOptional

Related entity to expand

Allowed values:

Response

idstringRead-onlyformat: "uuid"

Unique UUID v4 identifier for the SpectrumX Partition

namestring2-256 characters

Name of the SpectrumX Partition

siteIdstringformat: "uuid"

ID of the Site the Partition belongs to

tenantIdstringformat: "uuid"

ID of the Tenant that owns the Partition

statusenumRead-only

Status of the SpectrumX Partition. A Partition becomes Ready once the Site reports it in inventory

descriptionstring or nullOptional

Description of the SpectrumX Partition

siteobjectOptional

Summary of the Site, present when requested through includeRelation

tenantobjectOptional

Summary of the Tenant, present when requested through includeRelation

vniinteger or nullOptional

VXLAN Network Identifier for the Partition. Allocated by the Site when the create request omits it

labelsmap from strings to stringsOptional

String key-value pairs describing Partition labels. Up to 10 key-value pairs can be specified

statusHistorylist of objectsOptionalRead-only

Status detail records for the SpectrumX Partition over time

createddatetimeOptionalRead-only

ISO datetime string for when the SpectrumX Partition was created

updateddatetimeOptionalRead-only

ISO datetime string for when the SpectrumX Partition was last updated

Errors

403

Forbidden Error

404

Not Found Error