---
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

---

[API](https://skmtc.net/harness/apis/harness-artifact-registry-api.md) · [All operations](https://skmtc.net/harness/apis/harness-artifact-registry-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/harness/harness-artifact-registry-api/revisions/e315ed26a2f1/schema)