---
title: "Get a description of a kubernetes resource"
method: GET
path: "/kubernetes/{id}/describe"
tags: ["kubernetes"]
---

# Get a description of a kubernetes resource

`GET /kubernetes/{id}/describe`

Get a description of a kubernetes resource.
**Access policy**: Authenticated user.

## Path parameters

- `id` integer, required

## Query parameters

- `name` string, required
- `kind` string, required
- `namespace` string

## Response `200`

Success

- KubernetesDescribeResourceResponse
  - `describe` string

## Other responses

- `400` — Invalid request payload, such as missing required fields or fields not meeting validation criteria.
- `401` — Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
- `403` — Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
- `404` — Unable to find an environment with the specified identifier.
- `500` — Server error occurred while attempting to retrieve resource description

---

[API](https://skmtc.net/portainer/apis/portainerce-api.md) · [All operations](https://skmtc.net/portainer/apis/portainerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portainer/portainerce-api/versions/c0b0975cd11b/schema)