---
title: "Get a specified data plane"
method: GET
path: "/data-planes/{id}"
tags: ["data-planes"]
---

# Get a specified data plane

`GET /data-planes/{id}`

An account user or administrator is authorized to all data planes in use by applications defined in their account. Attempts to access other data planes will result in 404 NOT FOUND.

## Path parameters

- `id` string, required

## Response `200`

The call was successful.

- DataPlane — State for a data plane
  - `name` string — Name describing the data plane
  - `account` string — A reference to an account
  - `minimum_size` integer — Minimum number of proxies in this data plane
  - `maximum_size` integer — Maximum number of proxies in this data plane
  - `maximum_assignments_per_proxy` integer — Maximum number of application assignments per proxy
  - `blueprints` Blueprint[] — Array of blueprints
    - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint.
      - `file` string — A reference to a Webscale file.
      - `path` string — The absolute path where the file is made available on a server made with this blueprint.
    - `identity` IdentityConfiguration — Configuration of the identity assigned to cluster servers.
      - `name` string, required — Name of the identity.
      - `client_id` string, required — Client ID for the identity to be assigned.
      - `principal_id` string, required — Principal ID for the identity to be assigned.
    - `image` string — Resource href that includes the Webscale provider identifier.
    - `instance_template` string — The endpoint resource identifier for the instance template.
    - `instance_type` string — Resource href that includes the Webscale provider identifier.
    - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created with this blueprint. Server blueprint metadata overrides the cluster metadata on a key-by-key basis.
      - `key` string — A key name.
      - `value` string — A value associated with the given key.
    - `networks` ProviderResourceHref[] — List of network or subnet endpoint resource references to associate the server with. Network availability may be limited to specific zones depending on the cloud provider.
    - `network_tags` string[] — List of network tags to associate with the server. Only applicable for Google provider.
    - `placement` union
      - string — Resource href that includes the Webscale provider identifier.
      - string — The endpoint resource identifier for the server group, must be a URL encoded string. Only valid for CenturyLink provider.
    - `provider` Provider
      - `created` string — An iso8601 formatted timestamp
      - `href` string — Resource identifier for the provider, must be a URL encoded string.
      - `name` string
      - `type` 'aliyun' | 'aws' | 'centurylink' | 'cloudsigma' | 'google' — Type of the cloud provider.
      - `links` ProviderAttributes — Provider attributes that represent cloud provider attributes and may be queried via the API.
    - `security_groups` SecurityGroupHref[] — List of security group endpoint resource references to associate with the server. Only applicable for AWS provider.
    - `storage_account` string — Resource href that includes the Webscale provider identifier.
    - `zone` string — Resource href that includes the Webscale provider identifier.
  - `href` string — A reference to this data plane
  - `assigned_applications` string[] — Array of applications assigned to this data plane
  - `proxies` Proxy[] — Array of the assigned proxies to this data plane
    - `name` string — The name of the proxy
    - `public_addresses` Cidr[] — The public IP addresses of this proxy
    - `private_addresses` Cidr[] — The private IP addresses of this proxy
    - `blueprint` Blueprint — The endpoint resource reference to the blueprint of the servers.
      - `files` MetadataFileEntry[] — A set of files to be made available on servers created with this blueprint.
        - `file` string — A reference to a Webscale file.
        - `path` string — The absolute path where the file is made available on a server made with this blueprint.
      - `identity` IdentityConfiguration — Configuration of the identity assigned to cluster servers.
        - `name` string, required — Name of the identity.
        - `client_id` string, required — Client ID for the identity to be assigned.
        - `principal_id` string, required — Principal ID for the identity to be assigned.
      - `image` string — Resource href that includes the Webscale provider identifier.
      - `instance_template` string — The endpoint resource identifier for the instance template.
      - `instance_type` string — Resource href that includes the Webscale provider identifier.
      - `metadata` MetadataEntry[] — A set of key/value pairs that will be provided to servers created with this blueprint. Server blueprint metadata overrides the cluster metadata on a key-by-key basis.
        - `key` string — A key name.
        - `value` string — A value associated with the given key.
      - `networks` ProviderResourceHref[] — List of network or subnet endpoint resource references to associate the server with. Network availability may be limited to specific zones depending on the cloud provider.
      - `network_tags` string[] — List of network tags to associate with the server. Only applicable for Google provider.
      - `placement` union
        - string — Resource href that includes the Webscale provider identifier.
        - string — The endpoint resource identifier for the server group, must be a URL encoded string. Only valid for CenturyLink provider.
      - `provider` Provider
        - `created` string — An iso8601 formatted timestamp
        - `href` string — Resource identifier for the provider, must be a URL encoded string.
        - `name` string
        - `type` 'aliyun' | 'aws' | 'centurylink' | 'cloudsigma' | 'google' — Type of the cloud provider.
        - `links` ProviderAttributes — Provider attributes that represent cloud provider attributes and may be queried via the API.
      - `security_groups` SecurityGroupHref[] — List of security group endpoint resource references to associate with the server. Only applicable for AWS provider.
      - `storage_account` string — Resource href that includes the Webscale provider identifier.
      - `zone` string — Resource href that includes the Webscale provider identifier.
    - `version` string — The version of lgbroker that is running on this proxy
    - `href` string — A reference to this proxy
    - `state` 'creating' | 'installing' | 'acl_installing' | 'configuring' | 'running' | 'maintenance' | 'replacing' | 'failed' | 'deleting' — The state of the proxy
    - `created` string — An iso8601 formatted timestamp
    - `unreachable_since` string — An iso8601 formatted timestamp
    - `reachable_since` string — An iso8601 formatted timestamp
    - `configured` string — An iso8601 formatted timestamp
    - `replacement_for` string — The derivative proxy this proxy replaced

---

[API](https://skmtc.dev/webscale/apis/webscale-apis.md) · [All operations](https://skmtc.dev/webscale/apis/webscale-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/webscale/webscale-apis/revisions/c98d872b50cb/schema)