Skip to content

The organization's compute context

  • Method: GET
  • Path: /v1/orgs/{org}/compute
  • Operation ID: getComputeContext
  • Tag: Compute

Send Authorization: Bearer <credential>. The credential is either an API key (vsk_…) created for an organization, or an OIDC access token obtained by signing in to VirtScale.

Name Type Required Description
org string (uuid) Yes The organization’s id.
Field Type Required Enum Description
default_region_id string, nullable Yes
networks array of CustomerNetworkOut Yes One entry per region this org’s tenant network has been requested in. Empty until compute is enrolled and at least one region is active – an org that predates tenant networking, or whose enrollment has requested no region yet, reads the same way a brand-new org does.
networks.cidr string Yes This organization’s /24 in this region, e.g. 10.128.1.0/24.
networks.gateway string Yes The network’s own gateway address – the first address of the /24.
networks.region_id string Yes
networks.state string Yes pending | ensured | error.
org_id string (uuid) Yes
state string Yes active | suspended | disabled.

Every error response is application/problem+json (schema Problem).

Status Meaning
401 The credential is missing or invalid.
404 The resource does not exist.
default Any other status is possible; the code field identifies the error.
curl "https://api.virtscale.nl/v1/orgs/$ORG_ID/compute" \
  -H "Authorization: Bearer $VIRTSCALE_API_KEY"