---
title: "GET /public/console/v2/partner-zone/{partner-zone-name}"
method: GET
path: "/public/console/v2/partner-zone/{partner-zone-name}"
tags: ["cli_partner-zone_console_v2_17"]
---

# GET /public/console/v2/partner-zone/{partner-zone-name}

`GET /public/console/v2/partner-zone/{partner-zone-name}`

## Request

- Base URL: `https://developers.conduktor.io` (the document declares no server; this is the origin it was published from)
- URL: `https://developers.conduktor.io/public/console/v2/partner-zone/{partner-zone-name}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/conduktor/apis/conduktor-console-api/docs/public/console/v2/partner-zone/:partner-zone-name/get.ts> (a function with typed inputs; its response is checked against the schema)

Get PartnerZone by name

## Path parameters

- `partner-zone-name` string, required

## Response `200`

- PartnerZoneOutputResourceV2
  - `apiVersion` string, required
  - `kind` 'PartnerZone', required
  - `metadata` PartnerZoneMetadataOutput, required
    - `name` string, required
    - `id` string, uuid, required
    - `updatedAt` string, date-time, required
    - `status` 'DELETED' | 'FAILED' | 'PENDING_CREATE' | 'PENDING_UPDATE' | 'READY' | 'TO_DELETE', required
    - `failedReason` string
    - `labels` MapLabelKeyString
  - `spec` PartnerZoneSpec, required
    - `cluster` string, required: The gateway cluster to use for this Partner Zone
    - `underlyingCluster` string: The underlying cluster behind gateway to use for this Partner Zone. If not provided, defaults to the value of the `cluster` field
    - `displayName` string
    - `description` string
    - `url` string
    - `authenticationMode` AuthenticationMode, required
      - `serviceAccount` string, required
      - `type` 'MTLS' | 'OAUTHBEARER' | 'PLAIN', required
    - `topics` PartnerZoneTopic[], required
      - `name` string, required
      - `backingTopic` string, required
      - `permission` 'READ' | 'WRITE', required
    - `partner` Partner
      - `name` string, required
      - `role` string
      - `email` string
      - `phone` string
    - `trafficControlPolicies` TrafficControlPolicies
      - `maxProduceRate` integer: produce rate in bytes per second
      - `maxConsumeRate` integer: consume rate in bytes per second
      - `limitCommitOffset` integer: commit attempts per minute
    - `headers` Headers
      - `addOnProduce` ToAdd[]
        - `key` string, required
        - `value` string, required
        - `overrideIfExists` boolean, required
      - `removeOnConsume` ToRemove[]
        - `keyRegex` string, required: Must be a valid java regular expression
    - `vclusterName` string: Custom virtual cluster name. If not provided, it will be auto-generated
    - `skipInterceptorReconciliation` boolean: When enabled, interceptors are created once during partner zone creation but skipped on subsequent reconciliations. Use with caution as enabling this flag could lead to issues with upgrading to future versions of Console

## Other responses

- `400`: The request is not valid
- `401`: The user is not authenticated
- `403`: The user doesn't have sufficient privilege to do this operation
- `404`: No partner-zone with this technical id exists
- `500`: An unexpected error occurred in the server

---

[API](https://skmtc.dev/conduktor/apis/conduktor-console-api.md) - [All operations](https://skmtc.dev/conduktor/apis/conduktor-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/conduktor/apis/conduktor-console-api/revisions/24750c294805?raw)