---
title: "Returns CLI Client Setup Details"
method: GET
path: "/registry/{registry_ref}/client-setup-details"
tags: ["Registries"]
---

# Returns CLI Client Setup Details

`GET /registry/{registry_ref}/client-setup-details`

Returns CLI Client Setup Details based on package type

## Path parameters

- `registry_ref` string, required

## Query parameters

- `artifact` string
- `version` string

## Response `200`

response for client setup details

- object
  - `status` 'SUCCESS' | 'FAILURE' | 'ERROR', required — Indicates if the request was successful or not
  - `data` ClientSetupDetails, required — Client Setup Details
    - `mainHeader` string, required
    - `secHeader` string, required
    - `sections` ClientSetupSection[], required
      - union — Client Setup Section
        - object — Client Setup Step
          - `header` string
          - `secHeader` string
          - `type` 'INLINE' | 'TABS', required — refers to client setup section type
          - `steps` ClientSetupStep[]
            - `header` string
            - `commands` ClientSetupStepCommand[]
              - …
            - `type` 'Static' | 'GenerateToken' — ClientSetupStepType type
        - object — Tab Setup step config
          - `header` string
          - `secHeader` string
          - `type` 'INLINE' | 'TABS', required — refers to client setup section type
          - `tabs` TabSetupStep[]
            - `header` string
            - `sections` ClientSetupSection[]

## Other responses

- `400` — Bad request
- `401` — Unauthenticated
- `403` — Unauthorized
- `404` — The specified resource was not found
- `500` — Internal server error

## Changes

- **2025-01-24** `ac3ef7cfa91b` — 1 breaking, 1 warning, 3 info
  - added `#/components/schemas/ClientSetupStepConfig, #/components/schemas/TabSetupStepConfig` to the `data/sections/items/` response property `oneOf` list for the response status `200`
  - removed the optional property `data/sections/items/steps` from the response with the `200` status
  - added the optional property `data/sections/items/secHeader` to the response with the `200` status
  - added discriminator to `data/sections/items/` response property for the response status `200`
  - …1 more
- **2024-11-26** `2ddc91eb8638` — 1 breaking, 2 info
  - the `data/sections/items/steps/items/commands/items/` response's property type changed from `string` to `object` for status `200`
  - added the optional property `data/sections/items/steps/items/commands/items/label` to the response with the `200` status
  - added the optional property `data/sections/items/steps/items/commands/items/value` to the response with the `200` status
- **2024-10-23** `7fa72da6b8aa` — 1 breaking, 1 warning, 3 info
  - removed the required property `data/sections/items/type` from the response with the `200` status
  - removed the optional property `data/sections/items/secHeader` from the response with the `200` status
  - added the optional property `data/sections/items/steps` to the response with the `200` status
  - removed discriminator from `data/sections/items/` response property for the response status `200`
  - …1 more

[Change history](https://skmtc.dev/harness/apis/harness-artifact-registry-api/changes/registry/:registry_ref/client-setup-details/get.md)

---

[API](https://skmtc.dev/harness/apis/harness-artifact-registry-api.md) · [All operations](https://skmtc.dev/harness/apis/harness-artifact-registry-api/llms.txt) · [OpenAPI document](https://skmtc.dev/harness/apis/harness-artifact-registry-api/revisions/e315ed26a2f1?raw)